Class: Gem::Specification

Inherits:
BasicSpecification show all
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.authors     = ["Ruby Coder"]
  s.email       = '[email protected]'
  s.files       = ["lib/example.rb"]
  s.homepage    = 'https://rubygems.org/gems/example'
  s.metadata    = { "source_code_uri" => "https://github.com/example/example" }
end

Starting in RubyGems 2.0, a Specification can hold arbitrary metadata. See #metadata for restrictions on the format and size of metadata items you may add to a specification.

Constant Summary collapse

NONEXISTENT_SPECIFICATION_VERSION =

The version number of a specification that does not specify one (i.e. RubyGems 0.7 or earlier).

-1
CURRENT_SPECIFICATION_VERSION =

The specification version applied to any new Specification instances created. This should be bumped whenever something in the spec format changes.

Specification Version History:

spec   ruby
 ver    ver yyyy-mm-dd description
  -1 <0.8.0            pre-spec-version-history
   1  0.8.0 2004-08-01 Deprecated "test_suite_file" for "test_files"
                       "test_file=x" is a shortcut for "test_files=[x]"
   2  0.9.5 2007-10-01 Added "required_rubygems_version"
                       Now forward-compatible with future versions
   3  1.3.2 2009-01-03 Added Fixnum validation to specification_version
   4  1.9.0 2011-06-07 Added metadata

– When updating this number, be sure to also update #to_ruby.

NOTE RubyGems < 1.2 cannot load specification versions > 2.

4
SPECIFICATION_VERSION_HISTORY =

An informal list of changes to the specification. The highest-valued key should be equal to the CURRENT_SPECIFICATION_VERSION.

{ # :nodoc:
  -1 => ['(RubyGems versions up to and including 0.7 did not have versioned specifications)'],
  1  => [
    'Deprecated "test_suite_file" in favor of the new, but equivalent, "test_files"',
    '"test_file=x" is a shortcut for "test_files=[x]"'
  ],
  2  => [
    'Added "required_rubygems_version"',
    'Now forward-compatible with future versions',
  ],
  3  => [
    'Added Fixnum validation to the specification_version'
  ],
  4  => [
    'Added sandboxed freeform metadata to the specification version.'
  ]
}.freeze
MARSHAL_FIELDS =

:nodoc:

{ # :nodoc:
  -1 => 16,
   1 => 16,
   2 => 16,
   3 => 17,
   4 => 18,
}.freeze
TODAY =

:nodoc:

Time.utc(today.year, today.month, today.day)
LOAD_CACHE =

rubocop:disable Style/MutableConstant

{}
VALID_NAME_PATTERN =

:nodoc:

/\A[a-zA-Z0-9\.\-\_]+\z/.freeze
INITIALIZE_CODE_FOR_DEFAULTS =

rubocop:disable Style/MutableConstant

{ }
NOT_FOUND =

Sentinel object to represent “not found” stubs

Struct.new(:to_spec, :this).new
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.freeze
@@required_attributes =

List of attribute names: [:name, :version, …]

[:rubygems_version,
:specification_version,
:name,
:version,
:date,
:summary,
:require_paths]
@@default_value =

Map of attribute names to default values.

{
  :authors                   => [],
  :autorequire               => nil,
  :bindir                    => 'bin',
  :cert_chain                => [],
  :date                      => nil,
  :dependencies              => [],
  :description               => nil,
  :email                     => nil,
  :executables               => [],
  :extensions                => [],
  :extra_rdoc_files          => [],
  :files                     => [],
  :homepage                  => nil,
  :licenses                  => [],
  :metadata                  => {},
  :name                      => nil,
  :platform                  => Gem::Platform::RUBY,
  :post_install_message      => nil,
  :rdoc_options              => [],
  :require_paths             => ['lib'],
  :required_ruby_version     => Gem::Requirement.default,
  :required_rubygems_version => Gem::Requirement.default,
  :requirements              => [],
  :rubygems_version          => Gem::VERSION,
  :signing_key               => nil,
  :specification_version     => CURRENT_SPECIFICATION_VERSION,
  :summary                   => nil,
  :test_files                => [],
  :version                   => nil,
}.freeze
@@attributes = 
@@default_value.keys.sort_by { |s| s.to_s }
@@array_attributes = 
@@default_value.reject { |k,v| v != [] }.keys
@@stubs_by_name = 
{}
@@spec_with_requirable_file = 
{}
@@active_stub_with_requirable_file = 
{}

Instance Attribute Summary collapse

Attributes inherited from BasicSpecification

#extension_dir, #full_gem_path, #ignored, #loaded_from

Class Method Summary collapse

Instance Method Summary collapse

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, #this, #to_fullpath

Constructor Details

#initialize(name = nil, version = nil) {|_self| ... } ⇒ Specification

Specification constructor. Assigns the default values to the attributes and yields itself for further initialization. Optionally takes name and version.

Yields:

  • (_self)

Yield Parameters:



2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/rubygems/specification.rb', line 2046

def initialize(name = nil, version = nil)
  super()
  @gems_dir              = nil
  @base_dir              = nil
  @loaded = false
  @activated = false
  @loaded_from = nil
  @original_platform = nil
  @installed_by_version = nil

  set_nil_attributes_to_nil
  set_not_nil_attributes_to_default_values

  @new_platform = Gem::Platform::RUBY

  self.name = name if name
  self.version = version if version

  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.



2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/rubygems/specification.rb', line 2168

def method_missing(sym, *a, &b) # :nodoc:
  if @specification_version > CURRENT_SPECIFICATION_VERSION and
    sym.to_s =~ /=$/
    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.



706
707
708
 
# File 'lib/rubygems/specification.rb', line 706

def activated
  @activated
end

#autorequire ⇒ Object

Autorequire was used by old RubyGems to automatically require a file.

Deprecated: It is neither supported nor functional.



715
716
717
 
# File 'lib/rubygems/specification.rb', line 715

def autorequire
  @autorequire
end

#bindir ⇒ Object

The path in the gem for executable scripts. Usually ‘bin’

Usage:

spec.bindir = 'bin'



418
419
420
 
# File 'lib/rubygems/specification.rb', line 418

def bindir
  @bindir
end

#cert_chain ⇒ Object

The certificate chain used to sign this gem. See Gem::Security for details.



424
425
426
 
