Class: Gem::Specification

Inherits:
BasicSpecification
  • Object
show all
Extended by:
Enumerable
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.

Specifications must be deterministic, as in the example above. For instance, you cannot define attributes conditionally:

# INVALID: do not do this.
unless RUBY_ENGINE == "jruby"
s.extensions << "ext/example/extconf.rb"
end

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/
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=, :mark_version].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
@@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.select {|_k,v| v.is_a?(Array) }.keys

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
 
# File 'lib/rubygems/specification.rb', line 1956

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.



2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/rubygems/specification.rb', line 2067

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

#activated ⇒ Object Also known as: activated?

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



745
746
747
 
# File 'lib/rubygems/specification.rb', line 745

def activated
  @activated
end

#autorequire ⇒ Object

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

Deprecated: It is neither supported nor functional.



754
755
756
 
# File 'lib/rubygems/specification.rb', line 754

def autorequire
  @autorequire
end

#bindir ⇒ Object

The path in the gem for executable scripts. Usually 'exe'

Usage:

spec.bindir = 'exe'



444
445
446
 
# File 'lib/rubygems/specification.rb', line 444

def bindir
  @bindir
end

#cert_chain ⇒ Object

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



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

def cert_chain
  @cert_chain
end

#description ⇒ Object

A long description of this gem

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

Usage:

spec.description = "Rake is a Make-like program implemented in Ruby. Tasks and\ndependencies are specified in standard Ruby syntax.\n"



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

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



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

def email
  @email
end

#homepage ⇒ Object

The URL of this gem's home page

Usage:

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



325
326
327
 
# File 'lib/rubygems/specification.rb', line 325

def homepage
  @homepage
end

#metadata ⇒ Object

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

Metadata items have the following restrictions:

  • The metadata must be a Hash object
  • All keys and values must be Strings
  • Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes
  • All strings must be UTF-8, no binary data is allowed

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

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

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

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



421
422
423
 
# File 'lib/rubygems/specification.rb', line 421

def metadata
  @metadata
end

#name ⇒ Object

This gem's name.

Usage:

spec.name = 'rake'



209
210
211
 
# File 'lib/rubygems/specification.rb', line 209

def name
  @name
end

#original_platform ⇒ Object

Cruft. Use platform.



2136
2137
2138
 
# File 'lib/rubygems/specification.rb', line 2136

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



459
460
461
 
# File 'lib/rubygems/specification.rb', line 459

def post_install_message
  @post_install_message
end

#required_ruby_version ⇒ Object

The version of Ruby required by this gem

Usage:

spec.required_ruby_version = '>= 2.7.0'



290
291
292
 
# File 'lib/rubygems/specification.rb', line 290

def required_ruby_version
  @required_ruby_version
end

#required_rubygems_version ⇒ Object

The RubyGems version required by this gem



535
536
537
 
# File 'lib/rubygems/specification.rb', line 535

def required_rubygems_version
  @required_rubygems_version
end

#rubygems_version ⇒ Object

The version of RubyGems used to create this gem.



730
731
732
 
# File 'lib/rubygems/specification.rb', line 730

def rubygems_version
  @rubygems_version
end

#signing_key ⇒ Object

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



540
541
542
 
# File 'lib/rubygems/specification.rb', line 540

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.



766
767
768
 
# File 'lib/rubygems/specification.rb', line 766

def specification_version
  @specification_version
end

#summary ⇒ Object

A short summary of this gem's description. Displayed in gem list -d.

The #description should be more detailed than the summary.

Usage:

spec.summary = "This is a small summary of my gem"



233
234
235
 
# File 'lib/rubygems/specification.rb', line 233

def summary
  @summary
end

#version ⇒ Object

This gem's version.

The version string can contain numbers and periods, such as 1.0.0. A gem is a 'prerelease' gem if the version has a letter in it, such as 1.0.0.pre.

Usage:

spec.version = '0.4.1'



222
223
224
 
# File 'lib/rubygems/specification.rb', line 222

def version
  @version
end

Class Method Details

._all ⇒ Object

:nodoc:



768
769
770
 
# File 'lib/rubygems/specification.rb', line 768

