class Gem::Specification - Documentation for Ruby 4.0
Description: class Gem::Specification: The Specification class contains the information for a gem. Typically defined in a .
Keywords: ruby,class,Gem::Specification

🔍

No recent searches

# class Gem::Specification

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       = 'rubycoder@example.com'
      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

### Constants

NONEXISTENT_SPECIFICATION_VERSION

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

### Public Instance Methods

removed_method_calls ()
Source

    # File lib/rubygems/specification.rb, line 195
    def removed_method_calls
      @removed_method_calls ||= []
    end

## Optional gemspec attributes

### Constants

LATEST_RUBY_WITHOUT_PATCH_VERSIONS

### Attributes

bindir [RW]

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

Usage:

    spec.bindir = 'exe'

cert_chain [RW]

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

post_install_message [RW]

A message that gets displayed after the gem is installed.

Usage:

    spec.post_install_message = "Thanks for installing!"

required_rubygems_version [R]

The RubyGems version required by this gem

signing_key [RW]

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

### Public Instance Methods

add_dependency (gem, *requirements)
Source

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

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

Usage:

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

Also aliased as: add_runtime_dependency
add_development_dependency (gem, *requirements)
Source

    # File lib/rubygems/specification.rb, line 541
    def add_development_dependency(gem, *requirements)
      add_dependency_with_type(gem, :development, requirements)
    end

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.

author= (o)
Source

    # File lib/rubygems/specification.rb, line 421
    def author=(o)
      self.authors = [o]
    end

Singular (alternative) writer for `authors`

Usage:

    spec.author = 'John Jones'

executables ()
Source

    # File lib/rubygems/specification.rb, line 575
    def executables
      @executables ||= []
    end

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'

extensions ()
Source

    # File lib/rubygems/specification.rb, line 592
    def extensions
      @extensions ||= []
    end

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.

extra_rdoc_files ()
Source

    # File lib/rubygems/specification.rb, line 608
    def extra_rdoc_files
      @extra_rdoc_files ||= []
    end

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

platform= (platform)
Source

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

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

rdoc_options ()
Source

    # File lib/rubygems/specification.rb, line 638
    def rdoc_options
      @rdoc_options ||= []
    end

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

Usage:

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

require_paths= (val)
Source

    # File lib/rubygems/specification.rb, line 516
    def require_paths=(val)
      @require_paths = Array(val)
    end

Paths in the gem to add to `$LOAD_PATH` when this gem is activated. 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 = ['.']

required_ruby_version= (req)
Source

    # File lib/rubygems/specification.rb, line 668
    def required_ruby_version=(req)
      @required_ruby_version = Gem::Requirement.create req

      @required_ruby_version.requirements.map! do |op, v|
        if v >= LATEST_RUBY_WITHOUT_PATCH_VERSIONS && v.release.segments.size == 4
          [op == "~>" ? "=" : op, Gem::Version.new(v.segments.tap {|s| s.delete_at(3) }.join("."))]
        else
          [op, v]
        end
      end
    end

The version of Ruby required by this gem. The ruby version can be specified to the patch-level:

    $ ruby -v -e 'p Gem.ruby_version'
    ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-darwin12.4.0]
    #<Gem::Version "2.0.0.247">

Prereleases can also be specified.

Usage:

    # This gem will work with 1.8.6 or greater...
    spec.required_ruby_version = '>= 1.8.6'

    # Only with final releases of major version 2 where minor version is at least 3
    spec.required_ruby_version = '~> 2.3'

    # Only prereleases or final releases after 2.6.0.preview2
    spec.required_ruby_version = '> 2.6.0.preview2'

    # This gem will work with 2.3.0 or greater, including major version 3, but lesser than 4.0.0
    spec.required_ruby_version = '>= 2.3', '< 4'

required_rubygems_version= (req)
Source

    # File lib/rubygems/specification.rb, line 683
    def required_rubygems_version=(req)
      @required_rubygems_version = Gem::Requirement.create req
    end

The RubyGems version required by this gem

requirements ()
Source

    # File lib/rubygems/specification.rb, line 696
    def requirements
      @requirements ||= []
    end

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'

## Read-only attributes

### Attributes

rubygems_version [RW]

The version of RubyGems used to create this gem.

