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'
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
– 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.' ] }
- MARSHAL_FIELDS =
:nodoc:
{ # :nodoc: -1 => 16, 1 => 16, 2 => 16, 3 => 17, 4 => 18, }
- TODAY =
:nodoc:
Time.utc(today.year, today.month, today.day)
- Dupable =
:nodoc:
{ }
- NOT_FOUND =
Sentinel object to represent “not found” stubs
Struct.new(:to_spec, :this).new
- EMPTY =
:nodoc:
[].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
- @@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 => TODAY, :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 => [], :rubyforge_project => nil, :rubygems_version => Gem::VERSION, :signing_key => nil, :specification_version => CURRENT_SPECIFICATION_VERSION, :summary => nil, :test_files => [], :version => nil, }
- @@attributes =
@@default_value.keys.sort_by { |s| s.to_s }
- @@array_attributes =
@@default_value.reject { |k,v| v != [] }.keys
- @@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
:category: Recommended gemspec attributes.
-
#homepage ⇒ Object
:category: Recommended gemspec attributes.
-
#metadata ⇒ Object
:attr_accessor: metadata.
-
#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.
-
#rubyforge_project ⇒ Object
The rubyforge project this gem lives under.
-
#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:.
-
.add_spec(spec) ⇒ Object
Adds
spec
to the known specifications, keeping the collection properly sorted. -
.add_specs(*specs) ⇒ Object
Adds multiple specs to the known specifications.
-
.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.
-
.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_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_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.
-
.remove_spec(spec) ⇒ Object
Removes
spec
from the known specs. -
.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
. -
.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 writer for #authors.
-
#authors ⇒ Object
The list of author names who wrote this gem.
-
#authors=(value) ⇒ Object
Sets the list of authors, ensuring it is an array.
- #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.
-
#bundled_gem_in_old_ruby? ⇒ Boolean
Used to detect if the gem is bundled in older version of Ruby, but not detectable as default gem (see BasicSpecification#default_gem?).
-
#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 ⇒ 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:.
-
#lib_files ⇒ Object
Files in the Gem under one of the require_paths.
-
#license ⇒ Object
Singular accessor for #licenses.
-
#license=(o) ⇒ Object
:category: Recommended gemspec attributes.
-
#licenses ⇒ Object
Plural accessor for setting licenses.
-
#licenses=(licenses) ⇒ Object
:category: Recommended gemspec attributes The license(s) for the library.
-
#mark_version ⇒ Object
Sets the rubygems_version to the current RubyGems version.
-
#method_missing(sym, *a, &b) ⇒ Object
Warn about unknown attributes while loading a spec.
-
#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. -
#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) ⇒ Object
Checks that the specification contains all required fields, and does a very basic sanity check.
-
#validate_dependencies ⇒ Object
Checks that dependencies use requirements as we recommend.
-
#validate_permissions ⇒ Object
Checks to see if the files to be packaged are world-readable.
-
#warning(statement) ⇒ Object
:nodoc:.
-
#yaml_initialize(tag, vals) ⇒ Object
:nodoc:.
Methods included from Deprecate
deprecate, 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, #require_paths, #source_paths, #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
.
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 |
# File 'lib/rubygems/specification.rb', line 2025 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 @@nil_attributes.each do |key| instance_variable_set "@#{key}", nil end @@non_nil_attributes.each do |key| default = default_value(key) value = Dupable[key] ? default.dup : default instance_variable_set "@#{key}", value end @new_platform = Gem::Platform::RUBY self.name = name if name self.version = version if version 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
Warn about unknown attributes while loading a spec.
2154 2155 2156 2157 2158 2159 2160 2161 |
# File 'lib/rubygems/specification.rb', line 2154 def method_missing(sym, *a, &b) # :nodoc: if @specification_version > CURRENT_SPECIFICATION_VERSION and sym.to_s =~ /=$/ then 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.
685 686 687 |
# File 'lib/rubygems/specification.rb', line 685 def activated @activated end |
#autorequire ⇒ Object
Autorequire was used by old RubyGems to automatically require a file.
Deprecated: It is neither supported nor functional.
694 695 696 |
# File 'lib/rubygems/specification.rb', line 694 def autorequire @autorequire end |
#bindir ⇒ Object
The path in the gem for executable scripts. Usually ‘bin’
Usage:
spec.bindir = 'bin'
370 371 372 |
# File 'lib/rubygems/specification.rb', line 370 def bindir @bindir end |
#cert_chain ⇒ Object
The certificate chain used to sign this gem. See Gem::Security for details.
376 377 378 |
# File 'lib/rubygems/specification.rb', line 376 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.
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 |
# File 'lib/rubygems/specification.rb', line 1770 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 = " Rake is a Make-like program implemented in Ruby. Tasks and\n dependencies are specified in standard Ruby syntax.\n"
392 393 394 |
# File 'lib/rubygems/specification.rb', line 392 def description @description end |
#email ⇒ Object
:category: Recommended gemspec attributes
A contact email address (or addresses) for this gem
Usage:
spec.email = '[email protected]'
spec.email = ['[email protected]', '[email protected]']
404 405 406 |
# File 'lib/rubygems/specification.rb', line 404 def email @email end |
#homepage ⇒ Object
:category: Recommended gemspec attributes
The URL of this gem’s home page
Usage:
spec.homepage = 'https://github.com/ruby/rake'
415 416 417 |
# File 'lib/rubygems/specification.rb', line 415 def homepage @homepage end |
#metadata ⇒ Object
:attr_accessor: metadata
The metadata holds extra data for this gem that may be useful to other consumers and is settable by gem authors without requiring an update to the rubygems software.
Metadata items have the following restrictions:
-
The metadata must be a Hash object
-
All keys and values must be Strings
-
Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes
-
All strings must be UTF-8, no binary data is allowed
To add metadata for the location of a issue tracker:
s. = { "issue_tracker" => "https://example/issues" }
460 461 462 |
# File 'lib/rubygems/specification.rb', line 460 def end |
#name ⇒ Object
This gem’s name.
Usage:
spec.name = 'rake'
194 195 196 |
# File 'lib/rubygems/specification.rb', line 194 def name @name end |
#original_platform ⇒ Object
Cruft. Use platform
.
2218 2219 2220 |
# File 'lib/rubygems/specification.rb', line 2218 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!"
424 425 426 |
# File 'lib/rubygems/specification.rb', line 424 def end |
#required_ruby_version ⇒ Object
The version of Ruby required by this gem
429 430 431 |
# File 'lib/rubygems/specification.rb', line 429 def required_ruby_version @required_ruby_version end |
#required_rubygems_version ⇒ Object
The RubyGems version required by this gem
434 435 436 |
# File 'lib/rubygems/specification.rb', line 434 def required_rubygems_version @required_rubygems_version end |
#rubyforge_project ⇒ Object
The rubyforge project this gem lives under. i.e. RubyGems’ rubyforge_project is “rubygems”.
This option is deprecated.
714 715 716 |
# File 'lib/rubygems/specification.rb', line 714 def rubyforge_project @rubyforge_project 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.
235 236 237 |
# File 'lib/rubygems/specification.rb', line 235 def rubygems_version @rubygems_version end |
#signing_key ⇒ Object
The key used to sign this gem. See Gem::Security for details.
439 440 441 |
# File 'lib/rubygems/specification.rb', line 439 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.
721 722 723 |
# File 'lib/rubygems/specification.rb', line 721 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"
246 247 248 |
# File 'lib/rubygems/specification.rb', line 246 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'
207 208 209 |
# File 'lib/rubygems/specification.rb', line 207 def version @version end |
Class Method Details
._all ⇒ Object
:nodoc:
723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'lib/rubygems/specification.rb', line 723 def self._all # :nodoc: unless defined?(@@all) && @@all then @@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:
736 737 738 |
# File 'lib/rubygems/specification.rb', line 736 def self._clear_load_cache # :nodoc: LOAD_CACHE.clear end |
._latest_specs(specs, prerelease = false) ⇒ Object
:nodoc:
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 |
# File 'lib/rubygems/specification.rb', line 1126 def self._latest_specs specs, prerelease = false # :nodoc: result = Hash.new { |h,k| h[k] = {} } native = {} specs.reverse_each do |spec| next if spec.version.prerelease? unless prerelease native[spec.name] = spec.version if spec.platform == Gem::Platform::RUBY result[spec.name][spec.platform] = spec end result.map(&:last).map(&:values).flatten.reject { |spec| minimum = native[spec.name] minimum && spec.version < minimum }.sort_by{ |tup| tup.name } end |
._load(str) ⇒ Object
Load custom marshal format, re-initializing defaults as needed
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 |
# File 'lib/rubygems/specification.rb', line 1303 def self._load(str) array = Marshal.load str spec = Gem::Specification.new spec.instance_variable_set :@specification_version, array[1] current_version = CURRENT_SPECIFICATION_VERSION field_count = if spec.specification_version > current_version then spec.instance_variable_set :@specification_version, current_version MARSHAL_FIELDS[current_version] else MARSHAL_FIELDS[spec.specification_version] end if array.size < field_count then raise TypeError, "invalid Gem::Specification format #{array.inspect}" end # Cleanup any YAML::PrivateType. They only show up for an old bug # where nil => null, so just convert them to nil based on the type. array.map! { |e| e.kind_of?(YAML::PrivateType) ? nil : e } spec.instance_variable_set :@rubygems_version, array[0] # spec version spec.instance_variable_set :@name, array[2] spec.instance_variable_set :@version, array[3] spec.date = array[4] spec.instance_variable_set :@summary, array[5] spec.instance_variable_set :@required_ruby_version, array[6] spec.instance_variable_set :@required_rubygems_version, array[7] spec.instance_variable_set :@original_platform, array[8] spec.instance_variable_set :@dependencies, array[9] spec.instance_variable_set :@rubyforge_project, array[10] spec.instance_variable_set :@email, array[11] spec.instance_variable_set :@authors, array[12] spec.instance_variable_set :@description, array[13] spec.instance_variable_set :@homepage, array[14] spec.instance_variable_set :@has_rdoc, array[15] spec.instance_variable_set :@new_platform, array[16] spec.instance_variable_set :@platform, array[16].to_s spec.instance_variable_set :@license, array[17] spec.instance_variable_set :@metadata, array[18] spec.instance_variable_set :@loaded, false spec.instance_variable_set :@activated, false spec end |
._resort!(specs) ⇒ Object
:nodoc:
859 860 861 862 863 864 865 |
# File 'lib/rubygems/specification.rb', line 859 def self._resort!(specs) # :nodoc: specs.sort! { |a, b| names = a.name <=> b.name next names if names.nonzero? b.version <=> a.version } end |
.add_spec(spec) ⇒ Object
Adds spec
to the known specifications, keeping the collection properly sorted.
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'lib/rubygems/specification.rb', line 882 def self.add_spec spec warn "Gem::Specification.add_spec is deprecated and will be removed in Rubygems 3.0" unless Gem::Deprecate.skip # TODO: find all extraneous adds # puts # p :add_spec => [spec.full_name, caller.reject { |s| s =~ /minitest/ }] # TODO: flush the rest of the crap from the tests # raise "no dupes #{spec.full_name} in #{all_names.inspect}" if # _all.include? spec raise "nil spec!" unless spec # TODO: remove once we're happy with tests return if _all.include? spec _all << spec stubs << spec (@@stubs_by_name[spec.name] ||= []) << spec sort_by!(@@stubs_by_name[spec.name]) { |s| s.version } _resort!(_all) _resort!(stubs) end |
.add_specs(*specs) ⇒ Object
Adds multiple specs to the known specifications.
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 |
# File 'lib/rubygems/specification.rb', line 907 def self.add_specs *specs warn "Gem::Specification.add_specs is deprecated and will be removed in Rubygems 3.0" unless Gem::Deprecate.skip raise "nil spec!" if specs.any?(&:nil?) # TODO: remove once we're happy # TODO: this is much more efficient, but we need the extra checks for now # _all.concat specs # _resort! Gem::Deprecate.skip_during do specs.each do |spec| # TODO: slow add_spec spec end end end |
.all ⇒ Object
Returns all specifications. This method is discouraged from use. You probably want to use one of the Enumerable methods instead.
927 928 929 930 931 |
# File 'lib/rubygems/specification.rb', line 927 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
945 946 947 948 |
# File 'lib/rubygems/specification.rb', line 945 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.
953 954 955 |
# File 'lib/rubygems/specification.rb', line 953 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…
962 963 964 |
# File 'lib/rubygems/specification.rb', line 962 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…
971 972 973 |
# File 'lib/rubygems/specification.rb', line 971 def self.attribute_names @@attributes.dup end |
.dirs ⇒ Object
Return the directories that Specification uses to find specs.
978 979 980 981 982 |
# File 'lib/rubygems/specification.rb', line 978 def self.dirs @@dirs ||= Gem.path.collect { |dir| File.join dir.dup.untaint, "specifications" } end |
.dirs=(dirs) ⇒ Object
Set the directories that Specification uses to find specs. Setting this resets the list of known specs.
988 989 990 991 992 |
# File 'lib/rubygems/specification.rb', line 988 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.
1000 1001 1002 1003 1004 1005 1006 |
# File 'lib/rubygems/specification.rb', line 1000 def self.each return enum_for(:each) unless block_given? self._all.each do |x| yield x end end |
.each_gemspec(dirs) ⇒ Object
:nodoc:
740 741 742 743 744 745 746 |
# File 'lib/rubygems/specification.rb', line 740 def self.each_gemspec(dirs) # :nodoc: dirs.each do |dir| Dir[File.join(dir, "*.gemspec")].each do |path| yield path.untaint end end end |
.each_spec(dirs) ⇒ Object
:nodoc:
818 819 820 821 822 823 |
# File 'lib/rubygems/specification.rb', line 818 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
1053 1054 1055 1056 1057 1058 |
# File 'lib/rubygems/specification.rb', line 1053 def self.find_active_stub_by_path path stub = @@active_stub_with_requirable_file[path] ||= (stubs.find { |s| s.activated? and s.contains_requirable_file? path } || NOT_FOUND) stub.this end |
.find_all_by_name(name, *requirements) ⇒ Object
Returns every spec that matches name
and optional requirements
.
1011 1012 1013 1014 1015 1016 1017 |
# File 'lib/rubygems/specification.rb', line 1011 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.
1023 1024 1025 1026 1027 1028 1029 |
# File 'lib/rubygems/specification.rb', line 1023 def self.find_by_name name, *requirements requirements = Gem::Requirement.default if requirements.empty? # TODO: maybe try: find { |s| spec === dep } Gem::Dependency.new(name, *requirements).to_spec end |
.find_by_path(path) ⇒ Object
Return the best specification that contains the file matching path
.
1034 1035 1036 1037 1038 1039 1040 |
# File 'lib/rubygems/specification.rb', line 1034 def self.find_by_path path path = path.dup.freeze spec = @@spec_with_requirable_file[path] ||= (stubs.find { |s| s.contains_requirable_file? path } || NOT_FOUND) spec.to_spec end |
.find_in_unresolved(path) ⇒ Object
Return currently unresolved specs that contain the file matching path
.
1063 1064 1065 1066 1067 1068 |
# File 'lib/rubygems/specification.rb', line 1063 def self.find_in_unresolved path # TODO: do we need these?? Kill it specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten specs.find_all { |spec| spec.contains_requirable_file? path } end |
.find_in_unresolved_tree(path) ⇒ Object
Search through all unresolved deps and sub-dependencies and return specs that contain the file matching path
.
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 |
# File 'lib/rubygems/specification.rb', line 1074 def self.find_in_unresolved_tree path specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten specs.reverse_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.
1046 1047 1048 1049 1050 1051 |
# File 'lib/rubygems/specification.rb', line 1046 def self.find_inactive_by_path path stub = stubs.find { |s| s.contains_requirable_file? path unless s.activated? } 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.
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'lib/rubygems/specification.rb', line 1098 def self.from_yaml(input) Gem.load_yaml input = normalize_yaml_input input spec = YAML.load input if spec && spec.class == FalseClass then raise Gem::EndOfYAMLException end unless Gem::Specification === spec then raise Gem::Exception, "YAML data doesn't evaluate to gem specification" end spec.specification_version ||= NONEXISTENT_SPECIFICATION_VERSION spec.reset_nil_attributes_to_default spec end |
.latest_specs(prerelease = false) ⇒ Object
Return the latest specs, optionally including prerelease specs if prerelease
is true.
1122 1123 1124 |
# File 'lib/rubygems/specification.rb', line 1122 def self.latest_specs prerelease = false _latest_specs Gem::Specification._all, prerelease end |
.load(file) ⇒ Object
Loads Ruby format gemspec from file
.
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 |
# File 'lib/rubygems/specification.rb', line 1146 def self.load file return unless file _spec = LOAD_CACHE[file] return _spec if _spec file = file.dup.untaint return unless File.file?(file) code = if defined? Encoding File.read file, :mode => 'r:UTF-8:-' else File.read file end code.untaint begin _spec = eval code, binding, file if Gem::Specification === _spec _spec.loaded_from = File. file.to_s LOAD_CACHE[file] = _spec return _spec end warn "[#{file}] isn't a Gem::Specification (#{_spec.class} instead)." rescue SignalException, SystemExit raise rescue SyntaxError, Exception => e warn "Invalid gemspec in [#{file}]: #{e}" end nil end |
.load_defaults ⇒ Object
Loads the default specifications. It should be called only once.
870 871 872 873 874 875 876 |
# File 'lib/rubygems/specification.rb', line 870 def self.load_defaults each_spec([default_specifications_dir]) do |spec| # #load returns nil if the spec is bad, so we just ignore # it at this stage Gem.register_default_spec(spec) end end |
.non_nil_attributes ⇒ Object
Specification attributes that must be non-nil
1185 1186 1187 |
# File 'lib/rubygems/specification.rb', line 1185 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
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 |
# File 'lib/rubygems/specification.rb', line 1192 def self.normalize_yaml_input(input) result = input.respond_to?(:read) ? input.read : input result = "--- " + result unless result =~ /\A--- / result = result.dup result.gsub!(/ !!null \n/, " \n") # date: 2011-04-26 00:00:00.000000000Z # date: 2011-04-26 00:00:00.000000000 Z result.gsub!(/^(date: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+?)Z/, '\1 Z') result end |
.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.
1210 1211 1212 |
# File 'lib/rubygems/specification.rb', line 1210 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.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 |
# File 'lib/rubygems/specification.rb', line 1221 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 |
.remove_spec(spec) ⇒ Object
Removes spec
from the known specs.
1246 1247 1248 1249 1250 1251 1252 |
# File 'lib/rubygems/specification.rb', line 1246 def self.remove_spec spec warn "Gem::Specification.remove_spec is deprecated and will be removed in Rubygems 3.0" unless Gem::Deprecate.skip _all.delete spec stubs.delete_if { |s| s.full_name == spec.full_name } (@@stubs_by_name[spec.name] || []).delete_if { |s| s.full_name == spec.full_name } reset end |
.required_attribute?(name) ⇒ Boolean
Is name
a required attribute?
1257 1258 1259 |
# File 'lib/rubygems/specification.rb', line 1257 def self.required_attribute?(name) @@required_attributes.include? name.to_sym end |
.required_attributes ⇒ Object
Required specification attributes
1264 1265 1266 |
# File 'lib/rubygems/specification.rb', line 1264 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.
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 |
# File 'lib/rubygems/specification.rb', line 1272 def self.reset @@dirs = nil Gem.pre_reset_hooks.each { |hook| hook.call } @@all = nil @@stubs = nil @@stubs_by_name = {} @@spec_with_requirable_file = {} @@active_stub_with_requirable_file = {} _clear_load_cache unresolved = unresolved_deps unless unresolved.empty? then w = "W" + "ARN" warn "#{w}: Unresolved specs during Gem::Specification.reset:" unresolved.values.each do |dep| warn " #{dep}" end warn "#{w}: Clearing out unresolved specs." 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
828 829 830 831 832 833 834 835 836 837 838 |
# File 'lib/rubygems/specification.rb', line 828 def self.stubs @@stubs ||= begin pattern = "*.gemspec" stubs = default_stubs(pattern).concat installed_stubs(dirs, pattern) stubs = uniq_by(stubs) { |stub| stub.full_name } _resort!(stubs) @@stubs_by_name = stubs.group_by(&:name) stubs end end |
.stubs_for(name) ⇒ Object
Returns a Gem::StubSpecification for installed gem named name
845 846 847 848 849 850 851 852 853 854 855 856 857 |
# File 'lib/rubygems/specification.rb', line 845 def self.stubs_for name if @@stubs @@stubs_by_name[name] || [] else pattern = "#{name}-*.gemspec" stubs = default_stubs(pattern) + installed_stubs(dirs, pattern) stubs = uniq_by(stubs) { |stub| stub.full_name }.group_by(&:name) stubs.each_value { |v| sort_by!(v) { |i| i.version } } @@stubs_by_name.merge! stubs @@stubs_by_name[name] ||= EMPTY end end |
.unresolved_deps ⇒ Object
DOC: This method needs documented or nodoc’d
1296 1297 1298 |
# File 'lib/rubygems/specification.rb', line 1296 def self.unresolved_deps @unresolved_deps ||= Hash.new { |h, n| h[n] = Gem::Dependency.new n } end |
Instance Method Details
#<=>(other) ⇒ Object
:nodoc:
1354 1355 1356 |
# File 'lib/rubygems/specification.rb', line 1354 def <=>(other) # :nodoc: sort_obj <=> other.sort_obj end |
#==(other) ⇒ Object
:nodoc:
1358 1359 1360 1361 1362 1363 |
# File 'lib/rubygems/specification.rb', line 1358 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)
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 |
# File 'lib/rubygems/specification.rb', line 1371 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, , @description, @homepage, true, # has_rdoc @new_platform, @licenses, ] 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.
1458 1459 1460 1461 1462 1463 1464 |
# File 'lib/rubygems/specification.rb', line 1458 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.
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 |
# File 'lib/rubygems/specification.rb', line 1401 def activate other = Gem.loaded_specs[self.name] if other then check_version_conflict other return false end raise_if_conflicts activate_dependencies add_self_to_load_path Gem.loaded_specs[self.name] = self @activated = true @loaded = true return true end |
#activate_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.
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/rubygems/specification.rb', line 1425 def activate_dependencies unresolved = Gem::Specification.unresolved_deps self.runtime_dependencies.each do |spec_dep| if loaded = Gem.loaded_specs[spec_dep.name] next if spec_dep.matches_spec? loaded msg = "can't satisfy '#{spec_dep}', already activated '#{loaded.full_name}'" e = Gem::LoadError.new msg e.name = spec_dep.name raise e end specs = spec_dep.to_specs if specs.size == 1 then specs.first.activate else name = spec_dep.name unresolved[name] = unresolved[name].merge spec_dep end end unresolved.delete self.name end |
#add_bindir(executables) ⇒ Object
Returns an array with bindir attached to each executable in the executables
list
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 |
# File 'lib/rubygems/specification.rb', line 1500 def add_bindir(executables) return nil if executables.nil? if @bindir then Array(executables).map { |e| File.join(@bindir, e) } else executables end rescue return nil end |
#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.
473 474 475 |
# File 'lib/rubygems/specification.rb', line 473 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'
484 485 486 |
# File 'lib/rubygems/specification.rb', line 484 def add_runtime_dependency(gem, *requirements) 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.
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 |
# File 'lib/rubygems/specification.rb', line 1539 def add_self_to_load_path return if default_gem? paths = full_require_paths # gem directories must come after -I and ENV['RUBYLIB'] insert_index = Gem.load_path_insert_index if insert_index then # gem directories must come after -I and ENV['RUBYLIB'] $LOAD_PATH.insert(insert_index, *paths) else # we are probably testing in core, -I and RUBYLIB don't apply $LOAD_PATH.unshift(*paths) end end |
#author ⇒ Object
Singular reader for #authors. Returns the first author in the list
1559 1560 1561 |
# File 'lib/rubygems/specification.rb', line 1559 def val = and val.first end |
#author=(o) ⇒ Object
Singular writer for #authors
Usage:
spec. = 'John Jones'
255 256 257 |
# File 'lib/rubygems/specification.rb', line 255 def o self. = [o] end |
#authors ⇒ Object
The list of author names who wrote this gem.
spec. = ['Chad Fowler', 'Jim Weirich', 'Rich Kilmer']
1568 1569 1570 |
# File 'lib/rubygems/specification.rb', line 1568 def ||= [] end |
#authors=(value) ⇒ Object
Sets the list of authors, ensuring it is an array.
Usage:
spec. = ['John Jones', 'Mary Smith']
266 267 268 |
# File 'lib/rubygems/specification.rb', line 266 def value = Array(value).flatten.grep(String) end |
#base_dir ⇒ Object
2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'lib/rubygems/specification.rb', line 2078 def base_dir return Gem.dir unless loaded_from @base_dir ||= if default_gem? then File.dirname File.dirname File.dirname loaded_from else File.dirname File.dirname loaded_from end end |
#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.
1578 1579 1580 |
# File 'lib/rubygems/specification.rb', line 1578 def bin_dir @bin_dir ||= File.join gem_dir, bindir # TODO: this is unfortunate end |
#bin_file(name) ⇒ Object
Returns the full path to an executable named name
in this gem.
1585 1586 1587 |
# File 'lib/rubygems/specification.rb', line 1585 def bin_file name File.join bin_dir, name end |
#build_args ⇒ Object
Returns the build_args used to install the gem
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 |
# File 'lib/rubygems/specification.rb', line 1592 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.
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 |
# File 'lib/rubygems/specification.rb', line 1607 def build_extensions # :nodoc: return if default_gem? return if extensions.empty? return if installed_by_version < Gem::Version.new('2.2.0.preview.2') 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
1639 1640 1641 |
# File 'lib/rubygems/specification.rb', line 1639 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
1647 1648 1649 |
# File 'lib/rubygems/specification.rb', line 1647 def build_info_file File.join build_info_dir, "#{full_name}.info" end |
#bundled_gem_in_old_ruby? ⇒ Boolean
Used to detect if the gem is bundled in older version of Ruby, but not detectable as default gem (see BasicSpecification#default_gem?).
1655 1656 1657 1658 1659 |
# File 'lib/rubygems/specification.rb', line 1655 def bundled_gem_in_old_ruby? !default_gem? && RUBY_VERSION < "2.0.0" && summary == "This #{name} is bundled with Ruby" end |
#cache_dir ⇒ Object
Returns the full path to the cache directory containing this spec’s cached gem.
1665 1666 1667 |
# File 'lib/rubygems/specification.rb', line 1665 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.
1672 1673 1674 |
# File 'lib/rubygems/specification.rb', line 1672 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.
1693 1694 1695 1696 1697 1698 |
# File 'lib/rubygems/specification.rb', line 1693 def conficts_when_loaded_with?(list_of_specs) # :nodoc: result = list_of_specs.any? { |spec| spec.dependencies.any? { |dep| dep.runtime? && (dep.name == name) && !satisfies_requirement?(dep) } } result end |
#conflicts ⇒ Object
Return any possible conflicts against the currently loaded specs.
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 |
# File 'lib/rubygems/specification.rb', line 1679 def conflicts conflicts = {} self.runtime_dependencies.each { |dep| spec = Gem.loaded_specs[dep.name] if spec and not spec.satisfies_requirement? dep (conflicts[spec] ||= []) << dep end } conflicts end |
#date ⇒ Object
The date this gem was created. Lazily defaults to the current UTC date.
There is no need to set this in your gem specification.
1719 1720 1721 |
# File 'lib/rubygems/specification.rb', line 1719 def date @date ||= TODAY end |
#date=(date) ⇒ Object
The date this gem was created
DO NOT set this, it is set automatically when the gem is packaged.
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 |
# File 'lib/rubygems/specification.rb', line 1739 def date= date # We want to end up with a Time object with one-day resolution. # This is the cleanest, most-readable, faster-than-using-Date # way to do it. @date = case date when String then if DateTimeFormat =~ date then Time.utc($1.to_i, $2.to_i, $3.to_i) # Workaround for where the date format output from psych isn't # parsed as a Time object by syck and thus comes through as a # string. elsif /\A(\d{4})-(\d{2})-(\d{2}) \d{2}:\d{2}:\d{2}\.\d+?Z\z/ =~ date then Time.utc($1.to_i, $2.to_i, $3.to_i) else raise(Gem::InvalidSpecificationException, "invalid date format in specification: #{date.inspect}") end when Time, DateLike then Time.utc(date.year, date.month, date.day) else TODAY end end |
#default_value(name) ⇒ Object
The default value for specification attribute name
1784 1785 1786 |
# File 'lib/rubygems/specification.rb', line 1784 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.
1794 1795 1796 |
# File 'lib/rubygems/specification.rb', line 1794 def dependencies @dependencies ||= [] end |
#dependent_gems ⇒ 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]]
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 |
# File 'lib/rubygems/specification.rb', line 1804 def dependent_gems out = [] Gem::Specification.each do |spec| spec.dependencies.each do |dep| if self.satisfies_requirement?(dep) then sats = [] find_all_satisfiers(dep) do |sat| sats << sat end out << [spec, dep, sats] end end end out end |
#dependent_specs ⇒ Object
Returns all specs that matches this spec’s runtime dependencies.
1823 1824 1825 |
# File 'lib/rubygems/specification.rb', line 1823 def dependent_specs runtime_dependencies.map { |dep| dep.to_specs }.flatten end |
#development_dependencies ⇒ Object
List of dependencies that are used for development
1837 1838 1839 |
# File 'lib/rubygems/specification.rb', line 1837 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"
1849 1850 1851 1852 1853 1854 1855 1856 1857 |
# File 'lib/rubygems/specification.rb', line 1849 def doc_dir type = nil @doc_dir ||= File.join base_dir, 'doc', full_name if type then File.join @doc_dir, type else @doc_dir end end |
#encode_with(coder) ⇒ Object
:nodoc:
1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 |
# File 'lib/rubygems/specification.rb', line 1859 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:
1880 1881 1882 |
# File 'lib/rubygems/specification.rb', line 1880 def eql? other # :nodoc: self.class === other && same_attributes?(other) end |
#executable ⇒ Object
Singular accessor for #executables
1887 1888 1889 |
# File 'lib/rubygems/specification.rb', line 1887 def executable val = executables and val.first end |
#executable=(o) ⇒ Object
Singular accessor for #executables
1894 1895 1896 |
# File 'lib/rubygems/specification.rb', line 1894 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'
503 504 505 |
# File 'lib/rubygems/specification.rb', line 503 def executables @executables ||= [] end |
#executables=(value) ⇒ Object
Sets executables to value
, ensuring it is an array. Don’t use this, push onto the array instead.
1902 1903 1904 1905 |
# File 'lib/rubygems/specification.rb', line 1902 def executables= value # TODO: warn about setting instead of pushing @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.
520 521 522 |
# File 'lib/rubygems/specification.rb', line 520 def extensions @extensions ||= [] end |
#extensions=(extensions) ⇒ Object
Sets extensions to extensions
, ensuring it is an array. Don’t use this, push onto the array instead.
1911 1912 1913 1914 |
# File 'lib/rubygems/specification.rb', line 1911 def extensions= extensions # TODO: warn about setting instead of pushing @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']
536 537 538 |
# File 'lib/rubygems/specification.rb', line 536 def extra_rdoc_files @extra_rdoc_files ||= [] end |
#extra_rdoc_files=(files) ⇒ Object
Sets extra_rdoc_files to files
, ensuring it is an array. Don’t use this, push onto the array instead.
1920 1921 1922 1923 |
# File 'lib/rubygems/specification.rb', line 1920 def extra_rdoc_files= files # TODO: warn about setting instead of pushing @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"
1930 1931 1932 |
# File 'lib/rubygems/specification.rb', line 1930 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]*',
'test/**/*'].to_a
# or without Rake...
spec.files = Dir['lib/**/*.rb'] + Dir['bin/*']
spec.files += Dir['[A-Z]*'] + Dir['test/**/*']
spec.files.reject! { |fn| fn.include? "CVS" }
349 350 351 352 353 354 355 356 357 358 |
# File 'lib/rubygems/specification.rb', line 349 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.
1937 1938 1939 |
# File 'lib/rubygems/specification.rb', line 1937 def files= files @files = Array files end |
#for_cache ⇒ Object
Creates a duplicate spec without large blobs that aren’t used at runtime.
1955 1956 1957 1958 1959 1960 1961 1962 |
# File 'lib/rubygems/specification.rb', line 1955 def for_cache spec = dup spec.files = nil spec.test_files = nil spec end |
#full_name ⇒ Object
1964 1965 1966 |
# File 'lib/rubygems/specification.rb', line 1964 def full_name @full_name ||= super end |
#gem_dir ⇒ Object
Work around bundler removing my methods
1971 1972 1973 |
# File 'lib/rubygems/specification.rb', line 1971 def gem_dir # :nodoc: super end |
#gems_dir ⇒ Object
1975 1976 1977 1978 |
# File 'lib/rubygems/specification.rb', line 1975 def gems_dir # TODO: this logic seems terribly broken, but tests fail if just base_dir @gems_dir ||= File.join(loaded_from && base_dir || Gem.dir, "gems") end |
#has_conflicts? ⇒ Boolean
Return true if there are possible conflicts against the currently loaded specs.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 |
# File 'lib/rubygems/specification.rb', line 1703 def has_conflicts? self.dependencies.any? { |dep| if dep.runtime? then spec = Gem.loaded_specs[dep.name] spec and not spec.satisfies_requirement? dep else false end } end |
#has_rdoc ⇒ Object Also known as: has_rdoc?
Deprecated and ignored, defaults to true.
Formerly used to indicate this gem was RDoc-capable.
1985 1986 1987 |
# File 'lib/rubygems/specification.rb', line 1985 def has_rdoc # :nodoc: true end |
#has_rdoc=(ignored) ⇒ Object
Deprecated and ignored.
Formerly used to indicate this gem was RDoc-capable.
1994 1995 1996 |
# File 'lib/rubygems/specification.rb', line 1994 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
2003 2004 2005 |
# File 'lib/rubygems/specification.rb', line 2003 def has_unit_tests? # :nodoc: not test_files.empty? end |
#hash ⇒ Object
:startdoc:
2011 2012 2013 |
# File 'lib/rubygems/specification.rb', line 2011 def hash # :nodoc: name.hash ^ version.hash end |
#init_with(coder) ⇒ Object
:nodoc:
2015 2016 2017 2018 |
# File 'lib/rubygems/specification.rb', line 2015 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.
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 |
# File 'lib/rubygems/specification.rb', line 2056 def initialize_copy other_spec self.class.array_attributes.each do |name| name = :"@#{name}" next unless other_spec.instance_variable_defined? name begin val = other_spec.instance_variable_get(name) if val then instance_variable_set name, val.dup elsif Gem.configuration.really_verbose warn "WARNING: #{full_name} has an invalid nil value for #{name}" end rescue TypeError e = Gem::FormatException.new \ "#{full_name} has an invalid value for #{name}" e.file_path = loaded_from raise e end end end |
#inspect ⇒ Object
:nodoc:
2098 2099 2100 2101 2102 2103 2104 |
# File 'lib/rubygems/specification.rb', line 2098 def inspect # :nodoc: if $DEBUG super else "#<#{self.class}:0x#{__id__.to_s(16)} #{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.
545 546 547 |
# File 'lib/rubygems/specification.rb', line 545 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.
553 554 555 |
# File 'lib/rubygems/specification.rb', line 553 def installed_by_version= version # :nodoc: @installed_by_version = Gem::Version.new version end |
#internal_init ⇒ Object
:nodoc:
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 |
# File 'lib/rubygems/specification.rb', line 2133 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 |
#lib_files ⇒ Object
Files in the Gem under one of the require_paths
2109 2110 2111 2112 2113 2114 2115 |
# File 'lib/rubygems/specification.rb', line 2109 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
2120 2121 2122 |
# File 'lib/rubygems/specification.rb', line 2120 def license licenses.first end |
#license=(o) ⇒ Object
:category: Recommended gemspec attributes
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'
585 586 587 |
# File 'lib/rubygems/specification.rb', line 585 def license=o self.licenses = [o] end |
#licenses ⇒ Object
Plural accessor for setting licenses
See #license= for details
2129 2130 2131 |
# File 'lib/rubygems/specification.rb', line 2129 def licenses @licenses ||= [] end |
#licenses=(licenses) ⇒ Object
:category: Recommended gemspec attributes 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']
603 604 605 |
# File 'lib/rubygems/specification.rb', line 603 def licenses= licenses @licenses = Array licenses end |
#mark_version ⇒ Object
Sets the rubygems_version to the current RubyGems version.
2147 2148 2149 |
# File 'lib/rubygems/specification.rb', line 2147 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
2167 2168 2169 2170 2171 2172 2173 2174 |
# File 'lib/rubygems/specification.rb', line 2167 def missing_extensions? return false if default_gem? return false if extensions.empty? return false if installed_by_version < Gem::Version.new('2.2.0.preview.2') return false if File.exist? gem_build_complete_path true end |
#name_tuple ⇒ Object
Return a NameTuple that represents this Specification
2199 2200 2201 |
# File 'lib/rubygems/specification.rb', line 2199 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.
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 |
# File 'lib/rubygems/specification.rb', line 2182 def normalize if defined?(@extra_rdoc_files) and @extra_rdoc_files then @extra_rdoc_files.uniq! @files ||= [] @files.concat(@extra_rdoc_files) end @files = @files.uniq if @files @extensions = @extensions.uniq if @extensions @test_files = @test_files.uniq if @test_files @executables = @executables.uniq if @executables @extra_rdoc_files = @extra_rdoc_files.uniq if @extra_rdoc_files end |
#original_name ⇒ Object
Returns the full name (name-version) of this gemspec using the original platform. For use with legacy gems.
2207 2208 2209 2210 2211 2212 2213 |
# File 'lib/rubygems/specification.rb', line 2207 def original_name # :nodoc: if platform == Gem::Platform::RUBY or platform.nil? then "#{@name}-#{@version}" else "#{@name}-#{@version}-#{@original_platform}" end end |
#platform ⇒ Object
The platform this gem runs on. See Gem::Platform for details.
2225 2226 2227 |
# File 'lib/rubygems/specification.rb', line 2225 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
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/rubygems/specification.rb', line 293 def platform= platform if @original_platform.nil? or @original_platform == Gem::Platform::RUBY then @original_platform = platform end case platform when Gem::Platform::CURRENT then @new_platform = Gem::Platform.local @original_platform = @new_platform.to_s when Gem::Platform then @new_platform = platform # legacy constants when nil, Gem::Platform::RUBY then @new_platform = Gem::Platform::RUBY when 'mswin32' then # was Gem::Platform::WIN32 @new_platform = Gem::Platform.new 'x86-mswin32' when 'i586-linux' then # was Gem::Platform::LINUX_586 @new_platform = Gem::Platform.new 'x86-linux' when 'powerpc-darwin' then # was Gem::Platform::DARWIN @new_platform = Gem::Platform.new 'ppc-darwin' else @new_platform = Gem::Platform.new platform end @platform = @new_platform.to_s invalidate_memoized_attributes @new_platform end |
#pretty_print(q) ⇒ Object
:nodoc:
2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 |
# File 'lib/rubygems/specification.rb', line 2229 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 if current_value != default_value(attr_name) or self.class.required_attribute? attr_name then q.text "s.#{attr_name} = " if attr_name == :date then 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.
2283 2284 2285 2286 2287 |
# File 'lib/rubygems/specification.rb', line 2283 def raise_if_conflicts # :nodoc: if has_conflicts? then raise Gem::ConflictError.new self, conflicts end end |
#raw_require_paths ⇒ Object
:nodoc:
3001 3002 3003 |
# File 'lib/rubygems/specification.rb', line 3001 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'
616 617 618 |
# File 'lib/rubygems/specification.rb', line 616 def ||= [] end |
#rdoc_options=(options) ⇒ Object
Sets rdoc_options to value
, ensuring it is an array. Don’t use this, push onto the array instead.
2293 2294 2295 2296 |
# File 'lib/rubygems/specification.rb', line 2293 def # TODO: warn about setting instead of pushing = Array end |
#require_path ⇒ Object
Singular accessor for #require_paths
2301 2302 2303 |
# File 'lib/rubygems/specification.rb', line 2301 def require_path val = require_paths and val.first end |
#require_path=(path) ⇒ Object
Singular accessor for #require_paths
2308 2309 2310 |
# File 'lib/rubygems/specification.rb', line 2308 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 = ['.']
226 227 228 |
# File 'lib/rubygems/specification.rb', line 226 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'
663 664 665 |
# File 'lib/rubygems/specification.rb', line 663 def requirements @requirements ||= [] end |
#requirements=(req) ⇒ Object
Set requirements to req
, ensuring it is an array. Don’t use this, push onto the array instead.
2316 2317 2318 2319 |
# File 'lib/rubygems/specification.rb', line 2316 def requirements= req # TODO: warn about setting instead of pushing @requirements = Array req end |
#reset_nil_attributes_to_default ⇒ Object
Reset nil attributes to their default values to make the spec valid
2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 |
# File 'lib/rubygems/specification.rb', line 2976 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:
2321 2322 2323 |
# File 'lib/rubygems/specification.rb', line 2321 def respond_to_missing? m, include_private = false # :nodoc: false end |
#ri_dir ⇒ Object
Returns the full path to this spec’s ri directory.
2328 2329 2330 |
# File 'lib/rubygems/specification.rb', line 2328 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.
2361 2362 2363 |
# File 'lib/rubygems/specification.rb', line 2361 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.
1471 1472 1473 1474 1475 1476 |
# File 'lib/rubygems/specification.rb', line 1471 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.
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 |
# File 'lib/rubygems/specification.rb', line 1481 def sanitize_string(string) return string unless string # HACK the #to_s is in here because RSpec has an Array of Arrays of # Strings for authors. Need a way to disallow bad values on gemspec # generation. (Probably won't happen.) string = string.to_s begin Builder::XChar.encode string rescue NameError, NoMethodError string.to_xs end end |
#satisfies_requirement?(dependency) ⇒ Boolean
Checks if this specification meets the requirement of dependency
.
2377 2378 2379 2380 |
# File 'lib/rubygems/specification.rb', line 2377 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.
2385 2386 2387 |
# File 'lib/rubygems/specification.rb', line 2385 def sort_obj [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1] end |
#source ⇒ Object
Used by Gem::Resolver to order Gem::Specification objects
2392 2393 2394 |
# File 'lib/rubygems/specification.rb', line 2392 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
2400 2401 2402 |
# File 'lib/rubygems/specification.rb', line 2400 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
2408 2409 2410 |
# File 'lib/rubygems/specification.rb', line 2408 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"
2417 2418 2419 |
# File 'lib/rubygems/specification.rb', line 2417 def spec_name "#{full_name}.gemspec" end |
#stubbed? ⇒ Boolean
2954 2955 2956 |
# File 'lib/rubygems/specification.rb', line 2954 def stubbed? false end |
#test_file ⇒ Object
Singular accessor for #test_files
2432 2433 2434 |
# File 'lib/rubygems/specification.rb', line 2432 def test_file # :nodoc: val = test_files and val.first end |
#test_file=(file) ⇒ Object
Singular mutator for #test_files
2439 2440 2441 |
# File 'lib/rubygems/specification.rb', line 2439 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.
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 |
# File 'lib/rubygems/specification.rb', line 2447 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 then @test_files = [@test_suite_file].flatten @test_suite_file = nil end if defined?(@test_files) and @test_files then @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']
675 676 677 |
# File 'lib/rubygems/specification.rb', line 675 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.
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 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 |
# File 'lib/rubygems/specification.rb', line 2467 def to_ruby mark_version result = [] result << "# -*- encoding: utf-8 -*-" result << "#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{raw_require_paths.join("\0")}" result << "#{Gem::StubSpecification::PREFIX}#{extensions.join "\0"}" unless extensions.empty? result << nil result << "Gem::Specification.new do |s|" result << " s.name = #{ruby_code name}" result << " s.version = #{ruby_code version}" unless platform.nil? or platform == Gem::Platform::RUBY then result << " s.platform = #{ruby_code original_platform}" end result << "" result << " s.required_rubygems_version = #{ruby_code required_rubygems_version} if s.respond_to? :required_rubygems_version=" if and !.empty? result << " s.metadata = #{ruby_code metadata} if s.respond_to? :metadata=" end result << " s.require_paths = #{ruby_code raw_require_paths}" handled = [ :dependencies, :name, :platform, :require_paths, :required_rubygems_version, :specification_version, :version, :has_rdoc, :default_executable, :metadata ] @@attributes.each do |attr_name| next if handled.include? attr_name current_value = self.send(attr_name) if current_value != default_value(attr_name) or self.class.required_attribute? attr_name then result << " s.#{attr_name} = #{ruby_code current_value}" end end if @installed_by_version then result << nil result << " s.installed_by_version = \"#{Gem::VERSION}\" if s.respond_to? :installed_by_version" end unless dependencies.empty? then result << nil result << " if s.respond_to? :specification_version then" result << " s.specification_version = #{specification_version}" result << nil result << " if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then" dependencies.each do |dep| req = dep.requirements_list.inspect dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>.freeze, #{req})" end result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})" end result << ' end' result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})" end result << " end" end result << "end" result << nil result.join "\n" end |
#to_ruby_for_cache ⇒ Object
Returns a Ruby lighter-weight code representation of this specification, used for indexing only.
See #to_ruby.
2560 2561 2562 |
# File 'lib/rubygems/specification.rb', line 2560 def to_ruby_for_cache for_cache.to_ruby end |
#to_s ⇒ Object
:nodoc:
2564 2565 2566 |
# File 'lib/rubygems/specification.rb', line 2564 def to_s # :nodoc: "#<Gem::Specification name=#{@name} version=#{@version}>" end |
#to_spec ⇒ Object
Returns self
2571 2572 2573 |
# File 'lib/rubygems/specification.rb', line 2571 def to_spec self end |
#to_yaml(opts = {}) ⇒ Object
:nodoc:
2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 |
# File 'lib/rubygems/specification.rb', line 2575 def to_yaml(opts = {}) # :nodoc: if (YAML.const_defined?(:ENGINE) && !YAML::ENGINE.syck?) || (defined?(Psych) && YAML == Psych) then # 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 io = StringIO.new io.set_encoding Encoding::UTF_8 if Object.const_defined? :Encoding Psych::Visitors::Emitter.new(io).accept(ast) io.string.gsub(/ !!null \n/, " \n") else YAML.quick_emit object_id, opts do |out| out.map taguri, to_yaml_style do |map| encode_with map end end end end |
#traverse(trail = [], visited = {}, &block) ⇒ Object
Recursively walk dependencies of this spec, executing the block
for each hop.
2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 |
# File 'lib/rubygems/specification.rb', line 2608 def traverse trail = [], visited = {}, &block trail.push(self) begin dependencies.each do |dep| next unless dep.runtime? dep.to_specs.reverse_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) ⇒ 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..
2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 |
# File 'lib/rubygems/specification.rb', line 2641 def validate packaging = true @warnings = 0 require 'rubygems/user_interaction' extend Gem::UserInteraction normalize nil_attributes = self.class.non_nil_attributes.find_all do |attrname| instance_variable_get("@#{attrname}").nil? end unless nil_attributes.empty? then raise Gem::InvalidSpecificationException, "#{nil_attributes.join ', '} must not be nil" end if packaging and rubygems_version != Gem::VERSION then raise Gem::InvalidSpecificationException, "expected RubyGems version #{Gem::VERSION}, was #{rubygems_version}" end @@required_attributes.each do |symbol| unless self.send symbol then raise Gem::InvalidSpecificationException, "missing value for attribute #{symbol}" end end unless String === name then raise Gem::InvalidSpecificationException, "invalid value for attribute name: \"#{name.inspect}\"" end if raw_require_paths.empty? then raise Gem::InvalidSpecificationException, 'specification must have at least one require_path' end @files.delete_if { |x| File.directory?(x) && !File.symlink?(x) } @test_files.delete_if { |x| File.directory?(x) && !File.symlink?(x) } @executables.delete_if { |x| File.directory?(File.join(@bindir, x)) } @extra_rdoc_files.delete_if { |x| File.directory?(x) && !File.symlink?(x) } @extensions.delete_if { |x| File.directory?(x) && !File.symlink?(x) } non_files = files.reject { |x| File.file?(x) || File.symlink?(x) } unless not packaging or non_files.empty? then raise Gem::InvalidSpecificationException, "[\"#{non_files.join "\", \""}\"] are not files" end if files.include? file_name then raise Gem::InvalidSpecificationException, "#{full_name} contains itself (#{file_name}), check your files list" end unless specification_version.is_a?(Fixnum) raise Gem::InvalidSpecificationException, 'specification_version must be a Fixnum (did you mean version?)' end case platform when Gem::Platform, Gem::Platform::RUBY then # ok else raise Gem::InvalidSpecificationException, "invalid platform #{platform.inspect}, see Gem::Platform" end self.class.array_attributes.each do |field| val = self.send field klass = case field when :dependencies Gem::Dependency else String end unless Array === val and val.all? { |x| x.kind_of?(klass) } then raise(Gem::InvalidSpecificationException, "#{field} must be an Array of #{klass}") end end [:authors].each do |field| val = self.send field raise Gem::InvalidSpecificationException, "#{field} may not be empty" if val.empty? end unless Hash === raise Gem::InvalidSpecificationException, 'metadata must be a hash' end .keys.each do |k| if !k.kind_of?(String) raise Gem::InvalidSpecificationException, 'metadata keys must be a String' end if k.size > 128 raise Gem::InvalidSpecificationException, "metadata key too large (#{k.size} > 128)" end end .values.each do |k| if !k.kind_of?(String) raise Gem::InvalidSpecificationException, 'metadata values must be a String' end if k.size > 1024 raise Gem::InvalidSpecificationException, "metadata value too large (#{k.size} > 1024)" end end licenses.each { |license| if license.length > 64 raise Gem::InvalidSpecificationException, "each license must be 64 characters or less" end if !Gem::Licenses.match?(license) suggestions = Gem::Licenses.suggestions(license) = "license value '\#{license}' is invalid. Use a license identifier from\nhttp://spdx.org/licenses or '\#{Gem::Licenses::NONSTANDARD}' for a nonstandard license.\n warning\n message += \"Did you mean \#{suggestions.map { |s| \"'\#{s}'\"}.join(', ')}?\\n\" unless suggestions.nil?\n warning(message)\n end\n }\n\n warning <<-warning if licenses.empty?\nlicenses is empty, but is recommended. Use a license identifier from\nhttp://spdx.org/licenses or '\#{Gem::Licenses::NONSTANDARD}' for a nonstandard license.\n warning\n\n validate_permissions\n\n # reject lazy developers:\n\n lazy = '\"FIxxxXME\" or \"TOxxxDO\"'.gsub(/xxx/, '')\n\n unless authors.grep(/FI XME|TO DO/x).empty? then\n raise Gem::InvalidSpecificationException, \"\#{lazy} is not an author\"\n end\n\n unless Array(email).grep(/FI XME|TO DO/x).empty? then\n raise Gem::InvalidSpecificationException, \"\#{lazy} is not an email\"\n end\n\n if description =~ /FI XME|TO DO/x then\n raise Gem::InvalidSpecificationException, \"\#{lazy} is not a description\"\n end\n\n if summary =~ /FI XME|TO DO/x then\n raise Gem::InvalidSpecificationException, \"\#{lazy} is not a summary\"\n end\n\n if homepage and not homepage.empty? and\n homepage !~ /\\A[a-z][a-z\\d+.-]*:/i then\n raise Gem::InvalidSpecificationException,\n \"\\\"\#{homepage}\\\" is not a URI\"\n end\n\n # Warnings\n\n %w[author email homepage summary].each do |attribute|\n value = self.send attribute\n warning \"no \#{attribute} specified\" if value.nil? or value.empty?\n end\n\n if description == summary then\n warning 'description and summary are identical'\n end\n\n # TODO: raise at some given date\n warning \"deprecated autorequire specified\" if autorequire\n\n executables.each do |executable|\n executable_path = File.join(bindir, executable)\n shebang = File.read(executable_path, 2) == '#!'\n\n warning \"\#{executable_path} is missing #! line\" unless shebang\n end\n\n files.each do |file|\n next unless File.symlink?(file)\n warning \"\#{file} is a symlink, which is not supported on all platforms\"\n end\n\n validate_dependencies\n\n true\nensure\n if $! or @warnings > 0 then\n alert_warning \"See http://guides.rubygems.org/specification-reference/ for help\"\n end\nend\n" |
#validate_dependencies ⇒ Object
Checks that dependencies use requirements as we recommend. Warnings are issued when dependencies are open-ended or overly strict for semantic versioning.
2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 |
# File 'lib/rubygems/specification.rb', line 2848 def validate_dependencies # :nodoc: # NOTE: see REFACTOR note in Gem::Dependency about types - this might be brittle seen = Gem::Dependency::TYPES.inject({}) { |types, type| types.merge({ type => {}}) } = [] = [] dependencies.each do |dep| if prev = seen[dep.type][dep.name] then << "duplicate dependency on \#{dep}, (\#{prev.requirement}) use:\n add_\#{dep.type}_dependency '\#{dep.name}', '\#{dep.requirement}', '\#{prev.requirement}'\n MESSAGE\n end\n\n seen[dep.type][dep.name] = dep\n\n prerelease_dep = dep.requirements_list.any? do |req|\n Gem::Requirement.new(req).prerelease?\n end\n\n warning_messages << \"prerelease dependency on \#{dep} is not recommended\" if\n prerelease_dep && !version.prerelease?\n\n overly_strict = dep.requirement.requirements.length == 1 &&\n dep.requirement.requirements.any? do |op, version|\n op == '~>' and\n not version.prerelease? and\n version.segments.length > 2 and\n version.segments.first != 0\n end\n\n if overly_strict then\n _, dep_version = dep.requirement.requirements.first\n\n base = dep_version.segments.first 2\n\n warning_messages << <<-WARNING\npessimistic dependency on \#{dep} may be overly strict\nif \#{dep.name} is semantically versioned, use:\n add_\#{dep.type}_dependency '\#{dep.name}', '~> \#{base.join '.'}', '>= \#{dep_version}'\n WARNING\n end\n\n open_ended = dep.requirement.requirements.all? do |op, version|\n not version.prerelease? and (op == '>' or op == '>=')\n end\n\n if open_ended then\n op, dep_version = dep.requirement.requirements.first\n\n base = dep_version.segments.first 2\n\n bugfix = if op == '>' then\n \", '> \#{dep_version}'\"\n elsif op == '>=' and base != dep_version.segments then\n \", '>= \#{dep_version}'\"\n end\n\n warning_messages << <<-WARNING\nopen-ended dependency on \#{dep} is not recommended\nif \#{dep.name} is semantically versioned, use:\n add_\#{dep.type}_dependency '\#{dep.name}', '~> \#{base.join '.'}'\#{bugfix}\n WARNING\n end\n end\n if error_messages.any?\n raise Gem::InvalidSpecificationException, error_messages.join\n end\n if warning_messages.any?\n warning_messages.each { |warning_message| warning warning_message }\n end\nend\n" |
#validate_permissions ⇒ Object
Checks to see if the files to be packaged are world-readable.
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 |
# File 'lib/rubygems/specification.rb', line 2924 def return if Gem.win_platform? files.each do |file| next unless File.file?(file) next if File.stat(file).mode & 0444 == 0444 warning "#{file} is not world-readable" end executables.each do |name| exec = File.join @bindir, name next unless File.file?(exec) next if File.stat(exec).executable? warning "#{exec} is not executable" end end |
#warning(statement) ⇒ Object
:nodoc:
2995 2996 2997 2998 2999 |
# File 'lib/rubygems/specification.rb', line 2995 def warning statement # :nodoc: @warnings += 1 alert_warning statement end |
#yaml_initialize(tag, vals) ⇒ Object
:nodoc:
2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'lib/rubygems/specification.rb', line 2958 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.untaint else instance_variable_set "@#{ivar}", val.untaint end end @original_platform = @platform # for backwards compatibility self.platform = Gem::Platform.new @platform end |