# File 'lib/rubygems/specification.rb', line 424

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.



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
 
# File 'lib/rubygems/specification.rb', line 1773

def default_executable # :nodoc:
  if defined?(@default_executable) and @default_executable
    result = @default_executable
  elsif @executables and @executables.size == 1
    result = Array(@executables).first
  else
    result = nil
  end
  result
end

#description ⇒ Object

A long description of this gem

The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting.

Usage:

spec.description = <<-EOF
  Rake is a Make-like program implemented in Ruby. Tasks and
  dependencies are specified in standard Ruby syntax.
EOF



297
298
299
 
# File 'lib/rubygems/specification.rb', line 297

def description
  @description
end

#email ⇒ Object

A contact email address (or addresses) for this gem

Usage:

spec.email = '[email protected]'
spec.email = ['[email protected]', '[email protected]']



307
308
309
 
# File 'lib/rubygems/specification.rb', line 307

def email
  @email
end

#homepage ⇒ Object

The URL of this gem’s home page

Usage:

spec.homepage = 'https://github.com/ruby/rake'



316
317
318
 
# File 'lib/rubygems/specification.rb', line 316

def homepage
  @homepage
end

#metadata ⇒ Object

The metadata holds extra data for this gem that may be useful to other consumers and is settable by gem authors.

Metadata items have the following restrictions:

  • The metadata must be a Hash object

  • All keys and values must be Strings

  • Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes

  • All strings must be UTF-8, no binary data is allowed

You can use metadata to specify links to your gem’s homepage, codebase, documentation, wiki, mailing list, issue tracker and changelog.

s.metadata = {
  "bug_tracker_uri"   => "https://example.com/user/bestgemever/issues",
  "changelog_uri"     => "https://example.com/user/bestgemever/CHANGELOG.md",
  "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1",
  "homepage_uri"      => "https://bestgemever.example.io",
  "mailing_list_uri"  => "https://groups.example.com/bestgemever",
  "source_code_uri"   => "https://example.com/user/bestgemever",
  "wiki_uri"          => "https://example.com/user/bestgemever/wiki"
}

These links will be used on your gem’s page on rubygems.org and must pass validation against following regex.

%r{\Ahttps?:\/\/([^\s:@]+:[^\s:@]*@)?[A-Za-z\d\-]+(\.[A-Za-z\d\-]+)+\.?(:\d{1,5})?([\/?]\S*)?\z}



395
396
397
 
# File 'lib/rubygems/specification.rb', line 395

def metadata
  @metadata
end

#name ⇒ Object

This gem’s name.

Usage:

spec.name = 'rake'



207
208
209
 
# File 'lib/rubygems/specification.rb', line 207

def name
  @name
end

#original_platform ⇒ Object

Cruft. Use platform.



2232
2233
2234
 
# File 'lib/rubygems/specification.rb', line 2232

def original_platform # :nodoc:
  @original_platform ||= platform
end

#post_install_message ⇒ Object

A message that gets displayed after the gem is installed.

Usage:

spec.post_install_message = "Thanks for installing!"



433
434
435
 
# File 'lib/rubygems/specification.rb', line 433

def post_install_message
  @post_install_message
end

#required_ruby_version ⇒ Object

The version of Ruby required by this gem



516
517
518
 
# File 'lib/rubygems/specification.rb', line 516

def required_ruby_version
  @required_ruby_version
end

#required_rubygems_version ⇒ Object

The RubyGems version required by this gem



521
522
523
 
# File 'lib/rubygems/specification.rb', line 521

def required_rubygems_version
  @required_rubygems_version
end

#rubyforge_project=(value) ⇒ Object (writeonly)

Deprecated and ignored.

Formerly used to set rubyforge project.



735
736
737
 
# File 'lib/rubygems/specification.rb', line 735

def rubyforge_project=(value)
  @rubyforge_project = value
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.



528
529
530
 
# File 'lib/rubygems/specification.rb', line 528

def rubygems_version
  @rubygems_version
end

#signing_key ⇒ Object

The key used to sign this gem. See Gem::Security for details.



533
534
535
 
# File 'lib/rubygems/specification.rb', line 533

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.



742
743
744
 
# File 'lib/rubygems/specification.rb', line 742

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"



231
232
233
 
# File 'lib/rubygems/specification.rb', line 231

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'



220
221
222
 
# File 'lib/rubygems/specification.rb', line 220

def version
  @version
end

Class Method Details

._all ⇒ Object

:nodoc:



744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/rubygems/specification.rb', line 744

def self._all # :nodoc:
  unless defined?(@@all) && @@all
    @@all = stubs.map(&:to_spec)

    # After a reset, make sure already loaded specs
    # are still marked as activated.
    specs = {}
    Gem.loaded_specs.each_value{|s| specs[s] = true}
    @@all.each{|s| s.activated = true if specs[s]}
  end
  @@all
end

._clear_load_cache ⇒ Object

:nodoc:



757
758
759
 
# File 'lib/rubygems/specification.rb', line 757

def self._clear_load_cache # :nodoc:
  LOAD_CACHE.clear
end

._latest_specs(specs, prerelease = false) ⇒ Object

:nodoc:



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/rubygems/specification.rb', line 1129

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



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
1353
1354
1355
1356
1357
1358
1359
 
# File 'lib/rubygems/specification.rb', line 1308

def self._load(str)
  Gem.load_yaml

  array = Marshal.load str

  spec = Gem::Specification.new
  spec.instance_variable_set :@specification_version, array[1]

  current_version = CURRENT_SPECIFICATION_VERSION

  field_count = if spec.specification_version > current_version
                  spec.instance_variable_set :@specification_version,
                                             current_version
                  MARSHAL_FIELDS[current_version]
                else
                  MARSHAL_FIELDS[spec.specification_version]
                end

  if array.size < field_count
    raise TypeError, "invalid Gem::Specification format #{array.inspect}"
  end

  # Cleanup any YAML::PrivateType. They only show up for an old bug
  # where nil => null, so just convert them to nil based on the type.

  array.map! { |e| e.kind_of?(YAML::PrivateType) ? nil : e }

  spec.instance_variable_set :@rubygems_version,          array[0]
  # spec version
  spec.instance_variable_set :@name,                      array[2]
  spec.instance_variable_set :@version,                   array[3]
  spec.date =                                             array[4]
  spec.instance_variable_set :@summary,                   array[5]
  spec.instance_variable_set :@required_ruby_version,     array[6]
  spec.instance_variable_set :@required_rubygems_version, array[7]
  spec.instance_variable_set :@original_platform,         array[8]
  spec.instance_variable_set :@dependencies,              array[9]
  # offset due to rubyforge_project removal
  spec.instance_variable_set :@email,                     array[11]
  spec.instance_variable_set :@authors,                   array[12]
  spec.instance_variable_set :@description,               array[13]
  spec.instance_variable_set :@homepage,                  array[14]
  spec.instance_variable_set :@has_rdoc,                  array[15]
  spec.instance_variable_set :@new_platform,              array[16]
  spec.instance_variable_set :@platform,                  array[16].to_s
  spec.instance_variable_set :@license,                   array[17]
  spec.instance_variable_set :@metadata,                  array[18]
  spec.instance_variable_set :@loaded,                    false
  spec.instance_variable_set :@activated,                 false

  spec