def self._all # :nodoc:
  specification_record.all
end

._latest_specs(specs, prerelease = false) ⇒ Object

:nodoc:



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/rubygems/specification.rb', line 1082

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.flat_map(&:last).sort_by(&:name)
end

._load(str) ⇒ Object

Load custom marshal format, re-initializing defaults as needed



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
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
 
# File 'lib/rubygems/specification.rb', line 1262

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.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]
  # offset due to has_rdoc removal
  spec.instance_variable_set :@licenses,                  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:



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

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?
    platforms = Gem::Platform.sort_priority(b.platform) <=> Gem::Platform.sort_priority(a.platform)
    next platforms if platforms.nonzero?
    default_gem = a.default_gem_priority <=> b.default_gem_priority
    next default_gem if default_gem.nonzero?
    a.base_dir_priority(gem_path) <=> b.base_dir_priority(gem_path)
  end
end

.add_spec(spec) ⇒ Object

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



866
867
868
 
# File 'lib/rubygems/specification.rb', line 866

def self.add_spec(spec)
  specification_record.add_spec(spec)
end

.all ⇒ Object

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



881
882
883
884
885
 
# File 'lib/rubygems/specification.rb', line 881

def self.all
  warn "NOTE: Specification.all called from #{caller(1, 1).first}" unless
    Gem::Deprecate.skip
  _all
end

.all=(specs) ⇒ Object

Sets the known specs to specs.



890
891
892
 
# File 'lib/rubygems/specification.rb', line 890

def self.all=(specs)
  specification_record.all = specs
end

.all_names ⇒ Object

Return full names of all specs in sorted order.



897
898
899
 
# File 'lib/rubygems/specification.rb', line 897

def self.all_names
  specification_record.all_names
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...



906
907
908
 
# File 'lib/rubygems/specification.rb', line 906

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



915
916
917
 
# File 'lib/rubygems/specification.rb', line 915

def self.attribute_names
  @@attributes.dup
end

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

Returns a Gem::StubSpecification for default gems



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

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

.dirs ⇒ Object

Return the directories that Specification uses to find specs.



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

def self.dirs
  @@dirs ||= Gem::SpecificationRecord.dirs_from(gem_path)
end

.dirs=(dirs) ⇒ Object

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



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

def self.dirs=(dirs)
  reset

  @@dirs = Gem::SpecificationRecord.dirs_from(Array(dirs))
end

.each(&block) ⇒ Object

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



942
943
944
 
# File 'lib/rubygems/specification.rb', line 942

def self.each(&block)
  specification_record.each(&block)
end

.each_gemspec(dirs) ⇒ Object

:nodoc:



784
785
786
787
788
789
790
 
# File 'lib/rubygems/specification.rb', line 784

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

.each_spec(dirs) ⇒ Object

:nodoc:



796
797
798
799
800
801
 
# File 'lib/rubygems/specification.rb', line 796

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

Return the best specification that contains the file matching path, among those already activated.



1004
1005
1006
 
# File 'lib/rubygems/specification.rb', line 1004

def self.find_active_stub_by_path(path)
  specification_record.find_active_stub_by_path(path)
end

.find_all_by_full_name(full_name) ⇒ Object

Returns every spec that has the given full_name



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

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.



949
950
951
 
# File 'lib/rubygems/specification.rb', line 949

def self.find_all_by_name(name, *requirements)
  specification_record.find_all_by_name(name, *requirements)
end

.find_by_full_name(full_name) ⇒ Object

Find the best specification matching a full_name.



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

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.



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

def self.find_by_name(name, *requirements)
  requirements = Gem::Requirement.default if requirements.empty?

  Gem::Dependency.new(name, *requirements).to_spec
end

.find_by_path(path) ⇒ Object

Return the best specification that contains the file matching path.



979
980
981
 
# File 'lib/rubygems/specification.rb', line 979

def self.find_by_path(path)
  specification_record.find_by_path(path)
end

.find_in_unresolved(path) ⇒ Object

Return currently unresolved specs that contain the file matching path.



1011
1012
1013
 
# File 'lib/rubygems/specification.rb', line 1011

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.



