class Gem::Specification
TheSpecification class contains the information for a gem. Typically defined in a .gemspec file or a Rakefile, and looks like this:
Gem::Specification.newdo|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, aSpecification can hold arbitrary metadata. Seemetadata 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
Source
# File lib/rubygems/specification.rb, line 189defremoved_method_calls@removed_method_calls||= []end
Optional gemspec attributes
↑ topConstants
- 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. SeeGem::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. SeeGem::Security for details.
Public Instance Methods
Source
# File lib/rubygems/specification.rb, line 546defadd_dependency(gem,*requirements)ifrequirements.uniq.size!=requirements.sizewarn"WARNING: duplicated #{gem} dependency #{requirements}"endadd_dependency_with_type(gem,:runtime,requirements)end
Adds a runtime dependency namedgem withrequirements to this gem.
Usage:
spec.add_dependency'example','~> 1.1','>= 1.1.4'
Source
# File lib/rubygems/specification.rb, line 535defadd_development_dependency(gem,*requirements)add_dependency_with_type(gem,:development,requirements)end
Adds a development dependency namedgem withrequirements 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 415defauthor=(o)self.authors = [o]end
Singular (alternative) writer forauthors
Usage:
spec.author ='John Jones'
Source
# File lib/rubygems/specification.rb, line 569defexecutables@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 586defextensions@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'
SeeGem::Ext::Builder for information about writing extensions for gems.
Source
# File lib/rubygems/specification.rb, line 602defextra_rdoc_files@extra_rdoc_files||= []end
Extra files to add to RDoc such asREADME 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 466defplatform=(platform)@original_platform =platformcaseplatformwhenGem::Platform::CURRENTthen@new_platform =Gem::Platform.local@original_platform =@new_platform.to_swhenGem::Platformthen@new_platform =platform# legacy constantswhennil,Gem::Platform::RUBYthen@new_platform =Gem::Platform::RUBYwhen"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.newplatformend@platform =@new_platform.to_send
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 632defrdoc_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 510defrequire_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 662defrequired_ruby_version=(req)@required_ruby_version =Gem::Requirement.createreq@required_ruby_version.requirements.map!do|op,v|ifv>=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]endendend
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 3spec.required_ruby_version ='~> 2.3'# Only prereleases or final releases after 2.6.0.preview2spec.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.0spec.required_ruby_version ='>= 2.3','< 4'
Source
# File lib/rubygems/specification.rb, line 677defrequired_rubygems_version=(req)@required_rubygems_version =Gem::Requirement.createreqend
The RubyGems version required by this gem
Source
# File lib/rubygems/specification.rb, line 690defrequirements@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
↑ topAttributes
The version of RubyGems used to create this gem.
Public Instance Methods
Source
# File lib/rubygems/specification.rb, line 717defextensions_dir@extensions_dir||=superend
The path where this gem installs its extensions.
Gem::BasicSpecification#extensions_dirRecommended gemspec attributes
↑ topAttributes
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
HashobjectAll 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 351deflicense=(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 IDspdx.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 atchoosealicense.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 withlicenses=
Usage:
spec.license ='MIT'
Source
# File lib/rubygems/specification.rb, line 368deflicenses=(licenses)@licenses =Arraylicensesend
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.
Seelicense= for more discussion
Usage:
spec.licenses = ['MIT','GPL-2.0']
Required gemspec attributes
↑ topAttributes
This gem’s name.
Usage:
spec.name ='rake'
A short summary of this gem’s description. Displayed ingem list -d.
Thedescription 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 as1.0.0. A gem is a ‘prerelease’ gem if the version has a letter in it, such as1.0.0.pre.
Usage:
spec.version ='0.4.1'
Public Instance Methods
Source
# File lib/rubygems/specification.rb, line 270defauthors=(value)@authors =Array(value).flatten.grep(String)end
A list of authors for this gem.
Alternatively, a single author can be specified by assigning a string tospec.author
Usage:
spec.authors = ['John Jones','Mary Smith']
Source
# File lib/rubygems/specification.rb, line 250deffiles# 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.sortend
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
↑ topAttributes
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 toGem.bin_path.
TheGem::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 1243defself._load(str)Gem.load_yamlGem.load_safe_marshalyaml_set =falseretry_count =0array =beginGem::SafeMarshal.safe_loadstrrescueArgumentError=>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 definedraiseifretry_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.messageraiseunlessmessage.include?("YAML::")unlessObject.const_defined?(:YAML)Object.const_set"YAML",Psychyaml_set =trueendifmessage.include?("YAML::Syck::")YAML.const_set"Syck",YAMLunlessYAML.const_defined?(:Syck)YAML::Syck.const_set"DefaultKey",Class.newifmessage.include?("YAML::Syck::DefaultKey")&&!YAML::Syck.const_defined?(:DefaultKey)elsifmessage.include?("YAML::PrivateType")&&!YAML.const_defined?(:PrivateType)YAML.const_set"PrivateType",Class.newendretry_count+=1retryensureObject.__send__(:remove_const,"YAML")ifyaml_setendspec =Gem::Specification.newspec.instance_variable_set:@specification_version,array[1]current_version =CURRENT_SPECIFICATION_VERSIONfield_count =ifspec.specification_version>current_versionspec.instance_variable_set:@specification_version,current_versionMARSHAL_FIELDS[current_version]elseMARSHAL_FIELDS[spec.specification_version]endifarray.size<field_countraiseTypeError,"invalid Gem::Specification format #{array.inspect}"endspec.instance_variable_set:@rubygems_version,array[0]# spec versionspec.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 removalspec.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:@licenses,array[17]spec.instance_variable_set:@metadata,array[18]spec.instance_variable_set:@loaded,falsespec.instance_variable_set:@activated,falsespecend
Load custom marshal format, re-initializing defaults as needed
Source
# File lib/rubygems/specification.rb, line 856defself.add_spec(spec)specification_record.add_spec(spec)end
Addsspec to the known specifications, keeping the collection properly sorted.
Source
# File lib/rubygems/specification.rb, line 871defself.allwarn"NOTE: Specification.all called from #{caller(1, 1).first}"unlessGem::Deprecate.skip_allend
Returns all specifications. This method is discouraged from use. You probably want to use one of theEnumerable methods instead.
Source
# File lib/rubygems/specification.rb, line 880defself.all=(specs)specification_record.all =specsend
Sets the known specs tospecs.
Source
# File lib/rubygems/specification.rb, line 887defself.all_namesspecification_record.all_namesend
Return full names of all specs in sorted order.
Source
# File lib/rubygems/specification.rb, line 896defself.array_attributes@@array_attributes.dupend
Return the list of all array-oriented instance variables.
Source
# File lib/rubygems/specification.rb, line 905defself.attribute_names@@attributes.dupend
Return the list of all instance variables.
Source
# File lib/rubygems/specification.rb, line 803defself.default_stubs(pattern ="*.gemspec")base_dir =Gem.default_dirgems_dir =File.joinbase_dir,"gems"gemspec_stubs_in(Gem.default_specifications_dir,pattern)do|path|Gem::StubSpecification.default_gemspec_stub(path,base_dir,gems_dir)endend
Returns aGem::StubSpecification for default gems
Source
# File lib/rubygems/specification.rb, line 912defself.dirs@@dirs||=Gem::SpecificationRecord.dirs_from(gem_path)end
Return the directories thatSpecification uses to find specs.
Source
# File lib/rubygems/specification.rb, line 920defself.dirs=(dirs)reset@@dirs =Gem::SpecificationRecord.dirs_from(Array(dirs))end
Set the directories thatSpecification uses to find specs. Setting this resets the list of known specs.
Source
# File lib/rubygems/specification.rb, line 932defself.each(&block)specification_record.each(&block)end
Enumerate every known spec. See::dirs= and::add_spec to set the list of specs.
Source
# File lib/rubygems/specification.rb, line 985defself.find_active_stub_by_path(path)specification_record.find_active_stub_by_path(path)end
Return the best specification that contains the file matchingpath, among those already activated.
Source
# File lib/rubygems/specification.rb, line 946defself.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 givenfull_name
Source
# File lib/rubygems/specification.rb, line 939defself.find_all_by_name(name,*requirements)specification_record.find_all_by_name(name,*requirements)end
Returns every spec that matchesname and optionalrequirements.
Source
# File lib/rubygems/specification.rb, line 962defself.find_by_full_name(full_name)stubs.find {|s|s.full_name==full_name }&.to_specend
Find the best specification matching afull_name.
Source
# File lib/rubygems/specification.rb, line 954defself.find_by_name(name,*requirements)requirements =Gem::Requirement.defaultifrequirements.empty?Gem::Dependency.new(name,*requirements).to_specend
Find the best specification matching aname andrequirements. Raises if the dependency doesn’t resolve to a valid specification.
Source
# File lib/rubygems/specification.rb, line 969defself.find_by_path(path)specification_record.find_by_path(path)end
Return the best specification that contains the file matchingpath.
Source
# File lib/rubygems/specification.rb, line 992defself.find_in_unresolved(path)unresolved_specs.find_all {|spec|spec.contains_requirable_file?path }end
Return currently unresolved specs that contain the file matchingpath.
Source
# File lib/rubygems/specification.rb, line 1000defself.find_in_unresolved_tree(path)unresolved_specs.eachdo|spec|spec.traversedo|_from_spec,_dep,to_spec,trail|ifto_spec.has_conflicts?||to_spec.conflicts_when_loaded_with?(trail):nextelsereturntrail.reverseifto_spec.contains_requirable_file?pathendendend []end
Search through all unresolved deps and sub-dependencies and return specs that contain the file matchingpath.
Source
# File lib/rubygems/specification.rb, line 977defself.find_inactive_by_path(path)specification_record.find_inactive_by_path(path)end
Return the best specification that contains the file matchingpath amongst the specs that are not activated.
Source
# File lib/rubygems/specification.rb, line 1027defself.from_yaml(input)Gem.load_yamlinput =normalize_yaml_inputinputspec =Gem::SafeYAML.safe_loadinputifspec&&spec.class==FalseClassraiseGem::EndOfYAMLExceptionendunlessGem::Specification===specraiseGem::Exception,"YAML data doesn't evaluate to gem specification"endspec.specification_version||=NONEXISTENT_SPECIFICATION_VERSIONspec.reset_nil_attributes_to_defaultspec.flatten_require_pathsspecend
Special loader forYAML files. When aSpecification object is loaded from aYAML file, it bypasses the normal Ruby object initialization routine (initialize). This method makes up for that and deals with gems of different ages.
Source
# File lib/rubygems/specification.rb, line 1059defself.latest_spec_for(name)specification_record.latest_spec_for(name)end
Return the latest installed spec for gemname.
Source
# File lib/rubygems/specification.rb, line 1052defself.latest_specs(prerelease =false)specification_record.latest_specs(prerelease)end
Return the latest specs, optionally including prerelease specs ifprerelease is true.
Source
# File lib/rubygems/specification.rb, line 1080defself.load(file)returnunlessfilespec =@load_cache_mutex.synchronize {@load_cache[file] }returnspecifspecreturnunlessFile.file?(file)code =Gem.open_file(file,"r:UTF-8:-",&:read)beginspec =evalcode,binding,fileifGem::Specification===specspec.loaded_from =File.expand_pathfile.to_s@load_cache_mutex.synchronizedoprev =@load_cache[file]ifprevspec =prevelse@load_cache[file] =specendendreturnspecendwarn"[#{file}] isn't a Gem::Specification (#{spec.class} instead)."rescueSignalException,SystemExitraiserescueSyntaxError,StandardError=>ewarn"Invalid gemspec in [#{file}]: #{e}"endnilend
Loads Ruby format gemspec fromfile.
Source
# File lib/rubygems/specification.rb, line 844defself.load_defaultseach_spec([Gem.default_specifications_dir])do|spec|# #load returns nil if the spec is bad, so we just ignore# it at this stageGem.register_default_spec(spec)endend
Loads the default specifications. It should be called only once.
Source
# File lib/rubygems/specification.rb, line 1978definitialize(name =nil,version =nil)super()@gems_dir =nil@base_dir =nil@loaded =false@activated =false@loaded_from =nil@original_platform =nil@installed_by_version =nilset_nil_attributes_to_nilset_not_nil_attributes_to_default_values@new_platform =Gem::Platform::RUBYself.name =nameifnameself.version =versionifversionif (platform =Gem.platforms.last)&&platform!=Gem::Platform::RUBY&&platform!=Gem::Platform.localself.platform =platformendyieldselfifblock_given?end
Specification constructor. Assigns the default values to the attributes and yields itself for further initialization. Optionally takesname andversion.
Gem::BasicSpecification::newSource
# File lib/rubygems/specification.rb, line 1119defself.non_nil_attributes@@non_nil_attributes.dupend
Specification attributes that must be non-nil
Source
# File lib/rubygems/specification.rb, line 1126defself.normalize_yaml_input(input)result =input.respond_to?(:read)?input.read:inputresult ="--- "+resultunlessresult.start_with?("--- ")result =result.dupresult.gsub!(/ !!null \n/," \n")# date: 2011-04-26 00:00:00.000000000Z# date: 2011-04-26 00:00:00.000000000 Zresult.gsub!(/^(date: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+?)Z/,'\1 Z')resultend
Make sure theYAML specification is properly formatted with dashes
Source
# File lib/rubygems/specification.rb, line 1144defself.outdatedoutdated_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.
Useoutdated_and_latest_version if you wish to retrieve the latest remote version as well.
Source
# File lib/rubygems/specification.rb, line 1155defself.outdated_and_latest_versionreturnenum_for__method__unlessblock_given?# TODO: maybe we should switch to rubygems' version service?fetcher =Gem::SpecFetcher.fetcherlatest_specs(true).eachdo|local_spec|dependency =Gem::Dependency.newlocal_spec.name,">= #{local_spec.version}"remotes, =fetcher.search_for_dependencydependencyremotes =remotes.map {|n,_|n.version }latest_remote =remotes.sort.lastyield [local_spec,latest_remote]iflatest_remote&&local_spec.version<latest_remoteendnilend
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 863defself.remove_spec(spec)specification_record.remove_spec(spec)end
Removesspec from the known specs.
Source
# File lib/rubygems/specification.rb, line 1180defself.required_attribute?(name)@@required_attributes.include?name.to_symend
Isname a required attribute?
Source
# File lib/rubygems/specification.rb, line 1187defself.required_attributes@@required_attributes.dupend
Required specification attributes
Source
# File lib/rubygems/specification.rb, line 1195defself.reset@@dirs =nilGem.pre_reset_hooks.each(&:call)@specification_record =nilclear_load_cacheunlessunresolved_deps.empty?unresolved =unresolved_deps.filter_mapdo|name,dep|matching_versions =find_all_by_name(name)nextifdep.latest_version?&&matching_versions.any?(&:default_gem?) [dep,matching_versions.uniq(&:full_name)]end.to_hunlessunresolved.empty?warn"WARN: Unresolved or ambiguous specs during Gem::Specification.reset:"unresolved.eachdo|dep,versions|warn" #{dep}"unlessversions.empty?warn" Available/installed versions of this gem:"versions.each {|s|warn" - #{s.version}" }endendwarn"WARN: Clearing out unresolved specs. Try 'gem cleanup <gem>'"warn"Please report a bug if this causes problems."endunresolved_deps.clearendGem.post_reset_hooks.each(&:call)end
Reset the list of known specs, running pre and post reset hooks registered inGem.
Source
# File lib/rubygems/specification.rb, line 1231defself.specification_record@specification_record||=Gem::SpecificationRecord.new(dirs)end
Keeps track of all currently known specifications
Source
# File lib/rubygems/specification.rb, line 796defself.stubsspecification_record.stubsend
Returns aGem::StubSpecification for every installed gem
Source
# File lib/rubygems/specification.rb, line 815defself.stubs_for(name)specification_record.stubs_for(name)end
Returns aGem::StubSpecification for installed gem namedname only returns stubs that matchGem.platforms
Source
# File lib/rubygems/specification.rb, line 1236defself.unresolved_deps@unresolved_deps||=Hash.new {|h,n|h[n] =Gem::Dependency.newn }end
DOC: This method needs documented or nodoc’d
Private Class Methods
Source
# File lib/rubygems/specification.rb, line 1014defself.unresolved_specsunresolved_deps.values.flat_map(&:to_specs)end
Public Instance Methods
Source
# File lib/rubygems/specification.rb, line 1348def_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
Dump only crucial instance variables.
Source
# File lib/rubygems/specification.rb, line 1437defabbreviateself.files = []self.test_files = []self.rdoc_options = []self.extra_rdoc_files = []self.cert_chain = []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.
Source
# File lib/rubygems/specification.rb, line 1378defactivateother =Gem.loaded_specs[name]ifothercheck_version_conflictotherreturnfalseendraise_if_conflictsactivate_dependenciesadd_self_to_load_pathGem.loaded_specs[name] =self@activated =true@loaded =truetrueend
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.
Source
# File lib/rubygems/specification.rb, line 1402defactivate_dependenciesunresolved =Gem::Specification.unresolved_depsruntime_dependencies.eachdo|spec_dep|ifloaded =Gem.loaded_specs[spec_dep.name]nextifspec_dep.matches_spec?loadedmsg ="can't satisfy '#{spec_dep}', already activated '#{loaded.full_name}'"e =Gem::LoadError.newmsge.name =spec_dep.nameraiseeendspecs =spec_dep.matching_specs(true).uniq(&:full_name)ifspecs.size==0raiseGem::MissingSpecError.new(spec_dep.name,spec_dep.requirement,"at: #{spec_file}")elsifspecs.size==1specs.first.activateelsename =spec_dep.nameunresolved[name] =unresolved[name].mergespec_dependendunresolved.deleteself.nameend
Activate all unambiguously resolved runtime dependencies of this spec. Add any ambiguous dependencies to the unresolved list to be resolved later, as needed.
Source
# File lib/rubygems/specification.rb, line 1473defadd_bindir(executables)returnnilifexecutables.nil?if@bindirArray(executables).map {|e|File.join(@bindir,e) }elseexecutablesendrescueStandardErrornilend
Returns an array with bindir attached to each executable in theexecutables list
Source
# File lib/rubygems/specification.rb, line 1512defadd_self_to_load_pathreturnifdefault_gem?paths =full_require_pathsGem.add_to_load_path(*paths)end
Adds this spec’s require paths to LOAD_PATH, in the proper location.
Source
# File lib/rubygems/specification.rb, line 1523defauthor (val =authors)&&val.firstend
Singular reader forauthors. Returns the first author in the list
Source
# File lib/rubygems/specification.rb, line 1532defauthors@authors||= []end
The list of author names who wrote this gem.
spec.authors = ['Chad Fowler','Jim Weirich','Rich Kilmer']
Source
# File lib/rubygems/specification.rb, line 2032defbase_dirreturnGem.dirunlessloaded_from@base_dir||=ifdefault_gem?File.dirnameFile.dirnameFile.dirnameloaded_fromelseFile.dirnameFile.dirnameloaded_fromendend
Source
# File lib/rubygems/specification.rb, line 1542defbin_dir@bin_dir||=File.joingem_dir,bindirend
Returns the full path to installed gem’s bin directory.
NOTE: do not confuse this withbindir, which is just ‘bin’, not a full path.
Source
# File lib/rubygems/specification.rb, line 1549defbin_file(name)File.joinbin_dir,nameend
Returns the full path to an executable namedname in this gem.
Source
# File lib/rubygems/specification.rb, line 1556defbuild_argsifFile.exist?build_info_filebuild_info =File.readlinesbuild_info_filebuild_info =build_info.map(&:strip)build_info.delete""build_infoelse []endend
Returns thebuild_args used to install the gem
Source
# File lib/rubygems/specification.rb, line 1604defbuild_info_dirFile.joinbase_dir,"build_info"end
Returns the full path to the build info directory
Source
# File lib/rubygems/specification.rb, line 1612defbuild_info_fileFile.joinbuild_info_dir,"#{full_name}.info"end
Returns the full path to the file containing the build information generated when the gem was installed
Source
# File lib/rubygems/specification.rb, line 1620defcache_dirFile.joinbase_dir,"cache"end
Returns the full path to the cache directory containing this spec’s cached gem.
Source
# File lib/rubygems/specification.rb, line 1627defcache_fileFile.joincache_dir,"#{full_name}.gem"end
Returns the full path to the cached gem for this spec.
Source
# File lib/rubygems/specification.rb, line 1634defconflictsconflicts = {}runtime_dependencies.eachdo|dep|spec =Gem.loaded_specs[dep.name]ifspec&&!spec.satisfies_requirement?(dep) (conflicts[spec]||= [])<<dependendenv_req =Gem.env_requirement(name) (conflicts[self]||= [])<<env_requnlessenv_req.satisfied_by?versionconflictsend
Return any possible conflicts against the currently loaded specs.
Source
# File lib/rubygems/specification.rb, line 1678defdate@date||=Time.utc(*Gem.source_date_epoch.utc.to_a[3..5].reverse)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/
Source
# File lib/rubygems/specification.rb, line 1698defdate=(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 =casedatewhenStringthenifDateTimeFormat=~dateTime.utc($1.to_i,$2.to_i,$3.to_i)elseraise(Gem::InvalidSpecificationException,"invalid date format in specification: #{date.inspect}")endwhenTime,DateLikethenTime.utc(date.year,date.month,date.day)elseTODAYendend
The date this gem was created
DO NOT set this, it is set automatically when the gem is packaged.
Source
# File lib/rubygems/specification.rb, line 1738defdefault_value(name)@@default_value[name]end
The default value for specification attributename
Source
# File lib/rubygems/specification.rb, line 1748defdependencies@dependencies||= []end
A list ofGem::Dependency objects this gem depends on.
Useadd_dependency oradd_development_dependency to add dependencies to a gem.
Source
# File lib/rubygems/specification.rb, line 1758defdependent_gems(check_dev =true)out = []Gem::Specification.eachdo|spec|deps =check_dev?spec.dependencies:spec.runtime_dependenciesdeps.eachdo|dep|nextunlesssatisfies_requirement?(dep)sats = []find_all_satisfiers(dep)do|sat|sats<<satendout<< [spec,dep,sats]endendoutend
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]]
Source
# File lib/rubygems/specification.rb, line 1777defdependent_specsruntime_dependencies.flat_map(&:to_specs)end
Returns all specs that matches this spec’s runtime dependencies.
Source
# File lib/rubygems/specification.rb, line 1784defdescription=(str)@description =str.to_send
A detailed description of this gem. See alsosummary
Source
# File lib/rubygems/specification.rb, line 1791defdevelopment_dependenciesdependencies.select {|d|d.type==:development }end
List of dependencies that are used for development
Source
# File lib/rubygems/specification.rb, line 1803defdoc_dir(type =nil)@doc_dir||=File.joinbase_dir,"doc",full_nameiftypeFile.join@doc_dir,typeelse@doc_direndend
Returns the full path to this spec’s documentation directory. Iftype 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"
Source
# File lib/rubygems/specification.rb, line 1833defexecutable (val =executables)&&val.firstend
Singular accessor forexecutables
Source
# File lib/rubygems/specification.rb, line 1840defexecutable=(o)self.executables = [o]end
Singular accessor forexecutables
Source
# File lib/rubygems/specification.rb, line 1847defexecutables=(value)@executables =Array(value)end
Sets executables tovalue, ensuring it is an array.
Source
# File lib/rubygems/specification.rb, line 1854defextensions=(extensions)@extensions =Arrayextensionsend
Sets extensions toextensions, ensuring it is an array.
Source
# File lib/rubygems/specification.rb, line 1861defextra_rdoc_files=(files)@extra_rdoc_files =Arrayfilesend
Setsextra_rdoc_files tofiles, ensuring it is an array.
Source
# File lib/rubygems/specification.rb, line 1870deffile_name"#{full_name}.gem"end
The default (generated) file name of the gem. See alsospec_name.
spec.file_name# => "example-1.0.gem"
Source
# File lib/rubygems/specification.rb, line 1877deffiles=(files)@files =Arrayfilesend
Sets files tofiles, ensuring it is an array.
Source
# File lib/rubygems/specification.rb, line 1895deffor_cachespec =dupspec.files =nilspec.test_files =nilspecend
Creates a duplicate spec without large blobs that aren’t used at runtime.
Source
# File lib/rubygems/specification.rb, line 1912defgems_dir@gems_dir||=File.join(base_dir,"gems")end
Source
# File lib/rubygems/specification.rb, line 1660defhas_conflicts?returntrueunlessGem.env_requirement(name).satisfied_by?(version)runtime_dependencies.any?do|dep|spec =Gem.loaded_specs[dep.name]spec&&!spec.satisfies_requirement?(dep)endrescueArgumentError=>eraisee,"#{name} #{version}: #{e.message}"end
Return true if there are possible conflicts against the currently loaded specs.
Source
# File lib/rubygems/specification.rb, line 2007definitialize_copy(other_spec)self.class.array_attributes.eachdo|name|name =:"@#{name}"nextunlessother_spec.instance_variable_defined?namebeginval =other_spec.instance_variable_get(name)ifvalinstance_variable_setname,val.dupelsifGem.configuration.really_verbosewarn"WARNING: #{full_name} has an invalid nil value for #{name}"endrescueTypeErrore =Gem::FormatException.new \"#{full_name} has an invalid value for #{name}"e.file_path =loaded_fromraiseeendend@required_ruby_version =other_spec.required_ruby_version.dup@required_rubygems_version =other_spec.required_rubygems_version.dupend
DuplicatesArray andGem::Requirement attributes fromother_spec so state isn’t shared.
Source
# File lib/rubygems/specification.rb, line 2558defkeep_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
Source
# File lib/rubygems/specification.rb, line 2052deflib_files@files.selectdo|file|require_paths.any?do|path|file.start_with?pathendendend
Files in theGem under one of the require_paths
Source
# File lib/rubygems/specification.rb, line 2063deflicenselicenses.firstend
Singular accessor forlicenses
Source
# File lib/rubygems/specification.rb, line 2072deflicenses@licenses||= []end
Plural accessor for setting licenses
Seelicense= for details
Source
# File lib/rubygems/specification.rb, line 2107defmissing_extensions?returnfalseifextensions.empty?returnfalseifdefault_gem?returnfalseifFile.exist?gem_build_complete_pathtrueend
Is this specification missing its extensions? When this returns true you probably want to build_extensions
Source
# File lib/rubygems/specification.rb, line 2138defname_tupleGem::NameTuple.newname,version,original_platformend
Return a NameTuple that represents thisSpecification
Source
# File lib/rubygems/specification.rb, line 2121defnormalizeifdefined?(@extra_rdoc_files)&&@extra_rdoc_files@extra_rdoc_files.uniq!@files||= []@files.concat(@extra_rdoc_files)end@files =@files.uniq.sortif@files@extensions =@extensions.uniq.sortif@extensions@test_files =@test_files.uniq.sortif@test_files@executables =@executables.uniq.sortif@executables@extra_rdoc_files =@extra_rdoc_files.uniq.sortif@extra_rdoc_filesend
Normalize the list of files so that:
All file lists have redundancies removed.
Files referenced in the
extra_rdoc_filesare included in the package file list.
Source
# File lib/rubygems/specification.rb, line 2164defplatform@new_platform||=Gem::Platform::RUBY# rubocop:disable Naming/MemoizedInstanceVariableNameend
The platform this gem runs on. SeeGem::Platform for details.
Source
# File lib/rubygems/specification.rb, line 2230defrdoc_options=(options)@rdoc_options =Arrayoptionsend
Setsrdoc_options tovalue, ensuring it is an array.
Source
# File lib/rubygems/specification.rb, line 2237defrequire_path (val =require_paths)&&val.firstend
Singular accessor forrequire_paths
Source
# File lib/rubygems/specification.rb, line 2244defrequire_path=(path)self.require_paths =Array(path)end
Singular accessor forrequire_paths
Source
# File lib/rubygems/specification.rb, line 2251defrequirements=(req)@requirements =Arrayreqend
Set requirements toreq, ensuring it is an array.
Source
# File lib/rubygems/specification.rb, line 2613defreset_nil_attributes_to_defaultnil_attributes =self.class.non_nil_attributes.find_alldo|name|!instance_variable_defined?("@#{name}")||instance_variable_get("@#{name}").nil?endnil_attributes.eachdo|attribute|default =default_valueattributevalue =casedefaultwhenTime,Numeric,Symbol,true,false,nilthendefaultelsedefault.dupendinstance_variable_set"@#{attribute}",valueend@installed_by_version||=nilnilend
Reset nil attributes to their default values to make the spec valid
Source
# File lib/rubygems/specification.rb, line 2262defri_dir@ri_dir||=File.joinbase_dir,"ri",full_nameend
Returns the full path to this spec’s ri directory.
Source
# File lib/rubygems/specification.rb, line 2295defruntime_dependenciesdependencies.select(&:runtime?)end
List of dependencies that will automatically be activated at runtime.
Source
# File lib/rubygems/specification.rb, line 1450defsanitizeself.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 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.
Source
# File lib/rubygems/specification.rb, line 1460defsanitize_string(string)returnstringunlessstring# 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_send
Sanitize a single string.
Source
# File lib/rubygems/specification.rb, line 2311defsatisfies_requirement?(dependency)@name==dependency.name&&dependency.requirement.satisfied_by?(@version)end
Checks if this specification meets the requirement ofdependency.
Source
# File lib/rubygems/specification.rb, line 2319defsort_obj [@name,@version,Gem::Platform.sort_priority(@new_platform)]end
Returns an object you can use to sort specifications in sort_by.
Source
# File lib/rubygems/specification.rb, line 2334defspec_dir@spec_dir||=File.joinbase_dir,"specifications"end
Returns the full path to the directory containing this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications
Source
# File lib/rubygems/specification.rb, line 2342defspec_file@spec_file||=File.joinspec_dir,"#{full_name}.gemspec"end
Returns the full path to this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications/mygem-1.0.gemspec
Source
# File lib/rubygems/specification.rb, line 2351defspec_name"#{full_name}.gemspec"end
The default name of the gemspec. See alsofile_name
spec.spec_name# => "example-1.0.gemspec"
Source
# File lib/rubygems/specification.rb, line 2358defsummary=(str)@summary =str.to_s.strip.gsub(/(\w-)\n[ \t]*(\w)/,'\1\2').gsub(/\n[ \t]*/," ")# so. weird.end
A short summary of this gem’s description.
Source
# File lib/rubygems/specification.rb, line 2401defto_rubyresult = []result<<"# -*- encoding: utf-8 -*-"result<<"#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{raw_require_paths.join("\0")}"result<<"#{Gem::StubSpecification::PREFIX}#{extensions.join "\0"}"unlessextensions.empty?result<<nilresult<<"Gem::Specification.new do |s|"result<<" s.name = #{ruby_code name}"result<<" s.version = #{ruby_code version}"unlessplatform.nil?||platform==Gem::Platform::RUBYresult<<" s.platform = #{ruby_code original_platform}"endresult<<""result<<" s.required_rubygems_version = #{ruby_code required_rubygems_version} if s.respond_to? :required_rubygems_version="ifmetadata&&!metadata.empty?result<<" s.metadata = #{ruby_code metadata} if s.respond_to? :metadata="endresult<<" 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.eachdo|attr_name|nextifhandled.include?attr_namecurrent_value =send(attr_name)ifcurrent_value!=default_value(attr_name)||self.class.required_attribute?(attr_name)result<<" s.#{attr_name} = #{ruby_code current_value}"endendifString===signing_keyresult<<" s.signing_key = #{ruby_code signing_key}"endif@installed_by_versionresult<<nilresult<<" s.installed_by_version = #{ruby_code Gem::VERSION}"endunlessdependencies.empty?result<<nilresult<<" s.specification_version = #{specification_version}"result<<nildependencies.eachdo|dep|dep.instance_variable_set:@type,:runtimeifdep.type.nil?# HACKresult<<" s.add_#{dep.type}_dependency(%q<#{dep.name}>.freeze, #{ruby_code dep.requirements_list})"endendresult<<"end"result<<nilresult.join"\n"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.
Source
# File lib/rubygems/specification.rb, line 2477defto_ruby_for_cachefor_cache.to_rubyend
Returns a Ruby lighter-weight code representation of this specification, used for indexing only.
Seeto_ruby.
Source
# File lib/rubygems/specification.rb, line 2519deftraverse(trail = [],visited = {},&block)trail.push(self)beginruntime_dependencies.eachdo|dep|dep.matching_specs(true).eachdo|dep_spec|nextifvisited.key?(dep_spec)visited[dep_spec] =truetrail.push(dep_spec)beginresult =block[self,dep,dep_spec,trail]ensuretrail.popendnextifresult==:nextspec_name =dep_spec.namedep_spec.traverse(trail,visited,&block)unlesstrail.any? {|s|s.name==spec_name }endendensuretrail.popendend
Recursively walk dependencies of this spec, executing theblock for each hop.
Source
# File lib/rubygems/specification.rb, line 2550defvalidate(packaging =true,strict =false)normalizevalidation_policy =Gem::SpecificationPolicy.new(self)validation_policy.packaging =packagingvalidation_policy.validate(strict)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..
Source
# File lib/rubygems/specification.rb, line 2575defvalidate_dependenciesGem::SpecificationPolicy.new(self).validate_dependenciesend
Source
# File lib/rubygems/specification.rb, line 2566defvalidate_for_resolutionGem::SpecificationPolicy.new(self).validate_for_resolutionend
Source
# File lib/rubygems/specification.rb, line 2570defvalidate_metadataGem::SpecificationPolicy.new(self).validate_metadataend
Source
# File lib/rubygems/specification.rb, line 2580defvalidate_permissionsGem::SpecificationPolicy.new(self).validate_permissionsend
Source
# File lib/rubygems/specification.rb, line 2588defversion=(version)@version =Gem::Version.create(version)end
Set the version toversion.
Private Instance Methods
Source
# File lib/rubygems/specification.rb, line 1490defadd_dependency_with_type(dependency,type,requirements)requirements =ifrequirements.empty?Gem::Requirement.defaultelserequirements.flattenendunlessdependency.respond_to?(:name)&&dependency.respond_to?(:requirement)dependency =Gem::Dependency.new(dependency.to_s,requirements,type)enddependencies<<dependencyend
Adds a dependency on gemdependency with typetype that requiresrequirements. Valid types are currently:runtime and:development.
Source
# File lib/rubygems/specification.rb, line 1884deffind_all_satisfiers(dep)Gem::Specification.eachdo|spec|yieldspecifspec.satisfies_requirement?dependend
Finds all gems that satisfydep
Source
# File lib/rubygems/specification.rb, line 2270defruby_code(obj)caseobjwhenStringthenobj.dump+".freeze"whenArraythen"["+obj.map {|x|ruby_codex }.join(", ")+"]"whenHashthenseg =obj.keys.sort.map {|k|"#{k.to_s.dump} => #{obj[k].to_s.dump}" }"{ #{seg.join(", ")} }"whenGem::Versionthenruby_code(obj.to_s)whenDateLikethenobj.strftime("%Y-%m-%d").dumpwhenTimethenobj.strftime("%Y-%m-%d").dumpwhenNumericthenobj.inspectwhentrue,false,nilthenobj.inspectwhenGem::Platformthen"Gem::Platform.new(#{ruby_code obj.to_a})"whenGem::Requirementthenlist =obj.as_list"Gem::Requirement.new(#{ruby_code(list.size == 1 ? obj.to_s : list)})"elseraiseGem::Exception,"ruby_code case not handled: #{obj.class}"endend
Return a string containing a Ruby code representation of the given object.
Source
# File lib/rubygems/specification.rb, line 2302defsame_attributes?(spec)@@attributes.all? {|name,_default|send(name)==spec.send(name) }end
True if this gem has the same attributes asother.