Class: Gem::Specification
- Inherits:
-
BasicSpecification
- Object
- BasicSpecification
- Gem::Specification
- Extended by:
- Enumerable, Deprecate
- Defined in:
- lib/rubygems/specification.rb
Overview
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. = ["Ruby Coder"]
s.email = '[email protected]'
s.files = ["lib/example.rb"]
s.homepage = 'https://rubygems.org/gems/example'
s. = { "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.
Constant Summary collapse
- NONEXISTENT_SPECIFICATION_VERSION =
The version number of a specification that does not specify one (i.e. RubyGems 0.7 or earlier).
-1
- CURRENT_SPECIFICATION_VERSION =
The specification version applied to any new Specification instances created. This should be bumped whenever something in the spec format changes.
Specification Version History:
spec ruby ver ver yyyy-mm-dd description -1 <0.8.0 pre-spec-version-history 1 0.8.0 2004-08-01 Deprecated "test_suite_file" for "test_files" "test_file=x" is a shortcut for "test_files=[x]" 2 0.9.5 2007-10-01 Added "required_rubygems_version" Now forward-compatible with future versions 3 1.3.2 2009-01-03 Added Fixnum validation to specification_version 4 1.9.0 2011-06-07 Added metadata
– When updating this number, be sure to also update #to_ruby.
NOTE RubyGems < 1.2 cannot load specification versions > 2.
4
- SPECIFICATION_VERSION_HISTORY =
An informal list of changes to the specification. The highest-valued key should be equal to the CURRENT_SPECIFICATION_VERSION.
{ # :nodoc: -1 => ['(RubyGems versions up to and including 0.7 did not have versioned specifications)'], 1 => [ 'Deprecated "test_suite_file" in favor of the new, but equivalent, "test_files"', '"test_file=x" is a shortcut for "test_files=[x]"', ], 2 => [ 'Added "required_rubygems_version"', 'Now forward-compatible with future versions', ], 3 => [ 'Added Fixnum validation to the specification_version', ], 4 => [ 'Added sandboxed freeform metadata to the specification version.', ], }.freeze
- MARSHAL_FIELDS =
:nodoc:
{ # :nodoc: -1 => 16, 1 => 16, 2 => 16, 3 => 17, 4 => 18, }.freeze
- TODAY =
:nodoc:
Time.utc(today.year, today.month, today.day)
- LOAD_CACHE_MUTEX =
rubocop:enable Style/MutableConstant
Mutex.new
- VALID_NAME_PATTERN =
:nodoc:
/\A[a-zA-Z0-9\.\-\_]+\z/.freeze
- INITIALIZE_CODE_FOR_DEFAULTS =
rubocop:disable Style/MutableConstant
{ }
- NOT_FOUND =
Sentinel object to represent “not found” stubs
Struct.new(:to_spec, :this).new
- REMOVED_METHODS =
Tracking removed method calls to warn users during build time.
[:rubyforge_project=].freeze
- DateLike =
:nodoc:
Object.new
- DateTimeFormat =
:nodoc:
/\A (\d{4})-(\d{2})-(\d{2}) (\s+ \d{2}:\d{2}:\d{2}\.\d+ \s* (Z | [-+]\d\d:\d\d) )? \Z/x.freeze
- @@required_attributes =
List of attribute names: [:name, :version, …]
[:rubygems_version, :specification_version, :name, :version, :date, :summary, :require_paths]
- @@default_value =
Map of attribute names to default values.
{ :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
- @@attributes =
@@default_value.keys.sort_by {|s| s.to_s }
- @@array_attributes =
@@default_value.reject {|k,v| v != [] }.keys
- @@stubs =
nil
- @@stubs_by_name =
{}
- @@spec_with_requirable_file =
{}
- @@active_stub_with_requirable_file =
{}
Instance Attribute Summary collapse
-
#activated ⇒ Object
(also: #activated?)
True when this gemspec has been activated.
-
#autorequire ⇒ Object
Autorequire was used by old RubyGems to automatically require a file.
-
#bindir ⇒ Object
The path in the gem for executable scripts.
-
#cert_chain ⇒ Object
The certificate chain used to sign this gem.
-
#default_executable ⇒ Object
The default executable for this gem.
-
#description ⇒ Object
A long description of this gem.
-
#email ⇒ Object
A contact email address (or addresses) for this gem.
-
#homepage ⇒ Object
The URL of this gem’s home page.
-
#metadata ⇒ Object
The metadata holds extra data for this gem that may be useful to other consumers and is settable by gem authors.
-
#name ⇒ Object
This gem’s name.
-
#original_platform ⇒ Object
Cruft.
-
#post_install_message ⇒ Object
A message that gets displayed after the gem is installed.
-
#required_ruby_version ⇒ Object
The version of Ruby required by this gem.
-
#required_rubygems_version ⇒ Object
The RubyGems version required by this gem.
-
#rubygems_version ⇒ Object
The version of RubyGems used to create this gem.
-
#signing_key ⇒ Object
The key used to sign this gem.
-
#specification_version ⇒ Object
The Gem::Specification version of this gemspec.
-
#summary ⇒ Object
A short summary of this gem’s description.
-
#version ⇒ Object
This gem’s version.
Attributes inherited from BasicSpecification
#extension_dir, #full_gem_path, #ignored, #loaded_from
Class Method Summary collapse
-
._all ⇒ Object
:nodoc:.
-
._clear_load_cache ⇒ Object
:nodoc:.
-
._latest_specs(specs, prerelease = false) ⇒ Object
:nodoc:.
-
._load(str) ⇒ Object
Load custom marshal format, re-initializing defaults as needed.
-
._resort!(specs) ⇒ Object
:nodoc:.
-
.all ⇒ Object
Returns all specifications.
-
.all=(specs) ⇒ Object
Sets the known specs to
specs
. -
.all_names ⇒ Object
Return full names of all specs in sorted order.
-
.array_attributes ⇒ Object
Return the list of all array-oriented instance variables.
-
.attribute_names ⇒ Object
Return the list of all instance variables.
-
.default_stubs(pattern = "*.gemspec") ⇒ Object
Returns a Gem::StubSpecification for default gems.
-
.dirs ⇒ Object
Return the directories that Specification uses to find specs.
-
.dirs=(dirs) ⇒ Object
Set the directories that Specification uses to find specs.
-
.each ⇒ Object
Enumerate every known spec.
-
.each_gemspec(dirs) ⇒ Object
:nodoc:.
-
.each_spec(dirs) ⇒ Object
:nodoc:.
- .find_active_stub_by_path(path) ⇒ Object
-
.find_all_by_full_name(full_name) ⇒ Object
Returns every spec that has the given
full_name
. -
.find_all_by_name(name, *requirements) ⇒ Object
Returns every spec that matches
name
and optionalrequirements
. -
.find_by_name(name, *requirements) ⇒ Object
Find the best specification matching a
name
andrequirements
. -
.find_by_path(path) ⇒ Object
Return the best specification that contains the file matching
path
. -
.find_in_unresolved(path) ⇒ Object
Return currently unresolved specs that contain the file matching
path
. -
.find_in_unresolved_tree(path) ⇒ Object
Search through all unresolved deps and sub-dependencies and return specs that contain the file matching
path
. -
.find_inactive_by_path(path) ⇒ Object
Return the best specification that contains the file matching
path
amongst the specs that are not activated. -
.from_yaml(input) ⇒ Object
Special loader for YAML files.
-
.latest_spec_for(name) ⇒ Object
Return the latest installed spec for gem
name
. -
.latest_specs(prerelease = false) ⇒ Object
Return the latest specs, optionally including prerelease specs if
prerelease
is true. -
.load(file) ⇒ Object
Loads Ruby format gemspec from
file
. -
.load_defaults ⇒ Object
Loads the default specifications.
-
.non_nil_attributes ⇒ Object
Specification attributes that must be non-nil.
-
.normalize_yaml_input(input) ⇒ Object
Make sure the YAML specification is properly formatted with dashes.
-
.outdated ⇒ Object
Return a list of all outdated local gem names.
-
.outdated_and_latest_version ⇒ Object
Enumerates the outdated local gems yielding the local specification and the latest remote version.
-
.required_attribute?(name) ⇒ Boolean
Is
name
a required attribute?. -
.required_attributes ⇒ Object
Required specification attributes.
-
.reset ⇒ Object
Reset the list of known specs, running pre and post reset hooks registered in Gem.
-
.stubs ⇒ Object
Returns a Gem::StubSpecification for every installed gem.
-
.stubs_for(name) ⇒ Object
Returns a Gem::StubSpecification for installed gem named
name
only returns stubs that match Gem.platforms. -
.stubs_for_pattern(pattern, match_platform = true) ⇒ Object
Finds stub specifications matching a pattern from the standard locations, optionally filtering out specs not matching the current platform.
-
.unresolved_deps ⇒ Object
DOC: This method needs documented or nodoc’d.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
:nodoc:.
-
#==(other) ⇒ Object
:nodoc:.
-
#_dump(limit) ⇒ Object
Dump only crucial instance variables.
-
#abbreviate ⇒ Object
Abbreviate the spec for downloading.
-
#activate ⇒ Object
Activate this spec, registering it as a loaded spec and adding it’s lib paths to $LOAD_PATH.
-
#activate_dependencies ⇒ Object
Activate all unambiguously resolved runtime dependencies of this spec.
-
#add_bindir(executables) ⇒ Object
Returns an array with bindir attached to each executable in the
executables
list. -
#add_development_dependency(gem, *requirements) ⇒ Object
Adds a development dependency named
gem
withrequirements
to this gem. -
#add_runtime_dependency(gem, *requirements) ⇒ Object
(also: #add_dependency)
Adds a runtime dependency named
gem
withrequirements
to this gem. -
#add_self_to_load_path ⇒ Object
Adds this spec’s require paths to LOAD_PATH, in the proper location.
-
#author ⇒ Object
Singular reader for #authors.
-
#author=(o) ⇒ Object
Singular (alternative) writer for #authors.
-
#authors ⇒ Object
The list of author names who wrote this gem.
-
#authors=(value) ⇒ Object
A list of authors for this gem.
- #base_dir ⇒ Object
-
#bin_dir ⇒ Object
Returns the full path to installed gem’s bin directory.
-
#bin_file(name) ⇒ Object
Returns the full path to an executable named
name
in this gem. -
#build_args ⇒ Object
Returns the build_args used to install the gem.
-
#build_extensions ⇒ Object
Builds extensions for this platform if the gem has extensions listed and the gem.build_complete file is missing.
-
#build_info_dir ⇒ Object
Returns the full path to the build info directory.
-
#build_info_file ⇒ Object
Returns the full path to the file containing the build information generated when the gem was installed.
-
#cache_dir ⇒ Object
Returns the full path to the cache directory containing this spec’s cached gem.
-
#cache_file ⇒ Object
Returns the full path to the cached gem for this spec.
-
#conficts_when_loaded_with?(list_of_specs) ⇒ Boolean
return true if there will be conflict when spec if loaded together with the list of specs.
-
#conflicts ⇒ Object
Return any possible conflicts against the currently loaded specs.
-
#date ⇒ Object
The date this gem was created.
-
#date=(date) ⇒ Object
The date this gem was created.
-
#default_value(name) ⇒ Object
The default value for specification attribute
name
. -
#dependencies ⇒ Object
A list of Gem::Dependency objects this gem depends on.
-
#dependent_gems(check_dev = true) ⇒ Object
Return a list of all gems that have a dependency on this gemspec.
-
#dependent_specs ⇒ Object
Returns all specs that matches this spec’s runtime dependencies.
-
#development_dependencies ⇒ Object
List of dependencies that are used for development.
-
#doc_dir(type = nil) ⇒ Object
Returns the full path to this spec’s documentation directory.
-
#encode_with(coder) ⇒ Object
:nodoc:.
-
#eql?(other) ⇒ Boolean
:nodoc:.
-
#executable ⇒ Object
Singular accessor for #executables.
-
#executable=(o) ⇒ Object
Singular accessor for #executables.
-
#executables ⇒ Object
Executables included in the gem.
-
#executables=(value) ⇒ Object
Sets executables to
value
, ensuring it is an array. -
#extensions ⇒ Object
Extensions to build when installing the gem, specifically the paths to extconf.rb-style files used to compile extensions.
-
#extensions=(extensions) ⇒ Object
Sets extensions to
extensions
, ensuring it is an array. -
#extra_rdoc_files ⇒ Object
Extra files to add to RDoc such as README or doc/examples.txt.
-
#extra_rdoc_files=(files) ⇒ Object
Sets extra_rdoc_files to
files
, ensuring it is an array. -
#file_name ⇒ Object
The default (generated) file name of the gem.
-
#files ⇒ Object
Files included in this gem.
-
#files=(files) ⇒ Object
Sets files to
files
, ensuring it is an array. -
#for_cache ⇒ Object
Creates a duplicate spec without large blobs that aren’t used at runtime.
- #full_name ⇒ Object
-
#gem_dir ⇒ Object
Work around bundler removing my methods.
- #gems_dir ⇒ Object
-
#has_conflicts? ⇒ Boolean
Return true if there are possible conflicts against the currently loaded specs.
-
#has_rdoc ⇒ Object
(also: #has_rdoc?)
Deprecated and ignored, defaults to true.
-
#has_rdoc=(ignored) ⇒ Object
Deprecated and ignored.
-
#has_unit_tests? ⇒ Boolean
(also: #has_test_suite?)
True if this gem has files in test_files.
-
#hash ⇒ Object
:startdoc:.
-
#init_with(coder) ⇒ Object
:nodoc:.
-
#initialize(name = nil, version = nil) {|_self| ... } ⇒ Specification
constructor
Specification constructor.
-
#initialize_copy(other_spec) ⇒ Object
Duplicates array_attributes from
other_spec
so state isn’t shared. -
#inspect ⇒ Object
:nodoc:.
-
#installed_by_version ⇒ Object
The version of RubyGems that installed this gem.
-
#installed_by_version=(version) ⇒ Object
Sets the version of RubyGems that installed this gem.
-
#internal_init ⇒ Object
:nodoc:.
- #keep_only_files_and_directories ⇒ Object
-
#lib_files ⇒ Object
Files in the Gem under one of the require_paths.
-
#license ⇒ Object
Singular accessor for #licenses.
-
#license=(o) ⇒ Object
The license for this gem.
-
#licenses ⇒ Object
Plural accessor for setting licenses.
-
#licenses=(licenses) ⇒ Object
The license(s) for the library.
-
#mark_version ⇒ Object
Sets the rubygems_version to the current RubyGems version.
-
#method_missing(sym, *a, &b) ⇒ Object
Track removed method calls to warn about during build time.
-
#missing_extensions? ⇒ Boolean
Is this specification missing its extensions? When this returns true you probably want to build_extensions.
-
#name_tuple ⇒ Object
Return a NameTuple that represents this Specification.
-
#normalize ⇒ Object
Normalize the list of files so that: * All file lists have redundancies removed.
-
#original_name ⇒ Object
Returns the full name (name-version) of this gemspec using the original platform.
-
#platform ⇒ Object
The platform this gem runs on.
-
#platform=(platform) ⇒ Object
The platform this gem runs on.
-
#pretty_print(q) ⇒ Object
:nodoc:.
-
#raise_if_conflicts ⇒ Object
Check the spec for possible conflicts and freak out if there are any.
-
#raw_require_paths ⇒ Object
:nodoc:.
-
#rdoc_options ⇒ Object
Specifies the rdoc options to be used when generating API documentation.
-
#rdoc_options=(options) ⇒ Object
Sets rdoc_options to
value
, ensuring it is an array. - #removed_method_calls ⇒ Object
-
#require_path ⇒ Object
Singular accessor for #require_paths.
-
#require_path=(path) ⇒ Object
Singular accessor for #require_paths.
-
#require_paths=(val) ⇒ Object
Paths in the gem to add to
$LOAD_PATH
when this gem is activated. -
#requirements ⇒ Object
Lists the external (to RubyGems) requirements that must be met for this gem to work.
-
#requirements=(req) ⇒ Object
Set requirements to
req
, ensuring it is an array. -
#reset_nil_attributes_to_default ⇒ Object
Reset nil attributes to their default values to make the spec valid.
-
#respond_to_missing?(m, include_private = false) ⇒ Boolean
:nodoc:.
-
#ri_dir ⇒ Object
Returns the full path to this spec’s ri directory.
-
#runtime_dependencies ⇒ Object
List of dependencies that will automatically be activated at runtime.
-
#sanitize ⇒ Object
Sanitize the descriptive fields in the spec.
-
#sanitize_string(string) ⇒ Object
Sanitize a single string.
-
#satisfies_requirement?(dependency) ⇒ Boolean
Checks if this specification meets the requirement of
dependency
. -
#sort_obj ⇒ Object
Returns an object you can use to sort specifications in #sort_by.
-
#source ⇒ Object
Used by Gem::Resolver to order Gem::Specification objects.
-
#spec_dir ⇒ Object
Returns the full path to the directory containing this spec’s gemspec file.
-
#spec_file ⇒ Object
Returns the full path to this spec’s gemspec file.
-
#spec_name ⇒ Object
The default name of the gemspec.
- #stubbed? ⇒ Boolean
-
#test_file ⇒ Object
Singular accessor for #test_files.
-
#test_file=(file) ⇒ Object
Singular mutator for #test_files.
-
#test_files ⇒ Object
Test files included in this gem.
-
#test_files=(files) ⇒ Object
A collection of unit test files.
-
#to_ruby ⇒ Object
Returns a Ruby code representation of this specification, such that it can be eval’ed and reconstruct the same specification later.
-
#to_ruby_for_cache ⇒ Object
Returns a Ruby lighter-weight code representation of this specification, used for indexing only.
-
#to_s ⇒ Object
:nodoc:.
-
#to_spec ⇒ Object
Returns self.
-
#to_yaml(opts = {}) ⇒ Object
:nodoc:.
-
#traverse(trail = [], visited = {}, &block) ⇒ Object
Recursively walk dependencies of this spec, executing the
block
for each hop. -
#validate(packaging = true, strict = false) ⇒ Object
Checks that the specification contains all required fields, and does a very basic sanity check.
- #validate_dependencies ⇒ Object
- #validate_metadata ⇒ Object
- #validate_permissions ⇒ Object
-
#yaml_initialize(tag, vals) ⇒ Object
:nodoc:.
Methods included from Deprecate
deprecate, next_rubygems_major_version, rubygems_deprecate, rubygems_deprecate_command, skip, skip=, skip_during
Methods inherited from BasicSpecification
#contains_requirable_file?, #datadir, #default_gem?, default_specifications_dir, #extensions_dir, #full_require_paths, #gem_build_complete_path, #lib_dirs_glob, #matches_for_glob, #plugins, #require_paths, #source_paths, #this, #to_fullpath
Constructor Details
#initialize(name = nil, version = nil) {|_self| ... } ⇒ Specification
Specification constructor. Assigns the default values to the attributes and yields itself for further initialization. Optionally takes name
and version
.
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 |
# File 'lib/rubygems/specification.rb', line 1983 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 and platform != Gem::Platform::RUBY and platform != Gem::Platform.local self.platform = platform end yield self if block_given? end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(sym, *a, &b) ⇒ Object
Track removed method calls to warn about during build time. Warn about unknown attributes while loading a spec.
2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 |
# File 'lib/rubygems/specification.rb', line 2110 def method_missing(sym, *a, &b) # :nodoc: if REMOVED_METHODS.include?(sym) removed_method_calls << sym return end if @specification_version > CURRENT_SPECIFICATION_VERSION and sym.to_s.end_with?("=") warn "ignoring #{sym} loading #{full_name}" if $DEBUG else super end end |
Instance Attribute Details
#activated ⇒ Object Also known as: activated?
True when this gemspec has been activated. This attribute is not persisted.
715 716 717 |
# File 'lib/rubygems/specification.rb', line 715 def activated @activated end |
#autorequire ⇒ Object
Autorequire was used by old RubyGems to automatically require a file.
Deprecated: It is neither supported nor functional.
724 725 726 |
# File 'lib/rubygems/specification.rb', line 724 def autorequire @autorequire end |
#bindir ⇒ Object
The path in the gem for executable scripts. Usually ‘bin’
Usage:
spec.bindir = 'bin'
420 421 422 |
# File 'lib/rubygems/specification.rb', line 420 def bindir @bindir end |
#cert_chain ⇒ Object
The certificate chain used to sign this gem. See Gem::Security for details.
426 427 428 |
# File 'lib/rubygems/specification.rb', line 426 def cert_chain @cert_chain end |
#default_executable ⇒ Object
The default executable for this gem.
Deprecated: The name of the gem is assumed to be the name of the executable now. See Gem.bin_path.
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/rubygems/specification.rb', line 1716 def default_executable # :nodoc: if defined?(@default_executable) and @default_executable result = @default_executable elsif @executables and @executables.size == 1 result = Array(@executables).first else result = nil end result end |
#description ⇒ Object
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
298 299 300 |
# File 'lib/rubygems/specification.rb', line 298 def description @description end |
#email ⇒ Object
A contact email address (or addresses) for this gem
Usage:
spec.email = '[email protected]'
spec.email = ['[email protected]', '[email protected]']
308 309 310 |
# File 'lib/rubygems/specification.rb', line 308 def email @email end |
#homepage ⇒ Object
The URL of this gem’s home page
Usage:
spec.homepage = 'https://github.com/ruby/rake'
317 318 319 |
# File 'lib/rubygems/specification.rb', line 317 def homepage @homepage end |
#metadata ⇒ Object
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}
397 398 399 |
# File 'lib/rubygems/specification.rb', line 397 def @metadata end |
#name ⇒ Object
This gem’s name.
Usage:
spec.name = 'rake'
209 210 211 |
# File 'lib/rubygems/specification.rb', line 209 def name @name end |
#original_platform ⇒ Object
Cruft. Use platform
.
2178 2179 2180 |
# File 'lib/rubygems/specification.rb', line 2178 def original_platform # :nodoc: @original_platform ||= platform end |
#post_install_message ⇒ Object
A message that gets displayed after the gem is installed.
Usage:
spec. = "Thanks for installing!"
435 436 437 |
# File 'lib/rubygems/specification.rb', line 435 def @post_install_message end |
#required_ruby_version ⇒ Object
The version of Ruby required by this gem
518 519 520 |
# File 'lib/rubygems/specification.rb', line 518 def required_ruby_version @required_ruby_version end |
#required_rubygems_version ⇒ Object
The RubyGems version required by this gem
523 524 525 |
# File 'lib/rubygems/specification.rb', line 523 def required_rubygems_version @required_rubygems_version end |
#rubygems_version ⇒ Object
The version of RubyGems used to create this gem.
Do not set this, it is set automatically when the gem is packaged.
530 531 532 |
# File 'lib/rubygems/specification.rb', line 530 def rubygems_version @rubygems_version end |
#signing_key ⇒ Object
The key used to sign this gem. See Gem::Security for details.
535 536 537 |
# File 'lib/rubygems/specification.rb', line 535 def signing_key @signing_key end |
#specification_version ⇒ Object
The Gem::Specification version of this gemspec.
Do not set this, it is set automatically when the gem is packaged.
744 745 746 |
# File 'lib/rubygems/specification.rb', line 744 def specification_version @specification_version end |
#summary ⇒ Object
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"
233 234 235 |
# File 'lib/rubygems/specification.rb', line 233 def summary @summary end |
#version ⇒ Object
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'
222 223 224 |
# File 'lib/rubygems/specification.rb', line 222 def version @version end |
Class Method Details
._all ⇒ Object
:nodoc:
746 747 748 749 750 751 752 753 754 755 756 757 |
# File 'lib/rubygems/specification.rb', line 746 def self._all # :nodoc: unless defined?(@@all) && @@all @@all = stubs.map(&:to_spec) # After a reset, make sure already loaded specs # are still marked as activated. specs = {} Gem.loaded_specs.each_value{|s| specs[s] = true } @@all.each{|s| s.activated = true if specs[s] } end @@all end |
._clear_load_cache ⇒ Object
:nodoc:
759 760 761 762 763 |
# File 'lib/rubygems/specification.rb', line 759 def self._clear_load_cache # :nodoc: LOAD_CACHE_MUTEX.synchronize do LOAD_CACHE.clear end end |
._latest_specs(specs, prerelease = false) ⇒ Object
:nodoc:
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'lib/rubygems/specification.rb', line 1093 def self._latest_specs(specs, prerelease = false) # :nodoc: result = {} specs.reverse_each do |spec| next if spec.version.prerelease? unless prerelease result[spec.name] = spec end result.map(&:last).flatten.sort_by{|tup| tup.name } end |
._load(str) ⇒ Object
Load custom marshal format, re-initializing defaults as needed
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 |
# File 'lib/rubygems/specification.rb', line 1263 def self._load(str) Gem.load_yaml array = Marshal.load str spec = Gem::Specification.new spec.instance_variable_set :@specification_version, array[1] current_version = CURRENT_SPECIFICATION_VERSION field_count = if spec.specification_version > current_version 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 # Cleanup any YAML::PrivateType. They only show up for an old bug # where nil => null, so just convert them to nil based on the type. array.map! {|e| e.kind_of?(YAML::PrivateType) ? nil : e } spec.instance_variable_set :@rubygems_version, array[0] # spec version spec.instance_variable_set :@name, array[2] spec.instance_variable_set :@version, array[3] spec.date = array[4] spec.instance_variable_set :@summary, array[5] spec.instance_variable_set :@required_ruby_version, array[6] spec.instance_variable_set :@required_rubygems_version, array[7] spec.instance_variable_set :@original_platform, array[8] spec.instance_variable_set :@dependencies, array[9] # 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 :@license, array[17] spec.instance_variable_set :@metadata, array[18] spec.instance_variable_set :@loaded, false spec.instance_variable_set :@activated, false spec end |
._resort!(specs) ⇒ Object
:nodoc:
852 853 854 855 856 857 858 859 860 |
# File 'lib/rubygems/specification.rb', line 852 def self._resort!(specs) # :nodoc: specs.sort! do |a, b| names = a.name <=> b.name next names if names.nonzero? versions = b.version <=> a.version next versions if versions.nonzero? b.platform == Gem::Platform::RUBY ? -1 : 1 end end |
.all ⇒ Object
Returns all specifications. This method is discouraged from use. You probably want to use one of the Enumerable methods instead.
877 878 879 880 881 |
# File 'lib/rubygems/specification.rb', line 877 def self.all warn "NOTE: Specification.all called from #{caller.first}" unless Gem::Deprecate.skip _all end |
.all=(specs) ⇒ Object
Sets the known specs to specs
. Not guaranteed to work for you in the future. Use at your own risk. Caveat emptor. Doomy doom doom. Etc etc.
– Makes specs
the known specs Listen, time is a river Winter comes, code breaks
– wilsonb
895 896 897 898 |
# File 'lib/rubygems/specification.rb', line 895 def self.all=(specs) @@stubs_by_name = specs.group_by(&:name) @@all = @@stubs = specs end |
.all_names ⇒ Object
Return full names of all specs in sorted order.
903 904 905 |
# File 'lib/rubygems/specification.rb', line 903 def self.all_names self._all.map(&:full_name) end |
.array_attributes ⇒ Object
Return the list of all array-oriented instance variables. – Not sure why we need to use so much stupid reflection in here…
912 913 914 |
# File 'lib/rubygems/specification.rb', line 912 def self.array_attributes @@array_attributes.dup end |
.attribute_names ⇒ Object
Return the list of all instance variables. – Not sure why we need to use so much stupid reflection in here…
921 922 923 |
# File 'lib/rubygems/specification.rb', line 921 def self.attribute_names @@attributes.dup end |
.default_stubs(pattern = "*.gemspec") ⇒ Object
Returns a Gem::StubSpecification for default gems
817 818 819 820 821 822 823 |
# File 'lib/rubygems/specification.rb', line 817 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 |
.dirs ⇒ Object
Return the directories that Specification uses to find specs.
928 929 930 931 932 |
# File 'lib/rubygems/specification.rb', line 928 def self.dirs @@dirs ||= Gem.path.collect do |dir| File.join dir.dup.tap(&Gem::UNTAINT), "specifications" end end |
.dirs=(dirs) ⇒ Object
Set the directories that Specification uses to find specs. Setting this resets the list of known specs.
938 939 940 941 942 |
# File 'lib/rubygems/specification.rb', line 938 def self.dirs=(dirs) self.reset @@dirs = Array(dirs).map {|dir| File.join dir, "specifications" } end |
.each ⇒ Object
Enumerate every known spec. See ::dirs= and ::add_spec to set the list of specs.
950 951 952 953 954 955 956 |
# File 'lib/rubygems/specification.rb', line 950 def self.each return enum_for(:each) unless block_given? self._all.each do |x| yield x end end |
.each_gemspec(dirs) ⇒ Object
:nodoc:
765 766 767 768 769 770 771 |
# File 'lib/rubygems/specification.rb', line 765 def self.each_gemspec(dirs) # :nodoc: dirs.each do |dir| Gem::Util.glob_files_in_dir("*.gemspec", dir).each do |path| yield path.tap(&Gem::UNTAINT) end end end |
.each_spec(dirs) ⇒ Object
:nodoc:
794 795 796 797 798 799 |
# File 'lib/rubygems/specification.rb', line 794 def self.each_spec(dirs) # :nodoc: each_gemspec(dirs) do |path| spec = self.load path yield spec if spec end end |
.find_active_stub_by_path(path) ⇒ Object
1013 1014 1015 1016 1017 1018 |
# File 'lib/rubygems/specification.rb', line 1013 def self.find_active_stub_by_path(path) stub = @@active_stub_with_requirable_file[path] ||= (stubs.find do |s| s.activated? and s.contains_requirable_file? path end || NOT_FOUND) stub.this end |
.find_all_by_full_name(full_name) ⇒ Object
Returns every spec that has the given full_name
972 973 974 |
# File 'lib/rubygems/specification.rb', line 972 def self.find_all_by_full_name(full_name) stubs.select {|s| s.full_name == full_name }.map(&:to_spec) end |
.find_all_by_name(name, *requirements) ⇒ Object
Returns every spec that matches name
and optional requirements
.
961 962 963 964 965 966 967 |
# File 'lib/rubygems/specification.rb', line 961 def self.find_all_by_name(name, *requirements) requirements = Gem::Requirement.default if requirements.empty? # TODO: maybe try: find_all { |s| spec === dep } Gem::Dependency.new(name, *requirements).matching_specs end |
.find_by_name(name, *requirements) ⇒ Object
Find the best specification matching a name
and requirements
. Raises if the dependency doesn’t resolve to a valid specification.
980 981 982 983 984 985 986 |
# File 'lib/rubygems/specification.rb', line 980 def self.find_by_name(name, *requirements) requirements = Gem::Requirement.default if requirements.empty? # TODO: maybe try: find { |s| spec === dep } Gem::Dependency.new(name, *requirements).to_spec end |
.find_by_path(path) ⇒ Object
Return the best specification that contains the file matching path
.
991 992 993 994 995 996 997 998 |
# File 'lib/rubygems/specification.rb', line 991 def self.find_by_path(path) path = path.dup.freeze spec = @@spec_with_requirable_file[path] ||= (stubs.find do |s| next unless Gem::BundlerVersionFinder.compatible?(s) s.contains_requirable_file? path end || NOT_FOUND) spec.to_spec end |
.find_in_unresolved(path) ⇒ Object
Return currently unresolved specs that contain the file matching path
.
1023 1024 1025 |
# File 'lib/rubygems/specification.rb', line 1023 def self.find_in_unresolved(path) unresolved_specs.find_all {|spec| spec.contains_requirable_file? path } end |
.find_in_unresolved_tree(path) ⇒ Object
Search through all unresolved deps and sub-dependencies and return specs that contain the file matching path
.
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 |
# File 'lib/rubygems/specification.rb', line 1031 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 |
.find_inactive_by_path(path) ⇒ Object
Return the best specification that contains the file matching path
amongst the specs that are not activated.
1004 1005 1006 1007 1008 1009 1010 1011 |
# File 'lib/rubygems/specification.rb', line 1004 def self.find_inactive_by_path(path) stub = stubs.find do |s| next if s.activated? next unless Gem::BundlerVersionFinder.compatible?(s) s.contains_requirable_file? path end stub && stub.to_spec end |
.from_yaml(input) ⇒ Object
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.
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 |
# File 'lib/rubygems/specification.rb', line 1058 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 end |
.latest_spec_for(name) ⇒ Object
Return the latest installed spec for gem name
.
1089 1090 1091 |
# File 'lib/rubygems/specification.rb', line 1089 def self.latest_spec_for(name) latest_specs(true).find {|installed_spec| installed_spec.name == name } end |
.latest_specs(prerelease = false) ⇒ Object
Return the latest specs, optionally including prerelease specs if prerelease
is true.
1082 1083 1084 |
# File 'lib/rubygems/specification.rb', line 1082 def self.latest_specs(prerelease = false) _latest_specs Gem::Specification._all, prerelease end |
.load(file) ⇒ Object
Loads Ruby format gemspec from file
.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 |
# File 'lib/rubygems/specification.rb', line 1108 def self.load(file) return unless file _spec = LOAD_CACHE_MUTEX.synchronize { LOAD_CACHE[file] } return _spec if _spec file = file.dup.tap(&Gem::UNTAINT) return unless File.file?(file) code = File.read file, :mode => 'r:UTF-8:-' code.tap(&Gem::UNTAINT) begin _spec = eval code, binding, file if Gem::Specification === _spec _spec.loaded_from = File. 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, Exception => e warn "Invalid gemspec in [#{file}]: #{e}" end nil end |
.load_defaults ⇒ Object
Loads the default specifications. It should be called only once.
865 866 867 868 869 870 871 |
# File 'lib/rubygems/specification.rb', line 865 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 |
.non_nil_attributes ⇒ Object
Specification attributes that must be non-nil
1150 1151 1152 |
# File 'lib/rubygems/specification.rb', line 1150 def self.non_nil_attributes @@non_nil_attributes.dup end |
.normalize_yaml_input(input) ⇒ Object
Make sure the YAML specification is properly formatted with dashes
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 |
# File 'lib/rubygems/specification.rb', line 1157 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 |
.outdated ⇒ Object
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.
1175 1176 1177 |
# File 'lib/rubygems/specification.rb', line 1175 def self.outdated outdated_and_latest_version.map {|local, _| local.name } end |
.outdated_and_latest_version ⇒ Object
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.
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 |
# File 'lib/rubygems/specification.rb', line 1186 def self.outdated_and_latest_version return enum_for __method__ unless block_given? # TODO: maybe we should switch to rubygems' version service? fetcher = Gem::SpecFetcher.fetcher latest_specs(true).each do |local_spec| dependency = Gem::Dependency.new local_spec.name, ">= #{local_spec.version}" remotes, = fetcher.search_for_dependency dependency remotes = remotes.map {|n, _| n.version } latest_remote = remotes.sort.last yield [local_spec, latest_remote] if latest_remote and local_spec.version < latest_remote end nil end |
.required_attribute?(name) ⇒ Boolean
Is name
a required attribute?
1211 1212 1213 |
# File 'lib/rubygems/specification.rb', line 1211 def self.required_attribute?(name) @@required_attributes.include? name.to_sym end |
.required_attributes ⇒ Object
Required specification attributes
1218 1219 1220 |
# File 'lib/rubygems/specification.rb', line 1218 def self.required_attributes @@required_attributes.dup end |
.reset ⇒ Object
Reset the list of known specs, running pre and post reset hooks registered in Gem.
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 |
# File 'lib/rubygems/specification.rb', line 1226 def self.reset @@dirs = nil Gem.pre_reset_hooks.each {|hook| hook.call } @@all = nil @@stubs = nil @@stubs_by_name = {} @@spec_with_requirable_file = {} @@active_stub_with_requirable_file = {} _clear_load_cache unresolved = unresolved_deps unless unresolved.empty? w = "W" + "ARN" warn "#{w}: Unresolved or ambiguous specs during Gem::Specification.reset:" unresolved.values.each do |dep| warn " #{dep}" versions = find_all_by_name(dep.name) unless versions.empty? warn " Available/installed versions of this gem:" versions.each {|s| warn " - #{s.version}" } end end warn "#{w}: Clearing out unresolved specs. Try 'gem cleanup <gem>'" warn "Please report a bug if this causes problems." unresolved.clear end Gem.post_reset_hooks.each {|hook| hook.call } end |
.stubs ⇒ Object
Returns a Gem::StubSpecification for every installed gem
804 805 806 807 808 809 810 811 812 |
# File 'lib/rubygems/specification.rb', line 804 def self.stubs @@stubs ||= begin pattern = "*.gemspec" stubs = stubs_for_pattern(pattern, false) @@stubs_by_name = stubs.select {|s| Gem::Platform.match_spec? s }.group_by(&:name) stubs end end |
.stubs_for(name) ⇒ Object
Returns a Gem::StubSpecification for installed gem named name
only returns stubs that match Gem.platforms
829 830 831 832 833 834 835 836 837 |
# File 'lib/rubygems/specification.rb', line 829 def self.stubs_for(name) if @@stubs @@stubs_by_name[name] || [] else @@stubs_by_name[name] ||= stubs_for_pattern("#{name}-*.gemspec").select do |s| s.name == name end end end |
.stubs_for_pattern(pattern, match_platform = true) ⇒ Object
Finds stub specifications matching a pattern from the standard locations, optionally filtering out specs not matching the current platform
843 844 845 846 847 848 849 850 |
# File 'lib/rubygems/specification.rb', line 843 def self.stubs_for_pattern(pattern, match_platform = true) # :nodoc: installed_stubs = installed_stubs(Gem::Specification.dirs, pattern) installed_stubs.select! {|s| Gem::Platform.match_spec? s } if match_platform stubs = installed_stubs + default_stubs(pattern) stubs = stubs.uniq {|stub| stub.full_name } _resort!(stubs) stubs end |
.unresolved_deps ⇒ Object
DOC: This method needs documented or nodoc’d
1256 1257 1258 |
# File 'lib/rubygems/specification.rb', line 1256 def self.unresolved_deps @unresolved_deps ||= Hash.new {|h, n| h[n] = Gem::Dependency.new n } end |
Instance Method Details
#<=>(other) ⇒ Object
:nodoc:
1316 1317 1318 |
# File 'lib/rubygems/specification.rb', line 1316 def <=>(other) # :nodoc: sort_obj <=> other.sort_obj end |
#==(other) ⇒ Object
:nodoc:
1320 1321 1322 1323 1324 1325 |
# File 'lib/rubygems/specification.rb', line 1320 def ==(other) # :nodoc: self.class === other && name == other.name && version == other.version && platform == other.platform end |
#_dump(limit) ⇒ Object
Dump only crucial instance variables. – MAINTAIN ORDER! (down with the man)
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 |
# File 'lib/rubygems/specification.rb', line 1333 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 ⇒ Object
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.
1424 1425 1426 1427 1428 1429 1430 |
# File 'lib/rubygems/specification.rb', line 1424 def abbreviate self.files = [] self.test_files = [] self. = [] self.extra_rdoc_files = [] self.cert_chain = [] end |
#activate ⇒ Object
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.
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 |
# File 'lib/rubygems/specification.rb', line 1363 def activate other = Gem.loaded_specs[self.name] if other check_version_conflict other return false end raise_if_conflicts activate_dependencies add_self_to_load_path Gem.loaded_specs[self.name] = self @activated = true @loaded = true return true end |
#activate_dependencies ⇒ Object
Activate all unambiguously resolved runtime dependencies of this spec. Add any ambiguous dependencies to the unresolved list to be resolved later, as needed.
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 |
# File 'lib/rubygems/specification.rb', line 1387 def activate_dependencies unresolved = Gem::Specification.unresolved_deps self.runtime_dependencies.each do |spec_dep| if loaded = Gem.loaded_specs[spec_dep.name] next if spec_dep.matches_spec? loaded msg = "can't satisfy '#{spec_dep}', already activated '#{loaded.full_name}'" e = Gem::LoadError.new msg e.name = spec_dep.name raise e end begin specs = spec_dep.to_specs rescue Gem::MissingSpecError => e raise Gem::MissingSpecError.new(e.name, e.requirement, "at: #{self.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 |
#add_bindir(executables) ⇒ Object
Returns an array with bindir attached to each executable in the executables
list
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 |
# File 'lib/rubygems/specification.rb', line 1460 def add_bindir(executables) return nil if executables.nil? if @bindir Array(executables).map {|e| File.join(@bindir, e) } else executables end rescue return nil end |
#add_development_dependency(gem, *requirements) ⇒ Object
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.
548 549 550 |
# File 'lib/rubygems/specification.rb', line 548 def add_development_dependency(gem, *requirements) add_dependency_with_type(gem, :development, requirements) end |
#add_runtime_dependency(gem, *requirements) ⇒ Object Also known as: add_dependency
Adds a runtime dependency named gem
with requirements
to this gem.
Usage:
spec.add_runtime_dependency 'example', '~> 1.1', '>= 1.1.4'
559 560 561 562 563 564 565 |
# File 'lib/rubygems/specification.rb', line 559 def add_runtime_dependency(gem, *requirements) if requirements.uniq.size != requirements.size warn "WARNING: duplicated #{gem} dependency #{requirements}" end add_dependency_with_type(gem, :runtime, requirements) end |
#add_self_to_load_path ⇒ Object
Adds this spec’s require paths to LOAD_PATH, in the proper location.
1499 1500 1501 1502 1503 1504 1505 |
# File 'lib/rubygems/specification.rb', line 1499 def add_self_to_load_path return if default_gem? paths = full_require_paths Gem.add_to_load_path(*paths) end |
#author ⇒ Object
Singular reader for #authors. Returns the first author in the list
1510 1511 1512 |
# File 'lib/rubygems/specification.rb', line 1510 def val = and val.first end |
#author=(o) ⇒ Object
Singular (alternative) writer for #authors
Usage:
spec. = 'John Jones'
409 410 411 |
# File 'lib/rubygems/specification.rb', line 409 def (o) self. = [o] end |
#authors ⇒ Object
The list of author names who wrote this gem.
spec. = ['Chad Fowler', 'Jim Weirich', 'Rich Kilmer']
1519 1520 1521 |
# File 'lib/rubygems/specification.rb', line 1519 def @authors ||= [] end |
#authors=(value) ⇒ Object
A list of authors for this gem.
Alternatively, a single author can be specified by assigning a string to ‘spec.author`
Usage:
spec. = ['John Jones', 'Mary Smith']
277 278 279 |
# File 'lib/rubygems/specification.rb', line 277 def (value) @authors = Array(value).flatten.grep(String) end |
#base_dir ⇒ Object
2033 2034 2035 2036 2037 2038 2039 2040 |
# File 'lib/rubygems/specification.rb', line 2033 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 |
#bin_dir ⇒ Object
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.
1529 1530 1531 |
# File 'lib/rubygems/specification.rb', line 1529 def bin_dir @bin_dir ||= File.join gem_dir, bindir end |
#bin_file(name) ⇒ Object
Returns the full path to an executable named name
in this gem.
1536 1537 1538 |
# File 'lib/rubygems/specification.rb', line 1536 def bin_file(name) File.join bin_dir, name end |
#build_args ⇒ Object
Returns the build_args used to install the gem
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 |
# File 'lib/rubygems/specification.rb', line 1543 def build_args if File.exist? build_info_file build_info = File.readlines build_info_file build_info = build_info.map {|x| x.strip } build_info.delete "" build_info else [] end end |
#build_extensions ⇒ Object
Builds extensions for this platform if the gem has extensions listed and the gem.build_complete file is missing.
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/rubygems/specification.rb', line 1558 def build_extensions # :nodoc: return if default_gem? return if extensions.empty? return if File.exist? gem_build_complete_path return if !File.writable?(base_dir) return if !File.exist?(File.join(base_dir, 'extensions')) begin # We need to require things in $LOAD_PATH without looking for the # extension we are about to build. unresolved_deps = Gem::Specification.unresolved_deps.dup Gem::Specification.unresolved_deps.clear require 'rubygems/config_file' require 'rubygems/ext' require 'rubygems/user_interaction' ui = Gem::SilentUI.new Gem::DefaultUserInteraction.use_ui ui do builder = Gem::Ext::Builder.new self builder.build_extensions end ensure ui.close if ui Gem::Specification.unresolved_deps.replace unresolved_deps end end |
#build_info_dir ⇒ Object
Returns the full path to the build info directory
1589 1590 1591 |
# File 'lib/rubygems/specification.rb', line 1589 def build_info_dir File.join base_dir, "build_info" end |
#build_info_file ⇒ Object
Returns the full path to the file containing the build information generated when the gem was installed
1597 1598 1599 |
# File 'lib/rubygems/specification.rb', line 1597 def build_info_file File.join build_info_dir, "#{full_name}.info" end |
#cache_dir ⇒ Object
Returns the full path to the cache directory containing this spec’s cached gem.
1605 1606 1607 |
# File 'lib/rubygems/specification.rb', line 1605 def cache_dir @cache_dir ||= File.join base_dir, "cache" end |
#cache_file ⇒ Object
Returns the full path to the cached gem for this spec.
1612 1613 1614 |
# File 'lib/rubygems/specification.rb', line 1612 def cache_file @cache_file ||= File.join cache_dir, "#{full_name}.gem" end |
#conficts_when_loaded_with?(list_of_specs) ⇒ Boolean
return true if there will be conflict when spec if loaded together with the list of specs.
1635 1636 1637 1638 1639 1640 |
# File 'lib/rubygems/specification.rb', line 1635 def conficts_when_loaded_with?(list_of_specs) # :nodoc: result = list_of_specs.any? do |spec| spec.dependencies.any? {|dep| dep.runtime? && (dep.name == name) && !satisfies_requirement?(dep) } end result end |
#conflicts ⇒ Object
Return any possible conflicts against the currently loaded specs.
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 |
# File 'lib/rubygems/specification.rb', line 1619 def conflicts conflicts = {} self.runtime_dependencies.each do |dep| spec = Gem.loaded_specs[dep.name] if spec and not 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 |
#date ⇒ Object
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/
1665 1666 1667 |
# File 'lib/rubygems/specification.rb', line 1665 def date @date ||= Time.utc(*Gem.source_date_epoch.utc.to_a[3..5].reverse) end |
#date=(date) ⇒ Object
The date this gem was created
DO NOT set this, it is set automatically when the gem is packaged.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/rubygems/specification.rb', line 1685 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) # Workaround for where the date format output from psych isn't # parsed as a Time object by syck and thus comes through as a # string. elsif /\A(\d{4})-(\d{2})-(\d{2}) \d{2}:\d{2}:\d{2}\.\d+?Z\z/ =~ date 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 |
#default_value(name) ⇒ Object
The default value for specification attribute name
1731 1732 1733 |
# File 'lib/rubygems/specification.rb', line 1731 def default_value(name) @@default_value[name] end |
#dependencies ⇒ Object
A list of Gem::Dependency objects this gem depends on.
Use #add_dependency or #add_development_dependency to add dependencies to a gem.
1741 1742 1743 |
# File 'lib/rubygems/specification.rb', line 1741 def dependencies @dependencies ||= [] end |
#dependent_gems(check_dev = true) ⇒ Object
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]]
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 |
# File 'lib/rubygems/specification.rb', line 1751 def dependent_gems(check_dev=true) out = [] Gem::Specification.each do |spec| deps = check_dev ? spec.dependencies : spec.runtime_dependencies deps.each do |dep| if self.satisfies_requirement?(dep) sats = [] find_all_satisfiers(dep) do |sat| sats << sat end out << [spec, dep, sats] end end end out end |
#dependent_specs ⇒ Object
Returns all specs that matches this spec’s runtime dependencies.
1771 1772 1773 |
# File 'lib/rubygems/specification.rb', line 1771 def dependent_specs runtime_dependencies.map {|dep| dep.to_specs }.flatten end |
#development_dependencies ⇒ Object
List of dependencies that are used for development
1785 1786 1787 |
# File 'lib/rubygems/specification.rb', line 1785 def development_dependencies dependencies.select {|d| d.type == :development } end |
#doc_dir(type = nil) ⇒ Object
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"
1797 1798 1799 1800 1801 1802 1803 1804 1805 |
# File 'lib/rubygems/specification.rb', line 1797 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 |
#encode_with(coder) ⇒ Object
:nodoc:
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 |
# File 'lib/rubygems/specification.rb', line 1807 def encode_with(coder) # :nodoc: mark_version coder.add 'name', @name coder.add 'version', @version platform = case @original_platform when nil, '' then 'ruby' when String then @original_platform else @original_platform.to_s end coder.add 'platform', platform attributes = @@attributes.map(&:to_s) - %w[name version platform] attributes.each do |name| coder.add name, instance_variable_get("@#{name}") end end |
#eql?(other) ⇒ Boolean
:nodoc:
1828 1829 1830 |
# File 'lib/rubygems/specification.rb', line 1828 def eql?(other) # :nodoc: self.class === other && same_attributes?(other) end |
#executable ⇒ Object
Singular accessor for #executables
1835 1836 1837 |
# File 'lib/rubygems/specification.rb', line 1835 def executable val = executables and val.first end |
#executable=(o) ⇒ Object
Singular accessor for #executables
1842 1843 1844 |
# File 'lib/rubygems/specification.rb', line 1842 def executable=(o) self.executables = [o] end |
#executables ⇒ Object
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'
582 583 584 |
# File 'lib/rubygems/specification.rb', line 582 def executables @executables ||= [] end |
#executables=(value) ⇒ Object
Sets executables to value
, ensuring it is an array.
1849 1850 1851 |
# File 'lib/rubygems/specification.rb', line 1849 def executables=(value) @executables = Array(value) end |
#extensions ⇒ Object
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.
599 600 601 |
# File 'lib/rubygems/specification.rb', line 599 def extensions @extensions ||= [] end |
#extensions=(extensions) ⇒ Object
Sets extensions to extensions
, ensuring it is an array.
1856 1857 1858 |
# File 'lib/rubygems/specification.rb', line 1856 def extensions=(extensions) @extensions = Array extensions end |
#extra_rdoc_files ⇒ Object
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']
615 616 617 |
# File 'lib/rubygems/specification.rb', line 615 def extra_rdoc_files @extra_rdoc_files ||= [] end |
#extra_rdoc_files=(files) ⇒ Object
Sets extra_rdoc_files to files
, ensuring it is an array.
1863 1864 1865 |
# File 'lib/rubygems/specification.rb', line 1863 def extra_rdoc_files=(files) @extra_rdoc_files = Array files end |
#file_name ⇒ Object
The default (generated) file name of the gem. See also #spec_name.
spec.file_name # => "example-1.0.gem"
1872 1873 1874 |
# File 'lib/rubygems/specification.rb', line 1872 def file_name "#{full_name}.gem" end |
#files ⇒ Object
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" }
256 257 258 259 260 261 262 263 264 265 |
# 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=(files) ⇒ Object
Sets files to files
, ensuring it is an array.
1879 1880 1881 |
# File 'lib/rubygems/specification.rb', line 1879 def files=(files) @files = Array files end |
#for_cache ⇒ Object
Creates a duplicate spec without large blobs that aren’t used at runtime.
1897 1898 1899 1900 1901 1902 1903 1904 |
# File 'lib/rubygems/specification.rb', line 1897 def for_cache spec = dup spec.files = nil spec.test_files = nil spec end |
#full_name ⇒ Object
1906 1907 1908 |
# File 'lib/rubygems/specification.rb', line 1906 def full_name @full_name ||= super end |
#gem_dir ⇒ Object
Work around bundler removing my methods
1913 1914 1915 |
# File 'lib/rubygems/specification.rb', line 1913 def gem_dir # :nodoc: super end |
#gems_dir ⇒ Object
1917 1918 1919 |
# File 'lib/rubygems/specification.rb', line 1917 def gems_dir @gems_dir ||= File.join(base_dir, "gems") end |
#has_conflicts? ⇒ Boolean
Return true if there are possible conflicts against the currently loaded specs.
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 |
# File 'lib/rubygems/specification.rb', line 1645 def has_conflicts? return true unless Gem.env_requirement(name).satisfied_by?(version) self.dependencies.any? do |dep| if dep.runtime? spec = Gem.loaded_specs[dep.name] spec and not spec.satisfies_requirement? dep else false end end end |
#has_rdoc ⇒ Object Also known as: has_rdoc?
Deprecated and ignored, defaults to true.
Formerly used to indicate this gem was RDoc-capable.
1926 1927 1928 |
# File 'lib/rubygems/specification.rb', line 1926 def has_rdoc # :nodoc: true end |
#has_rdoc=(ignored) ⇒ Object
Deprecated and ignored.
Formerly used to indicate this gem was RDoc-capable.
1936 1937 1938 |
# File 'lib/rubygems/specification.rb', line 1936 def has_rdoc=(ignored) # :nodoc: @has_rdoc = true end |
#has_unit_tests? ⇒ Boolean Also known as: has_test_suite?
True if this gem has files in test_files
1947 1948 1949 |
# File 'lib/rubygems/specification.rb', line 1947 def has_unit_tests? # :nodoc: not test_files.empty? end |
#hash ⇒ Object
:startdoc:
1955 1956 1957 |
# File 'lib/rubygems/specification.rb', line 1955 def hash # :nodoc: name.hash ^ version.hash end |
#init_with(coder) ⇒ Object
:nodoc:
1959 1960 1961 1962 |
# File 'lib/rubygems/specification.rb', line 1959 def init_with(coder) # :nodoc: @installed_by_version ||= nil yaml_initialize coder.tag, coder.map end |
#initialize_copy(other_spec) ⇒ Object
Duplicates array_attributes from other_spec
so state isn’t shared.
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 |
# File 'lib/rubygems/specification.rb', line 2011 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 end |
#inspect ⇒ Object
:nodoc:
2053 2054 2055 2056 2057 2058 2059 |
# File 'lib/rubygems/specification.rb', line 2053 def inspect # :nodoc: if $DEBUG super else "#{super[0..-2]} #{full_name}>" end end |
#installed_by_version ⇒ Object
The version of RubyGems that installed this gem. Returns Gem::Version.new(0)
for gems installed by versions earlier than RubyGems 2.2.0.
624 625 626 |
# File 'lib/rubygems/specification.rb', line 624 def installed_by_version # :nodoc: @installed_by_version ||= Gem::Version.new(0) end |
#installed_by_version=(version) ⇒ Object
Sets the version of RubyGems that installed this gem. See also #installed_by_version.
632 633 634 |
# File 'lib/rubygems/specification.rb', line 632 def installed_by_version=(version) # :nodoc: @installed_by_version = Gem::Version.new version end |
#internal_init ⇒ Object
:nodoc:
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 |
# File 'lib/rubygems/specification.rb', line 2088 def internal_init # :nodoc: super @bin_dir = nil @cache_dir = nil @cache_file = nil @doc_dir = nil @ri_dir = nil @spec_dir = nil @spec_file = nil end |
#keep_only_files_and_directories ⇒ Object
2595 2596 2597 2598 2599 2600 2601 |
# File 'lib/rubygems/specification.rb', line 2595 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 |
#lib_files ⇒ Object
Files in the Gem under one of the require_paths
2064 2065 2066 2067 2068 2069 2070 |
# File 'lib/rubygems/specification.rb', line 2064 def lib_files @files.select do |file| require_paths.any? do |path| file.start_with? path end end end |
#license ⇒ Object
Singular accessor for #licenses
2075 2076 2077 |
# File 'lib/rubygems/specification.rb', line 2075 def license licenses.first end |
#license=(o) ⇒ Object
The license for this gem.
The license must be no more than 64 characters.
This should just be the name of your license. The full text of the license should be inside of the gem (at the top level) when you build it.
The simplest way, is to specify the standard SPDX ID spdx.org/licenses/ for the license. Ideally you should pick one that is OSI (Open Source Initiative) opensource.org/licenses/alphabetical approved.
The most commonly used OSI approved licenses are MIT and Apache-2.0. GitHub also provides a license picker at choosealicense.com/.
You should specify a license for your gem so that people know how they are permitted to use it, and any restrictions you’re placing on it. Not specifying a license means all rights are reserved; others have no rights to use the code for any purpose.
You can set multiple licenses with #licenses=
Usage:
spec.license = 'MIT'
345 346 347 |
# File 'lib/rubygems/specification.rb', line 345 def license=(o) self.licenses = [o] end |
#licenses ⇒ Object
Plural accessor for setting licenses
See #license= for details
2084 2085 2086 |
# File 'lib/rubygems/specification.rb', line 2084 def licenses @licenses ||= [] end |
#licenses=(licenses) ⇒ Object
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']
362 363 364 |
# File 'lib/rubygems/specification.rb', line 362 def licenses=(licenses) @licenses = Array licenses end |
#mark_version ⇒ Object
Sets the rubygems_version to the current RubyGems version.
2102 2103 2104 |
# File 'lib/rubygems/specification.rb', line 2102 def mark_version @rubygems_version = Gem::VERSION end |
#missing_extensions? ⇒ Boolean
Is this specification missing its extensions? When this returns true you probably want to build_extensions
2128 2129 2130 2131 2132 2133 2134 |
# File 'lib/rubygems/specification.rb', line 2128 def missing_extensions? return false if default_gem? return false if extensions.empty? return false if File.exist? gem_build_complete_path true end |
#name_tuple ⇒ Object
Return a NameTuple that represents this Specification
2159 2160 2161 |
# File 'lib/rubygems/specification.rb', line 2159 def name_tuple Gem::NameTuple.new name, version, original_platform end |
#normalize ⇒ Object
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.
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 |
# File 'lib/rubygems/specification.rb', line 2142 def normalize if defined?(@extra_rdoc_files) and @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 |
#original_name ⇒ Object
Returns the full name (name-version) of this gemspec using the original platform. For use with legacy gems.
2167 2168 2169 2170 2171 2172 2173 |
# File 'lib/rubygems/specification.rb', line 2167 def original_name # :nodoc: if platform == Gem::Platform::RUBY or platform.nil? "#{@name}-#{@version}" else "#{@name}-#{@version}-#{@original_platform}" end end |
#platform ⇒ Object
The platform this gem runs on. See Gem::Platform for details.
2185 2186 2187 |
# File 'lib/rubygems/specification.rb', line 2185 def platform @new_platform ||= Gem::Platform::RUBY end |
#platform=(platform) ⇒ Object
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
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/rubygems/specification.rb', line 460 def platform=(platform) if @original_platform.nil? or @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 @new_platform end |
#pretty_print(q) ⇒ Object
:nodoc:
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 |
# File 'lib/rubygems/specification.rb', line 2189 def pretty_print(q) # :nodoc: q.group 2, 'Gem::Specification.new do |s|', 'end' do q.breakable attributes = @@attributes - [:name, :version] attributes.unshift :installed_by_version attributes.unshift :version attributes.unshift :name attributes.each do |attr_name| current_value = self.send attr_name current_value = current_value.sort if %i[files test_files].include? attr_name if current_value != default_value(attr_name) or self.class.required_attribute? attr_name q.text "s.#{attr_name} = " if attr_name == :date current_value = current_value.utc q.text "Time.utc(#{current_value.year}, #{current_value.month}, #{current_value.day})" else q.pp current_value end q.breakable end end end end |
#raise_if_conflicts ⇒ Object
Check the spec for possible conflicts and freak out if there are any.
2243 2244 2245 2246 2247 |
# File 'lib/rubygems/specification.rb', line 2243 def raise_if_conflicts # :nodoc: if has_conflicts? raise Gem::ConflictError.new self, conflicts end end |
#raw_require_paths ⇒ Object
:nodoc:
2676 2677 2678 |
# File 'lib/rubygems/specification.rb', line 2676 def raw_require_paths # :nodoc: @require_paths end |
#rdoc_options ⇒ Object
Specifies the rdoc options to be used when generating API documentation.
Usage:
spec. << '--title' << 'Rake -- Ruby Make' <<
'--main' << 'README' <<
'--line-numbers'
645 646 647 |
# File 'lib/rubygems/specification.rb', line 645 def @rdoc_options ||= [] end |
#rdoc_options=(options) ⇒ Object
Sets rdoc_options to value
, ensuring it is an array.
2252 2253 2254 |
# File 'lib/rubygems/specification.rb', line 2252 def () @rdoc_options = Array end |
#removed_method_calls ⇒ Object
195 196 197 |
# File 'lib/rubygems/specification.rb', line 195 def removed_method_calls @removed_method_calls ||= [] end |
#require_path ⇒ Object
Singular accessor for #require_paths
2259 2260 2261 |
# File 'lib/rubygems/specification.rb', line 2259 def require_path val = require_paths and val.first end |
#require_path=(path) ⇒ Object
Singular accessor for #require_paths
2266 2267 2268 |
# File 'lib/rubygems/specification.rb', line 2266 def require_path=(path) self.require_paths = Array(path) end |
#require_paths=(val) ⇒ Object
Paths in the gem to add to $LOAD_PATH
when this gem is activated. – See also #require_paths ++ 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 = ['.']
511 512 513 |
# File 'lib/rubygems/specification.rb', line 511 def require_paths=(val) @require_paths = Array(val) end |
#requirements ⇒ Object
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'
693 694 695 |
# File 'lib/rubygems/specification.rb', line 693 def requirements @requirements ||= [] end |
#requirements=(req) ⇒ Object
Set requirements to req
, ensuring it is an array.
2273 2274 2275 |
# File 'lib/rubygems/specification.rb', line 2273 def requirements=(req) @requirements = Array req end |
#reset_nil_attributes_to_default ⇒ Object
Reset nil attributes to their default values to make the spec valid
2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 |
# File 'lib/rubygems/specification.rb', line 2657 def reset_nil_attributes_to_default nil_attributes = self.class.non_nil_attributes.find_all do |name| !instance_variable_defined?("@#{name}") || instance_variable_get("@#{name}").nil? end nil_attributes.each do |attribute| default = self.default_value attribute value = case default when Time, Numeric, Symbol, true, false, nil then default else default.dup end instance_variable_set "@#{attribute}", value end @installed_by_version ||= nil end |
#respond_to_missing?(m, include_private = false) ⇒ Boolean
:nodoc:
2277 2278 2279 |
# File 'lib/rubygems/specification.rb', line 2277 def respond_to_missing?(m, include_private = false) # :nodoc: false end |
#ri_dir ⇒ Object
Returns the full path to this spec’s ri directory.
2284 2285 2286 |
# File 'lib/rubygems/specification.rb', line 2284 def ri_dir @ri_dir ||= File.join base_dir, 'ri', full_name end |
#runtime_dependencies ⇒ Object
List of dependencies that will automatically be activated at runtime.
2317 2318 2319 |
# File 'lib/rubygems/specification.rb', line 2317 def runtime_dependencies dependencies.select(&:runtime?) end |
#sanitize ⇒ Object
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.
1437 1438 1439 1440 1441 1442 |
# File 'lib/rubygems/specification.rb', line 1437 def sanitize self.summary = sanitize_string(summary) self.description = sanitize_string(description) self. = sanitize_string() self. = .collect {|a| sanitize_string(a) } end |
#sanitize_string(string) ⇒ Object
Sanitize a single string.
1447 1448 1449 1450 1451 1452 1453 1454 |
# File 'lib/rubygems/specification.rb', line 1447 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 |
#satisfies_requirement?(dependency) ⇒ Boolean
Checks if this specification meets the requirement of dependency
.
2333 2334 2335 2336 |
# File 'lib/rubygems/specification.rb', line 2333 def satisfies_requirement?(dependency) return @name == dependency.name && dependency.requirement.satisfied_by?(@version) end |
#sort_obj ⇒ Object
Returns an object you can use to sort specifications in #sort_by.
2341 2342 2343 |
# File 'lib/rubygems/specification.rb', line 2341 def sort_obj [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1] end |
#source ⇒ Object
Used by Gem::Resolver to order Gem::Specification objects
2348 2349 2350 |
# File 'lib/rubygems/specification.rb', line 2348 def source # :nodoc: Gem::Source::Installed.new end |
#spec_dir ⇒ Object
Returns the full path to the directory containing this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications
2356 2357 2358 |
# File 'lib/rubygems/specification.rb', line 2356 def spec_dir @spec_dir ||= File.join base_dir, "specifications" end |
#spec_file ⇒ Object
Returns the full path to this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications/mygem-1.0.gemspec
2364 2365 2366 |
# File 'lib/rubygems/specification.rb', line 2364 def spec_file @spec_file ||= File.join spec_dir, "#{full_name}.gemspec" end |
#spec_name ⇒ Object
The default name of the gemspec. See also #file_name
spec.spec_name # => "example-1.0.gemspec"
2373 2374 2375 |
# File 'lib/rubygems/specification.rb', line 2373 def spec_name "#{full_name}.gemspec" end |
#stubbed? ⇒ Boolean
2635 2636 2637 |
# File 'lib/rubygems/specification.rb', line 2635 def stubbed? false end |
#test_file ⇒ Object
Singular accessor for #test_files
2388 2389 2390 |
# File 'lib/rubygems/specification.rb', line 2388 def test_file # :nodoc: val = test_files and val.first end |
#test_file=(file) ⇒ Object
Singular mutator for #test_files
2395 2396 2397 |
# File 'lib/rubygems/specification.rb', line 2395 def test_file=(file) # :nodoc: self.test_files = [file] end |
#test_files ⇒ Object
Test files included in this gem. You cannot append to this accessor, you must assign to it.
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 |
# File 'lib/rubygems/specification.rb', line 2403 def test_files # :nodoc: # Handle the possibility that we have @test_suite_file but not # @test_files. This will happen when an old gem is loaded via # YAML. if defined? @test_suite_file @test_files = [@test_suite_file].flatten @test_suite_file = nil end if defined?(@test_files) and @test_files @test_files else @test_files = [] end end |
#test_files=(files) ⇒ Object
A collection of unit test files. They will be loaded as unit tests when the user requests a gem to be unit tested.
Usage:
spec.test_files = Dir.glob('test/tc_*.rb')
spec.test_files = ['tests/test-suite.rb']
705 706 707 |
# File 'lib/rubygems/specification.rb', line 705 def test_files=(files) # :nodoc: @test_files = Array files end |
#to_ruby ⇒ Object
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.
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 |
# File 'lib/rubygems/specification.rb', line 2423 def to_ruby mark_version result = [] result << "# -*- encoding: utf-8 -*-" result << "#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{raw_require_paths.join("\0")}" result << "#{Gem::StubSpecification::PREFIX}#{extensions.join "\0"}" unless extensions.empty? result << nil result << "Gem::Specification.new do |s|" result << " s.name = #{ruby_code name}" result << " s.version = #{ruby_code version}" unless platform.nil? or platform == Gem::Platform::RUBY 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 and !.empty? result << " s.metadata = #{ruby_code } 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 = self.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 = #{signing_key.dump}.freeze" end if @installed_by_version result << nil result << " s.installed_by_version = \"#{Gem::VERSION}\" if s.respond_to? :installed_by_version" end unless dependencies.empty? result << nil result << " if s.respond_to? :specification_version then" result << " s.specification_version = #{specification_version}" result << " end" result << nil result << " if s.respond_to? :add_runtime_dependency then" dependencies.each do |dep| req = dep.requirements_list.inspect dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>.freeze, #{req})" end result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})" end result << " end" end result << "end" result << nil result.join "\n" end |
#to_ruby_for_cache ⇒ Object
Returns a Ruby lighter-weight code representation of this specification, used for indexing only.
See #to_ruby.
2512 2513 2514 |
# File 'lib/rubygems/specification.rb', line 2512 def to_ruby_for_cache for_cache.to_ruby end |
#to_s ⇒ Object
:nodoc:
2516 2517 2518 |
# File 'lib/rubygems/specification.rb', line 2516 def to_s # :nodoc: "#<Gem::Specification name=#{@name} version=#{@version}>" end |
#to_spec ⇒ Object
Returns self
2523 2524 2525 |
# File 'lib/rubygems/specification.rb', line 2523 def to_spec self end |
#to_yaml(opts = {}) ⇒ Object
:nodoc:
2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 |
# File 'lib/rubygems/specification.rb', line 2527 def to_yaml(opts = {}) # :nodoc: Gem.load_yaml # Because the user can switch the YAML engine behind our # back, we have to check again here to make sure that our # psych code was properly loaded, and load it if not. unless Gem.const_defined?(:NoAliasYAMLTree) require 'rubygems/psych_tree' end builder = Gem::NoAliasYAMLTree.create builder << self ast = builder.tree require 'stringio' io = StringIO.new io.set_encoding Encoding::UTF_8 Psych::Visitors::Emitter.new(io).accept(ast) io.string.gsub(/ !!null \n/, " \n") end |
#traverse(trail = [], visited = {}, &block) ⇒ Object
Recursively walk dependencies of this spec, executing the block
for each hop.
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 |
# File 'lib/rubygems/specification.rb', line 2554 def traverse(trail = [], visited = {}, &block) trail.push(self) begin dependencies.each do |dep| next unless dep.runtime? dep.matching_specs(true).each do |dep_spec| next if visited.has_key?(dep_spec) visited[dep_spec] = true trail.push(dep_spec) begin result = block[self, dep, dep_spec, trail] ensure trail.pop end unless result == :next spec_name = dep_spec.name dep_spec.traverse(trail, visited, &block) unless trail.any? {|s| s.name == spec_name } end end end ensure trail.pop end end |
#validate(packaging = true, strict = false) ⇒ Object
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..
2587 2588 2589 2590 2591 2592 2593 |
# File 'lib/rubygems/specification.rb', line 2587 def validate(packaging = true, strict = false) normalize validation_policy = Gem::SpecificationPolicy.new(self) validation_policy.packaging = packaging validation_policy.validate(strict) end |
#validate_dependencies ⇒ Object
2608 2609 2610 |
# File 'lib/rubygems/specification.rb', line 2608 def validate_dependencies Gem::SpecificationPolicy.new(self).validate_dependencies end |
#validate_metadata ⇒ Object
2603 2604 2605 |
# File 'lib/rubygems/specification.rb', line 2603 def Gem::SpecificationPolicy.new(self). end |
#validate_permissions ⇒ Object
2613 2614 2615 |
# File 'lib/rubygems/specification.rb', line 2613 def Gem::SpecificationPolicy.new(self). end |
#yaml_initialize(tag, vals) ⇒ Object
:nodoc:
2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 |
# File 'lib/rubygems/specification.rb', line 2639 def yaml_initialize(tag, vals) # :nodoc: vals.each do |ivar, val| case ivar when "date" # Force Date to go through the extra coerce logic in date= self.date = val.tap(&Gem::UNTAINT) else instance_variable_set "@#{ivar}", val.tap(&Gem::UNTAINT) end end @original_platform = @platform # for backwards compatibility self.platform = Gem::Platform.new @platform end |