end

._resort!(specs) ⇒ Object

:nodoc:



852
853
854
855
856
857
858
 
# File 'lib/rubygems/specification.rb', line 852

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.



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/rubygems/specification.rb', line 875

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.



900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/rubygems/specification.rb', line 900

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.



920
921
922
923
924
 
# File 'lib/rubygems/specification.rb', line 920

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



938
939
940
941
 
# File 'lib/rubygems/specification.rb', line 938

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.



946
947
948
 
# File 'lib/rubygems/specification.rb', line 946

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…



955
956
957
 
# File 'lib/rubygems/specification.rb', line 955

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…



964
965
966
 
# File 'lib/rubygems/specification.rb', line 964

def self.attribute_names
  @@attributes.dup
end

.dirs ⇒ Object

Return the directories that Specification uses to find specs.



971
972
973
974
975
 
# File 'lib/rubygems/specification.rb', line 971

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.



981
982
983
984
985
 
# File 'lib/rubygems/specification.rb', line 981

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.



993
994
995
996
997
998
999
 
# File 'lib/rubygems/specification.rb', line 993

def self.each
  return enum_for(:each) unless block_given?

  self._all.each do |x|
    yield x
  end
end

.each_gemspec(dirs) ⇒ Object

:nodoc:



761
762
763
764
765
766
767
 
# File 'lib/rubygems/specification.rb', line 761

def self.each_gemspec(dirs) # :nodoc:
  dirs.each do |dir|
    Gem::Util.glob_files_in_dir("*.gemspec", dir).each do |path|
      yield path.untaint
    end
  end
end

.each_spec(dirs) ⇒ Object

:nodoc:



809
810
811
812
813
814
 
# File 'lib/rubygems/specification.rb', line 809

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 



1056
1057
1058
1059
1060
1061
 
# File 'lib/rubygems/specification.rb', line 1056

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_full_name(full_name) ⇒ Object

Returns every spec that has the given full_name



1015
1016
1017
 
# File 'lib/rubygems/specification.rb', line 1015

def self.find_all_by_full_name(full_name)
  stubs.select {|s| s.full_name == full_name }.map(&:to_spec)
end

.find_all_by_name(name, *requirements) ⇒ Object

Returns every spec that matches name and optional requirements.



1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/rubygems/specification.rb', line 1004

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
1041
 
# 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|
    next unless Gem::BundlerVersionFinder.compatible?(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.



1066
1067
1068
1069
1070
1071
 
# File 'lib/rubygems/specification.rb', line 1066

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.



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/rubygems/specification.rb', line 1077

def self.find_in_unresolved_tree(path)
  specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten

  specs.each do |spec|
    spec.traverse do |from_spec, dep, to_spec, trail|
      if to_spec.has_conflicts? || to_spec.conficts_when_loaded_with?(trail)
        :next
      else
        return trail.reverse if to_spec.contains_requirable_file? path
      end
    end
  end

  []
end

.find_inactive_by_path(path) ⇒ Object

Return the best specification that contains the file matching path amongst the specs that are not activated.



1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/rubygems/specification.rb', line 1047

def self.find_inactive_by_path(path)
  stub = stubs.find { |s|
    next if s.activated?
    next unless Gem::BundlerVersionFinder.compatible?(s)
    s.contains_requirable_file? path
  }
  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.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/rubygems/specification.rb', line 1101

def self.from_yaml(input)
  Gem.load_yaml

  input = normalize_yaml_input input
  spec = Gem::SafeYAML.safe_load input

  if spec && spec.class == FalseClass
    raise Gem::EndOfYAMLException
  end

  unless Gem::Specification === spec
    raise Gem::Exception, "YAML data doesn't evaluate to gem specification"
  end

  spec.specification_version ||= NONEXISTENT_SPECIFICATION_VERSION
  spec.reset_nil_attributes_to_default

  spec
end

.latest_specs(prerelease = false) ⇒ Object

Return the latest specs, optionally including prerelease specs if prerelease is true.



1125
1126
1127
 
# File 'lib/rubygems/specification.rb', line 1125

def self.latest_specs(prerelease = false)
  _latest_specs Gem::Specification._all, prerelease
end

.load(file) ⇒ Object

Loads Ruby format gemspec from file.



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
 
# File 'lib/rubygems/specification.rb', line 1149

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 = File.read file, :mode => 'r:UTF-8:-'

  code.untaint

  begin
    _spec = eval code, binding, file

    if Gem::Specification === _spec
      _spec.loaded_from = File.expand_path 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.



863
864
865
866
867
868
869
 
# File 'lib/rubygems/specification.rb', line 863

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



1184
1185
1186
 
# File 'lib/rubygems/specification.rb', line 1184

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



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/rubygems/specification.rb', line 1191

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.



1209
1210
1211
 
# File 'lib/rubygems/specification.rb', line 1209

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.



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/rubygems/specification.rb', line 1220

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.



1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/rubygems/specification.rb', line 1245

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?

Returns:

  • (Boolean) 


1256
1257
1258
 
# File 'lib/rubygems/specification.rb', line 1256

def self.required_attribute?(name)
  @@required_attributes.include? name.to_sym
end

.required_attributes ⇒ Object

Required specification attributes



1263
1264
1265
 
# File 'lib/rubygems/specification.rb', line 1263

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.



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
 
# File 'lib/rubygems/specification.rb', line 1271

def self.reset
  @@dirs = nil
  Gem.pre_reset_hooks.each { |hook| hook.call }
  @@all = nil
  @@stubs = nil
  @@stubs_by_name = {}
  @@spec_with_requirable_file          = {}
  @@active_stub_with_requirable_file   = {}
  _clear_load_cache
  unresolved = unresolved_deps
  unless unresolved.empty?
    w = "W" + "ARN"
    warn "#{w}: Unresolved or ambigious specs during Gem::Specification.reset:"
    unresolved.values.each do |dep|
      warn "      #{dep}"

      versions = find_all_by_name(dep.name)
      unless versions.empty?
        warn "      Available/installed versions of this gem:"
        versions.each { |s| warn "      - #{s.version}" }
      end
    end
    warn "#{w}: Clearing out unresolved specs. Try 'gem cleanup <gem>'"
    warn "Please report a bug if this causes problems."
    unresolved.clear
  end
  Gem.post_reset_hooks.each { |hook| hook.call }
end

.stubs ⇒ Object

Returns a Gem::StubSpecification for every installed gem



819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/rubygems/specification.rb', line 819

def self.stubs
  @@stubs ||= begin
    pattern = "*.gemspec"
    stubs = Gem.loaded_specs.values + default_stubs(pattern) + installed_stubs(dirs, pattern)
    stubs = uniq_by(stubs) { |stub| stub.full_name }

    _resort!(stubs)
    @@stubs_by_name = stubs.select { |s| Gem::Platform.match s.platform }.group_by(&:name)
    stubs
  end
end

.stubs_for(name) ⇒ Object

Returns a Gem::StubSpecification for installed gem named name only returns stubs that match Gem.platforms



837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/rubygems/specification.rb', line 837

def self.stubs_for(name)
  if @@stubs
    @@stubs_by_name[name] || []
  else
    pattern = "#{name}-*.gemspec"
    stubs = Gem.loaded_specs.values + default_stubs(pattern) +
      installed_stubs(dirs, pattern).select { |s| Gem::Platform.match s.platform }
    stubs = uniq_by(stubs) { |stub| stub.full_name }.group_by(&:name)
    stubs.each_value { |v| _resort!(v) }

    @@stubs_by_name.merge! stubs
    @@stubs_by_name[name] ||= EMPTY
  end
end

.unresolved_deps ⇒ Object

DOC: This method needs documented or nodoc’d



1301
1302
1303
 
# File 'lib/rubygems/specification.rb', line 1301

def self.unresolved_deps
  @unresolved_deps ||= Hash.new { |h, n| h[n] = Gem::Dependency.new n }
end

Instance Method Details

#<=>(other) ⇒ Object

:nodoc:



1361
1362
1363
 
# File 'lib/rubygems/specification.rb', line 1361

def <=>(other) # :nodoc:
  sort_obj <=> other.sort_obj
end

#==(other) ⇒ Object

:nodoc:



1365
1366
1367
1368
1369
1370
 
# File 'lib/rubygems/specification.rb', line 1365

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)



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
 