1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/rubygems/specification.rb', line 1019

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



996
997
998
 
# File 'lib/rubygems/specification.rb', line 996

def self.find_inactive_by_path(path)
  specification_record.find_inactive_by_path(path)
end

.find_unloaded_by_path(path) ⇒ Object

Return the best specification that contains the file matching path amongst the specs that are not loaded. This method is different than find_inactive_by_path as it will filter out loaded specs by their name.



988
989
990
 
# File 'lib/rubygems/specification.rb', line 988

def self.find_unloaded_by_path(path)
  specification_record.find_unloaded_by_path(path)
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.



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'lib/rubygems/specification.rb', line 1046

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

.gemspec_stubs_in(dir, pattern) ⇒ Object

:nodoc:



792
793
794
 
# File 'lib/rubygems/specification.rb', line 792

def self.gemspec_stubs_in(dir, pattern) # :nodoc:
  Gem::Util.glob_files_in_dir(pattern, dir).map {|path| yield path }.select(&:valid?)
end

.latest_spec_for(name) ⇒ Object

Return the latest installed spec for gem name.



1078
1079
1080
 
# File 'lib/rubygems/specification.rb', line 1078

def self.latest_spec_for(name)
  specification_record.latest_spec_for(name)
end

.latest_specs(prerelease = false) ⇒ Object

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



1071
1072
1073
 
# File 'lib/rubygems/specification.rb', line 1071

def self.latest_specs(prerelease = false)
  specification_record.latest_specs(prerelease)
end

.load(file) ⇒ Object

Loads Ruby format gemspec from file.



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/rubygems/specification.rb', line 1099

def self.load(file)
  return unless file

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

  return unless File.file?(file)

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

  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_defaults ⇒ Object

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



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

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

.non_nil_attributes ⇒ Object

Specification attributes that must be non-nil



1138
1139
1140
 
# File 'lib/rubygems/specification.rb', line 1138

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



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/rubygems/specification.rb', line 1145

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

.outdated ⇒ Object

Return a list of all outdated local gem names. This method is HEAVY as it must go fetch specifications from the server.

Use outdated_and_latest_version if you wish to retrieve the latest remote version as well.



1163
1164
1165
 
# File 'lib/rubygems/specification.rb', line 1163

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.



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/rubygems/specification.rb', line 1174

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.



873
874
875
 
# File 'lib/rubygems/specification.rb', line 873

def self.remove_spec(spec)
  specification_record.remove_spec(spec)
end

.required_attribute?(name) ⇒ Boolean

Is name a required attribute?

Returns:

  • (Boolean) 


1199
1200
1201
 
# File 'lib/rubygems/specification.rb', line 1199

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

.required_attributes ⇒ Object

Required specification attributes



1206
1207
1208
 
# File 'lib/rubygems/specification.rb', line 1206

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.



1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/rubygems/specification.rb', line 1214

def self.reset
  @@dirs = nil
  Gem.pre_reset_hooks.each(&:call)
  @specification_record = nil
  clear_load_cache

  unless unresolved_deps.empty?
    unresolved = unresolved_deps.filter_map do |name, dep|
      matching_versions = find_all_by_name(name)
      next if dep.latest_version? && matching_versions.any?(&:default_gem?)

      [dep, matching_versions.uniq(&:full_name)]
    end.to_h

    unless unresolved.empty?
      warn "WARN: Unresolved or ambiguous specs during Gem::Specification.reset:"
      unresolved.each do |dep, versions|
        warn "      #{dep}"

        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."
    end

    unresolved_deps.clear
  end
  Gem.post_reset_hooks.each(&:call)
end

.specification_record ⇒ Object

Keeps track of all currently known specifications



1250
1251
1252
 
# File 'lib/rubygems/specification.rb', line 1250

def self.specification_record
  @specification_record ||= Gem::SpecificationRecord.new(dirs)
end

.stubs ⇒ Object

Returns a Gem::StubSpecification for every installed gem



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

def self.stubs
  specification_record.stubs
end

.stubs_for(name) ⇒ Object

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



825
826
827
 
# File 'lib/rubygems/specification.rb', line 825