### Public Instance Methods

extensions_dir ()
Source

    # File lib/rubygems/specification.rb, line 723
    def extensions_dir
      @extensions_dir ||= super
    end

The path where this gem installs its extensions.

Calls superclass method `Gem::BasicSpecification#extensions_dir`

## Recommended gemspec attributes

### Attributes

description [R]

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

email [RW]

A contact email address (or addresses) for this gem

Usage:

    spec.email = 'john.jones@example.com'
    spec.email = ['jack@example.com', 'jill@example.com']

homepage [RW]

The URL of this gem’s home page

Usage:

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

metadata [RW]

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}

required_ruby_version [R]

The version of Ruby required by this gem

Usage:

    spec.required_ruby_version = '>= 2.7.0'

### Public Instance Methods

license= (o)
Source

    # File lib/rubygems/specification.rb, line 357
    def license=(o)
      self.licenses = [o]
    end

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'

licenses= (licenses)
Source

    # File lib/rubygems/specification.rb, line 374
    def licenses=(licenses)
      @licenses = Array licenses
    end

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

## Required gemspec attributes

### Attributes

name [RW]

This gem’s name.

Usage:

    spec.name = 'rake'

summary [R]

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"

version [R]

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'

### Public Instance Methods

authors= (value)
Source

    # File lib/rubygems/specification.rb, line 276
    def authors=(value)
      @authors = Array(value).flatten.grep(String)
    end

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

files ()
Source

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

## Specification internals

### Attributes

activated [RW]

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

activated? [RW]

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

specification_version [RW]

The `Gem::Specification` version of this gemspec.

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

### Public Class Methods

_load (str)
Source

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

Load custom marshal format, re-initializing defaults as needed

add_spec (spec)
Source

    # File lib/rubygems/specification.rb, line 854
    def self.add_spec(spec)
      specification_record.add_spec(spec)
    end

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

all ()
Source

    # File lib/rubygems/specification.rb, line 869
    def self.all
      warn "NOTE: Specification.all called from #{caller(1, 1).first}" unless
        Gem::Deprecate.skip
      _all
    end

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

all= (specs)
Source

    # File lib/rubygems/specification.rb, line 878
    def self.all=(specs)
      specification_record.all = specs
    end

Sets the known specs to `specs`.

all_names ()
Source

    # File lib/rubygems/specification.rb, line 885
    def self.all_names
      specification_record.all_names
    end

Return full names of all specs in sorted order.

array_attributes ()
Source

    # File lib/rubygems/specification.rb, line 894
    def self.array_attributes
      @@array_attributes.dup
    end

Return the list of all array-oriented instance variables.

attribute_names ()
Source

    # File lib/rubygems/specification.rb, line 903
    def self.attribute_names
      @@attributes.dup
    end

Return the list of all instance variables.

default_stubs (pattern = "*.gemspec")
Source

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

Returns a `Gem::StubSpecification` for default gems

dirs ()
Source

    # File lib/rubygems/specification.rb, line 910
    def self.dirs
      @@dirs ||= Gem::SpecificationRecord.dirs_from(gem_path)
    end

Return the directories that `Specification` uses to find specs.

dirs= (dirs)
Source

    # File lib/rubygems/specification.rb, line 918
    def self.dirs=(dirs)
      reset

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

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

each (&block)
Source

    # File lib/rubygems/specification.rb, line 930
    def self.each(&block)
      specification_record.each(&block)
    end

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

find_active_stub_by_path (path)
Source

    # File lib/rubygems/specification.rb, line 992
    def self.find_active_stub_by_path(path)
      specification_record.find_active_stub_by_path(path)
    end

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

find_all_by_full_name (full_name)
Source

    # File lib/rubygems/specification.rb, line 944
    def self.find_all_by_full_name(full_name)
      stubs.select {|s| s.full_name == full_name }.map(&:to_spec)
    end

Returns every spec that has the given `full_name`

find_all_by_name (name, *requirements)
Source

    # File lib/rubygems/specification.rb, line 937
    def self.find_all_by_name(name, *requirements)
      specification_record.find_all_by_name(name, *requirements)
    end

Returns every spec that matches `name` and optional `requirements`.