# File 'lib/rubygems/specification.rb', line 1378

def _dump(limit)
  Marshal.dump [
    @rubygems_version,
    @specification_version,
    @name,
    @version,
    date,
    @summary,
    @required_ruby_version,
    @required_rubygems_version,
    @original_platform,
    @dependencies,
    '', # rubyforge_project
    @email,
    @authors,
    @description,
    @homepage,
    true, # has_rdoc
    @new_platform,
    @licenses,
    @metadata
  ]
end

#abbreviate ⇒ Object

Abbreviate the spec for downloading. Abbreviated specs are only used for searching, downloading and related activities and do not need deployment specific information (e.g. list of files). So we abbreviate the spec, making it much smaller for quicker downloads.



1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/rubygems/specification.rb', line 1465

def abbreviate
  self.files = []
  self.test_files = []
  self.rdoc_options = []
  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.



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/rubygems/specification.rb', line 1408

def activate
  other = Gem.loaded_specs[self.name]
  if other
    check_version_conflict other
    return false
  end

  raise_if_conflicts

  activate_dependencies
  add_self_to_load_path

  Gem.loaded_specs[self.name] = self
  @activated = true
  @loaded = true

  return true
end

#activate_dependencies ⇒ Object

Activate all unambiguously resolved runtime dependencies of this spec. Add any ambiguous dependencies to the unresolved list to be resolved later, as needed.



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/rubygems/specification.rb', line 1432

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
      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



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/rubygems/specification.rb', line 1507

def add_bindir(executables)
  return nil if executables.nil?

  if @bindir
    Array(executables).map { |e| File.join(@bindir, e) }
  else
    executables
  end
rescue
  return nil
end

#add_development_dependency(gem, *requirements) ⇒ Object

Adds a development dependency named gem with requirements to this gem.

Usage:

spec.add_development_dependency 'example', '~> 1.1', '>= 1.1.4'

Development dependencies aren’t installed by default and aren’t activated when a gem is required.



546
547
548
 
# File 'lib/rubygems/specification.rb', line 546

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'



557
558
559
 
# File 'lib/rubygems/specification.rb', line 557

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.



1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/rubygems/specification.rb', line 1546

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
    # 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



1566
1567
1568
 
# File 'lib/rubygems/specification.rb', line 1566

def author
  val = authors and val.first
end

#author=(o) ⇒ Object

Singular (alternative) writer for #authors

Usage:

spec.author = 'John Jones'



407
408
409
 
# File 'lib/rubygems/specification.rb', line 407

def author=(o)
  self.authors = [o]
end

#authors ⇒ Object

The list of author names who wrote this gem.

spec.authors = ['Chad Fowler', 'Jim Weirich', 'Rich Kilmer']



1575
1576
1577
 
# File 'lib/rubygems/specification.rb', line 1575

def authors
  @authors ||= []
end

#authors=(value) ⇒ Object

A list of authors for this gem.