def self.stubs_for(name)
  specification_record.stubs_for(name)
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



833
834
835
 
# File 'lib/rubygems/specification.rb', line 833

def self.stubs_for_pattern(pattern, match_platform = true) # :nodoc:
  specification_record.stubs_for_pattern(pattern, match_platform)
end

.unresolved_deps ⇒ Object

DOC: This method needs documented or nodoc'd



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

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

Instance Method Details

#<=>(other) ⇒ Object

:nodoc:



1350
1351
1352
 
# File 'lib/rubygems/specification.rb', line 1350

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

#==(other) ⇒ Object

:nodoc:



1354
1355
1356
1357
1358
1359
 
# File 'lib/rubygems/specification.rb', line 1354

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)



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 1367

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.



1456
1457
1458
1459
1460
1461
1462
 
# File 'lib/rubygems/specification.rb', line 1456

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.



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/rubygems/specification.rb', line 1397

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



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/rubygems/specification.rb', line 1421

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

    specs = spec_dep.matching_specs(true).uniq(&:full_name)

    if specs.size == 0
      raise Gem::MissingSpecError.new(spec_dep.name, spec_dep.requirement, "at: #{spec_file}")
    elsif 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



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

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_dependency(gem, *requirements) ⇒ Object Also known as: add_runtime_dependency

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

Usage:

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



564
565
566
567
568
569
570
 
# File 'lib/rubygems/specification.rb', line 564

def add_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_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.



553
554
555
 
# File 'lib/rubygems/specification.rb', line 553

def add_development_dependency(gem, *requirements)
  add_dependency_with_type(gem, :development, requirements)
end

#add_self_to_load_path ⇒ Object

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



1531
1532
1533
1534
1535
1536
1537
 
# File 'lib/rubygems/specification.rb', line 1531

def add_self_to_load_path
  return if default_gem?

  paths = full_require_paths

  Gem.add_to_load_path(*paths)
end

#author ⇒ Object

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



1542
1543
1544
 
# File 'lib/rubygems/specification.rb', line 1542

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

#author=(o) ⇒ Object

Singular (alternative) writer for #authors

Usage:

spec.author = 'John Jones'



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

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



1551
1552
1553
 
# File 'lib/rubygems/specification.rb', line 1551

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 



2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'lib/rubygems/specification.rb', line 2010

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.



1561
1562
1563
 
# File 'lib/rubygems/specification.rb', line 1561

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.



1568
1569
1570
 
# File 'lib/rubygems/specification.rb', line 1568

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

#build_args ⇒ Object

Returns the build_args used to install the gem



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
 
# File 'lib/rubygems/specification.rb', line 1575

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_extensions ⇒ Object

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



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'lib/rubygems/specification.rb', line 1590

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_dir ⇒ Object

Returns the full path to the build info directory



1623
1624
1625
 
# File 'lib/rubygems/specification.rb', line 1623

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



1631
1632
1633
 
# File 'lib/rubygems/specification.rb', line 1631

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.



1639
1640
1641
 
# File 'lib/rubygems/specification.rb', line 1639

def cache_dir
  File.join base_dir, "cache"
end

#cache_file ⇒ Object

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



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

def cache_file
  File.join cache_dir, "#{full_name}.gem"
end

#conflicts ⇒ Object

Return any possible conflicts against the currently loaded specs.



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/rubygems/specification.rb', line 1653

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

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


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

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

#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: https://reproducible-builds.org/specs/source-date-epoch/



1697
1698
1699
 
# File 'lib/rubygems/specification.rb', line 1697

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.



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
 
# File 'lib/rubygems/specification.rb', line 1717

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



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

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.



1749
1750
1751
 
# File 'lib/rubygems/specification.rb', line 1749

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



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

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_specs ⇒ Object

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



1778
1779
1780
 
# File 'lib/rubygems/specification.rb', line 1778

def dependent_specs
  runtime_dependencies.flat_map(&:to_specs)
end

#development_dependencies ⇒ Object

List of dependencies that are used for development



1792
1793
1794
 
# File 'lib/rubygems/specification.rb', line 1792

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"



1804
1805
1806
1807
1808
1809
1810
1811
1812
 
