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.    = { "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)
VALID_NAME_PATTERN =

:nodoc:

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

rubocop:disable Style/MutableConstant

{}
NOT_FOUND =

Sentinel object to represent “not found” stubs

Struct.new(:to_spec, :this).new
REMOVED_METHODS =

Tracking removed method calls to warn users during build time.

[:rubyforge_project=].freeze
LATEST_RUBY_WITHOUT_PATCH_VERSIONS =
Gem::Version.new("2.1")
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(&:to_s)
@@array_attributes =
@@default_value.reject {|_k,v| v != [] }.keys

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, next_rubygems_major_version, rubygems_deprecate, rubygems_deprecate_command, skip, skip=, skip_during

Methods inherited from BasicSpecification

#contains_requirable_file?, #datadir, #default_gem?, default_specifications_dir, #extensions_dir, #full_require_paths, #gem_build_complete_path, #lib_dirs_glob, #matches_for_glob, #plugins, #require_paths, #source_paths, #this, #to_fullpath

Constructor Details

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

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

Yields:

  • (_self)

Yield Parameters:



2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
# File 'lib/rubygems/specification.rb', line 2051

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

  set_nil_attributes_to_nil
  set_not_nil_attributes_to_default_values

  @new_platform = Gem::Platform::RUBY

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

  if (platform = Gem.platforms.last) && platform != Gem::Platform::RUBY && platform != Gem::Platform.local
    self.platform = platform
  end

  yield self if block_given?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *a, &b) ⇒ Object

Track removed method calls to warn about during build time. Warn about unknown attributes while loading a spec.



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
# File 'lib/rubygems/specification.rb', line 2178

def method_missing(sym, *a, &b) # :nodoc:
  if REMOVED_METHODS.include?(sym)
    removed_method_calls << sym
    return
  end

  if @specification_version > CURRENT_SPECIFICATION_VERSION &&
     sym.to_s.end_with?("=")
    warn "ignoring #{sym} loading #{full_name}" if $DEBUG
  else
    super
  end
end

Instance Attribute Details

#activatedObject Also known as: activated?

True when this gemspec has been activated. This attribute is not persisted.



733
734
735
# File 'lib/rubygems/specification.rb', line 733

def activated
  @activated
end

#autorequireObject

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

Deprecated: It is neither supported nor functional.



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

def autorequire
  @autorequire
end

#bindirObject

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

Usage:

spec.bindir = 'exe'


435
436
437
# File 'lib/rubygems/specification.rb', line 435

def bindir
  @bindir
end

#cert_chainObject

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



441
442
443
# File 'lib/rubygems/specification.rb', line 441

def cert_chain
  @cert_chain
end

#default_executableObject

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.



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
# File 'lib/rubygems/specification.rb', line 1785

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

#descriptionObject

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


309
310
311
# File 'lib/rubygems/specification.rb', line 309

def description
  @description
end

#emailObject

A contact email address (or addresses) for this gem

Usage:

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


319
320
321
# File 'lib/rubygems/specification.rb', line 319

def email
  @email
end

#homepageObject

The URL of this gem’s home page

Usage:

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


328
329
330
# File 'lib/rubygems/specification.rb', line 328

def homepage
  @homepage
end

#metadataObject

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

Metadata items have the following restrictions:

  • The metadata must be a Hash object

  • All keys and values must be Strings

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

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

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

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

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

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


412
413
414
# File 'lib/rubygems/specification.rb', line 412

def 
  @metadata
end

#nameObject

This gem’s name.

Usage:

spec.name = 'rake'


212
213
214
# File 'lib/rubygems/specification.rb', line 212

def name
  @name
end

#original_platformObject

Cruft. Use platform.



2246
2247
2248
# File 'lib/rubygems/specification.rb', line 2246

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

#post_install_messageObject

A message that gets displayed after the gem is installed.

Usage:

spec.post_install_message = "Thanks for installing!"


450
451
452
# File 'lib/rubygems/specification.rb', line 450

def post_install_message
  @post_install_message
end

#required_ruby_versionObject

The version of Ruby required by this gem

Usage:

spec.required_ruby_version = '>= 2.7.0'


293
294
295
# File 'lib/rubygems/specification.rb', line 293

def required_ruby_version
  @required_ruby_version
end

#required_rubygems_versionObject

The RubyGems version required by this gem



531
532
533
# File 'lib/rubygems/specification.rb', line 531

def required_rubygems_version
  @required_rubygems_version
end

#rubygems_versionObject

The version of RubyGems used to create this gem.

Do not set this, it is set automatically when the gem is packaged.



538
539
540
# File 'lib/rubygems/specification.rb', line 538

def rubygems_version
  @rubygems_version
end

#signing_keyObject

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



543
544
545
# File 'lib/rubygems/specification.rb', line 543

def signing_key
  @signing_key
end

#specification_versionObject

The Gem::Specification version of this gemspec.

Do not set this, it is set automatically when the gem is packaged.



762
763
764
# File 'lib/rubygems/specification.rb', line 762

def specification_version
  @specification_version
end

#summaryObject

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"


236
237
238
# File 'lib/rubygems/specification.rb', line 236

def summary
  @summary
end

#versionObject

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'


225
226
227
# File 'lib/rubygems/specification.rb', line 225

def version
  @version
end

Class Method Details

._allObject

:nodoc:



764
765
766
# File 'lib/rubygems/specification.rb', line 764

def self._all # :nodoc:
  @@all ||= Gem.loaded_specs.values | stubs.map(&:to_spec)
end

._latest_specs(specs, prerelease = false) ⇒ Object

