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.
Specifications must be deterministic, as in the example above. For instance, you cannot define attributes conditionally:
# INVALID: do not do this. unless RUBY_ENGINE == "jruby" s.extensions << "ext/example/extconf.rb" end
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
Source
# File lib/rubygems/specification.rb, line 195 def removed_method_calls @removed_method_calls ||= [] end
Source
# File lib/rubygems/specification.rb, line 136 { authors: [], autorequire: nil, bindir: "bin", cert_chain: [], date: nil, dependencies: [], description: nil, email: nil, executables: [], extensions: [], extra_rdoc_files: [], files: [], homepage: nil, licenses: [], metadata: {}, name: nil, platform: Gem::Platform::RUBY, post_install_message: nil, rdoc_options: [], require_paths: ["lib"], required_ruby_version: Gem::Requirement.default, required_rubygems_version: Gem::Requirement.default, requirements: [], rubygems_version: Gem::VERSION, signing_key: nil, specification_version: CURRENT_SPECIFICATION_VERSION, summary: nil, test_files: [], version: nil, }.freeze
Map of attribute names to default values.
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
# File lib/rubygems/specification.rb, line 552 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 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 541 def add_development_dependency(gem, *requirements) add_dependency_with_type(gem, :development, 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.
Source
# File lib/rubygems/specification.rb, line 575 def executables @executables ||= [] 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'
Source
# File lib/rubygems/specification.rb, line 592 def extensions @extensions ||= [] 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.
Source
# File lib/rubygems/specification.rb, line 608 def extra_rdoc_files @extra_rdoc_files ||= [] 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']
Source
# File lib/rubygems/specification.rb, line 472 def platform=(platform) @original_platform = platform 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 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
Source
# File lib/rubygems/specification.rb, line 638 def rdoc_options @rdoc_options ||= [] end
Specifies the rdoc options to be used when generating API documentation.
Usage:
spec.rdoc_options << '--title' << 'Rake -- Ruby Make' << '--main' << 'README' << '--line-numbers'
Source
# File lib/rubygems/specification.rb, line 516 def require_paths=(val) @require_paths = Array(val) 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 = ['.']
Source
# File lib/rubygems/specification.rb, line 668 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 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 683 def required_rubygems_version=(req) @required_rubygems_version = Gem::Requirement.create req end
The RubyGems version required by this gem
Source
# File lib/rubygems/specification.rb, line 696 def requirements @requirements ||= [] 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'
Read-only attributes
Attributes
The version of RubyGems used to create this gem.
Public Instance Methods
Source
# File lib/rubygems/specification.rb, line 723 def extensions_dir @extensions_dir ||= super end
The path where this gem installs its extensions.
Gem::BasicSpecification#extensions_dir
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
Hashobject -
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
Source
# File lib/rubygems/specification.rb, line 357 def license=(o) self.licenses = [o] end
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'
Source
# File lib/rubygems/specification.rb, line 374 def licenses=(licenses) @licenses = Array licenses 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']
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
Source
# File lib/rubygems/specification.rb, line 256 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
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" }
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.
The Gem::Specification version of this gemspec.
Do not set this, it is set automatically when the gem is packaged.
Public Class Methods
Source
# File lib/rubygems/specification.rb, line 1250 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.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] # offset due to has_rdoc removal 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
Load custom marshal format, re-initializing defaults as needed
Source
# File lib/rubygems/specification.rb, line 854 def self.add_spec(spec) specification_record.add_spec(spec) end
Adds spec to the known specifications, keeping the collection properly sorted.
Source
# File lib/rubygems/specification.rb, line 869 def self.all warn "NOTE: Specification.all called from #{caller(1, 1).first}" unless Gem::Deprecate.skip _all end
Returns all specifications. This method is discouraged from use. You probably want to use one of the Enumerable methods instead.
Source
# File lib/rubygems/specification.rb, line 878 def self.all=(specs) specification_record.all = specs end
Sets the known specs to specs.
Source
# File lib/rubygems/specification.rb, line 885 def self.all_names specification_record.all_names end
Return full names of all specs in sorted order.
Source
# File lib/rubygems/specification.rb, line 894 def self.array_attributes @@array_attributes.dup end
Return the list of all array-oriented instance variables.
Source
# File lib/rubygems/specification.rb, line 903 def self.attribute_names @@attributes.dup end
Return the list of all instance variables.
# File lib/rubygems/specification.rb, line 801 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
Returns a Gem::StubSpecification for default gems
Source
# File lib/rubygems/specification.rb, line 910 def self.dirs @@dirs ||= Gem::SpecificationRecord.dirs_from(gem_path) end
Return the directories that Specification uses to find specs.
Source
# File lib/rubygems/specification.rb, line 918 def self.dirs=(dirs) reset @@dirs = Gem::SpecificationRecord.dirs_from(Array(dirs)) end
Set the directories that Specification uses to find specs. Setting this resets the list of known specs.
Source
# File lib/rubygems/specification.rb, line 930 def self.each(&block) specification_record.each(&block) end
Enumerate every known spec. See ::dirs= and ::add_spec to set the list of specs.
# File lib/rubygems/specification.rb, line 992 def self.find_active_stub_by_path(path) specification_record.find_active_stub_by_path(path) end
Return the best specification that contains the file matching path, among those already activated.
# File lib/rubygems/specification.rb, line 944 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 has the given full_name
# File lib/rubygems/specification.rb, line 937 def self.find_all_by_name(name, *requirements) specification_record.find_all_by_name(name, *requirements) end
Returns every spec that matches name and optional requirements.
# File lib/rubygems/specification.rb, line 960 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 full_name.
# File lib/rubygems/specification.rb, line 952 def self.find_by_name(name, *requirements) requirements = Gem::Requirement.default if requirements.empty? Gem::Dependency.new(name, *requirements).to_spec end
Find the best specification matching a name and requirements. Raises if the dependency doesn’t resolve to a valid specification.
Source
# File lib/rubygems/specification.rb, line 967 def self.find_by_path(path) specification_record.find_by_path(path) end
Return the best specification that contains the file matching path.
Source
# File lib/rubygems/specification.rb, line 999 def self.find_in_unresolved(path) unresolved_specs.find_all {|spec| spec.contains_requirable_file? path } end
Return currently unresolved specs that contain the file matching path.
# File lib/rubygems/specification.rb, line 1007 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.conflicts_when_loaded_with?(trail) :next else return trail.reverse if to_spec.contains_requirable_file? path end end end [] end
Search through all unresolved deps and sub-dependencies and return specs that contain the file matching path.
Source
# File lib/rubygems/specification.rb, line 984 def self.find_inactive_by_path(path) specification_record.find_inactive_by_path(path) end
Return the best specification that contains the file matching path amongst the specs that are not activated.
Source
# File lib/rubygems/specification.rb, line 976 def self.find_unloaded_by_path(path) specification_record.find_unloaded_by_path(path) end
Return the best specification that contains the file matching path amongst the specs that are not loaded. This method is different than find_inactive_by_path as it will filter out loaded specs by their name.
Source
# File lib/rubygems/specification.rb, line 1034 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
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.
Source
# File lib/rubygems/specification.rb, line 1066 def self.latest_spec_for(name) specification_record.latest_spec_for(name) end
Return the latest installed spec for gem name.
# File lib/rubygems/specification.rb, line 1059 def self.latest_specs(prerelease = false) specification_record.latest_specs(prerelease) end
Return the latest specs, optionally including prerelease specs if prerelease is true.
Source
# File lib/rubygems/specification.rb, line 1087 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 Ruby format gemspec from file.
Source
# File lib/rubygems/specification.rb, line 842 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
Loads the default specifications. It should be called only once.
# File lib/rubygems/specification.rb, line 1944 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 constructor. Assigns the default values to the attributes and yields itself for further initialization. Optionally takes name and version.
Gem::BasicSpecification::new
Source
# File lib/rubygems/specification.rb, line 1126 def self.non_nil_attributes @@non_nil_attributes.dup end
Specification attributes that must be non-nil
Source
# File lib/rubygems/specification.rb, line 1133 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
Make sure the YAML specification is properly formatted with dashes
Source
# File lib/rubygems/specification.rb, line 1151 def self.outdated outdated_and_latest_version.map {|local, _| local.name } 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 1162 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
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.
Source
# File lib/rubygems/specification.rb, line 861 def self.remove_spec(spec) specification_record.remove_spec(spec) end
Removes spec from the known specs.
Source
# File lib/rubygems/specification.rb, line 1187 def self.required_attribute?(name) @@required_attributes.include? name.to_sym end
Is name a required attribute?
Source
# File lib/rubygems/specification.rb, line 1194 def self.required_attributes @@required_attributes.dup end
Required specification attributes
Source
# File lib/rubygems/specification.rb, line 1202 def self.reset @@dirs = nil Gem.pre_reset_hooks.each(&:call) @specification_record = nil clear_load_cache unless unresolved_deps.empty? unresolved = unresolved_deps.filter_map do |name, dep| matching_versions = find_all_by_name(name) next if dep.latest_version? && matching_versions.any?(&:default_gem?) [dep, matching_versions.uniq(&:full_name)] end.to_h unless unresolved.empty? warn "WARN: Unresolved or ambiguous specs during Gem::Specification.reset:" unresolved.each do |dep, versions| warn " #{dep}" 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." end unresolved_deps.clear end Gem.post_reset_hooks.each(&:call) end
Reset the list of known specs, running pre and post reset hooks registered in Gem.
Source
# File lib/rubygems/specification.rb, line 1238 def self.specification_record @specification_record ||= Gem::SpecificationRecord.new(dirs) end
Keeps track of all currently known specifications
Source
# File lib/rubygems/specification.rb, line 794 def self.stubs specification_record.stubs end
Returns a Gem::StubSpecification for every installed gem