# File 'lib/rubygems/specification.rb', line 1804

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:



1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
 
# File 'lib/rubygems/specification.rb', line 1814

def encode_with(coder) # :nodoc:
  coder.add "name", @name
  coder.add "version", @version
  coder.add "platform", platform.to_s
  coder.add "original_platform", original_platform.to_s if platform.to_s != original_platform.to_s

  attributes = @@attributes.map(&:to_s) - %w[name version platform]
  attributes.each do |name|
    value = instance_variable_get("@#{name}")
    coder.add name, value unless value.nil?
  end
end

#eql?(other) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

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

#executable ⇒ Object

Singular accessor for #executables



1834
1835
1836
 
# File 'lib/rubygems/specification.rb', line 1834

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

#executable=(o) ⇒ Object

Singular accessor for #executables



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

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'



587
588
589
 
# File 'lib/rubygems/specification.rb', line 587

def executables
  @executables ||= []
end

#executables=(value) ⇒ Object

Sets executables to value, ensuring it is an array.



1848
1849
1850
 
# File 'lib/rubygems/specification.rb', line 1848

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

#extensions ⇒ Object

Extensions to build when installing the gem, specifically the paths to extconf.rb-style files used to compile extensions.

These files will be run when the gem is installed, causing the C (or whatever) code to be compiled on the user's machine.

Usage:

spec.extensions << 'ext/rmagic/extconf.rb'

See Gem::Ext::Builder for information about writing extensions for gems.



604
605
606
 
# File 'lib/rubygems/specification.rb', line 604

def extensions
  @extensions ||= []
end

#extensions=(extensions) ⇒ Object

Sets extensions to extensions, ensuring it is an array.



1855
1856
1857
 
# File 'lib/rubygems/specification.rb', line 1855

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

#extensions_dir ⇒ Object

The path where this gem installs its extensions.



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

def extensions_dir
  @extensions_dir ||= super
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']



620
621
622
 
# File 'lib/rubygems/specification.rb', line 620

def extra_rdoc_files
  @extra_rdoc_files ||= []
end

#extra_rdoc_files=(files) ⇒ Object

Sets extra_rdoc_files to files, ensuring it is an array.



1862
1863
1864
 
# File 'lib/rubygems/specification.rb', line 1862

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

#file_name ⇒ Object

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

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



1871
1872
1873
 
# File 'lib/rubygems/specification.rb', line 1871

def file_name
  "#{full_name}.gem"
end

#files ⇒ Object

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

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

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

Usage:

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

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



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

def files
  # DO NOT CHANGE TO ||= ! This is not a normal accessor. (yes, it sucks)
  # DOC: Why isn't it normal? Why does it suck? How can we fix this?
  @files = [@files,
            @test_files,
            add_bindir(@executables),
            @extra_rdoc_files,
            @extensions].flatten.compact.uniq.sort
end

#files=(files) ⇒ Object

Sets files to files, ensuring it is an array.



1878
1879
1880
 
# File 'lib/rubygems/specification.rb', line 1878

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

#flatten_require_paths ⇒ Object

:nodoc:



2596
2597
2598
2599
2600
2601
 
# File 'lib/rubygems/specification.rb', line 2596

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_cache ⇒ Object

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



1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/rubygems/specification.rb', line 1896

def for_cache
  spec = dup

  spec.files = nil
  spec.test_files = nil

  spec
end

#gem_dir ⇒ Object

Work around old bundler versions removing my methods Can be removed once RubyGems can no longer install Bundler 2.5



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

def gem_dir # :nodoc:
  super
end

#gems_dir ⇒ Object 



1913
1914
1915
 
# File 'lib/rubygems/specification.rb', line 1913

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) 


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

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_unit_tests? ⇒ Boolean Also known as: has_test_suite?

True if this gem has files in test_files

Returns:

  • (Boolean) 


1920
1921
1922
 
# File 'lib/rubygems/specification.rb', line 1920

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

#hash ⇒ Object

:startdoc:



1928
1929
1930
 
# File 'lib/rubygems/specification.rb', line 1928

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

#init_with(coder) ⇒ Object

:nodoc:



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