find_by_full_name (full_name)
Source

    # File lib/rubygems/specification.rb, line 960
    def self.find_by_full_name(full_name)
      stubs.find {|s| s.full_name == full_name }&.to_spec
    end

`Find` the best specification matching a `full_name`.

find_by_name (name, *requirements)
Source

    # File lib/rubygems/specification.rb, line 952
    def self.find_by_name(name, *requirements)
      requirements = Gem::Requirement.default if requirements.empty?

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

`Find` the best specification matching a `name` and `requirements`. Raises if the dependency doesn’t resolve to a valid specification.

find_by_path (path)
Source

    # File lib/rubygems/specification.rb, line 967
    def self.find_by_path(path)
      specification_record.find_by_path(path)
    end

Return the best specification that contains the file matching `path`.

find_in_unresolved (path)
Source

    # File lib/rubygems/specification.rb, line 999
    def self.find_in_unresolved(path)
      unresolved_specs.find_all {|spec| spec.contains_requirable_file? path }
    end

Return currently unresolved specs that contain the file matching `path`.

find_in_unresolved_tree (path)
Source

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

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

find_inactive_by_path (path)
Source

    # File lib/rubygems/specification.rb, line 984
    def self.find_inactive_by_path(path)
      specification_record.find_inactive_by_path(path)
    end

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

find_unloaded_by_path (path)
Source

    # File lib/rubygems/specification.rb, line 976
    def self.find_unloaded_by_path(path)
      specification_record.find_unloaded_by_path(path)
    end

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.

from_yaml (input)
Source

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

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

latest_spec_for (name)
Source

    # File lib/rubygems/specification.rb, line 1066
    def self.latest_spec_for(name)
      specification_record.latest_spec_for(name)
    end

Return the latest installed spec for gem `name`.

latest_specs (prerelease = false)
Source

    # File lib/rubygems/specification.rb, line 1059
    def self.latest_specs(prerelease = false)
      specification_record.latest_specs(prerelease)
    end

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

load (file)
Source

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

Loads Ruby format gemspec from `file`.

load_defaults ()
Source

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

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

new (name = nil, version = nil) { |self| ... }
Source

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

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

Calls superclass method `Gem::BasicSpecification::new`
non_nil_attributes ()
Source

    # File lib/rubygems/specification.rb, line 1126
    def self.non_nil_attributes
      @@non_nil_attributes.dup
    end

`Specification` attributes that must be non-nil

normalize_yaml_input (input)
Source

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

Make sure the `YAML` specification is properly formatted with dashes

outdated ()
Source

    # File lib/rubygems/specification.rb, line 1151
    def self.outdated
      outdated_and_latest_version.map {|local, _| local.name }
    end

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.

outdated_and_latest_version () { |local_spec, latest_remote| ... }
Source

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

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.

remove_spec (spec)
Source

    # File lib/rubygems/specification.rb, line 861
    def self.remove_spec(spec)
      specification_record.remove_spec(spec)
    end

Removes `spec` from the known specs.

required_attribute? (name)
Source

    # File lib/rubygems/specification.rb, line 1187
    def self.required_attribute?(name)
      @@required_attributes.include? name.to_sym
    end

Is `name` a required attribute?

required_attributes ()
Source

    # File lib/rubygems/specification.rb, line 1194
    def self.required_attributes
      @@required_attributes.dup
    end

Required specification attributes

reset ()
Source

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

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

specification_record ()
Source

    # File lib/rubygems/specification.rb, line 1238
    def self.specification_record
      @specification_record ||= Gem::SpecificationRecord.new(dirs)
    end

Keeps track of all currently known specifications

stubs ()
Source

    # File lib/rubygems/specification.rb, line 794
    def self.stubs
      specification_record.stubs
    end

Returns a `Gem::StubSpecification` for every installed gem

stubs_for (name)
Source

    # File lib/rubygems/specification.rb, line 813
    def self.stubs_for(name)
      specification_record.stubs_for(name)
    end

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

unresolved_deps ()
Source

    # File lib/rubygems/specification.rb, line 1243
    def self.unresolved_deps
      @unresolved_deps ||= Hash.new {|h, n| h[n] = Gem::Dependency.new n }
    end

DOC: This method needs documented or nodoc’d

### Private Class Methods