:nodoc:



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'lib/rubygems/specification.rb', line 1134

def self._latest_specs(specs, prerelease = false) # :nodoc:
  result = {}

  specs.reverse_each do |spec|
    unless prerelease
      next if spec.version.prerelease?
    end

    result[spec.name] = spec
  end

  result.map(&:last).flatten.sort_by(&:name)
end

._load(str) ⇒ Object

Load custom marshal format, re-initializing defaults as needed



1301
1302
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
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
# File 'lib/rubygems/specification.rb', line 1301

def self._load(str)
  Gem.load_yaml
  Gem.load_safe_marshal

  yaml_set = false
  retry_count = 0

  array = begin
    Gem::SafeMarshal.safe_load str
  rescue ArgumentError => e
    # Avoid an infinite retry loop when the argument error has nothing to do
    # with the classes not being defined.
    # 1 retry each allowed in case all 3 of
    # - YAML
    # - YAML::Syck::DefaultKey
    # - YAML::PrivateType
    # need to be defined
    raise if retry_count >= 3

    #
    # Some very old marshaled specs included references to `YAML::PrivateType`
    # and `YAML::Syck::DefaultKey` constants due to bugs in the old emitter
    # that generated them. Workaround the issue by defining the necessary
    # constants and retrying.
    #
    message = e.message
    raise unless message.include?("YAML::")

    unless Object.const_defined?(:YAML)
      Object.const_set "YAML", Psych
      yaml_set = true
    end

    if message.include?("YAML::Syck::")
      YAML.const_set "Syck", YAML unless YAML.const_defined?(:Syck)

      YAML::Syck.const_set "DefaultKey", Class.new if message.include?("YAML::Syck::DefaultKey") && !YAML::Syck.const_defined?(:DefaultKey)
    elsif message.include?("YAML::PrivateType") && !YAML.const_defined?(:PrivateType)
      YAML.const_set "PrivateType", Class.new
    end

    retry_count += 1
    retry
  ensure
    Object.__send__(:remove_const, "YAML") if yaml_set
  end

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

  current_version = CURRENT_SPECIFICATION_VERSION

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

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

  spec.instance_variable_set :@rubygems_version,          array[0]
  # spec version
  spec.instance_variable_set :@name,                      array[2]
  spec.instance_variable_set :@version,                   array[3]
  spec.date =                                             array[4]
  spec.instance_variable_set :@summary,                   array[5]
  spec.instance_variable_set :@required_ruby_version,     array[6]
  spec.instance_variable_set :@required_rubygems_version, array[7]
  spec.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:



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

def self._resort!(specs) # :nodoc:
  specs.sort! do |a, b|
    names = a.name <=> b.name
    next names if names.nonzero?
    versions = b.version <=> a.version
    next versions if versions.nonzero?
    Gem::Platform.sort_priority(b.platform)
  end
end

.add_spec(spec) ⇒ Object

Adds spec to the known specifications, keeping the collection properly sorted.



887
888
889
890
891
892
893
894
895
896
# File 'lib/rubygems/specification.rb', line 887

def self.add_spec(spec)
  return if _all.include? spec

  _all << spec
  stubs << spec
  (@@stubs_by_name[spec.name] ||= []) << spec

  _resort!(@@stubs_by_name[spec.name])
  _resort!(stubs)
end

.allObject

Returns all specifications. This method is discouraged from use. You probably want to use one of the Enumerable methods instead.



911
912
913
914
915
# File 'lib/rubygems/specification.rb', line 911

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



929
930
931
932
# File 'lib/rubygems/specification.rb', line 929

def self.all=(specs)
  @@stubs_by_name = specs.group_by(&:name)
  @@all = @@stubs = specs
end

.all_namesObject

Return full names of all specs in sorted order.



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

def self.all_names
  _all.map(&:full_name)
end

.array_attributesObject

Return the list of all array-oriented instance variables. – Not sure why we need to use so much stupid reflection in here…



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

def self.array_attributes
  @@array_attributes.dup
end

.attribute_namesObject

Return the list of all 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.attribute_names
  @@attributes.dup
end

.default_stubs(pattern = "*.gemspec") ⇒ Object

Returns a Gem::StubSpecification for default gems



827
828
829
830
831
832
833
# File 'lib/rubygems/specification.rb', line 827

def self.default_stubs(pattern = "*.gemspec")
  base_dir = Gem.default_dir
  gems_dir = File.join base_dir, "gems"
  gemspec_stubs_in(Gem.default_specifications_dir, pattern) do |path|
    Gem::StubSpecification.default_gemspec_stub(path, base_dir, gems_dir)
  end
end

.dirsObject

Return the directories that Specification uses to find specs.



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

def self.dirs
  @@dirs ||= Gem.path.collect do |dir|
    File.join dir.dup.tap(&Gem::UNTAINT), "specifications"
  end
end

.dirs=(dirs) ⇒ Object

Set the directories that Specification uses to find specs. Setting this resets the list of known specs.



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

def self.dirs=(dirs)
  reset

  @@dirs = Array(dirs).map {|dir| File.join dir, "specifications" }
end

.eachObject

Enumerate every known spec. See ::dirs= and ::add_spec to set the list of specs.



984
985
986
987
988
989
990
# File 'lib/rubygems/specification.rb', line 984

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

  _all.each do |x|
    yield x
  end
end

.each_gemspec(dirs) ⇒ Object

:nodoc:



775
776
777
778
779
780
781
# File 'lib/rubygems/specification.rb', line 775

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

.each_spec(dirs) ⇒ Object

:nodoc:



804
805
806
807
808
809
# File 'lib/rubygems/specification.rb', line 804

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



1052
1053
1054
1055
1056
1057
1058
# File 'lib/rubygems/specification.rb', line 1052

def self.find_active_stub_by_path(path)
  stub = @@active_stub_with_requirable_file[path] ||= stubs.find do |s|
    s.activated? && s.contains_requirable_file?(path)
  end || NOT_FOUND

  stub.this
end

.find_all_by_full_name(full_name) ⇒ Object

Returns every spec that has the given full_name



1006
1007
1008
# File 'lib/rubygems/specification.rb', line 1006

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.



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

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

Find the best specification matching a full_name.



1024
1025
1026
# File 'lib/rubygems/specification.rb', line 1024

def self.find_by_full_name(full_name)
  stubs.find {|s| s.full_name == full_name }&.to_spec
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.



1014
1015
1016
1017
1018
1019
1020
# File 'lib/rubygems/specification.rb', line 1014

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.



1031
1032
1033
1034
1035
1036
1037
1038
# File 'lib/rubygems/specification.rb', line 1031

def self.find_by_path(path)
  path = path.dup.freeze
  spec = @@spec_with_requirable_file[path] ||= stubs.find do |s|
    s.contains_requirable_file? path
  end || NOT_FOUND

  spec.to_spec
end

.find_in_unresolved(path) ⇒ Object

Return currently unresolved specs that contain the file matching path.



1063
1064
1065
# File 'lib/rubygems/specification.rb', line 1063

def self.find_in_unresolved(path)
  unresolved_specs.find_all {|spec| spec.contains_requirable_file? path }
end

.find_in_unresolved_tree(path) ⇒ Object

Search through all unresolved deps and sub-dependencies and return specs that contain the file matching path.



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
# File 'lib/rubygems/specification.rb', line 1071

def self.find_in_unresolved_tree(path)
  unresolved_specs.each do |spec|
    spec.traverse do |_from_spec, _dep, to_spec, trail|
      if to_spec.has_conflicts? || to_spec.conficts_when_loaded_with?(trail)
        :next
      else
        return trail.reverse if to_spec.contains_requirable_file? path
      end
    end
  end

  []
end

.find_inactive_by_path(path) ⇒ Object

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



1044
1045
1046
1047
1048
1049
1050
# File 'lib/rubygems/specification.rb', line 1044

def self.find_inactive_by_path(path)
  stub = stubs.find do |s|
    next if s.activated?
    s.contains_requirable_file? path
  end
  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
1117
# File 'lib/rubygems/specification.rb', line 1098

def self.from_yaml(input)
  Gem.load_yaml

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

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

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

  spec.specification_version ||= NONEXISTENT_SPECIFICATION_VERSION
  spec.reset_nil_attributes_to_default
  spec.flatten_require_paths

  spec
end

.latest_spec_for(name) ⇒ Object

Return the latest installed spec for gem name.



1130
1131
1132
# File 'lib/rubygems/specification.rb', line 1130

def self.latest_spec_for(name)
  latest_specs(true).find {|installed_spec| installed_spec.name == name }
end

.latest_specs(prerelease = false) ⇒ Object

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



1123
1124
1125
# File 'lib/rubygems/specification.rb', line 1123

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

.load(file) ⇒ Object

Loads Ruby format gemspec from file.



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
1181
1182
1183
1184
1185
1186
1187
1188
# File 'lib/rubygems/specification.rb', line 1151

def self.load(file)
  return unless file

  spec = @load_cache_mutex.synchronize { @load_cache[file] }
  return spec if spec

  file = file.dup.tap(&Gem::UNTAINT)
  return unless File.file?(file)

  code = Gem.open_file(file, "r:UTF-8:-", &:read)

  code.tap(&Gem::UNTAINT)

  begin
    spec = eval code, binding, file

    if Gem::Specification === spec
      spec.loaded_from = File.expand_path file.to_s
      @load_cache_mutex.synchronize do
        prev = @load_cache[file]
        if prev
          spec = prev
        else
          @load_cache[file] = spec
        end
      end
      return spec
    end

    warn "[#{file}] isn't a Gem::Specification (#{spec.class} instead)."
  rescue SignalException, SystemExit
    raise
  rescue SyntaxError, StandardError => e
    warn "Invalid gemspec in [#{file}]: #{e}"
  end

  nil
end

.load_defaultsObject

Loads the default specifications. It should be called only once.



875
876
877
878
879
880
881
# File 'lib/rubygems/specification.rb', line 875

def self.load_defaults
  each_spec([Gem.default_specifications_dir]) do |spec|
    # #load returns nil if the spec is bad, so we just ignore
    # it at this stage
    Gem.register_default_spec(spec)
  end
end

.non_nil_attributesObject

Specification attributes that must be non-nil



1193
1194
1195
# File 'lib/rubygems/specification.rb', line 1193

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



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'lib/rubygems/specification.rb', line 1200

def self.normalize_yaml_input(input)
  result = input.respond_to?(:read) ? input.read : input
  result = "--- " + result unless result.start_with?("--- ")
  result = result.dup
  result.gsub!(/ !!null \n/, " \n")
  # date: 2011-04-26 00:00:00.000000000Z
  # date: 2011-04-26 00:00:00.000000000 Z
  result.gsub!(/^(date: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+?)Z/, '\1 Z')
  result
end

.outdatedObject

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.



1218
1219
1220
# File 'lib/rubygems/specification.rb', line 1218

def self.outdated
  outdated_and_latest_version.map {|local, _| local.name }
