The Specification class contains the information for a Gem. Typically defined in a .gemspec file or a Rakefile, and looks like this:
Gem::Specification.new do |s| s.name = 'example' s.version = '0.1.0' s.licenses = ['MIT'] s.summary = "This is an example!" s.description = "Much longer explanation of the example!" s.authors = ["Ruby Coder"] s.email = 'rubycoder@example.com' s.files = ["lib/example.rb"] s.homepage = 'https://rubygems.org/gems/example' s.metadata = { "source_code_uri" => "https://github.com/example/example" } end
Starting in RubyGems 2.0, a Specification can hold arbitrary metadata. See metadata for restrictions on the format and size of metadata items you may add to a specification.
The version number of a specification that does not specify one (i.e. RubyGems 0.7 or earlier).
A message that gets displayed after the gem is installed.
Usage:
spec.post_install_message = "Thanks for installing!"
Adds a development dependency named gem
with
requirements
to this gem.
Usage:
spec.add_development_dependency 'example', '~> 1.1', '>= 1.1.4'
Development dependencies aren't installed by default and aren't activated when a gem is required.
# File rubygems/specification.rb, line 539 def add_development_dependency(gem, *requirements) add_dependency_with_type(gem, :development, requirements) end
Adds a runtime dependency named gem
with
requirements
to this gem.
Usage:
spec.add_runtime_dependency 'example', '~> 1.1', '>= 1.1.4'
# File rubygems/specification.rb, line 550 def add_runtime_dependency(gem, *requirements) add_dependency_with_type(gem, :runtime, requirements) end
Executables included in the gem.
For example, the rake gem has rake as an executable. You don’t specify the full path (as in bin/rake); all application-style files are expected to be found in bindir. These files must be executable Ruby files. Files that use bash or other interpreters will not work.
Executables included may only be ruby scripts, not scripts for other languages or compiled binaries.
Usage:
spec.executables << 'rake'
# File rubygems/specification.rb, line 569 def executables @executables ||= [] end
Extensions to build when installing the gem, specifically the paths to extconf.rb-style files used to compile extensions.
These files will be run when the gem is installed, causing the C (or whatever) code to be compiled on the user’s machine.
Usage:
spec.extensions << 'ext/rmagic/extconf.rb'
See Gem::Ext::Builder for information about writing extensions for gems.
# File rubygems/specification.rb, line 586 def extensions @extensions ||= [] end
Extra files to add to RDoc such as README or doc/examples.txt
When the user elects to generate the RDoc documentation for a gem (typically at install time), all the library files are sent to RDoc for processing. This option allows you to have some non-code files included for a more complete set of documentation.
Usage:
spec.extra_rdoc_files = ['README', 'doc/user-guide.txt']
# File rubygems/specification.rb, line 602 def extra_rdoc_files @extra_rdoc_files ||= [] end
The platform this gem runs on.
This is usually Gem::Platform::RUBY or Gem::Platform::CURRENT.
Most gems contain pure Ruby code; they should simply leave the default value in place. Some gems contain C (or other) code to be compiled into a Ruby “extension”. The gem should leave the default value in place unless the code will only compile on a certain type of system. Some gems consist of pre-compiled code (“binary gems”). It's especially important that they set the platform attribute appropriately. A shortcut is to set the platform to Gem::Platform::CURRENT, which will cause the gem builder to set the platform to the appropriate value for the system on which the build is being performed.
If this attribute is set to a non-default value, it will be included in the filename of the gem when it is built such as: nokogiri-1.6.0-x86-mingw32.gem
Usage:
spec.platform = Gem::Platform.local
# File rubygems/specification.rb, line 451 def platform= platform if @original_platform.nil? or @original_platform == Gem::Platform::RUBY then @original_platform = platform end case platform when Gem::Platform::CURRENT then @new_platform = Gem::Platform.local @original_platform = @new_platform.to_s when Gem::Platform then @new_platform = platform # legacy constants when nil, Gem::Platform::RUBY then @new_platform = Gem::Platform::RUBY when 'mswin32' then # was Gem::Platform::WIN32 @new_platform = Gem::Platform.new 'x86-mswin32' when 'i586-linux' then # was Gem::Platform::LINUX_586 @new_platform = Gem::Platform.new 'x86-linux' when 'powerpc-darwin' then # was Gem::Platform::DARWIN @new_platform = Gem::Platform.new 'ppc-darwin' else @new_platform = Gem::Platform.new platform end @platform = @new_platform.to_s invalidate_memoized_attributes @new_platform end
Specifies the rdoc options to be used when generating API documentation.
Usage:
spec.rdoc_options << '--title' << 'Rake -- Ruby Make' << '--main' << 'README' << '--line-numbers'
# File rubygems/specification.rb, line 632 def rdoc_options @rdoc_options ||= [] end
Paths in the gem to add to $LOAD_PATH
when this gem is
activated. If you have an extension you do not need to add
"ext"
to the require path, the extension build
process will copy the extension files into “lib” for you.
The default value is "lib"
Usage:
# If all library files are in the root directory... spec.require_paths = ['.']
# File rubygems/specification.rb, line 502 def require_paths=(val) @require_paths = Array(val) end
The version of Ruby required by this gem. The ruby version can be specified to the patch-level:
$ ruby -v -e 'p Gem.ruby_version' ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-darwin12.4.0] #<Gem::Version "2.0.0.247">
Because patch-level is taken into account, be very careful specifying using `<=`: `<= 2.2.2` will not match any patch-level of 2.2.2 after the `p0` release. It is much safer to specify `< 2.2.3` instead
Usage:
# This gem will work with 1.8.6 or greater... spec.required_ruby_version = '>= 1.8.6' # Only with ruby 2.0.x spec.required_ruby_version = '~> 2.0' # Only with ruby between 2.2.0 and 2.2.2 spec.required_ruby_version = ['>= 2.2.0', '< 2.2.3']
# File rubygems/specification.rb, line 659 def required_ruby_version= req @required_ruby_version = Gem::Requirement.create req end
The RubyGems version required by this gem
# File rubygems/specification.rb, line 666 def required_rubygems_version= req @required_rubygems_version = Gem::Requirement.create req end
Lists the external (to RubyGems) requirements that must be met for this gem to work. It's simply information for the user.
Usage:
spec.requirements << 'libmagick, v6.0' spec.requirements << 'A good graphics card'
# File rubygems/specification.rb, line 679 def requirements @requirements ||= [] end
A long description of this gem
The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting.
Usage:
spec.description = <<-EOF Rake is a Make-like program implemented in Ruby. Tasks and dependencies are specified in standard Ruby syntax. EOF
A contact email address (or addresses) for this gem
Usage:
spec.email = 'john.jones@example.com' spec.email = ['jack@example.com', 'jill@example.com']
The metadata holds extra data for this gem that may be useful to other consumers and is settable by gem authors without requiring an update to the rubygems software.
Metadata items have the following restrictions:
The metadata must be a Hash object
All keys and values must be Strings
Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes
All strings must be UTF-8, no binary data is allowed
You can use metadata to specify links to your gem's homepage, codebase, documentation, wiki, mailing list, issue tracker and changelog.
s.metadata = { "bug_tracker_uri" => "https://example.com/user/bestgemever/issues", "changelog_uri" => "https://example.com/user/bestgemever/CHANGELOG.md", "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1", "homepage_uri" => "https://bestgemever.example.io", "mailing_list_uri" => "https://groups.example.com/bestgemever", "source_code_uri" => "https://example.com/user/bestgemever", "wiki_uri" => "https://example.com/user/bestgemever/wiki" }
These links will be used on your gem's page on rubygems.org and must pass validation against following regex.
%r{\Ahttps?:\/\/([^\s:@]+:[^\s:@]*@)?[A-Za-z\d\-]+(\.[A-Za-z\d\-]+)+\.?(:\d{1,5})?([\/?]\S*)?\z}
The license for this gem.
The license must be no more than 64 characters.
This should just be the name of your license. The full text of the license should be inside of the gem (at the top level) when you build it.
The simplest way, is to specify the standard SPDX ID spdx.org/licenses/ for the license. Ideally you should pick one that is OSI (Open Source Initiative) opensource.org/licenses/alphabetical approved.
The most commonly used OSI approved licenses are MIT and Apache-2.0. GitHub also provides a license picker at choosealicense.com/.
You should specify a license for your gem so that people know how they are permitted to use it, and any restrictions you're placing on it. Not specifying a license means all rights are reserved; others have no rights to use the code for any purpose.
You can set multiple licenses with licenses=
Usage:
spec.license = 'MIT'
# File rubygems/specification.rb, line 347 def license=o self.licenses = [o] end
The license(s) for the library.
Each license must be a short name, no more than 64 characters.
This should just be the name of your license. The full text of the license should be inside of the gem when you build it.
See license= for more discussion
Usage:
spec.licenses = ['MIT', 'GPL-2.0']
# File rubygems/specification.rb, line 364 def licenses= licenses @licenses = Array licenses end
A short summary of this gem's description. Displayed in `gem list -d`.
The description should be more detailed than the summary.
Usage:
spec.summary = "This is a small summary of my gem"
Files included in this gem. You cannot append to this accessor, you must assign to it.
Only add files you can require to this list, not directories, etc.
Directories are automatically stripped from this list when building a gem, other non-files cause an error.
Usage:
require 'rake' spec.files = FileList['lib .rb', 'bin/*', '[A-Z]*', 'test/ *'].to_a # or without Rake... spec.files = Dir['lib/ *.rb'] + Dir['bin/*'] spec.files += Dir['[A-Z]*'] + Dir['test/**/*'] spec.files.reject! { |fn| fn.include? "CVS" }
# File rubygems/specification.rb, line 250 def files # DO NOT CHANGE TO ||= ! This is not a normal accessor. (yes, it sucks) # DOC: Why isn't it normal? Why does it suck? How can we fix this? @files = [@files, @test_files, add_bindir(@executables), @extra_rdoc_files, @extensions, ].flatten.compact.uniq.sort end
Sets the default executable for this gem.
Deprecated: You must now specify the executable name to Gem.bin_path.
The rubyforge project this gem lives under. i.e. RubyGems' #rubyforge_project is “rubygems”.
This option is deprecated.
The Gem::Specification version of this gemspec.
Do not set this, it is set automatically when the gem is packaged.
Load custom marshal format, re-initializing defaults as needed
# File rubygems/specification.rb, line 1308 def self._load(str) array = Marshal.load str spec = Gem::Specification.new spec.instance_variable_set :@specification_version, array[1] current_version = CURRENT_SPECIFICATION_VERSION field_count = if spec.specification_version > current_version then spec.instance_variable_set :@specification_version, current_version MARSHAL_FIELDS[current_version] else MARSHAL_FIELDS[spec.specification_version] end if array.size < field_count then raise TypeError, "invalid Gem::Specification format #{array.inspect}" end # Cleanup any YAML::PrivateType. They only show up for an old bug # where nil => null, so just convert them to nil based on the type. array.map! { |e| e.kind_of?(YAML::PrivateType) ? nil : e } spec.instance_variable_set :@rubygems_version, array[0] # spec version spec.instance_variable_set :@name, array[2] spec.instance_variable_set :@version, array[3] spec.date = array[4] spec.instance_variable_set :@summary, array[5] spec.instance_variable_set :@required_ruby_version, array[6] spec.instance_variable_set :@required_rubygems_version, array[7] spec.instance_variable_set :@original_platform, array[8] spec.instance_variable_set :@dependencies, array[9] spec.instance_variable_set :@rubyforge_project, array[10] spec.instance_variable_set :@email, array[11] spec.instance_variable_set :@authors, array[12] spec.instance_variable_set :@description, array[13] spec.instance_variable_set :@homepage, array[14] spec.instance_variable_set :@has_rdoc, array[15] spec.instance_variable_set :@new_platform, array[16] spec.instance_variable_set :@platform, array[16].to_s spec.instance_variable_set :@license, array[17] spec.instance_variable_set :@metadata, array[18] spec.instance_variable_set :@loaded, false spec.instance_variable_set :@activated, false spec end
Adds spec
to the known specifications, keeping the collection
properly sorted.
# File rubygems/specification.rb, line 874 def self.add_spec spec warn "Gem::Specification.add_spec is deprecated and will be removed in RubyGems 3.0" unless Gem::Deprecate.skip # TODO: find all extraneous adds # puts # p :add_spec => [spec.full_name, caller.reject { |s| s =~ /minitest/ }] # TODO: flush the rest of the crap from the tests # raise "no dupes #{spec.full_name} in #{all_names.inspect}" if # _all.include? spec raise "nil spec!" unless spec # TODO: remove once we're happy with tests return if _all.include? spec _all << spec stubs << spec (@@stubs_by_name[spec.name] ||= []) << spec sort_by!(@@stubs_by_name[spec.name]) { |s| s.version } _resort!(_all) _resort!(stubs) end
Adds multiple specs to the known specifications.
# File rubygems/specification.rb, line 899 def self.add_specs *specs warn "Gem::Specification.add_specs is deprecated and will be removed in RubyGems 3.0" unless Gem::Deprecate.skip raise "nil spec!" if specs.any?(&:nil?) # TODO: remove once we're happy # TODO: this is much more efficient, but we need the extra checks for now # _all.concat specs # _resort! Gem::Deprecate.skip_during do specs.each do |spec| # TODO: slow add_spec spec end end end
Returns all specifications. This method is discouraged from use. You probably want to use one of the Enumerable methods instead.
# File rubygems/specification.rb, line 919 def self.all warn "NOTE: Specification.all called from #{caller.first}" unless Gem::Deprecate.skip _all end
Sets the known specs to specs
. Not guaranteed to work for you
in the future. Use at your own risk. Caveat emptor. Doomy doom doom. Etc
etc.
# File rubygems/specification.rb, line 937 def self.all= specs raise "nil spec!" if specs.any?(&:nil?) # TODO: remove once we're happy @@stubs_by_name = specs.group_by(&:name) @@all = @@stubs = specs end
Return full names of all specs in sorted order.
# File rubygems/specification.rb, line 946 def self.all_names self._all.map(&:full_name) end
Return the list of all array-oriented instance variables.
# File rubygems/specification.rb, line 955 def self.array_attributes @@array_attributes.dup end
Return the list of all instance variables.
# File rubygems/specification.rb, line 964 def self.attribute_names @@attributes.dup end
Return the directories that Specification uses to find specs.
# File rubygems/specification.rb, line 971 def self.dirs @@dirs ||= Gem.path.collect { |dir| File.join dir.dup.untaint, "specifications" } end
Set the directories that Specification uses to find specs. Setting this resets the list of known specs.
# File rubygems/specification.rb, line 981 def self.dirs= dirs self.reset @@dirs = Array(dirs).map { |dir| File.join dir, "specifications" } end
Enumerate every known spec. See ::dirs= and ::add_spec to set the list of specs.
# File rubygems/specification.rb, line 993 def self.each return enum_for(:each) unless block_given? self._all.each do |x| yield x end end
# File rubygems/specification.rb, line 1056 def self.find_active_stub_by_path path stub = @@active_stub_with_requirable_file[path] ||= (stubs.find { |s| s.activated? and s.contains_requirable_file? path } || NOT_FOUND) stub.this end
Returns every spec that has the given full_name
# File rubygems/specification.rb, line 1015 def self.find_all_by_full_name(full_name) stubs.select {|s| s.full_name == full_name }.map(&:to_spec) end
Returns every spec that matches name
and optional
requirements
.
# File rubygems/specification.rb, line 1004 def self.find_all_by_name name, *requirements requirements = Gem::Requirement.default if requirements.empty? # TODO: maybe try: find_all { |s| spec === dep } Gem::Dependency.new(name, *requirements).matching_specs end
Find the best specification matching a name
and
requirements
. Raises if the dependency doesn't resolve to
a valid specification.
# File rubygems/specification.rb, line 1023 def self.find_by_name name, *requirements requirements = Gem::Requirement.default if requirements.empty? # TODO: maybe try: find { |s| spec === dep } Gem::Dependency.new(name, *requirements).to_spec end
Return the best specification that contains the file matching
path
.
# File rubygems/specification.rb, line 1034 def self.find_by_path path path = path.dup.freeze spec = @@spec_with_requirable_file[path] ||= (stubs.find { |s| next unless Gem::BundlerVersionFinder.compatible?(s) s.contains_requirable_file? path } || NOT_FOUND) spec.to_spec end
Return currently unresolved specs that contain the file matching
path
.
# File rubygems/specification.rb, line 1066 def self.find_in_unresolved path # TODO: do we need these?? Kill it specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten specs.find_all { |spec| spec.contains_requirable_file? path } end
Search through all unresolved deps and sub-dependencies and return specs
that contain the file matching path
.
# File rubygems/specification.rb, line 1077 def self.find_in_unresolved_tree path specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten specs.each do |spec| spec.traverse do |from_spec, dep, to_spec, trail| if to_spec.has_conflicts? || to_spec.conficts_when_loaded_with?(trail) :next else return trail.reverse if to_spec.contains_requirable_file? path end end end [] end
Return the best specification that contains the file matching
path
amongst the specs that are not activated.
# File rubygems/specification.rb, line 1047 def self.find_inactive_by_path path stub = stubs.find { |s| next if s.activated? next unless Gem::BundlerVersionFinder.compatible?(s) s.contains_requirable_file? path } stub && stub.to_spec end
Special loader for YAML files. When a Specification object is loaded from a YAML file, it bypasses the normal Ruby object initialization routine (#initialize). This method makes up for that and deals with gems of different ages.
input
can be anything that YAML.load() accepts: String or IO.
# File rubygems/specification.rb, line 1101 def self.from_yaml(input) Gem.load_yaml input = normalize_yaml_input input spec = Gem::SafeYAML.safe_load input if spec && spec.class == FalseClass then raise Gem::EndOfYAMLException end unless Gem::Specification === spec then raise Gem::Exception, "YAML data doesn't evaluate to gem specification" end spec.specification_version ||= NONEXISTENT_SPECIFICATION_VERSION spec.reset_nil_attributes_to_default spec end
Return the latest specs, optionally including prerelease specs if
prerelease
is true.
# File rubygems/specification.rb, line 1125 def self.latest_specs prerelease = false _latest_specs Gem::Specification._all, prerelease end
Loads Ruby format gemspec from file
.
# File rubygems/specification.rb, line 1149 def self.load file return unless file _spec = LOAD_CACHE[file] return _spec if _spec file = file.dup.untaint return unless File.file?(file) code = File.read file, :mode => 'r:UTF-8:-' code.untaint begin _spec = eval code, binding, file if Gem::Specification === _spec _spec.loaded_from = File.expand_path file.to_s LOAD_CACHE[file] = _spec return _spec end warn "[#{file}] isn't a Gem::Specification (#{_spec.class} instead)." rescue SignalException, SystemExit raise rescue SyntaxError, Exception => e warn "Invalid gemspec in [#{file}]: #{e}" end nil end
Loads the default specifications. It should be called only once.
# File rubygems/specification.rb, line 862 def self.load_defaults each_spec([default_specifications_dir]) do |spec| # #load returns nil if the spec is bad, so we just ignore # it at this stage Gem.register_default_spec(spec) end end
Specification constructor. Assigns the
default values to the attributes and yields itself for further
initialization. Optionally takes name
and
version
.
# File rubygems/specification.rb, line 2054 def initialize name = nil, version = nil super() @gems_dir = nil @base_dir = nil @loaded = false @activated = false @loaded_from = nil @original_platform = nil @installed_by_version = nil set_nil_attributes_to_nil set_not_nil_attributes_to_default_values @new_platform = Gem::Platform::RUBY self.name = name if name self.version = version if version yield self if block_given? end
Specification attributes that must be non-nil
# File rubygems/specification.rb, line 1184 def self.non_nil_attributes @@non_nil_attributes.dup end
Make sure the YAML specification is properly formatted with dashes
# File rubygems/specification.rb, line 1191 def self.normalize_yaml_input(input) result = input.respond_to?(:read) ? input.read : input result = "--- " + result unless result =~ /\A--- / result = result.dup result.gsub!(/ !!null \n/, " \n") # date: 2011-04-26 00:00:00.000000000Z # date: 2011-04-26 00:00:00.000000000 Z result.gsub!(/^(date: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+?)Z/, '\1 Z') result end
Return a list of all outdated local gem names. This method is HEAVY as it must go fetch specifications from the server.
Use ::outdated_and_latest_version if you wish to retrieve the latest remote version as well.
# File rubygems/specification.rb, line 1209 def self.outdated outdated_and_latest_version.map { |local, _| local.name } end
Enumerates the outdated local gems yielding the local specification and the latest remote version.
This method may take some time to return as it must check each local gem against the server's index.
# File rubygems/specification.rb, line 1220 def self.outdated_and_latest_version return enum_for __method__ unless block_given? # TODO: maybe we should switch to rubygems' version service? fetcher = Gem::SpecFetcher.fetcher latest_specs(true).each do |local_spec| dependency = Gem::Dependency.new local_spec.name, ">= #{local_spec.version}" remotes, = fetcher.search_for_dependency dependency remotes = remotes.map { |n, _| n.version } latest_remote = remotes.sort.last yield [local_spec, latest_remote] if latest_remote and local_spec.version < latest_remote end nil end
Removes spec
from the known specs.
# File rubygems/specification.rb, line 1245 def self.remove_spec spec warn "Gem::Specification.remove_spec is deprecated and will be removed in RubyGems 3.0" unless Gem::Deprecate.skip _all.delete spec stubs.delete_if { |s| s.full_name == spec.full_name } (@@stubs_by_name[spec.name] || []).delete_if { |s| s.full_name == spec.full_name } reset end
Is name
a required attribute?
# File rubygems/specification.rb, line 1256 def self.required_attribute?(name) @@required_attributes.include? name.to_sym end
Required specification attributes
# File rubygems/specification.rb, line 1263 def self.required_attributes @@required_attributes.dup end
Reset the list of known specs, running pre and post reset hooks registered in Gem.
# File rubygems/specification.rb, line 1271 def self.reset @@dirs = nil Gem.pre_reset_hooks.each { |hook| hook.call } @@all = nil @@stubs = nil @@stubs_by_name = {} @@spec_with_requirable_file = {} @@active_stub_with_requirable_file = {} _clear_load_cache unresolved = unresolved_deps unless unresolved.empty? then w = "W" + "ARN" warn "#{w}: Unresolved or ambigious specs during Gem::Specification.reset:" unresolved.values.each do |dep| warn " #{dep}" versions = find_all_by_name(dep.name) unless versions.empty? warn " Available/installed versions of this gem:" versions.each { |s| warn " - #{s.version}" } end end warn "#{w}: Clearing out unresolved specs. Try 'gem cleanup <gem>'" warn "Please report a bug if this causes problems." unresolved.clear end Gem.post_reset_hooks.each { |hook| hook.call } end
Returns a Gem::StubSpecification for every installed gem
# File rubygems/specification.rb, line 818 def self.stubs @@stubs ||= begin pattern = "*.gemspec" stubs = Gem.loaded_specs.values + default_stubs(pattern) + installed_stubs(dirs, pattern) stubs = uniq_by(stubs) { |stub| stub.full_name } _resort!(stubs) @@stubs_by_name = stubs.select { |s| Gem::Platform.match s.platform }.group_by(&:name) stubs end end
Returns a Gem::StubSpecification for
installed gem named name
only returns stubs that match Gem.platforms
# File rubygems/specification.rb, line 836 def self.stubs_for name if @@stubs @@stubs_by_name[name] || [] else pattern = "#{name}-*.gemspec" stubs = Gem.loaded_specs.values + default_stubs(pattern) + installed_stubs(dirs, pattern).select { |s| Gem::Platform.match s.platform } stubs = uniq_by(stubs) { |stub| stub.full_name }.group_by(&:name) stubs.each_value { |v| _resort!(v) } @@stubs_by_name.merge! stubs @@stubs_by_name[name] ||= EMPTY end end
Dump only crucial instance variables.
# File rubygems/specification.rb, line 1376 def _dump(limit) Marshal.dump [ @rubygems_version, @specification_version, @name, @version, date, @summary, @required_ruby_version, @required_rubygems_version, @original_platform, @dependencies, @rubyforge_project, @email, @authors, @description, @homepage, true, # has_rdoc @new_platform, @licenses, @metadata ] end
Abbreviate the spec for downloading. Abbreviated specs are only used for searching, downloading and related activities and do not need deployment specific information (e.g. list of files). So we abbreviate the spec, making it much smaller for quicker downloads.
# File rubygems/specification.rb, line 1463 def abbreviate self.files = [] self.test_files = [] self.rdoc_options = [] self.extra_rdoc_files = [] self.cert_chain = [] end
Activate this spec, registering it as a loaded spec and adding it's lib paths to $LOAD_PATH. Returns true if the spec was activated, false if it was previously activated. Freaks out if there are conflicts upon activation.
# File rubygems/specification.rb, line 1406 def activate other = Gem.loaded_specs[self.name] if other then check_version_conflict other return false end raise_if_conflicts activate_dependencies add_self_to_load_path Gem.loaded_specs[self.name] = self @activated = true @loaded = true return true end
Activate all unambiguously resolved runtime dependencies of this spec. Add any ambiguous dependencies to the unresolved list to be resolved later, as needed.
# File rubygems/specification.rb, line 1430 def activate_dependencies unresolved = Gem::Specification.unresolved_deps self.runtime_dependencies.each do |spec_dep| if loaded = Gem.loaded_specs[spec_dep.name] next if spec_dep.matches_spec? loaded msg = "can't satisfy '#{spec_dep}', already activated '#{loaded.full_name}'" e = Gem::LoadError.new msg e.name = spec_dep.name raise e end specs = spec_dep.to_specs if specs.size == 1 then specs.first.activate else name = spec_dep.name unresolved[name] = unresolved[name].merge spec_dep end end unresolved.delete self.name end
Returns an array with bindir attached to each executable in the
executables
list
# File rubygems/specification.rb, line 1505 def add_bindir(executables) return nil if executables.nil? if @bindir then Array(executables).map { |e| File.join(@bindir, e) } else executables end rescue return nil end
Adds this spec's require paths to LOAD_PATH, in the proper location.
# File rubygems/specification.rb, line 1544 def add_self_to_load_path return if default_gem? paths = full_require_paths # gem directories must come after -I and ENV['RUBYLIB'] insert_index = Gem.load_path_insert_index if insert_index then # gem directories must come after -I and ENV['RUBYLIB'] $LOAD_PATH.insert(insert_index, *paths) else # we are probably testing in core, -I and RUBYLIB don't apply $LOAD_PATH.unshift(*paths) end end
# File rubygems/specification.rb, line 2100 def base_dir return Gem.dir unless loaded_from @base_dir ||= if default_gem? then File.dirname File.dirname File.dirname loaded_from else File.dirname File.dirname loaded_from end end
Returns the full path to installed gem's bin directory.
NOTE: do not confuse this with bindir
, which is just
'bin', not a full path.
# File rubygems/specification.rb, line 1583 def bin_dir @bin_dir ||= File.join gem_dir, bindir # TODO: this is unfortunate end
Returns the full path to an executable named name
in this gem.
# File rubygems/specification.rb, line 1590 def bin_file name File.join bin_dir, name end
Returns the #build_args used to install the gem
# File rubygems/specification.rb, line 1597 def build_args if File.exist? build_info_file build_info = File.readlines build_info_file build_info = build_info.map { |x| x.strip } build_info.delete "" build_info else [] end end
Returns the full path to the build info directory
# File rubygems/specification.rb, line 1644 def build_info_dir File.join base_dir, "build_info" end
Returns the full path to the file containing the build information generated when the gem was installed
# File rubygems/specification.rb, line 1652 def build_info_file File.join build_info_dir, "#{full_name}.info" end
Used to detect if the gem is bundled in older version of Ruby, but not detectable as default gem (see BasicSpecification#default_gem?).
# File rubygems/specification.rb, line 1660 def bundled_gem_in_old_ruby? !default_gem? && RUBY_VERSION < "2.0.0" && summary == "This #{name} is bundled with Ruby" end
Returns the full path to the cache directory containing this spec's cached gem.
# File rubygems/specification.rb, line 1670 def cache_dir @cache_dir ||= File.join base_dir, "cache" end
Returns the full path to the cached gem for this spec.
# File rubygems/specification.rb, line 1677 def cache_file @cache_file ||= File.join cache_dir, "#{full_name}.gem" end
Return any possible conflicts against the currently loaded specs.
# File rubygems/specification.rb, line 1684 def conflicts conflicts = {} self.runtime_dependencies.each { |dep| spec = Gem.loaded_specs[dep.name] if spec and not spec.satisfies_requirement? dep (conflicts[spec] ||= []) << dep end } env_req = Gem.env_requirement(name) (conflicts[self] ||= []) << env_req unless env_req.satisfied_by? version conflicts end
The date this gem was created.
If SOURCE_DATE_EPOCH is set as an environment variable, use that to support reproducible builds; otherwise, default to the current UTC date.
Details on SOURCE_DATE_EPOCH: reproducible-builds.org/specs/source-date-epoch/
# File rubygems/specification.rb, line 1730 def date @date ||= ENV["SOURCE_DATE_EPOCH"] ? Time.utc(*Time.at(ENV["SOURCE_DATE_EPOCH"].to_i).utc.to_a[3..5].reverse) : TODAY end
The date this gem was created
DO NOT set this, it is set automatically when the gem is packaged.
# File rubygems/specification.rb, line 1750 def date= date # We want to end up with a Time object with one-day resolution. # This is the cleanest, most-readable, faster-than-using-Date # way to do it. @date = case date when String then if DateTimeFormat =~ date then Time.utc($1.to_i, $2.to_i, $3.to_i) # Workaround for where the date format output from psych isn't # parsed as a Time object by syck and thus comes through as a # string. elsif /\A(\d{4})-(\d{2})-(\d{2}) \d{2}:\d{2}:\d{2}\.\d+?Z\z/ =~ date then Time.utc($1.to_i, $2.to_i, $3.to_i) else raise(Gem::InvalidSpecificationException, "invalid date format in specification: #{date.inspect}") end when Time, DateLike then Time.utc(date.year, date.month, date.day) else TODAY end end
The default value for specification attribute name
# File rubygems/specification.rb, line 1796 def default_value name @@default_value[name] end
A list of Gem::Dependency objects this gem depends on.
Use add_dependency or add_development_dependency to add dependencies to a gem.
# File rubygems/specification.rb, line 1806 def dependencies @dependencies ||= [] end
Return a list of all gems that have a dependency on this gemspec. The list is structured with entries that conform to:
[depending_gem, dependency, [list_of_gems_that_satisfy_dependency]]
# File rubygems/specification.rb, line 1816 def dependent_gems out = [] Gem::Specification.each do |spec| spec.dependencies.each do |dep| if self.satisfies_requirement?(dep) then sats = [] find_all_satisfiers(dep) do |sat| sats << sat end out << [spec, dep, sats] end end end out end
Returns all specs that matches this spec's runtime dependencies.
# File rubygems/specification.rb, line 1835 def dependent_specs runtime_dependencies.map { |dep| dep.to_specs }.flatten end
A detailed description of this gem. See also summary
# File rubygems/specification.rb, line 1842 def description= str @description = str.to_s end
List of dependencies that are used for development
# File rubygems/specification.rb, line 1849 def development_dependencies dependencies.select { |d| d.type == :development } end
Returns the full path to this spec's documentation directory. If
type
is given it will be appended to the end. For example:
spec.doc_dir # => "/path/to/gem_repo/doc/a-1" spec.doc_dir 'ri' # => "/path/to/gem_repo/doc/a-1/ri"
# File rubygems/specification.rb, line 1861 def doc_dir type = nil @doc_dir ||= File.join base_dir, 'doc', full_name if type then File.join @doc_dir, type else @doc_dir end end
Singular accessor for executables
# File rubygems/specification.rb, line 1899 def executable val = executables and val.first end
Singular accessor for executables
# File rubygems/specification.rb, line 1906 def executable=o self.executables = [o] end
Sets executables to value
, ensuring it is an array. Don't
use this, push onto the array instead.
# File rubygems/specification.rb, line 1914 def executables= value # TODO: warn about setting instead of pushing @executables = Array(value) end
Sets extensions to extensions
, ensuring it is an array.
Don't use this, push onto the array instead.
# File rubygems/specification.rb, line 1923 def extensions= extensions # TODO: warn about setting instead of pushing @extensions = Array extensions end
Sets #extra_rdoc_files
to files
, ensuring it is an array. Don't use this, push
onto the array instead.
# File rubygems/specification.rb, line 1932 def extra_rdoc_files= files # TODO: warn about setting instead of pushing @extra_rdoc_files = Array files end
The default (generated) file name of the gem. See also spec_name.
spec.file_name # => "example-1.0.gem"
# File rubygems/specification.rb, line 1942 def file_name "#{full_name}.gem" end
Sets files to files
, ensuring it is an array.
# File rubygems/specification.rb, line 1949 def files= files @files = Array files end
Creates a duplicate spec without large blobs that aren't used at runtime.
# File rubygems/specification.rb, line 1967 def for_cache spec = dup spec.files = nil spec.test_files = nil spec end
# File rubygems/specification.rb, line 1976 def full_name @full_name ||= super end
# File rubygems/specification.rb, line 1987 def gems_dir # TODO: this logic seems terribly broken, but tests fail if just base_dir @gems_dir ||= File.join(loaded_from && base_dir || Gem.dir, "gems") end
Return true if there are possible conflicts against the currently loaded specs.
# File rubygems/specification.rb, line 1710 def has_conflicts? return true unless Gem.env_requirement(name).satisfied_by?(version) self.dependencies.any? { |dep| if dep.runtime? then spec = Gem.loaded_specs[dep.name] spec and not spec.satisfies_requirement? dep else false end } end
Duplicates ::array_attributes
from other_spec
so state isn't shared.
# File rubygems/specification.rb, line 2078 def initialize_copy other_spec self.class.array_attributes.each do |name| name = :"@#{name}" next unless other_spec.instance_variable_defined? name begin val = other_spec.instance_variable_get(name) if val then instance_variable_set name, val.dup elsif Gem.configuration.really_verbose warn "WARNING: #{full_name} has an invalid nil value for #{name}" end rescue TypeError e = Gem::FormatException.new \ "#{full_name} has an invalid value for #{name}" e.file_path = loaded_from raise e end end end
# File rubygems/specification.rb, line 2664 def keep_only_files_and_directories @executables.delete_if { |x| File.directory?(File.join(@bindir, x)) } @extensions.delete_if { |x| File.directory?(x) && !File.symlink?(x) } @extra_rdoc_files.delete_if { |x| File.directory?(x) && !File.symlink?(x) } @files.delete_if { |x| File.directory?(x) && !File.symlink?(x) } @test_files.delete_if { |x| File.directory?(x) && !File.symlink?(x) } end
Files in the Gem under one of the require_paths
# File rubygems/specification.rb, line 2131 def lib_files @files.select do |file| require_paths.any? do |path| file.start_with? path end end end
Singular accessor for licenses
# File rubygems/specification.rb, line 2142 def license licenses.first end
Plural accessor for setting licenses
See license= for details
# File rubygems/specification.rb, line 2151 def licenses @licenses ||= [] end
Sets the #rubygems_version to the current RubyGems version.
# File rubygems/specification.rb, line 2169 def mark_version @rubygems_version = Gem::VERSION end
Is this specification missing its extensions? When this returns true you probably want to build_extensions
# File rubygems/specification.rb, line 2189 def missing_extensions? return false if default_gem? return false if extensions.empty? return false if installed_by_version < Gem::Version.new('2.2.0.preview.2') return false if File.exist? gem_build_complete_path true end
Return a NameTuple that represents this Specification
# File rubygems/specification.rb, line 2221 def name_tuple Gem::NameTuple.new name, version, original_platform end
Normalize the list of files so that:
All file lists have redundancies removed.
Files referenced in the #extra_rdoc_files are included in the package file list.
# File rubygems/specification.rb, line 2204 def normalize if defined?(@extra_rdoc_files) and @extra_rdoc_files then @extra_rdoc_files.uniq! @files ||= [] @files.concat(@extra_rdoc_files) end @files = @files.uniq if @files @extensions = @extensions.uniq if @extensions @test_files = @test_files.uniq if @test_files @executables = @executables.uniq if @executables @extra_rdoc_files = @extra_rdoc_files.uniq if @extra_rdoc_files end
The platform this gem runs on. See Gem::Platform for details.
# File rubygems/specification.rb, line 2247 def platform @new_platform ||= Gem::Platform::RUBY end
Sets #rdoc_options
to value
, ensuring it is an array. Don't use this, push
onto the array instead.
# File rubygems/specification.rb, line 2315 def rdoc_options= options # TODO: warn about setting instead of pushing @rdoc_options = Array options end
Singular accessor for require_paths
# File rubygems/specification.rb, line 2323 def require_path val = require_paths and val.first end
Singular accessor for require_paths
# File rubygems/specification.rb, line 2330 def require_path= path self.require_paths = Array(path) end
Set requirements to req
, ensuring it is an array. Don't
use this, push onto the array instead.
# File rubygems/specification.rb, line 2338 def requirements= req # TODO: warn about setting instead of pushing @requirements = Array req end
Reset nil attributes to their default values to make the spec valid
# File rubygems/specification.rb, line 2729 def reset_nil_attributes_to_default nil_attributes = self.class.non_nil_attributes.find_all do |name| !instance_variable_defined?("@#{name}") || instance_variable_get("@#{name}").nil? end nil_attributes.each do |attribute| default = self.default_value attribute value = case default when Time, Numeric, Symbol, true, false, nil then default else default.dup end instance_variable_set "@#{attribute}", value end @installed_by_version ||= nil end
Returns the full path to this spec's ri directory.
# File rubygems/specification.rb, line 2350 def ri_dir @ri_dir ||= File.join base_dir, 'ri', full_name end
List of dependencies that will automatically be activated at runtime.
# File rubygems/specification.rb, line 2383 def runtime_dependencies dependencies.select(&:runtime?) end
Sanitize the descriptive fields in the spec. Sometimes non-ASCII characters will garble the site index. Non-ASCII characters will be replaced by their XML entity equivalent.
# File rubygems/specification.rb, line 1476 def sanitize self.summary = sanitize_string(summary) self.description = sanitize_string(description) self.post_install_message = sanitize_string(post_install_message) self.authors = authors.collect { |a| sanitize_string(a) } end
Sanitize a single string.
# File rubygems/specification.rb, line 1486 def sanitize_string(string) return string unless string # HACK the #to_s is in here because RSpec has an Array of Arrays of # Strings for authors. Need a way to disallow bad values on gemspec # generation. (Probably won't happen.) string = string.to_s begin Builder::XChar.encode string rescue NameError, NoMethodError string.to_xs end end
Checks if this specification meets the requirement of
dependency
.
# File rubygems/specification.rb, line 2399 def satisfies_requirement? dependency return @name == dependency.name && dependency.requirement.satisfied_by?(@version) end
Returns an object you can use to sort specifications in sort_by.
# File rubygems/specification.rb, line 2407 def sort_obj [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1] end
Returns the full path to the directory containing this spec's gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications
# File rubygems/specification.rb, line 2422 def spec_dir @spec_dir ||= File.join base_dir, "specifications" end
Returns the full path to this spec's gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications/mygem-1.0.gemspec
# File rubygems/specification.rb, line 2430 def spec_file @spec_file ||= File.join spec_dir, "#{full_name}.gemspec" end
The default name of the gemspec. See also file_name
spec.spec_name # => "example-1.0.gemspec"
# File rubygems/specification.rb, line 2439 def spec_name "#{full_name}.gemspec" end
# File rubygems/specification.rb, line 2707 def stubbed? false end
A short summary of this gem's description.
# File rubygems/specification.rb, line 2446 def summary= str @summary = str.to_s.strip. gsub(/(\w-)\n[ \t]*(\w)/, '\1\2').gsub(/\n[ \t]*/, " ") # so. weird. end
Returns a Ruby code representation of this specification, such that it can be eval'ed and reconstruct the same specification later. Attributes that still have their default values are omitted.
# File rubygems/specification.rb, line 2489 def to_ruby mark_version result = [] result << "# -*- encoding: utf-8 -*-" result << "#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{raw_require_paths.join("\0")}" result << "#{Gem::StubSpecification::PREFIX}#{extensions.join "\0"}" unless extensions.empty? result << nil result << "Gem::Specification.new do |s|" result << " s.name = #{ruby_code name}" result << " s.version = #{ruby_code version}" unless platform.nil? or platform == Gem::Platform::RUBY then result << " s.platform = #{ruby_code original_platform}" end result << "" result << " s.required_rubygems_version = #{ruby_code required_rubygems_version} if s.respond_to? :required_rubygems_version=" if metadata and !metadata.empty? result << " s.metadata = #{ruby_code metadata} if s.respond_to? :metadata=" end result << " s.require_paths = #{ruby_code raw_require_paths}" handled = [ :dependencies, :name, :platform, :require_paths, :required_rubygems_version, :specification_version, :version, :has_rdoc, :default_executable, :metadata ] @@attributes.each do |attr_name| next if handled.include? attr_name current_value = self.send(attr_name) if current_value != default_value(attr_name) or self.class.required_attribute? attr_name then result << " s.#{attr_name} = #{ruby_code current_value}" end end if @installed_by_version then result << nil result << " s.installed_by_version = \"#{Gem::VERSION}\" if s.respond_to? :installed_by_version" end unless dependencies.empty? then result << nil result << " if s.respond_to? :specification_version then" result << " s.specification_version = #{specification_version}" result << nil result << " if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then" dependencies.each do |dep| req = dep.requirements_list.inspect dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>.freeze, #{req})" end result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})" end result << ' end' result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})" end result << " end" end result << "end" result << nil result.join "\n" end
Returns a Ruby lighter-weight code representation of this specification, used for indexing only.
See to_ruby.
# File rubygems/specification.rb, line 2582 def to_ruby_for_cache for_cache.to_ruby end
Returns self
# File rubygems/specification.rb, line 2593 def to_spec self end
Recursively walk dependencies of this spec, executing the
block
for each hop.
# File rubygems/specification.rb, line 2621 def traverse trail = [], visited = {}, &block trail.push(self) begin dependencies.each do |dep| next unless dep.runtime? dep.to_specs.each do |dep_spec| next if visited.has_key?(dep_spec) visited[dep_spec] = true trail.push(dep_spec) begin result = block[self, dep, dep_spec, trail] ensure trail.pop end unless result == :next spec_name = dep_spec.name dep_spec.traverse(trail, visited, &block) unless trail.any? { |s| s.name == spec_name } end end end ensure trail.pop end end
Checks that the specification contains all required fields, and does a very basic sanity check.
Raises InvalidSpecificationException if the spec does not pass the checks..
# File rubygems/specification.rb, line 2654 def validate packaging = true, strict = false require 'rubygems/user_interaction' extend Gem::UserInteraction normalize validation_policy = Gem::SpecificationPolicy.new(self) validation_policy.packaging = packaging validation_policy.validate(strict) end
Checks that dependencies use requirements as we recommend. Warnings are issued when dependencies are open-ended or overly strict for semantic versioning.
# File rubygems/specification.rb, line 2680 def validate_dependencies Gem::SpecificationPolicy.new(self).validate_dependencies end
# File rubygems/specification.rb, line 2672 def validate_metadata Gem::SpecificationPolicy.new(self).validate_metadata end
Checks to see if the files to be packaged are world-readable.
# File rubygems/specification.rb, line 2686 def validate_permissions Gem::SpecificationPolicy.new(self).validate_permissions end
Set the version to version
, potentially also setting #required_rubygems_version
if version
indicates it is a prerelease.
# File rubygems/specification.rb, line 2695 def version= version @version = Gem::Version.create(version) # skip to set required_ruby_version when pre-released rubygems. # It caused to raise CircularDependencyError if @version.prerelease? && @name.strip != "rubygems" self.required_rubygems_version = '> 1.3.1' end invalidate_memoized_attributes return @version end