unresolved_specs ()
Source

    # File lib/rubygems/specification.rb, line 1021
    def self.unresolved_specs
      unresolved_deps.values.flat_map(&:to_specs)
    end

### Public Instance Methods

_dump (limit)
Source

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

Dump only crucial instance variables.

abbreviate ()
Source

    # File lib/rubygems/specification.rb, line 1444
    def abbreviate
      self.files = []
      self.test_files = []
      self.rdoc_options = []
      self.extra_rdoc_files = []
      self.cert_chain = []
    end

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.

activate ()
Source

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

activate_dependencies ()
Source

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

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

add_bindir (executables)
Source

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

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

add_runtime_dependency (gem, *requirements)
Alias for: add_dependency
add_self_to_load_path ()
Source

    # File lib/rubygems/specification.rb, line 1519
    def add_self_to_load_path
      return if default_gem?

      paths = full_require_paths

      Gem.add_to_load_path(*paths)
    end

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

author ()
Source

    # File lib/rubygems/specification.rb, line 1530
    def author
      (val = authors) && val.first
    end

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

authors ()
Source

    # File lib/rubygems/specification.rb, line 1539
    def authors
      @authors ||= []
    end

The list of author names who wrote this gem.

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

base_dir ()
Source

    # File lib/rubygems/specification.rb, line 1998
    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 ()
Source

    # File lib/rubygems/specification.rb, line 1549
    def bin_dir
      @bin_dir ||= File.join gem_dir, bindir
    end

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.

bin_file (name)
Source

    # File lib/rubygems/specification.rb, line 1556
    def bin_file(name)
      File.join bin_dir, name
    end

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

build_args ()
Source

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

Returns the `build_args` used to install the gem

build_info_dir ()
Source

    # File lib/rubygems/specification.rb, line 1611
    def build_info_dir
      File.join base_dir, "build_info"
    end

Returns the full path to the build info directory

build_info_file ()
Source

    # File lib/rubygems/specification.rb, line 1619
    def build_info_file
      File.join build_info_dir, "#{full_name}.info"
    end

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

cache_dir ()
Source

    # File lib/rubygems/specification.rb, line 1627
    def cache_dir
      File.join base_dir, "cache"
    end

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

cache_file ()
Source

    # File lib/rubygems/specification.rb, line 1634
    def cache_file
      File.join cache_dir, "#{full_name}.gem"
    end

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

conflicts ()
Source

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

Return any possible conflicts against the currently loaded specs.

date ()
Source

    # File lib/rubygems/specification.rb, line 1685
    def date
      @date ||= Time.utc(*Gem.source_date_epoch.utc.to_a[3..5].reverse)
    end

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/

date= (date)
Source

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

The date this gem was created

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

default_value (name)
Source

    # File lib/rubygems/specification.rb, line 1727
    def default_value(name)
      @@default_value[name]
    end

The default value for specification attribute `name`

dependencies ()
Source

    # File lib/rubygems/specification.rb, line 1737
    def dependencies
      @dependencies ||= []
    end

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

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

dependent_gems (check_dev = true)
Source

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

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

dependent_specs ()
Source

    # File lib/rubygems/specification.rb, line 1766
    def dependent_specs
      runtime_dependencies.flat_map(&:to_specs)
    end

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

description= (str)
Source

    # File lib/rubygems/specification.rb, line 1773
    def description=(str)
      @description = str.to_s
    end

A detailed description of this gem. See also `summary`

development_dependencies ()
Source

    # File lib/rubygems/specification.rb, line 1780
    def development_dependencies
      dependencies.select {|d| d.type == :development }
    end

List of dependencies that are used for development

doc_dir (type = nil)
Source

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

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"

executable ()
Source

    # File lib/rubygems/specification.rb, line 1822
    def executable
      (val = executables) && val.first
    end

Singular accessor for `executables`

executable= (o)
Source

    # File lib/rubygems/specification.rb, line 1829
    def executable=(o)
      self.executables = [o]
    end

Singular accessor for `executables`

executables= (value)
Source

    # File lib/rubygems/specification.rb, line 1836
    def executables=(value)
      @executables = Array(value)
    end

Sets executables to `value`, ensuring it is an array.