end

.outdated_and_latest_versionObject

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.



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
# File 'lib/rubygems/specification.rb', line 1229

def self.outdated_and_latest_version
  return enum_for __method__ unless block_given?

  # TODO: maybe we should switch to rubygems' version service?
  fetcher = Gem::SpecFetcher.fetcher

  latest_specs(true).each do |local_spec|
    dependency =
      Gem::Dependency.new local_spec.name, ">= #{local_spec.version}"

    remotes, = fetcher.search_for_dependency dependency
    remotes  = remotes.map {|n, _| n.version }

    latest_remote = remotes.sort.last

    yield [local_spec, latest_remote] if
      latest_remote && local_spec.version < latest_remote
  end

  nil
end

.remove_spec(spec) ⇒ Object

Removes spec from the known specs.



901
902
903
904
905
# File 'lib/rubygems/specification.rb', line 901

def self.remove_spec(spec)
  _all.delete spec.to_spec
  stubs.delete spec
  (@@stubs_by_name[spec.name] || []).delete spec
end

.required_attribute?(name) ⇒ Boolean

Is name a required attribute?

Returns:

  • (Boolean)


1254
1255
1256
# File 'lib/rubygems/specification.rb', line 1254

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

.required_attributesObject

Required specification attributes



1261
1262
1263
# File 'lib/rubygems/specification.rb', line 1261

def self.required_attributes
  @@required_attributes.dup
end

.resetObject

Reset the list of known specs, running pre and post reset hooks registered in Gem.



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
# File 'lib/rubygems/specification.rb', line 1269

def self.reset
  @@dirs = nil
  Gem.pre_reset_hooks.each(&:call)
  clear_specs
  clear_load_cache
  unresolved = unresolved_deps
  unless unresolved.empty?
    warn "WARN: Unresolved or ambiguous specs during Gem::Specification.reset:"
    unresolved.values.each do |dep|
      warn "      #{dep}"

      versions = find_all_by_name(dep.name)
      unless versions.empty?
        warn "      Available/installed versions of this gem:"
        versions.each {|s| warn "      - #{s.version}" }
      end
    end
    warn "WARN: 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(&:call)
end

.stubsObject

Returns a Gem::StubSpecification for every installed gem



814
815
816
817
818
819
820
821
822
# File 'lib/rubygems/specification.rb', line 814

def self.stubs
  @@stubs ||= begin
    pattern = "*.gemspec"
    stubs = stubs_for_pattern(pattern, false)

    @@stubs_by_name = stubs.select {|s| Gem::Platform.match_spec? s }.group_by(&:name)
    stubs
  end
end

.stubs_for(name) ⇒ Object

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



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

def self.stubs_for(name)
  if @@stubs
    @@stubs_by_name[name] || []
  else
    @@stubs_by_name[name] ||= stubs_for_pattern("#{name}-*.gemspec").select do |s|
      s.name == name
    end
  end
end

.stubs_for_pattern(pattern, match_platform = true) ⇒ Object

Finds stub specifications matching a pattern from the standard locations, optionally filtering out specs not matching the current platform



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

def self.stubs_for_pattern(pattern, match_platform = true) # :nodoc:
  installed_stubs = installed_stubs(Gem::Specification.dirs, pattern)
  installed_stubs.select! {|s| Gem::Platform.match_spec? s } if match_platform
  stubs = installed_stubs + default_stubs(pattern)
  stubs = stubs.uniq(&:full_name)
  _resort!(stubs)
  stubs
end

.unresolved_depsObject

DOC: This method needs documented or nodoc’d



1294
1295
1296
# File 'lib/rubygems/specification.rb', line 1294

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

Instance Method Details

#<=>(other) ⇒ Object

:nodoc:



1391
1392
1393
# File 'lib/rubygems/specification.rb', line 1391

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

#==(other) ⇒ Object

:nodoc:



1395
1396
1397
1398
1399
1400
# File 'lib/rubygems/specification.rb', line 1395

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)



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

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

#abbreviateObject

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.



1499
1500
1501
1502
1503
1504
1505
# File 'lib/rubygems/specification.rb', line 1499

def abbreviate
  self.files = []
  self.test_files = []
  self.rdoc_options = []
  self.extra_rdoc_files = []
  self.cert_chain = []
end

#activateObject

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.



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
# File 'lib/rubygems/specification.rb', line 1438

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

  raise_if_conflicts

  activate_dependencies
  add_self_to_load_path

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

  true
end

#activate_dependenciesObject

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



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
# File 'lib/rubygems/specification.rb', line 1462

def activate_dependencies
  unresolved = Gem::Specification.unresolved_deps

  runtime_dependencies.each do |spec_dep|
    if loaded = Gem.loaded_specs[spec_dep.name]
      next if spec_dep.matches_spec? loaded

      msg = "can't satisfy '#{spec_dep}', already activated '#{loaded.full_name}'"
      e = Gem::LoadError.new msg
      e.name = spec_dep.name

      raise e
    end

    begin
      specs = spec_dep.to_specs
    rescue Gem::MissingSpecError => e
      raise Gem::MissingSpecError.new(e.name, e.requirement, "at: #{spec_file}")
    end

    if specs.size == 1
      specs.first.activate
    else
      name = spec_dep.name
      unresolved[name] = unresolved[name].merge spec_dep
    end
  end

  unresolved.delete self.name
end

#add_bindir(executables) ⇒ Object

Returns an array with bindir attached to each executable in the executables list



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'lib/rubygems/specification.rb', line 1535

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

  if @bindir
    Array(executables).map {|e| File.join(@bindir, e) }
  else
    executables
  end