def init_with(coder) # :nodoc:
  @installed_by_version ||= nil
  yaml_initialize coder.tag, coder.map
end

#initialize_copy(other_spec) ⇒ Object

Duplicates Array and Gem::Requirement attributes from other_spec so state isn't shared.



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
 
# File 'lib/rubygems/specification.rb', line 1985

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

  @required_ruby_version = other_spec.required_ruby_version.dup
  @required_rubygems_version = other_spec.required_rubygems_version.dup
end

#inspect ⇒ Object

:nodoc:



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

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.



629
630
631
 
# File 'lib/rubygems/specification.rb', line 629

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.



637
638
639
 
# File 'lib/rubygems/specification.rb', line 637

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

#internal_init ⇒ Object

:nodoc:



2054
2055
2056
2057
2058
2059
2060
2061
 
# File 'lib/rubygems/specification.rb', line 2054

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

#keep_only_files_and_directories ⇒ Object 



2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/rubygems/specification.rb', line 2535

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



2030
2031
2032
2033
2034
2035
2036
 
# File 'lib/rubygems/specification.rb', line 2030

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



2041
2042
2043
 
# File 'lib/rubygems/specification.rb', line 2041

def license
  licenses.first
end

#license=(o) ⇒ Object

The license for this gem.

The license must be no more than 64 characters, and should be a single SPDX license identifier from https://spdx.org/licenses/. Ideally, you should pick one that is OSI (Open Source Initiative) https://opensource.org/licenses/ approved.

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

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

RubyGems validates the license against the SPDX license list when you run gem build and warns about unknown or deprecated identifiers. An identifier may carry a trailing + (this version or any later version) and a license exception joined with WITH, for example Apache-2.0 WITH LLVM-exception.

Compound SPDX license expressions such as MIT OR Apache-2.0 are not currently supported. RubyGems treats the whole string as a single identifier and warns that it is invalid. For a gem available under more than one license, set each license as a separate entry with #licenses=.

For a license that has no SPDX identifier, use Nonstandard, or LicenseRef- 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.

Usage:

spec.license = 'MIT'



364
365
366
 
# File 'lib/rubygems/specification.rb', line 364

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

#licenses ⇒ Object

Plural accessor for setting licenses

See #license= for details



2050
2051
2052
 
# File 'lib/rubygems/specification.rb', line 2050

def licenses
  @licenses ||= []
end

#licenses=(licenses) ⇒ Object

The license(s) for the library.

Each entry must be a single SPDX license identifier, no more than 64 characters. Entries are validated independently, so a compound expression such as MIT OR Apache-2.0 is not valid as an entry. Listing the identifiers as separate array elements is currently the only way RubyGems supports declaring a dual- or multi-licensed gem.

Note that the array itself does not state how the licenses combine. Include the full text of each license in the gem and describe the exact terms there.

See #license= for more discussion

Usage:

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



386
387
388
 
# File 'lib/rubygems/specification.rb', line 386

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

#missing_extensions? ⇒ Boolean

Is this specification missing its extensions? When this returns true you probably want to build_extensions

Returns:

  • (Boolean) 


2085
2086
2087
2088
2089
2090
2091
2092
 
# File 'lib/rubygems/specification.rb', line 2085

def missing_extensions?
  return false if RUBY_ENGINE == "jruby"
  return false if extensions.empty?
  return false if default_gem?
  return false if File.exist? gem_build_complete_path

  true
end

#name_tuple ⇒ Object

Return a NameTuple that represents this Specification



2117
2118
2119
 
# File 'lib/rubygems/specification.rb', line 2117

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.


2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
 
# File 'lib/rubygems/specification.rb', line 2100

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

  @files            = @files.uniq.sort if @files
  @extensions       = @extensions.uniq.sort if @extensions
  @test_files       = @test_files.uniq.sort if @test_files
  @executables      = @executables.uniq.sort if @executables
  @extra_rdoc_files = @extra_rdoc_files.uniq.sort 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.



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

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

#platform ⇒ Object

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



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

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



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/rubygems/specification.rb', line 484

def platform=(platform)
  @original_platform = platform

  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
end

#pretty_print(q) ⇒ Object