extensions= (extensions)
Source

    # File lib/rubygems/specification.rb, line 1843
    def extensions=(extensions)
      @extensions = Array extensions
    end

Sets extensions to `extensions`, ensuring it is an array.

extra_rdoc_files= (files)
Source

    # File lib/rubygems/specification.rb, line 1850
    def extra_rdoc_files=(files)
      @extra_rdoc_files = Array files
    end

Sets `extra_rdoc_files` to `files`, ensuring it is an array.

file_name ()
Source

    # File lib/rubygems/specification.rb, line 1859
    def file_name
      "#{full_name}.gem"
    end

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

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

files= (files)
Source

    # File lib/rubygems/specification.rb, line 1866
    def files=(files)
      @files = Array files
    end

Sets files to `files`, ensuring it is an array.

for_cache ()
Source

    # File lib/rubygems/specification.rb, line 1884
    def for_cache
      spec = dup

      spec.files = nil
      spec.test_files = nil

      spec
    end

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

gems_dir ()
Source

    # File lib/rubygems/specification.rb, line 1901
    def gems_dir
      @gems_dir ||= File.join(base_dir, "gems")
    end

has_conflicts? ()
Source

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

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

initialize_copy (other_spec)
Source

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

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

keep_only_files_and_directories ()
Source

    # File lib/rubygems/specification.rb, line 2523
    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 ()
Source

    # File lib/rubygems/specification.rb, line 2018
    def lib_files
      @files.select do |file|
        require_paths.any? do |path|
          file.start_with? path
        end
      end
    end

Files in the Gem under one of the require_paths

license ()
Source

    # File lib/rubygems/specification.rb, line 2029
    def license
      licenses.first
    end

Singular accessor for `licenses`

licenses ()
Source

    # File lib/rubygems/specification.rb, line 2038
    def licenses
      @licenses ||= []
    end

Plural accessor for setting licenses

See `license=` for details

missing_extensions? ()
Source

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

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

name_tuple ()
Source

    # File lib/rubygems/specification.rb, line 2105
    def name_tuple
      Gem::NameTuple.new name, version, original_platform
    end

Return a NameTuple that represents this `Specification`

normalize ()
Source

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

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.

platform ()
Source

    # File lib/rubygems/specification.rb, line 2131
    def platform
      @new_platform ||= Gem::Platform::RUBY # rubocop:disable Naming/MemoizedInstanceVariableName
    end

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

rdoc_options= (options)
Source

    # File lib/rubygems/specification.rb, line 2197
    def rdoc_options=(options)
      @rdoc_options = Array options
    end

Sets `rdoc_options` to `value`, ensuring it is an array.

require_path ()
Source

    # File lib/rubygems/specification.rb, line 2204
    def require_path
      (val = require_paths) && val.first
    end

Singular accessor for `require_paths`

require_path= (path)
Source

    # File lib/rubygems/specification.rb, line 2211
    def require_path=(path)
      self.require_paths = Array(path)
    end

Singular accessor for `require_paths`

requirements= (req)
Source

    # File lib/rubygems/specification.rb, line 2218
    def requirements=(req)
      @requirements = Array req
    end

Set requirements to `req`, ensuring it is an array.

reset_nil_attributes_to_default ()
Source

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

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

ri_dir ()
Source

    # File lib/rubygems/specification.rb, line 2229
    def ri_dir
      @ri_dir ||= File.join base_dir, "ri", full_name
    end

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

runtime_dependencies ()
Source

    # File lib/rubygems/specification.rb, line 2262
    def runtime_dependencies
      dependencies.select(&:runtime?)
    end

List of dependencies that will automatically be activated at runtime.

sanitize ()
Source

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

sanitize_string (string)
Source

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

Sanitize a single string.

satisfies_requirement? (dependency)
Source

    # File lib/rubygems/specification.rb, line 2278
    def satisfies_requirement?(dependency)
      @name == dependency.name &&
        dependency.requirement.satisfied_by?(@version)
    end

Checks if this specification meets the requirement of `dependency`.

sort_obj ()
Source

    # File lib/rubygems/specification.rb, line 2286
    def sort_obj
      [@name, @version, Gem::Platform.sort_priority(@new_platform)]
    end

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