rescue StandardError
  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.



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

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'


567
568
569
570
571
572
573
# File 'lib/rubygems/specification.rb', line 567

def add_runtime_dependency(gem, *requirements)
  if requirements.uniq.size != requirements.size
    warn "WARNING: duplicated #{gem} dependency #{requirements}"
  end

  add_dependency_with_type(gem, :runtime, requirements)
end

#add_self_to_load_pathObject

Adds this spec’s require paths to LOAD_PATH, in the proper location.



1574
1575
1576
1577
1578
1579
1580
# File 'lib/rubygems/specification.rb', line 1574

def add_self_to_load_path
  return if default_gem?

  paths = full_require_paths

  Gem.add_to_load_path(*paths)
end

#authorObject

Singular reader for #authors. Returns the first author in the list



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

def author
  (val = authors) && val.first
end

#author=(o) ⇒ Object

Singular (alternative) writer for #authors

Usage:

spec.author = 'John Jones'


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

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

#authorsObject

The list of author names who wrote this gem.

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


1594
1595
1596
# File 'lib/rubygems/specification.rb', line 1594

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


279
280
281
# File 'lib/rubygems/specification.rb', line 279

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

#base_dirObject



2101
2102
2103
2104
2105
2106
2107
2108
# File 'lib/rubygems/specification.rb', line 2101

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_dirObject

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.



1604
1605
1606
# File 'lib/rubygems/specification.rb', line 1604

def bin_dir
  @bin_dir ||= File.join gem_dir, bindir
end

#bin_file(name) ⇒ Object

Returns the full path to an executable named name in this gem.



1611
1612
1613
# File 'lib/rubygems/specification.rb', line 1611

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

#build_argsObject

Returns the build_args used to install the gem



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
# File 'lib/rubygems/specification.rb', line 1618

def build_args
  if File.exist? build_info_file
    build_info = File.readlines build_info_file
    build_info = build_info.map(&:strip)
    build_info.delete ""
    build_info
  else
    []
  end
end

#build_extensionsObject

Builds extensions for this platform if the gem has extensions listed and the gem.build_complete file is missing.



1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
# File 'lib/rubygems/specification.rb', line 1633

def build_extensions # :nodoc:
  return if extensions.empty?
  return if default_gem?
  # we need to fresh build when same name and version of default gems
  return if self.class.find_by_full_name(full_name)&.default_gem?
  return if File.exist? gem_build_complete_path
  return unless File.writable?(base_dir)
  return unless 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_relative "config_file"
    require_relative "ext"
    require_relative "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
    Gem::Specification.unresolved_deps.replace unresolved_deps
  end
end

#build_info_dirObject

Returns the full path to the build info directory



1666
1667
1668
# File 'lib/rubygems/specification.rb', line 1666

def build_info_dir
  File.join base_dir, "build_info"
end

#build_info_fileObject

Returns the full path to the file containing the build information generated when the gem was installed



1674
1675
1676
# File 'lib/rubygems/specification.rb', line 1674

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

#cache_dirObject

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



1682
1683
1684
# File 'lib/rubygems/specification.rb', line 1682

def cache_dir
  @cache_dir ||= File.join base_dir, "cache"
end

#cache_fileObject

Returns the full path to the cached gem for this spec.



1689
1690
1691
# File 'lib/rubygems/specification.rb', line 1689

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)


1712
1713
1714
1715
1716
1717
# File 'lib/rubygems/specification.rb', line 1712

def conficts_when_loaded_with?(list_of_specs) # :nodoc:
  result = list_of_specs.any? do |spec|
    spec.runtime_dependencies.any? {|dep| (dep.name == name) && !satisfies_requirement?(dep) }
  end
  result
end

#conflictsObject

Return any possible conflicts against the currently loaded specs.



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
# File 'lib/rubygems/specification.rb', line 1696

def conflicts
  conflicts = {}
  runtime_dependencies.each do |dep|
    spec = Gem.loaded_specs[dep.name]
    if spec && !spec.satisfies_requirement?(dep)
      (conflicts[spec] ||= []) << dep
    end
  end
  env_req = Gem.env_requirement(name)
  (conflicts[self] ||= []) << env_req unless env_req.satisfied_by? version
  conflicts
end

#dateObject

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/



1740
1741
1742
# File 'lib/rubygems/specification.rb', line 1740

def date
  @date ||= Time.utc(*Gem.source_date_epoch.utc.to_a[3..5].reverse)
end

#date=(date) ⇒ Object

The date this gem was created

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



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'lib/rubygems/specification.rb', line 1760

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



1800
1801
1802
# File 'lib/rubygems/specification.rb', line 1800

def default_value(name)
  @@default_value[name]
end

#dependenciesObject

A list of Gem::Dependency objects this gem depends on.

Use #add_dependency or #add_development_dependency to add dependencies to a gem.



1810
1811
1812
# File 'lib/rubygems/specification.rb', line 1810

def dependencies
  @dependencies ||= []
end

#dependent_gems(check_dev = true) ⇒ Object

Return a list of all gems that have a dependency on this gemspec. The list is structured with entries that conform to:

[depending_gem, dependency, [list_of_gems_that_satisfy_dependency]]


1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
# File 'lib/rubygems/specification.rb', line 1820

def dependent_gems(check_dev=true)
  out = []
  Gem::Specification.each do |spec|
    deps = check_dev ? spec.dependencies : spec.runtime_dependencies
    deps.each do |dep|
      next unless satisfies_requirement?(dep)
      sats = []
      find_all_satisfiers(dep) do |sat|
        sats << sat
      end
      out << [spec, dep, sats]
    end
  end
  out