Alternatively, a single author can be specified by assigning a string to ‘spec.author`

Usage:

spec.authors = ['John Jones', 'Mary Smith']



276
277
278
 
# File 'lib/rubygems/specification.rb', line 276

def authors=(value)
  @authors = Array(value).flatten.grep(String)
end

#base_dir ⇒ Object 



2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/rubygems/specification.rb', line 2092

def base_dir
  return Gem.dir unless loaded_from
  @base_dir ||= if default_gem?
                  File.dirname File.dirname File.dirname loaded_from
                else
                  File.dirname File.dirname loaded_from
                end
end

#bin_dir ⇒ Object

Returns the full path to installed gem’s bin directory.

NOTE: do not confuse this with bindir, which is just ‘bin’, not a full path.



1585
1586
1587
 
# File 'lib/rubygems/specification.rb', line 1585

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.



1592
1593
1594
 
# File 'lib/rubygems/specification.rb', line 1592

def bin_file(name)
  File.join bin_dir, name
end

#build_args ⇒ Object

Returns the build_args used to install the gem



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'lib/rubygems/specification.rb', line 1599

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.



1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/rubygems/specification.rb', line 1614

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



1646
1647
1648
 
# File 'lib/rubygems/specification.rb', line 1646

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



1654
1655
1656
 
# File 'lib/rubygems/specification.rb', line 1654

def build_info_file
  File.join build_info_dir, "#{full_name}.info"
end

#cache_dir ⇒ Object

Returns the full path to the cache directory containing this spec’s cached gem.



1662
1663
1664
 
# File 'lib/rubygems/specification.rb', line 1662

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.



1669
1670
1671
 
# File 'lib/rubygems/specification.rb', line 1669

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.

Returns:

  • (Boolean) 


1692
1693
1694
1695
1696
1697
 
# File 'lib/rubygems/specification.rb', line 1692

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.



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
 
# File 'lib/rubygems/specification.rb', line 1676

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
  }
  env_req = Gem.env_requirement(name)
  (conflicts[self] ||= []) << env_req unless env_req.satisfied_by? version
  conflicts
end

#date ⇒ Object

The date this gem was created.

If SOURCE_DATE_EPOCH is set as an environment variable, use that to support reproducible builds; otherwise, default to the current UTC date.

Details on SOURCE_DATE_EPOCH: reproducible-builds.org/specs/source-date-epoch/



1722
1723
1724
 
# File 'lib/rubygems/specification.rb', line 1722

def date
  @date ||= ENV["SOURCE_DATE_EPOCH"] ? Time.utc(*Time.at(ENV["SOURCE_DATE_EPOCH"].to_i).utc.to_a[3..5].reverse) : TODAY
end

#date=(date) ⇒ Object

The date this gem was created

DO NOT set this, it is set automatically when the gem is packaged.



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
 
# File 'lib/rubygems/specification.rb', line 1742

def date=(date)
  # We want to end up with a Time object with one-day resolution.
  # This is the cleanest, most-readable, faster-than-using-Date
  # way to do it.
  @date = case date
          when String then
            if DateTimeFormat =~ date
              Time.utc($1.to_i, $2.to_i, $3.to_i)

            # Workaround for where the date format output from psych isn't
            # parsed as a Time object by syck and thus comes through as a
            # string.
            elsif /\A(\d{4})-(\d{2})-(\d{2}) \d{2}:\d{2}:\d{2}\.\d+?Z\z/ =~ date
              Time.utc($1.to_i, $2.to_i, $3.to_i)
            else
              raise(Gem::InvalidSpecificationException,
                    "invalid date format in specification: #{date.inspect}")
            end
          when Time, DateLike then
            Time.utc(date.year, date.month, date.day)
          else
            TODAY
          end
end

#default_value(name) ⇒ Object

The default value for specification attribute name



1788
1789
1790
 
# File 'lib/rubygems/specification.rb', line 1788

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.



1798
1799
1800
 
# File 'lib/rubygems/specification.rb', line 1798

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]]



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'lib/rubygems/specification.rb', line 1808

def dependent_gems
  out = []
  Gem::Specification.each do |spec|
    spec.dependencies.each do |dep|
      if self.satisfies_requirement?(dep)
        sats = []
        find_all_satisfiers(dep) do |sat|
          sats << sat
        end
        out << [spec, dep, sats]
      end
    end
  end
  out
end

#dependent_specs ⇒ Object

Returns all specs that matches this spec’s runtime dependencies.



1827
1828
1829
 
# File 'lib/rubygems/specification.rb', line 1827

def dependent_specs
  runtime_dependencies.map { |dep| dep.to_specs }.flatten
end

#development_dependencies ⇒ Object

List of dependencies that are used for development



1841
1842
1843
 
# File 'lib/rubygems/specification.rb', line 1841

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"



1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'lib/rubygems/specification.rb', line 1853

def doc_dir(type = nil)
  @doc_dir ||= File.join base_dir, 'doc', full_name

  if type
    File.join @doc_dir, type
  else
    @doc_dir
  end
end

#encode_with(coder) ⇒ Object

:nodoc:



1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'lib/rubygems/specification.rb', line 1863

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:

Returns:

  • (Boolean) 


1884
1885
1886
 
# File 'lib/rubygems/specification.rb', line 1884

def eql?(other) # :nodoc:
  self.class === other && same_attributes?(other)
end

#executable ⇒ Object

Singular accessor for #executables



1891
1892
1893
 
# File 'lib/rubygems/specification.rb', line 1891

def executable
  val = executables and val.first
end

#executable=(o) ⇒ Object

Singular accessor for #executables



1898
1899
1900
 
# File 'lib/rubygems/specification.rb', line 1898

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'



576
577
578
 
# File 'lib/rubygems/specification.rb', line 576

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.



1906
1907
1908
1909
 
# File 'lib/rubygems/specification.rb', line 1906

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.



593
594
595
 
# File 'lib/rubygems/specification.rb', line 593

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.



1915
1916
1917
1918
 
# File 'lib/rubygems/specification.rb', line 1915

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']



609
610
611
 
# File 'lib/rubygems/specification.rb', line 609

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.



1924
1925
1926
1927
 
# File 'lib/rubygems/specification.rb', line 1924

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"



1934
1935
1936
 
# File 'lib/rubygems/specification.rb', line 1934

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" }



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rubygems/specification.rb', line 255

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.



1941
1942
1943
 
# File 'lib/rubygems/specification.rb', line 1941

def files=(files)
  @files = Array files
end

#for_cache ⇒ Object

Creates a duplicate spec without large blobs that aren’t used at runtime.



1959
1960
1961
1962
1963
1964
1965
1966
 
# File 'lib/rubygems/specification.rb', line 1959

def for_cache
  spec = dup

  spec.files = nil
  spec.test_files = nil

  spec
end

#full_name ⇒ Object 



1968
1969
1970
 
# File 'lib/rubygems/specification.rb', line 1968

def full_name
  @full_name ||= super
end

#gem_dir ⇒ Object

Work around bundler removing my methods



1975
1976
1977
 
# File 'lib/rubygems/specification.rb', line 1975

def gem_dir # :nodoc:
  super
end

#gems_dir ⇒ Object 



1979
1980
1981
1982
 
# File 'lib/rubygems/specification.rb', line 1979

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.

Returns:

  • (Boolean) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
 
# File 'lib/rubygems/specification.rb', line 1702

def has_conflicts?
  return true unless Gem.env_requirement(name).satisfied_by?(version)
  self.dependencies.any? { |dep|
    if dep.runtime?
      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.



1989
1990
1991
 
# File 'lib/rubygems/specification.rb', line 1989

def has_rdoc # :nodoc:
  true
end

#has_rdoc=(ignored) ⇒ Object

Deprecated and ignored.

Formerly used to indicate this gem was RDoc-capable.



1999
2000
2001
 
# File 'lib/rubygems/specification.rb', line 1999

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

Returns:

  • (Boolean) 


2010
2011
2012
 
# File 'lib/rubygems/specification.rb', line 2010

def has_unit_tests? # :nodoc:
  not test_files.empty?
end

#hash ⇒ Object

:startdoc:



2018
2019
2020
 
# File 'lib/rubygems/specification.rb', line 2018

def hash # :nodoc:
  name.hash ^ version.hash
end

#init_with(coder) ⇒ Object

:nodoc:



2022
2023
2024
2025
 
# File 'lib/rubygems/specification.rb', line 2022

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.



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
 
# File 'lib/rubygems/specification.rb', line 2070

def initialize_copy(other_spec)
  self.class.array_attributes.each do |name|
    name = :"@#{name}"
    next unless other_spec.instance_variable_defined? name

    begin
      val = other_spec.instance_variable_get(name)
      if val
        instance_variable_set name, val.dup
      elsif Gem.configuration.really_verbose
        warn "WARNING: #{full_name} has an invalid nil value for #{name}"
      end
    rescue TypeError
      e = Gem::FormatException.new \
        "#{full_name} has an invalid value for #{name}"

      e.file_path = loaded_from
      raise e
    end
  end
end

#inspect ⇒ Object

:nodoc:



2112
2113
2114
2115
2116
2117
2118
 
# File 'lib/rubygems/specification.rb', line 2112

def inspect # :nodoc:
  if $DEBUG
    super
  else
    "#{super[0..-2]} #{full_name}>"
  end
end

#installed_by_version ⇒ Object

The version of RubyGems that installed this gem. Returns Gem::Version.new(0) for gems installed by versions earlier than RubyGems 2.2.0.



618
619
620
 
# File 'lib/rubygems/specification.rb', line 618

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.



626
627
628
 
# File 'lib/rubygems/specification.rb', line 626

def installed_by_version=(version) # :nodoc:
  @installed_by_version = Gem::Version.new version
end

#internal_init ⇒ Object

:nodoc:



2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/rubygems/specification.rb', line 2147

def internal_init # :nodoc:
  super
  @bin_dir       = nil
  @cache_dir     = nil
  @cache_file    = nil
  @doc_dir       = nil
  @ri_dir        = nil
  @spec_dir      = nil
  @spec_file     = nil
end

#keep_only_files_and_directories ⇒ Object 



2657
2658
2659
2660
2661
2662
2663
 
# File 'lib/rubygems/specification.rb', line 2657

def keep_only_files_and_directories
  @executables.delete_if      { |x| File.directory?(File.join(@bindir, x)) }
  @extensions.delete_if       { |x| File.directory?(x) && !File.symlink?(x) }
  @extra_rdoc_files.delete_if { |x| File.directory?(x) && !File.symlink?(x) }
  @files.delete_if            { |x| File.directory?(x) && !File.symlink?(x) }
  @test_files.delete_if       { |x| File.directory?(x) && !File.symlink?(x) }
end

#lib_files ⇒ Object

Files in the Gem under one of the require_paths



2123
2124
2125
2126
2127
2128
2129
 
# File 'lib/rubygems/specification.rb', line 2123

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



2134
2135
2136
 
# File 'lib/rubygems/specification.rb', line 2134

def license
  licenses.first
end

#license=(o) ⇒ Object

The license for this gem.

The license must be no more than 64 characters.

This should just be the name of your license. The full text of the license should be inside of the gem (at the top level) when you build it.

The simplest way, is to specify the standard SPDX ID spdx.org/licenses/ for the license. Ideally you should pick one that is OSI (Open Source Initiative) opensource.org/licenses/alphabetical approved.

The most commonly used OSI approved licenses are MIT and Apache-2.0. GitHub also provides a license picker at choosealicense.com/.

You should specify a license for your gem so that people know how they are permitted to use it, and any restrictions you’re placing on it. Not specifying a license means all rights are reserved; others have no rights to use the code for any purpose.

You can set multiple licenses with #licenses=

Usage:

spec.license = 'MIT'



344
345
346
 
# File 'lib/rubygems/specification.rb', line 344

def license=(o)
  self.licenses = [o]
end

#licenses ⇒ Object

Plural accessor for setting licenses

See #license= for details



2143
2144
2145
 
# File 'lib/rubygems/specification.rb', line 2143

def licenses
  @licenses ||= []
end

#licenses=(licenses) ⇒ Object

The license(s) for the library.

Each license must be a short name, no more than 64 characters.

This should just be the name of your license. The full text of the license should be inside of the gem when you build it.

See #license= for more discussion

Usage:

spec.licenses = ['MIT', 'GPL-2.0']



361
362
363
 
# File 'lib/rubygems/specification.rb', line 361

def licenses=(licenses)
  @licenses = Array licenses
end

#mark_version ⇒ Object

Sets the rubygems_version to the current RubyGems version.



2161
2162
2163
 
# File 'lib/rubygems/specification.rb', line 2161

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

Returns:

  • (Boolean) 


2181
2182
2183
2184
2185
2186
2187
2188
 
# File 'lib/rubygems/specification.rb', line 2181

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



2213
2214
2215
 
# File 'lib/rubygems/specification.rb', line 2213

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.



2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
 
# File 'lib/rubygems/specification.rb', line 2196

def normalize
  if defined?(@extra_rdoc_files) and @extra_rdoc_files
    @extra_rdoc_files.uniq!
    @files ||= []
    @files.concat(@extra_rdoc_files)
  end

  @files            = @files.uniq if @files
  @extensions       = @extensions.uniq if @extensions
  @test_files       = @test_files.uniq if @test_files
  @executables      = @executables.uniq if @executables
  @extra_rdoc_files = @extra_rdoc_files.uniq if @extra_rdoc_files
end

#original_name ⇒ Object

Returns the full name (name-version) of this gemspec using the original platform. For use with legacy gems.



2221
2222
2223
2224
2225
2226
2227
 
# File 'lib/rubygems/specification.rb', line 2221

def original_name # :nodoc:
  if platform == Gem::Platform::RUBY or platform.nil?
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{@original_platform}"
  end
end

#platform ⇒ Object

The platform this gem runs on. See Gem::Platform for details.



2239
2240
2241
 
# File 'lib/rubygems/specification.rb', line 2239

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



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/rubygems/specification.rb', line 458

def platform=(platform)
  if @original_platform.nil? or
     @original_platform == Gem::Platform::RUBY
    @original_platform = platform
  end

  case platform
  when Gem::Platform::CURRENT then
    @new_platform = Gem::Platform.local
    @original_platform = @new_platform.to_s

  when Gem::Platform then
    @new_platform = platform

  # legacy constants
  when nil, Gem::Platform::RUBY then
    @new_platform = Gem::Platform::RUBY
  when 'mswin32' then # was Gem::Platform::WIN32
    @new_platform = Gem::Platform.new 'x86-mswin32'
  when 'i586-linux' then # was Gem::Platform::LINUX_586
    @new_platform = Gem::Platform.new 'x86-linux'
  when 'powerpc-darwin' then # was Gem::Platform::DARWIN
    @new_platform = Gem::Platform.new 'ppc-darwin'
  else
    @new_platform = Gem::Platform.new platform
  end

  @platform = @new_platform.to_s

  invalidate_memoized_attributes

  @new_platform
end

#pretty_print(q) ⇒ Object

:nodoc:



2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
 
# File 'lib/rubygems/specification.rb', line 2243

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

        q.text "s.#{attr_name} = "

        if attr_name == :date
          current_value = current_value.utc

          q.text "Time.utc(#{current_value.year}, #{current_value.month}, #{current_value.day})"
        else
          q.pp current_value
        end

        q.breakable
      end
    end
  end
end

#raise_if_conflicts ⇒ Object

Check the spec for possible conflicts and freak out if there are any.



2296
2297
2298
2299
2300
 
# File 'lib/rubygems/specification.rb', line 2296

def raise_if_conflicts # :nodoc:
  if has_conflicts?
    raise Gem::ConflictError.new self, conflicts
  end
end

#raw_require_paths ⇒ Object

:nodoc:



2741
2742
2743
 
# File 'lib/rubygems/specification.rb', line 2741

def raw_require_paths # :nodoc:
  @require_paths
end

#rdoc_options ⇒ Object

Specifies the rdoc options to be used when generating API documentation.

Usage:

spec.rdoc_options << '--title' << 'Rake -- Ruby Make' <<
  '--main' << 'README' <<
  '--line-numbers'



639
640
641
 
# File 'lib/rubygems/specification.rb', line 639

def rdoc_options
  @rdoc_options ||= []
end

#rdoc_options=(options) ⇒ Object

Sets rdoc_options to value, ensuring it is an array. Don’t use this, push onto the array instead.



2306
2307
2308
2309
 
# File 'lib/rubygems/specification.rb', line 2306

def rdoc_options=(options)
  # TODO: warn about setting instead of pushing
  @rdoc_options = Array options
end

#require_path ⇒ Object

Singular accessor for #require_paths



2314
2315
2316
 
# File 'lib/rubygems/specification.rb', line 2314

def require_path
  val = require_paths and val.first
end

#require_path=(path) ⇒ Object

Singular accessor for #require_paths



2321
2322
2323
 
# File 'lib/rubygems/specification.rb', line 2321

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 = ['.']



509
510
511
 
# File 'lib/rubygems/specification.rb', line 509

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'



684
685
686
 
# File 'lib/rubygems/specification.rb', line 684

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.



2329
2330
2331
2332
 
# File 'lib/rubygems/specification.rb', line 2329

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



2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
 
# File 'lib/rubygems/specification.rb', line 2722

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:

Returns:

  • (Boolean) 


2334
2335
2336
 
# File 'lib/rubygems/specification.rb', line 2334

def respond_to_missing?(m, include_private = false) # :nodoc:
  false
end

#ri_dir ⇒ Object

Returns the full path to this spec’s ri directory.



2341
2342
2343
 
# File 'lib/rubygems/specification.rb', line 2341

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.



2374
2375
2376
 
# File 'lib/rubygems/specification.rb', line 2374

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.



1478
1479
1480
1481
1482
1483
 
# File 'lib/rubygems/specification.rb', line 1478

def sanitize
  self.summary              = sanitize_string(summary)
  self.description          = sanitize_string(description)
  self.post_install_message = sanitize_string(post_install_message)
  self.authors              = authors.collect { |a| sanitize_string(a) }
end

#sanitize_string(string) ⇒ Object

Sanitize a single string.



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/rubygems/specification.rb', line 1488

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.

Returns:

  • (Boolean) 


2390
2391
2392
2393
 
# File 'lib/rubygems/specification.rb', line 2390

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.



2398
2399
2400
 
# File 'lib/rubygems/specification.rb', line 2398

def sort_obj
  [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1]
end

#source ⇒ Object

Used by Gem::Resolver to order Gem::Specification objects



2405
2406
2407
 
# File 'lib/rubygems/specification.rb', line 2405

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



2413
2414
2415
 
# File 'lib/rubygems/specification.rb', line 2413

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



2421
2422
2423
 
# File 'lib/rubygems/specification.rb', line 2421

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"



2430
2431
2432
 
# File 'lib/rubygems/specification.rb', line 2430

def spec_name
  "#{full_name}.gemspec"
end

#stubbed? ⇒ Boolean

Returns:

  • (Boolean) 


2700
2701
2702
 
# File 'lib/rubygems/specification.rb', line 2700

def stubbed?
  false
end

#test_file ⇒ Object

Singular accessor for #test_files



2445
2446
2447
 
# File 'lib/rubygems/specification.rb', line 2445

def test_file # :nodoc:
  val = test_files and val.first
end

#test_file=(file) ⇒ Object

Singular mutator for #test_files



2452
2453
2454
 
# File 'lib/rubygems/specification.rb', line 2452

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.



2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
 
# File 'lib/rubygems/specification.rb', line 2460

def test_files # :nodoc:
  # Handle the possibility that we have @test_suite_file but not
  # @test_files.  This will happen when an old gem is loaded via
  # YAML.
  if defined? @test_suite_file
    @test_files = [@test_suite_file].flatten
    @test_suite_file = nil
  end
  if defined?(@test_files) and @test_files
    @test_files
  else
    @test_files = []
  end
end

#test_files=(files) ⇒ Object

A collection of unit test files. They will be loaded as unit tests when the user requests a gem to be unit tested.

Usage:

spec.test_files = Dir.glob('test/tc_*.rb')
spec.test_files = ['tests/test-suite.rb']



696
697
698
 
# File 'lib/rubygems/specification.rb', line 696

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.



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
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
 
# File 'lib/rubygems/specification.rb', line 2480

def to_ruby
  mark_version
  result = []
  result << "# -*- encoding: utf-8 -*-"
  result << "#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{raw_require_paths.join("\0")}"
  result << "#{Gem::StubSpecification::PREFIX}#{extensions.join "\0"}" unless
    extensions.empty?
  result << nil
  result << "Gem::Specification.new do |s|"

  result << "  s.name = #{ruby_code name}"
  result << "  s.version = #{ruby_code version}"
  unless platform.nil? or platform == Gem::Platform::RUBY
    result << "  s.platform = #{ruby_code original_platform}"
  end
  result << ""
  result << "  s.required_rubygems_version = #{ruby_code required_rubygems_version} if s.respond_to? :required_rubygems_version="

  if metadata and !metadata.empty?
    result << "  s.metadata = #{ruby_code metadata} if s.respond_to? :metadata="
  end
  result << "  s.require_paths = #{ruby_code raw_require_paths}"

  handled = [
    :dependencies,
    :name,
    :platform,
    :require_paths,
    :required_rubygems_version,
    :specification_version,
    :version,
    :has_rdoc,
    :default_executable,
    :metadata
  ]

  @@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
      result << "  s.#{attr_name} = #{ruby_code current_value}"
    end
  end

  if @installed_by_version
    result << nil
    result << "  s.installed_by_version = \"#{Gem::VERSION}\" if s.respond_to? :installed_by_version"
  end

  unless dependencies.empty?
    result << nil
    result << "  if s.respond_to? :specification_version then"
    result << "    s.specification_version = #{specification_version}"
    result << 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.



2573
2574
2575
 
# File 'lib/rubygems/specification.rb', line 2573

def to_ruby_for_cache
  for_cache.to_ruby
end

#to_s ⇒ Object

:nodoc:



2577
2578
2579
 
# File 'lib/rubygems/specification.rb', line 2577

def to_s # :nodoc:
  "#<Gem::Specification name=#{@name} version=#{@version}>"
end

#to_spec ⇒ Object

Returns self



2584
2585
2586
 
# File 'lib/rubygems/specification.rb', line 2584

def to_spec
  self
end

#to_yaml(opts = {}) ⇒ Object

:nodoc:



2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
 
# File 'lib/rubygems/specification.rb', line 2588

def to_yaml(opts = {}) # :nodoc:
  Gem.load_yaml

  # Because the user can switch the YAML engine behind our
  # back, we have to check again here to make sure that our
  # psych code was properly loaded, and load it if not.
  unless Gem.const_defined?(:NoAliasYAMLTree)
    require 'rubygems/psych_tree'
  end

  builder = Gem::NoAliasYAMLTree.create
  builder << self
  ast = builder.tree

  io = StringIO.new
  io.set_encoding Encoding::UTF_8

  Psych::Visitors::Emitter.new(io).accept(ast)

  io.string.gsub(/ !!null \n/, " \n")
end

#traverse(trail = [], visited = {}, &block) ⇒ Object

Recursively walk dependencies of this spec, executing the block for each hop.



2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
 
# File 'lib/rubygems/specification.rb', line 2614

def traverse(trail = [], visited = {}, &block)
  trail.push(self)
  begin
    dependencies.each do |dep|
      next unless dep.runtime?
      dep.to_specs.each do |dep_spec|
        next if visited.has_key?(dep_spec)
        visited[dep_spec] = true
        trail.push(dep_spec)
        begin
          result = block[self, dep, dep_spec, trail]
        ensure
          trail.pop
        end
        unless result == :next
          spec_name = dep_spec.name
          dep_spec.traverse(trail, visited, &block) unless
            trail.any? { |s| s.name == spec_name }
        end
      end
    end
  ensure
    trail.pop
  end
end

#validate(packaging = true, strict = false) ⇒ Object

Checks that the specification contains all required fields, and does a very basic sanity check.

Raises InvalidSpecificationException if the spec does not pass the checks..



2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'lib/rubygems/specification.rb', line 2647

def validate(packaging = true, strict = false)
  require 'rubygems/user_interaction'
  extend Gem::UserInteraction
  normalize

  validation_policy = Gem::SpecificationPolicy.new(self)
  validation_policy.packaging = packaging
  validation_policy.validate(strict)
end

#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.



2673
2674
2675
 
# File 'lib/rubygems/specification.rb', line 2673

def validate_dependencies
  Gem::SpecificationPolicy.new(self).validate_dependencies
end

#validate_metadata ⇒ Object 



2665
2666
2667
 
# File 'lib/rubygems/specification.rb', line 2665

def validate_metadata
  Gem::SpecificationPolicy.new(self).validate_metadata
end

#validate_permissions ⇒ Object

Checks to see if the files to be packaged are world-readable.



2679
2680
2681
 
# File 'lib/rubygems/specification.rb', line 2679

def validate_permissions
  Gem::SpecificationPolicy.new(self).validate_permissions
end

#yaml_initialize(tag, vals) ⇒ Object

:nodoc:



2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
 
# File 'lib/rubygems/specification.rb', line 2704

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