spec_dir ()
Source

    # File lib/rubygems/specification.rb, line 2301
    def spec_dir
      @spec_dir ||= File.join base_dir, "specifications"
    end

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

spec_file ()
Source

    # File lib/rubygems/specification.rb, line 2309
    def spec_file
      @spec_file ||= File.join spec_dir, "#{full_name}.gemspec"
    end

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

spec_name ()
Source

    # File lib/rubygems/specification.rb, line 2318
    def spec_name
      "#{full_name}.gemspec"
    end

The default name of the gemspec. See also `file_name`

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

stubbed? ()
Source

    # File lib/rubygems/specification.rb, line 2542
    def stubbed?
      false
    end

summary= (str)
Source

    # File lib/rubygems/specification.rb, line 2325
    def summary=(str)
      @summary = str.to_s.strip.
        gsub(/(\w-)\n[ \t]*(\w)/, '\1\2').gsub(/\n[ \t]*/, " ") # so. weird.
    end

A short summary of this gem’s description.

to_ruby ()
Source

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

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.

to_ruby_for_cache ()
Source

    # File lib/rubygems/specification.rb, line 2442
    def to_ruby_for_cache
      for_cache.to_ruby
    end

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

See `to_ruby`.

to_spec ()
Source

    # File lib/rubygems/specification.rb, line 2453
    def to_spec
      self
    end

Returns self

traverse (trail = [], visited = {}, &block)
Source

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

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

validate (packaging = true, strict = false)
Source

    # File lib/rubygems/specification.rb, line 2515
    def validate(packaging = true, strict = false)
      normalize

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

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

validate_for_resolution ()
Source

    # File lib/rubygems/specification.rb, line 2531
    def validate_for_resolution
      Gem::SpecificationPolicy.new(self).validate_for_resolution
    end

version= (version)
Source

    # File lib/rubygems/specification.rb, line 2538
    def version=(version)
      @version = version.nil? ? version : Gem::Version.create(version)
    end

Set the version to `version`.

### Private Instance Methods

add_dependency_with_type (dependency, type, requirements)
Source

    # File lib/rubygems/specification.rb, line 1497
    def add_dependency_with_type(dependency, type, requirements)
      requirements = if requirements.empty?
        Gem::Requirement.default
      else
        requirements.flatten
      end

      unless dependency.respond_to?(:name) &&
             dependency.respond_to?(:requirement)
        dependency = Gem::Dependency.new(dependency.to_s, requirements, type)
      end

      dependencies << dependency
    end

Adds a dependency on gem `dependency` with type `type` that requires `requirements`. Valid types are currently `:runtime` and `:development`.

find_all_satisfiers (dep) { |spec| ... }
Source

    # File lib/rubygems/specification.rb, line 1873
    def find_all_satisfiers(dep)
      Gem::Specification.each do |spec|
        yield spec if spec.satisfies_requirement? dep
      end
    end

Finds all gems that satisfy `dep`

ruby_code (obj)
Source

    # File lib/rubygems/specification.rb, line 2237
    def ruby_code(obj)
      case obj
      when String             then obj.dump + ".freeze"
      when Array              then "[" + obj.map {|x| ruby_code x }.join(", ") + "]"
      when Hash               then
        seg = obj.keys.sort.map {|k| "#{k.to_s.dump} => #{obj[k].to_s.dump}" }
        "{ #{seg.join(", ")} }"
      when Gem::Version       then ruby_code(obj.to_s)
      when DateLike           then obj.strftime("%Y-%m-%d").dump
      when Time               then obj.strftime("%Y-%m-%d").dump
      when Numeric            then obj.inspect
      when true, false, nil   then obj.inspect
      when Gem::Platform      then "Gem::Platform.new(#{ruby_code obj.to_a})"
      when Gem::Requirement   then
        list = obj.as_list
        "Gem::Requirement.new(#{ruby_code(list.size == 1 ? obj.to_s : list)})"
      else raise Gem::Exception, "ruby_code case not handled: #{obj.class}"
      end
    end

Return a string containing a Ruby code representation of the given object.

same_attributes? (spec)
Source

    # File lib/rubygems/specification.rb, line 2269
    def same_attributes?(spec)
      @@attributes.all? {|name, _default| send(name) == spec.send(name) }
    end

True if this gem has the same attributes as `other`.