end

#dependent_specsObject

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



1839
1840
1841
# File 'lib/rubygems/specification.rb', line 1839

def dependent_specs
  runtime_dependencies.map(&:to_specs).flatten
end

#development_dependenciesObject

List of dependencies that are used for development



1853
1854
1855
# File 'lib/rubygems/specification.rb', line 1853

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"


1865
1866
1867
1868
1869
1870
1871
1872
1873
# File 'lib/rubygems/specification.rb', line 1865

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:



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
# File 'lib/rubygems/specification.rb', line 1875

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)


1896
1897
1898
# File 'lib/rubygems/specification.rb', line 1896

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

#executableObject

Singular accessor for #executables



1903
1904
1905
# File 'lib/rubygems/specification.rb', line 1903

def executable
  (val = executables) && val.first
end

#executable=(o) ⇒ Object

Singular accessor for #executables



1910
1911
1912
# File 'lib/rubygems/specification.rb', line 1910

def executable=(o)
  self.executables = [o]
end

#executablesObject

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'


590
591
592
# File 'lib/rubygems/specification.rb', line 590

def executables
  @executables ||= []
end

#executables=(value) ⇒ Object

Sets executables to value, ensuring it is an array.



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

def executables=(value)
  @executables = Array(value)
end

#extensionsObject

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.



607
608
609
# File 'lib/rubygems/specification.rb', line 607

def extensions
  @extensions ||= []
end

#extensions=(extensions) ⇒ Object

Sets extensions to extensions, ensuring it is an array.



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

def extensions=(extensions)
  @extensions = Array extensions
end

#extra_rdoc_filesObject

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


623
624
625
# File 'lib/rubygems/specification.rb', line 623

def extra_rdoc_files
  @extra_rdoc_files ||= []
end

#extra_rdoc_files=(files) ⇒ Object

Sets extra_rdoc_files to files, ensuring it is an array.



1931
1932
1933
# File 'lib/rubygems/specification.rb', line 1931

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

#file_nameObject

The default (generated) file name of the gem. See also #spec_name.

spec.file_name # => "example-1.0.gem"


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

def file_name
  "#{full_name}.gem"
end

#filesObject

Files included in this gem. You cannot append to this accessor, you must assign to it.

Only add files you can require to this list, not directories, etc.

Directories are automatically stripped from this list when building a gem, other non-files cause an error.

Usage:

require 'rake'
spec.files = FileList['lib/**/*.rb',
                      'bin/*',
                      '[A-Z]*'].to_a

# or without Rake...
spec.files = Dir['lib/**/*.rb'] + Dir['bin/*']
spec.files += Dir['[A-Z]*']
spec.files.reject! { |fn| fn.include? "CVS" }


259
260
261
262
263
264
265
266
267
# File 'lib/rubygems/specification.rb', line 259

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.



1947
1948
1949
# File 'lib/rubygems/specification.rb', line 1947

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

#flatten_require_pathsObject

:nodoc:



2731
2732
2733
2734
2735
2736
# File 'lib/rubygems/specification.rb', line 2731

def flatten_require_paths # :nodoc:
  return unless raw_require_paths.first.is_a?(Array)

  warn "#{name} #{version} includes a gemspec with `require_paths` set to an array of arrays. Newer versions of this gem might've already fixed this"
  raw_require_paths.flatten!
end

#for_cacheObject

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



1965
1966
1967
1968
1969
1970
1971
1972
# File 'lib/rubygems/specification.rb', line 1965

def for_cache
  spec = dup

  spec.files = nil
  spec.test_files = nil

  spec
end

#full_nameObject



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

def full_name
  @full_name ||= super
end

#gem_dirObject

Work around bundler removing my methods



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

def gem_dir # :nodoc:
  super
end

#gems_dirObject



1985
1986
1987
# File 'lib/rubygems/specification.rb', line 1985

def gems_dir
  @gems_dir ||= File.join(base_dir, "gems")
end

#has_conflicts?Boolean

Return true if there are possible conflicts against the currently loaded specs.

Returns:

  • (Boolean)


1722
1723
1724
1725
1726
1727
1728
1729
1730
# File 'lib/rubygems/specification.rb', line 1722

def has_conflicts?
  return true unless Gem.env_requirement(name).satisfied_by?(version)
  runtime_dependencies.any? do |dep|
    spec = Gem.loaded_specs[dep.name]
    spec && !spec.satisfies_requirement?(dep)
  end
rescue ArgumentError => e
  raise e, "#{name} #{version}: #{e.message}"
end

#has_rdocObject Also known as: has_rdoc?

Deprecated and ignored, defaults to true.

Formerly used to indicate this gem was RDoc-capable.



1994
1995
1996
# File 'lib/rubygems/specification.rb', line 1994

def has_rdoc # :nodoc:
  true
end

#has_rdoc=(ignored) ⇒ Object

Deprecated and ignored.

Formerly used to indicate this gem was RDoc-capable.



2004
2005
2006
# File 'lib/rubygems/specification.rb', line 2004

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)


2015
2016
2017
# File 'lib/rubygems/specification.rb', line 2015

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

#hashObject

:startdoc:



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

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

#init_with(coder) ⇒ Object

:nodoc:



2027
2028
2029
2030
# File 'lib/rubygems/specification.rb', line 2027

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.



2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
# File 'lib/rubygems/specification.rb', line 2079

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

#inspectObject

:nodoc:



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

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

#installed_by_versionObject

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