:nodoc:



2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/rubygems/specification.rb', line 2147

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_conflicts ⇒ Object

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



2200
2201
2202
2203
2204
 
# File 'lib/rubygems/specification.rb', line 2200

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

#raw_require_paths ⇒ Object

:nodoc:



2603
2604
2605
 
# File 'lib/rubygems/specification.rb', line 2603

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'



650
651
652
 
# File 'lib/rubygems/specification.rb', line 650

def rdoc_options
  @rdoc_options ||= []
end

#rdoc_options=(options) ⇒ Object

Sets rdoc_options to value, ensuring it is an array.



2209
2210
2211
 
# File 'lib/rubygems/specification.rb', line 2209

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

#removed_method_calls ⇒ Object 



195
196
197
 
# File 'lib/rubygems/specification.rb', line 195

def removed_method_calls
  @removed_method_calls ||= []
end

#require_path ⇒ Object

Singular accessor for #require_paths



2216
2217
2218
 
# File 'lib/rubygems/specification.rb', line 2216

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

#require_path=(path) ⇒ Object

Singular accessor for #require_paths



2223
2224
2225
 
# File 'lib/rubygems/specification.rb', line 2223

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



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

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'



708
709
710
 
# File 'lib/rubygems/specification.rb', line 708

def requirements
  @requirements ||= []
end

#requirements=(req) ⇒ Object

Set requirements to req, ensuring it is an array.



2230
2231
2232
 
# File 'lib/rubygems/specification.rb', line 2230

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

#reset_nil_attributes_to_default ⇒ Object

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



2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
 
# File 'lib/rubygems/specification.rb', line 2575

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) 


2234
2235
2236
 
# File 'lib/rubygems/specification.rb', line 2234

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

#ri_dir ⇒ Object

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



2241
2242
2243
 
# File 'lib/rubygems/specification.rb', line 2241

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.



2274
2275
2276
 
# File 'lib/rubygems/specification.rb', line 2274

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.



1469
1470
1471
1472
1473
1474
 
# File 'lib/rubygems/specification.rb', line 1469

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.



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

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) 


2290
2291
2292
2293
 
# File 'lib/rubygems/specification.rb', line 2290

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

#sort_obj ⇒ Object

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



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

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

#source ⇒ Object

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



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

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



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

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



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

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"



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

def spec_name
  "#{full_name}.gemspec"
end

#stubbed? ⇒ Boolean

Returns:

  • (Boolean) 


2554
2555
2556
 
# File 'lib/rubygems/specification.rb', line 2554

def stubbed?
  false
end

#test_file ⇒ Object

Singular accessor for #test_files



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

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

#test_file=(file) ⇒ Object

Singular mutator for #test_files



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

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.



2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/rubygems/specification.rb', line 2360

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



720
721
722
 
# File 'lib/rubygems/specification.rb', line 720

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.



2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
 
# File 'lib/rubygems/specification.rb', line 2380

def to_ruby
  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 metadata && !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,
    :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}"
  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_cache ⇒ Object

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

See #to_ruby.



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

def to_ruby_for_cache
  for_cache.to_ruby
end

#to_s ⇒ Object

:nodoc:



2458
2459
2460
 
# File 'lib/rubygems/specification.rb', line 2458

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

#to_spec ⇒ Object

Returns self



2465
2466
2467
 
# File 'lib/rubygems/specification.rb', line 2465

def to_spec
  self
end

#to_yaml(opts = {}) ⇒ Object

:nodoc:



2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/rubygems/specification.rb', line 2469

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.



2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
 
# File 'lib/rubygems/specification.rb', line 2496

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



2527
2528
2529
2530
2531
2532
2533
 
# File 'lib/rubygems/specification.rb', line 2527

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

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

#validate_for_resolution ⇒ Object 



2543
2544
2545
 
# File 'lib/rubygems/specification.rb', line 2543

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

#yaml_initialize(tag, vals) ⇒ Object

:nodoc:



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
 
# File 'lib/rubygems/specification.rb', line 2558

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
    when "platform"
      self.platform = val
    else
      instance_variable_set "@#{ivar}", val
    end
  end
end