class Gem::Specification
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.
Constants
- NONEXISTENT_SPECIFICATION_VERSION
The version number of a specification that does not specify one (i.e. RubyGems 0.7 or earlier).
Public Instance Methods
# File lib/rubygems/specification.rb, line 189 def removed_method_calls @removed_method_calls ||= [] end
Optional gemspec attributes
Constants
- LATEST_RUBY_WITHOUT_PATCH_VERSIONS
Attributes
The path in the gem for executable scripts. Usually ‘exe’
Usage:
spec.bindir = 'exe'
The certificate chain used to sign this gem. See Gem::Security
for details.
A message that gets displayed after the gem is installed.
Usage:
spec.post_install_message = "Thanks for installing!"
The RubyGems version required by this gem
The key used to sign this gem. See Gem::Security
for details.
Public Instance Methods
Adds a runtime dependency named gem
with requirements
to this gem.
Usage:
spec.add_dependency 'example', '~> 1.1', '>= 1.1.4'
# File lib/rubygems/specification.rb, line 551 def add_dependency(gem, *requirements) if requirements.uniq.size != requirements.size warn "WARNING: duplicated #{gem} dependency #{requirements}" end add_dependency_with_type(gem, :runtime, requirements) end
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 lib/rubygems/specification.rb, line 540 def add_development_dependency(gem, *requirements) add_dependency_with_type(gem, :development, 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 lib/rubygems/specification.rb, line 574 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 lib/rubygems/specification.rb, line 591 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 lib/rubygems/specification.rb, line 607 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 lib/rubygems/specification.rb, line 466 def platform=(platform) if @original_platform.nil? || @original_platform == Gem::Platform::RUBY @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 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 lib/rubygems/specification.rb, line 637 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 lib/rubygems/specification.rb, line 515 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">
Prereleases can also be specified.
Usage:
# This gem will work with 1.8.6 or greater... spec.required_ruby_version = '>= 1.8.6' # Only with final releases of major version 2 where minor version is at least 3 spec.required_ruby_version = '~> 2.3' # Only prereleases or final releases after 2.6.0.preview2 spec.required_ruby_version = '> 2.6.0.preview2' # This gem will work with 2.3.0 or greater, including major version 3, but lesser than 4.0.0 spec.required_ruby_version = '>= 2.3', '< 4'
# File lib/rubygems/specification.rb, line 667 def required_ruby_version=(req) @required_ruby_version = Gem::Requirement.create req @required_ruby_version.requirements.map! do |op, v| if v >= LATEST_RUBY_WITHOUT_PATCH_VERSIONS && v.release.segments.size == 4 [op == "~>" ? "=" : op, Gem::Version.new(v.segments.tap {|s| s.delete_at(3) }.join("."))] else [op, v] end end end
The RubyGems version required by this gem
# File lib/rubygems/specification.rb, line 682 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 lib/rubygems/specification.rb, line 695 def requirements @requirements ||= [] end
Read-only attributes
Attributes
The version of RubyGems used to create this gem.
Public Instance Methods
The path where this gem installs its extensions.
Gem::BasicSpecification#extensions_dir
# File lib/rubygems/specification.rb, line 722 def extensions_dir @extensions_dir ||= super end
Recommended gemspec attributes
Attributes
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 URL of this gem’s home page
Usage:
spec.homepage = 'https://github.com/ruby/rake'
The metadata holds extra data for this gem that may be useful to other consumers and is settable by gem authors.
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" "funding_uri" => "https://example.com/donate" }
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 version of Ruby required by this gem
Usage:
spec.required_ruby_version = '>= 2.7.0'
Public Instance Methods
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/ approved.
The most commonly used OSI-approved licenses are MIT and Apache-2.0. GitHub also provides a license picker at choosealicense.com/.
You can also use a custom license file along with your gemspec and specify a LicenseRef-<idstring>, where idstring is the name of the file containing the license text.
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 right to use the code for any purpose.
You can set multiple licenses with licenses=
Usage:
spec.license = 'MIT'
# File lib/rubygems/specification.rb, line 351 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 lib/rubygems/specification.rb, line 368 def licenses=(licenses) @licenses = Array licenses end
Required gemspec attributes
Attributes
This gem’s name.
Usage:
spec.name = 'rake'
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"
This gem’s version.
The version string can contain numbers and periods, such as 1.0.0
. A gem is a ‘prerelease’ gem if the version has a letter in it, such as 1.0.0.pre
.
Usage:
spec.version = '0.4.1'
Public Instance Methods
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]*'].to_a # or without Rake... spec.files = Dir['lib/**/*.rb'] + Dir['bin/*'] spec.files += Dir['[A-Z]*'] spec.files.reject! { |fn| fn.include? "CVS" }
# File lib/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
Specification internals
Attributes
True when this gemspec has been activated. This attribute is not persisted.
True when this gemspec has been activated. This attribute is not persisted.
Sets the default executable for this gem.
Deprecated: You must now specify the executable name to Gem.bin_path
.
The Gem::Specification
version of this gemspec.
Do not set this, it is set automatically when the gem is packaged.
Public Class Methods
Load custom marshal format, re-initializing defaults as needed
# File lib/rubygems/specification.rb, line 1239 def self._load(str) Gem.load_yaml Gem.load_safe_marshal yaml_set = false retry_count = 0 array = begin Gem::SafeMarshal.safe_load str rescue ArgumentError => e # Avoid an infinite retry loop when the argument error has nothing to do # with the classes not being defined. # 1 retry each allowed in case all 3 of # - YAML # - YAML::Syck::DefaultKey # - YAML::PrivateType # need to be defined raise if retry_count >= 3 # # Some very old marshaled specs included references to `YAML::PrivateType` # and `YAML::Syck::DefaultKey` constants due to bugs in the old emitter # that generated them. Workaround the issue by defining the necessary # constants and retrying. # message = e.message raise unless message.include?("YAML::") unless Object.const_defined?(:YAML) Object.const_set "YAML", Psych yaml_set = true end if message.include?("YAML::Syck::") YAML.const_set "Syck", YAML unless YAML.const_defined?(:Syck) YAML::Syck.const_set "DefaultKey", Class.new if message.include?("YAML::Syck::DefaultKey") && !YAML::Syck.const_defined?(:DefaultKey) elsif message.include?("YAML::PrivateType") && !YAML.const_defined?(:PrivateType) YAML.const_set "PrivateType", Class.new end retry_count += 1 retry ensure Object.__send__(:remove_const, "YAML") if yaml_set end 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 spec.instance_variable_set :@specification_version, current_version MARSHAL_FIELDS[current_version] else MARSHAL_FIELDS[spec.specification_version] end if array.size < field_count raise TypeError, "invalid Gem::Specification format #{array.inspect}" end 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] # offset due to rubyforge_project removal 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 :@licenses, [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 lib/rubygems/specification.rb, line 861 def self.add_spec(spec) specification_record.add_spec(spec) end
Returns all specifications. This method is discouraged from use. You probably want to use one of the Enumerable
methods instead.
# File lib/rubygems/specification.rb, line 876 def self.all warn "NOTE: Specification.all called from #{caller(1, 1).first}" unless Gem::Deprecate.skip _all end
Sets the known specs to specs
.
# File lib/rubygems/specification.rb, line 885 def self.all=(specs) specification_record.all = specs end
Return full names of all specs in sorted order.
# File lib/rubygems/specification.rb, line 892 def self.all_names specification_record.all_names end
Return the list of all array-oriented instance variables.
# File lib/rubygems/specification.rb, line 901 def self.array_attributes @@array_attributes.dup end
Return the list of all instance variables.
# File lib/rubygems/specification.rb, line 910 def self.attribute_names @@attributes.dup end
Returns a Gem::StubSpecification
for default gems
# File lib/rubygems/specification.rb, line 808 def self.default_stubs(pattern = "*.gemspec") base_dir = Gem.default_dir gems_dir = File.join base_dir, "gems" gemspec_stubs_in(Gem.default_specifications_dir, pattern) do |path| Gem::StubSpecification.default_gemspec_stub(path, base_dir, gems_dir) end end
Return the directories that Specification
uses to find specs.
# File lib/rubygems/specification.rb, line 917 def self.dirs @@dirs ||= Gem::SpecificationRecord.dirs_from(gem_path) end
Set
the directories that Specification
uses to find specs. Setting this resets the list of known specs.
# File lib/rubygems/specification.rb, line 925 def self.dirs=(dirs) reset @@dirs = Gem::SpecificationRecord.dirs_from(Array(dirs)) end
Enumerate every known spec. See ::dirs=
and ::add_spec
to set the list of specs.
# File lib/rubygems/specification.rb, line 937 def self.each(&block) specification_record.each(&block) end
Return the best specification that contains the file matching path
, among those already activated.
# File lib/rubygems/specification.rb, line 990 def self.find_active_stub_by_path(path) specification_record.find_active_stub_by_path(path) end
Returns every spec that has the given full_name
# File lib/rubygems/specification.rb, line 951 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 lib/rubygems/specification.rb, line 944 def self.find_all_by_name(name, *requirements) specification_record.find_all_by_name(name, *requirements) end
Find
the best specification matching a full_name
.
# File lib/rubygems/specification.rb, line 967 def self.find_by_full_name(full_name) stubs.find {|s| s.full_name == full_name }&.to_spec end
Find
the best specification matching a name
and requirements
. Raises if the dependency doesn’t resolve to a valid specification.
# File lib/rubygems/specification.rb, line 959 def self.find_by_name(name, *requirements) requirements = Gem::Requirement.default if requirements.empty? Gem::Dependency.new(name, *requirements).to_spec end
Return the best specification that contains the file matching path
.
# File lib/rubygems/specification.rb, line 974 def self.find_by_path(path) specification_record.find_by_path(path) end
Return currently unresolved specs that contain the file matching path
.
# File lib/rubygems/specification.rb, line 997 def self.find_in_unresolved(path) unresolved_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 lib/rubygems/specification.rb, line 1005 def self.find_in_unresolved_tree(path) unresolved_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 lib/rubygems/specification.rb, line 982 def self.find_inactive_by_path(path) specification_record.find_inactive_by_path(path) 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 lib/rubygems/specification.rb, line 1032 def self.from_yaml(input) Gem.load_yaml input = normalize_yaml_input input spec = Gem::SafeYAML.safe_load input if spec && spec.class == FalseClass raise Gem::EndOfYAMLException end unless Gem::Specification === spec 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.flatten_require_paths spec end
Return the latest installed spec for gem name
.
# File lib/rubygems/specification.rb, line 1064 def self.latest_spec_for(name) specification_record.latest_spec_for(name) end
Return the latest specs, optionally including prerelease specs if prerelease
is true.
# File lib/rubygems/specification.rb, line 1057 def self.latest_specs(prerelease = false) specification_record.latest_specs(prerelease) end
Loads Ruby format gemspec from file
.
# File lib/rubygems/specification.rb, line 1085 def self.load(file) return unless file spec = @load_cache_mutex.synchronize { @load_cache[file] } return spec if spec return unless File.file?(file) code = Gem.open_file(file, "r:UTF-8:-", &:read) begin spec = eval code, binding, file if Gem::Specification === spec spec.loaded_from = File.expand_path file.to_s @load_cache_mutex.synchronize do prev = @load_cache[file] if prev spec = prev else @load_cache[file] = spec end end return spec end warn "[#{file}] isn't a Gem::Specification (#{spec.class} instead)." rescue SignalException, SystemExit raise rescue SyntaxError, StandardError => e warn "Invalid gemspec in [#{file}]: #{e}" end nil end
Loads the default specifications. It should be called only once.
# File lib/rubygems/specification.rb, line 849 def self.load_defaults each_spec([Gem.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
.
Gem::BasicSpecification::new
# File lib/rubygems/specification.rb, line 1989 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 if (platform = Gem.platforms.last) && platform != Gem::Platform::RUBY && platform != Gem::Platform.local self.platform = platform end yield self if block_given? end
Specification
attributes that must be non-nil
# File lib/rubygems/specification.rb, line 1124 def self.non_nil_attributes @@non_nil_attributes.dup end
Make sure the YAML
specification is properly formatted with dashes
# File lib/rubygems/specification.rb, line 1131 def self.normalize_yaml_input(input) result = input.respond_to?(:read) ? input.read : input result = "--- " + result unless result.start_with?("--- ") 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 lib/rubygems/specification.rb, line 1149 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 lib/rubygems/specification.rb, line 1160 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 && local_spec.version < latest_remote end nil end
Removes spec
from the known specs.
# File lib/rubygems/specification.rb, line 868 def self.remove_spec(spec) specification_record.remove_spec(spec) end
Is name
a required attribute?
# File lib/rubygems/specification.rb, line 1185 def self.required_attribute?(name) @@required_attributes.include? name.to_sym end
Required specification attributes
# File lib/rubygems/specification.rb, line 1192 def self.required_attributes @@required_attributes.dup end
Reset the list of known specs, running pre and post reset hooks registered in Gem.
# File lib/rubygems/specification.rb, line 1200 def self.reset @@dirs = nil Gem.pre_reset_hooks.each(&:call) @specification_record = nil clear_load_cache unresolved = unresolved_deps unless unresolved.empty? warn "WARN: Unresolved or ambiguous specs during Gem::Specification.reset:" unresolved.values.each do |dep| warn " #{dep}" versions = find_all_by_name(dep.name).uniq(&:full_name) unless versions.empty? warn " Available/installed versions of this gem:" versions.each {|s| warn " - #{s.version}" } end end warn "WARN: 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(&:call) end
Keeps track of all currently known specifications
# File lib/rubygems/specification.rb, line 1227 def self.specification_record @specification_record ||= Gem::SpecificationRecord.new(dirs) end
Returns a Gem::StubSpecification
for every installed gem
# File lib/rubygems/specification.rb, line 801 def self.stubs specification_record.stubs end
Returns a Gem::StubSpecification
for installed gem named name
only returns stubs that match Gem.platforms
# File lib/rubygems/specification.rb, line 820 def self.stubs_for(name) specification_record.stubs_for(name) end
DOC: This method needs documented or nodoc’d
# File lib/rubygems/specification.rb, line 1232 def self.unresolved_deps @unresolved_deps ||= Hash.new {|h, n| h[n] = Gem::Dependency.new n } end
Public Instance Methods
Dump only crucial instance variables.
# File lib/rubygems/specification.rb, line 1346 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 lib/rubygems/specification.rb, line 1437 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 lib/rubygems/specification.rb, line 1376 def activate other = Gem.loaded_specs[name] if other check_version_conflict other return false end raise_if_conflicts activate_dependencies add_self_to_load_path Gem.loaded_specs[name] = self @activated = true @loaded = true 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 lib/rubygems/specification.rb, line 1400 def activate_dependencies unresolved = Gem::Specification.unresolved_deps 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 begin specs = spec_dep.to_specs.uniq(&:full_name) rescue Gem::MissingSpecError => e raise Gem::MissingSpecError.new(e.name, e.requirement, "at: #{spec_file}") end if specs.size == 1 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 lib/rubygems/specification.rb, line 1473 def add_bindir(executables) return nil if executables.nil? if @bindir Array(executables).map {|e| File.join(@bindir, e) } else executables end rescue StandardError nil end
Adds this spec’s require paths to LOAD_PATH, in the proper location.
# File lib/rubygems/specification.rb, line 1512 def add_self_to_load_path return if default_gem? paths = full_require_paths Gem.add_to_load_path(*paths) end
# File lib/rubygems/specification.rb, line 2043 def base_dir return Gem.dir unless loaded_from @base_dir ||= if default_gem? 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 lib/rubygems/specification.rb, line 1542 def bin_dir @bin_dir ||= File.join gem_dir, bindir end
Returns the full path to an executable named name
in this gem.
# File lib/rubygems/specification.rb, line 1549 def bin_file(name) File.join bin_dir, name end
Returns the build_args
used to install the gem
# File lib/rubygems/specification.rb, line 1556 def build_args if File.exist? build_info_file build_info = File.readlines build_info_file build_info = build_info.map(&:strip) build_info.delete "" build_info else [] end end
Returns the full path to the build info directory
# File lib/rubygems/specification.rb, line 1604 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 lib/rubygems/specification.rb, line 1612 def build_info_file File.join build_info_dir, "#{full_name}.info" end
Returns the full path to the cache directory containing this spec’s cached gem.
# File lib/rubygems/specification.rb, line 1620 def cache_dir @cache_dir ||= File.join base_dir, "cache" end
Returns the full path to the cached gem for this spec.
# File lib/rubygems/specification.rb, line 1627 def cache_file @cache_file ||= File.join cache_dir, "#{full_name}.gem" end
Return any possible conflicts against the currently loaded specs.
# File lib/rubygems/specification.rb, line 1634 def conflicts conflicts = {} runtime_dependencies.each do |dep| spec = Gem.loaded_specs[dep.name] if spec && !spec.satisfies_requirement?(dep) (conflicts[spec] ||= []) << dep end 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 lib/rubygems/specification.rb, line 1678 def date @date ||= Time.utc(*Gem.source_date_epoch.utc.to_a[3..5].reverse) end
The date this gem was created
DO NOT set this, it is set automatically when the gem is packaged.
# File lib/rubygems/specification.rb, line 1698 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 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 lib/rubygems/specification.rb, line 1738 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 lib/rubygems/specification.rb, line 1748 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 lib/rubygems/specification.rb, line 1758 def dependent_gems(check_dev=true) out = [] Gem::Specification.each do |spec| deps = check_dev ? spec.dependencies : spec.runtime_dependencies deps.each do |dep| next unless satisfies_requirement?(dep) sats = [] find_all_satisfiers(dep) do |sat| sats << sat end out << [spec, dep, sats] end end out end
Returns all specs that matches this spec’s runtime dependencies.
# File lib/rubygems/specification.rb, line 1777 def dependent_specs runtime_dependencies.map(&:to_specs).flatten end
A detailed description of this gem. See also summary
# File lib/rubygems/specification.rb, line 1784 def description=(str) @description = str.to_s end
List of dependencies that are used for development
# File lib/rubygems/specification.rb, line 1791 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 lib/rubygems/specification.rb, line 1803 def doc_dir(type = nil) @doc_dir ||= File.join base_dir, "doc", full_name if type File.join @doc_dir, type else @doc_dir end end
Singular accessor for executables
# File lib/rubygems/specification.rb, line 1840 def executable (val = executables) && val.first end
Singular accessor for executables
# File lib/rubygems/specification.rb, line 1847 def executable=(o) self.executables = [o] end
Sets executables to value
, ensuring it is an array.
# File lib/rubygems/specification.rb, line 1854 def executables=(value) @executables = Array(value) end
Sets extensions to extensions
, ensuring it is an array.
# File lib/rubygems/specification.rb, line 1861 def extensions=(extensions) @extensions = Array extensions end
Sets extra_rdoc_files
to files
, ensuring it is an array.
# File lib/rubygems/specification.rb, line 1868 def extra_rdoc_files=(files) @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 lib/rubygems/specification.rb, line 1877 def file_name "#{full_name}.gem" end
Sets files to files
, ensuring it is an array.
# File lib/rubygems/specification.rb, line 1884 def files=(files) @files = Array files end
Creates a duplicate spec without large blobs that aren’t used at runtime.
# File lib/rubygems/specification.rb, line 1902 def for_cache spec = dup spec.files = nil spec.test_files = nil spec end
Gem::BasicSpecification#full_name
# File lib/rubygems/specification.rb, line 1911 def full_name @full_name ||= super end
# File lib/rubygems/specification.rb, line 1923 def gems_dir @gems_dir ||= File.join(base_dir, "gems") end
Return true if there are possible conflicts against the currently loaded specs.
# File lib/rubygems/specification.rb, line 1660 def has_conflicts? return true unless Gem.env_requirement(name).satisfied_by?(version) runtime_dependencies.any? do |dep| spec = Gem.loaded_specs[dep.name] spec && !spec.satisfies_requirement?(dep) end rescue ArgumentError => e raise e, "#{name} #{version}: #{e.message}" end
Duplicates Array
and Gem::Requirement
attributes from other_spec
so state isn’t shared.
# File lib/rubygems/specification.rb, line 2018 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 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 @required_ruby_version = other_spec.required_ruby_version.dup @required_rubygems_version = other_spec.required_rubygems_version.dup end
# File lib/rubygems/specification.rb, line 2582 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 lib/rubygems/specification.rb, line 2074 def lib_files @files.select do |file| require_paths.any? do |path| file.start_with? path end end end
Singular accessor for licenses
# File lib/rubygems/specification.rb, line 2085 def license licenses.first end
Plural accessor for setting licenses
See license=
for details
# File lib/rubygems/specification.rb, line 2094 def licenses @licenses ||= [] end
Is this specification missing its extensions? When this returns true you probably want to build_extensions
# File lib/rubygems/specification.rb, line 2131 def missing_extensions? return false if extensions.empty? return false if default_gem? return false if File.exist? gem_build_complete_path true end
Return a NameTuple that represents this Specification
# File lib/rubygems/specification.rb, line 2162 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 lib/rubygems/specification.rb, line 2145 def normalize if defined?(@extra_rdoc_files) && @extra_rdoc_files @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 lib/rubygems/specification.rb, line 2188 def platform @new_platform ||= Gem::Platform::RUBY # rubocop:disable Naming/MemoizedInstanceVariableName end
Sets rdoc_options
to value
, ensuring it is an array.
# File lib/rubygems/specification.rb, line 2254 def rdoc_options=(options) @rdoc_options = Array options end
Singular accessor for require_paths
# File lib/rubygems/specification.rb, line 2261 def require_path (val = require_paths) && val.first end
Singular accessor for require_paths
# File lib/rubygems/specification.rb, line 2268 def require_path=(path) self.require_paths = Array(path) end
Set
requirements to req
, ensuring it is an array.
# File lib/rubygems/specification.rb, line 2275 def requirements=(req) @requirements = Array req end
Reset nil attributes to their default values to make the spec valid
# File lib/rubygems/specification.rb, line 2641 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 = 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 nil end
Returns the full path to this spec’s ri directory.
# File lib/rubygems/specification.rb, line 2286 def ri_dir @ri_dir ||= File.join base_dir, "ri", full_name end
List of dependencies that will automatically be activated at runtime.
# File lib/rubygems/specification.rb, line 2319 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 lib/rubygems/specification.rb, line 1450 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 lib/rubygems/specification.rb, line 1460 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.to_s end
Checks if this specification meets the requirement of dependency
.
# File lib/rubygems/specification.rb, line 2335 def satisfies_requirement?(dependency) @name == dependency.name && dependency.requirement.satisfied_by?(@version) end
Returns an object you can use to sort specifications in sort_by.
# File lib/rubygems/specification.rb, line 2343 def sort_obj [@name, @version, Gem::Platform.sort_priority(@new_platform)] end
Returns the full path to the directory containing this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications
# File lib/rubygems/specification.rb, line 2358 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 lib/rubygems/specification.rb, line 2366 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 lib/rubygems/specification.rb, line 2375 def spec_name "#{full_name}.gemspec" end
# File lib/rubygems/specification.rb, line 2619 def stubbed? false end
A short summary of this gem’s description.
# File lib/rubygems/specification.rb, line 2382 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 lib/rubygems/specification.rb, line 2425 def to_ruby 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? || platform == Gem::Platform::RUBY 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 && !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, :signing_key, ] @@attributes.each do |attr_name| next if handled.include? attr_name current_value = send(attr_name) if current_value != default_value(attr_name) || self.class.required_attribute?(attr_name) result << " s.#{attr_name} = #{ruby_code current_value}" end end if String === signing_key result << " s.signing_key = #{ruby_code signing_key}" end if @installed_by_version result << nil result << " s.installed_by_version = #{ruby_code Gem::VERSION}" end unless dependencies.empty? result << nil result << " s.specification_version = #{specification_version}" result << nil dependencies.each do |dep| dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>.freeze, #{ruby_code dep.requirements_list})" 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 lib/rubygems/specification.rb, line 2501 def to_ruby_for_cache for_cache.to_ruby end
Returns self
# File lib/rubygems/specification.rb, line 2512 def to_spec self end
Recursively walk dependencies of this spec, executing the block
for each hop.
# File lib/rubygems/specification.rb, line 2543 def traverse(trail = [], visited = {}, &block) trail.push(self) begin runtime_dependencies.each do |dep| dep.matching_specs(true).each do |dep_spec| next if visited.key?(dep_spec) visited[dep_spec] = true trail.push(dep_spec) begin result = block[self, dep, dep_spec, trail] ensure trail.pop end next if result == :next spec_name = dep_spec.name dep_spec.traverse(trail, visited, &block) unless trail.any? {|s| s.name == spec_name } 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 lib/rubygems/specification.rb, line 2574 def validate(packaging = true, strict = false) normalize validation_policy = Gem::SpecificationPolicy.new(self) validation_policy.packaging = packaging validation_policy.validate(strict) end
# File lib/rubygems/specification.rb, line 2599 def validate_dependencies Gem::SpecificationPolicy.new(self).validate_dependencies end
# File lib/rubygems/specification.rb, line 2590 def validate_for_resolution Gem::SpecificationPolicy.new(self).validate_for_resolution end
# File lib/rubygems/specification.rb, line 2594 def validate_metadata Gem::SpecificationPolicy.new(self).validate_metadata end
# File lib/rubygems/specification.rb, line 2604 def validate_permissions Gem::SpecificationPolicy.new(self).validate_permissions end
Set
the version to version
.
# File lib/rubygems/specification.rb, line 2612 def version=(version) @version = Gem::Version.create(version) return if @version.nil? invalidate_memoized_attributes end