632
633
634
# File 'lib/rubygems/specification.rb', line 632

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.



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

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

#internal_initObject

:nodoc:



2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
# File 'lib/rubygems/specification.rb', line 2156

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_directoriesObject



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

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_filesObject

Files in the Gem under one of the require_paths



2132
2133
2134
2135
2136
2137
2138
# File 'lib/rubygems/specification.rb', line 2132

def lib_files
  @files.select do |file|
    require_paths.any? do |path|
      file.start_with? path
    end
  end
end

#licenseObject

Singular accessor for #licenses



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

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/ approved.

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

You can also use a custom license file along with your gemspec and specify a LicenseRef-<idstring>, where idstring is the name of the file containing the license text.

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

You can set multiple licenses with #licenses=

Usage:

spec.license = 'MIT'


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

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

#licensesObject

Plural accessor for setting licenses

See #license= for details



2152
2153
2154
# File 'lib/rubygems/specification.rb', line 2152

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


377
378
379
# File 'lib/rubygems/specification.rb', line 377

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

#mark_versionObject

Sets the rubygems_version to the current RubyGems version.



2170
2171
2172
# File 'lib/rubygems/specification.rb', line 2170

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)


2196
2197
2198
2199
2200
2201
2202
# File 'lib/rubygems/specification.rb', line 2196

def missing_extensions?
  return false if extensions.empty?
  return false if default_gem?
  return false if File.exist? gem_build_complete_path

  true
end

#name_tupleObject

Return a NameTuple that represents this Specification



2227
2228
2229
# File 'lib/rubygems/specification.rb', line 2227

def name_tuple
  Gem::NameTuple.new name, version, original_platform
end

#normalizeObject

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.



2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'lib/rubygems/specification.rb', line 2210

def normalize
  if defined?(@extra_rdoc_files) && @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_nameObject

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



2235
2236
2237
2238
2239
2240
2241
# File 'lib/rubygems/specification.rb', line 2235

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

#platformObject

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



2253
2254
2255
# File 'lib/rubygems/specification.rb', line 2253

def platform
  @new_platform ||= Gem::Platform::RUBY # rubocop:disable Naming/MemoizedInstanceVariableName
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


475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'lib/rubygems/specification.rb', line 475

def platform=(platform)
  if @original_platform.nil? ||
     @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
end

#pretty_print(q) ⇒ Object

:nodoc:



2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
# File 'lib/rubygems/specification.rb', line 2257

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 = send attr_name
      current_value = current_value.sort if [:files, :test_files].include? attr_name
      next unless current_value != default_value(attr_name) ||
                  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

#raise_if_conflictsObject

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



2310
2311
2312
2313
2314
# File 'lib/rubygems/specification.rb', line 2310

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

#raw_require_pathsObject

:nodoc:



2738
2739
2740
# File 'lib/rubygems/specification.rb', line 2738

def raw_require_paths # :nodoc:
  @require_paths
end

#rdoc_optionsObject

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

Usage:

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


653
654
655
# File 'lib/rubygems/specification.rb', line 653

def rdoc_options
  @rdoc_options ||= []
end

#rdoc_options=(options) ⇒ Object

Sets rdoc_options to value, ensuring it is an array.



2319
2320
2321
# File 'lib/rubygems/specification.rb', line 2319

def rdoc_options=(options)
  @rdoc_options = Array options
end

#removed_method_callsObject



198
199
200
# File 'lib/rubygems/specification.rb', line 198

def removed_method_calls
  @removed_method_calls ||= []
end

#require_pathObject

Singular accessor for #require_paths



2326
2327
2328
# File 'lib/rubygems/specification.rb', line 2326

def require_path
  (val = require_paths) && val.first
end

#require_path=(path) ⇒ Object

Singular accessor for #require_paths



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

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


524
525
526
# File 'lib/rubygems/specification.rb', line 524

def require_paths=(val)
  @require_paths = Array(val)
end

#requirementsObject

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'


711
712
713
# File 'lib/rubygems/specification.rb', line 711

def requirements
  @requirements ||= []
end

#requirements=(req) ⇒ Object

Set requirements to req, ensuring it is an array.



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

def requirements=(req)
  @requirements = Array req
end

#reset_nil_attributes_to_defaultObject

Reset nil attributes to their default values to make the spec valid



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'lib/rubygems/specification.rb', line 2710

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

  nil
end

#respond_to_missing?(m, include_private = false) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)


2344
2345
2346
# File 'lib/rubygems/specification.rb', line 2344

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

#ri_dirObject

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



2351
2352
2353
# File 'lib/rubygems/specification.rb', line 2351

def ri_dir
  @ri_dir ||= File.join base_dir, "ri", full_name
end

#runtime_dependenciesObject

List of dependencies that will automatically be activated at runtime.



2384
2385
2386
# File 'lib/rubygems/specification.rb', line 2384

def runtime_dependencies
  dependencies.select(&:runtime?)
end

#sanitizeObject

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.



1512
1513
1514
1515
1516
1517
# File 'lib/rubygems/specification.rb', line 1512

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.



1522
1523
1524
1525
1526
1527
1528
1529
# File 'lib/rubygems/specification.rb', line 1522

def sanitize_string(string)
  return string unless string

  # HACK: the #to_s is in here because RSpec has an Array of Arrays of
  # Strings for authors.  Need a way to disallow bad values on gemspec
  # generation.  (Probably won't happen.)
  string.to_s
end

#satisfies_requirement?(dependency) ⇒ Boolean

Checks if this specification meets the requirement of dependency.

Returns:

  • (Boolean)


2400
2401
2402
2403
# File 'lib/rubygems/specification.rb', line 2400

def satisfies_requirement?(dependency)
  @name == dependency.name &&
    dependency.requirement.satisfied_by?(@version)
end

#sort_objObject

Returns an object you can use to sort specifications in #sort_by.



2408
2409
2410
# File 'lib/rubygems/specification.rb', line 2408

def sort_obj
  [@name, @version, Gem::Platform.sort_priority(@new_platform)]
end

#sourceObject

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



2415
2416
2417
# File 'lib/rubygems/specification.rb', line 2415

def source # :nodoc:
  Gem::Source::Installed.new
end

#spec_dirObject

Returns the full path to the directory containing this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications



2423
2424
2425
# File 'lib/rubygems/specification.rb', line 2423

def spec_dir
  @spec_dir ||= File.join base_dir, "specifications"
end

#spec_fileObject

Returns the full path to this spec’s gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications/mygem-1.0.gemspec



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

def spec_file
  @spec_file ||= File.join spec_dir, "#{full_name}.gemspec"
end

#spec_nameObject

The default name of the gemspec. See also #file_name

spec.spec_name # => "example-1.0.gemspec"


2440
2441
2442
# File 'lib/rubygems/specification.rb', line 2440

def spec_name
  "#{full_name}.gemspec"
end

#stubbed?Boolean

Returns:

  • (Boolean)


2688
2689
2690
# File 'lib/rubygems/specification.rb', line 2688

def stubbed?
  false
end

#test_fileObject

Singular accessor for #test_files



2455
2456
2457
# File 'lib/rubygems/specification.rb', line 2455

def test_file # :nodoc:
  (val = test_files) && val.first
end

#test_file=(file) ⇒ Object

Singular mutator for #test_files



2462
2463
2464
# File 'lib/rubygems/specification.rb', line 2462

def test_file=(file) # :nodoc:
  self.test_files = [file]
end

#test_filesObject

Test files included in this gem. You cannot append to this accessor, you must assign to it.



2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'lib/rubygems/specification.rb', line 2470

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) && @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']


723
724
725
# File 'lib/rubygems/specification.rb', line 723

def test_files=(files) # :nodoc:
  @test_files = Array files
end

#to_rubyObject

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.



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

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? || 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  && !.empty?
    result << "  s.metadata = #{ruby_code } if s.respond_to? :metadata="
  end
  result << "  s.require_paths = #{ruby_code raw_require_paths}"

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

  @@attributes.each do |attr_name|
    next if handled.include? attr_name
    current_value = send(attr_name)
    if current_value != default_value(attr_name) || self.class.required_attribute?(attr_name)
      result << "  s.#{attr_name} = #{ruby_code current_value}"
    end
  end

  if String === signing_key
    result << "  s.signing_key = #{ruby_code signing_key}"
  end

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

  unless dependencies.empty?
    result << nil
    result << "  s.specification_version = #{specification_version}"
    result << nil

    dependencies.each do |dep|
      dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK
      result << "  s.add_#{dep.type}_dependency(%q<#{dep.name}>.freeze, #{ruby_code dep.requirements_list})"
    end
  end

  result << "end"
  result << nil

  result.join "\n"
end

#to_ruby_for_cacheObject

Returns a Ruby lighter-weight code representation of this specification, used for indexing only.

See #to_ruby.



2567
2568
2569
# File 'lib/rubygems/specification.rb', line 2567

def to_ruby_for_cache
  for_cache.to_ruby
end

#to_sObject

:nodoc:



2571
2572
2573
# File 'lib/rubygems/specification.rb', line 2571

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

#to_specObject

Returns self



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

def to_spec
  self
end

#to_yaml(opts = {}) ⇒ Object

:nodoc:



2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
# File 'lib/rubygems/specification.rb', line 2582

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_relative "psych_tree"
  end

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

  require "stringio"
  io = StringIO.new
  io.set_encoding Encoding::UTF_8

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

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

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

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



2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'lib/rubygems/specification.rb', line 2609

def traverse(trail = [], visited = {}, &block)
  trail.push(self)
  begin
    runtime_dependencies.each do |dep|
      dep.matching_specs(true).each do |dep_spec|
        next if visited.key?(dep_spec)
        visited[dep_spec] = true
        trail.push(dep_spec)
        begin
          result = block[self, dep, dep_spec, trail]
        ensure
          trail.pop
        end
        next if result == :next
        spec_name = dep_spec.name
        dep_spec.traverse(trail, visited, &block) unless
          trail.any? {|s| s.name == spec_name }
      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..



2640
2641
2642
2643
2644
2645
2646
# File 'lib/rubygems/specification.rb', line 2640

def validate(packaging = true, strict = false)
  normalize

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

#validate_dependenciesObject



2661
2662
2663
# File 'lib/rubygems/specification.rb', line 2661

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

#validate_metadataObject



2656
2657
2658
# File 'lib/rubygems/specification.rb', line 2656

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

#validate_permissionsObject



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

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

#yaml_initialize(tag, vals) ⇒ Object

:nodoc:



2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'lib/rubygems/specification.rb', line 2692

def yaml_initialize(tag, vals) # :nodoc:
  vals.each do |ivar, val|
    case ivar
    when "date"
      # Force Date to go through the extra coerce logic in date=
      self.date = val.tap(&Gem::UNTAINT)
    else
      instance_variable_set "@#{ivar}", val.tap(&Gem::UNTAINT)
    end
  end

  @original_platform = @platform # for backwards compatibility
  self.platform = Gem::Platform.new @platform
end