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

### Constants

NONEXISTENT_SPECIFICATION_VERSION

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

## Optional gemspec attributes

↑ top

### Attributes

bindir[RW]

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

Usage:

    spec.bindir = 'bin'

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_ruby_version[R]

The version of Ruby required by this gem

required_rubygems_version[R]

The RubyGems version required by this gem

rubygems_version[RW]

The version of RubyGems used to create this gem.

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

signing_key[RW]

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

### Public Instance Methods

add_development_dependency(gem, *requirements) click to toggle source

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.

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

add_runtime_dependency(gem, *requirements) click to toggle source

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

Usage:

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

    # File lib/rubygems/specification.rb, line 548
    def add_runtime_dependency(gem, *requirements)
      add_dependency_with_type(gem, :runtime, requirements)
    end

Also aliased as: add_dependency
executables() click to toggle source

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'

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

extensions() click to toggle source

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.

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

extra_rdoc_files() click to toggle source

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

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

platform=(platform) click to toggle source

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

    # File lib/rubygems/specification.rb, line 449
    def platform= platform
      if @original_platform.nil? or
         @original_platform == Gem::Platform::RUBY then
        @original_platform = platform
      end

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

      when Gem::Platform then
        @new_platform = platform

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

      @platform = @new_platform.to_s

      invalidate_memoized_attributes

      @new_platform
    end

rdoc_options() click to toggle source

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

Usage:

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

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

require_paths=(val) click to toggle source

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

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

required_ruby_version=(req) click to toggle source

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

Because patch-level is taken into account, be very careful specifying using `<=`: `<= 2.2.2` will not match any patch-level of 2.2.2 after the `p0` release. It is much safer to specify `< 2.2.3` instead

Usage:

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

    # Only with ruby 2.0.x
    spec.required_ruby_version = '~> 2.0'

    # Only with ruby between 2.2.0 and 2.2.2
    spec.required_ruby_version = ['>= 2.2.0', '< 2.2.3']

    # File lib/rubygems/specification.rb, line 657
    def required_ruby_version= req
      @required_ruby_version = Gem::Requirement.create req
    end

required_rubygems_version=(req) click to toggle source

The RubyGems version required by this gem

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

requirements() click to toggle source

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'

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

## Recommended gemspec attributes

↑ top

### 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 without requiring an update to the rubygems software.

Metadata items have the following restrictions:

- The metadata must be a Hash object

- All keys and values must be Strings

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

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

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

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

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

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

### Public Instance Methods

author=(o) click to toggle source

Singular writer for authors

Usage:

    spec.author = 'John Jones'

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

authors=(value) click to toggle source

Sets the list of authors, ensuring it is an array.

Usage:

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

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

license=(o) click to toggle source

The license for this gem.

The license must be no more than 64 characters.

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

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

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

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

You can set multiple licenses with licenses=

Usage:

    spec.license = 'MIT'

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

licenses=(licenses) click to toggle source

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

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

## Required gemspec attributes

↑ top

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

files() click to toggle source

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

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

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

Usage:

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

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

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

## Specification internals

↑ top

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

default_executable[W]

Sets the default executable for this gem.

Deprecated: You must now specify the executable name to Gem.bin_path.

rubyforge_project[RW]

The rubyforge project this gem lives under. i.e. RubyGems' #rubyforge_project is “rubygems”.

This option is deprecated.

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) click to toggle source

Load custom marshal format, re-initializing defaults as needed

    # File lib/rubygems/specification.rb, line 1331
    def self._load(str)
      array = Marshal.load str

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

      current_version = CURRENT_SPECIFICATION_VERSION

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

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

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

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

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

      spec
    end

add_spec(spec) click to toggle source

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

    # File lib/rubygems/specification.rb, line 899
    def self.add_spec spec
      warn "Gem::Specification.add_spec is deprecated and will be removed in RubyGems 3.0" unless Gem::Deprecate.skip
      # TODO: find all extraneous adds
      # puts
      # p :add_spec => [spec.full_name, caller.reject { |s| s =~ /minitest/ }]

      # TODO: flush the rest of the crap from the tests
      # raise "no dupes #{spec.full_name} in #{all_names.inspect}" if
      #   _all.include? spec

      raise "nil spec!" unless spec # TODO: remove once we're happy with tests

      return if _all.include? spec

      _all << spec
      stubs << spec
      (@@stubs_by_name[spec.name] ||= []) << spec
      sort_by!(@@stubs_by_name[spec.name]) { |s| s.version }
      _resort!(_all)
      _resort!(stubs)
    end

add_specs(*specs) click to toggle source

Adds multiple specs to the known specifications.

    # File lib/rubygems/specification.rb, line 924
    def self.add_specs *specs
      warn "Gem::Specification.add_specs is deprecated and will be removed in RubyGems 3.0" unless Gem::Deprecate.skip

      raise "nil spec!" if specs.any?(&:nil?) # TODO: remove once we're happy

      # TODO: this is much more efficient, but we need the extra checks for now
      # _all.concat specs
      # _resort!

      Gem::Deprecate.skip_during do
        specs.each do |spec| # TODO: slow
          add_spec spec
        end
      end
    end

all() click to toggle source

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

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

all=(specs) click to toggle source

Sets the known specs to `specs`. Not guaranteed to work for you in the future. Use at your own risk. Caveat emptor. Doomy doom doom. Etc etc.

    # File lib/rubygems/specification.rb, line 962
    def self.all= specs
      raise "nil spec!" if specs.any?(&:nil?) # TODO: remove once we're happy
      @@stubs_by_name = specs.group_by(&:name)
      @@all = @@stubs = specs
    end

all_names() click to toggle source

Return full names of all specs in sorted order.

    # File lib/rubygems/specification.rb, line 971
    def self.all_names
      self._all.map(&:full_name)
    end

array_attributes() click to toggle source

Return the list of all array-oriented instance variables.

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

attribute_names() click to toggle source

Return the list of all instance variables.

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

dirs() click to toggle source

Return the directories that Specification uses to find specs.

    # File lib/rubygems/specification.rb, line 996
    def self.dirs
      @@dirs ||= Gem.path.collect { |dir|
        File.join dir.dup.untaint, "specifications"
      }
    end

dirs=(dirs) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1006
    def self.dirs= dirs
      self.reset

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

each() { |x| ... } click to toggle source

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

    # File lib/rubygems/specification.rb, line 1018
    def self.each
      return enum_for(:each) unless block_given?

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

find_active_stub_by_path(path) click to toggle source

    # File lib/rubygems/specification.rb, line 1081
    def self.find_active_stub_by_path path
      stub = @@active_stub_with_requirable_file[path] ||= (stubs.find { |s|
        s.activated? and s.contains_requirable_file? path
      } || NOT_FOUND)
      stub.this
    end

find_all_by_full_name(full_name) click to toggle source

Returns every spec that has the given `full_name`

    # File lib/rubygems/specification.rb, line 1040
    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) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1029
    def self.find_all_by_name name, *requirements
      requirements = Gem::Requirement.default if requirements.empty?

      # TODO: maybe try: find_all { |s| spec === dep }

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

find_by_name(name, *requirements) click to toggle source

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

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

      # TODO: maybe try: find { |s| spec === dep }

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

find_by_path(path) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1059
    def self.find_by_path path
      path = path.dup.freeze
      spec = @@spec_with_requirable_file[path] ||= (stubs.find { |s|
        next unless Gem::BundlerVersionFinder.compatible?(s)
        s.contains_requirable_file? path
      } || NOT_FOUND)
      spec.to_spec
    end

find_in_unresolved(path) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1091
    def self.find_in_unresolved path
      # TODO: do we need these?? Kill it
      specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten

      specs.find_all { |spec| spec.contains_requirable_file? path }
    end

find_in_unresolved_tree(path) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1102
    def self.find_in_unresolved_tree path
      specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten

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

      []
    end

find_inactive_by_path(path) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1072
    def self.find_inactive_by_path path
      stub = stubs.find { |s|
        next if s.activated?
        next unless Gem::BundlerVersionFinder.compatible?(s)
        s.contains_requirable_file? path
      }
      stub && stub.to_spec
    end

from_yaml(input) click to toggle source

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.

    # File lib/rubygems/specification.rb, line 1126
    def self.from_yaml(input)
      Gem.load_yaml

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

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

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

      spec.specification_version ||= NONEXISTENT_SPECIFICATION_VERSION
      spec.reset_nil_attributes_to_default

      spec
    end

latest_specs(prerelease = false) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1150
    def self.latest_specs prerelease = false
      _latest_specs Gem::Specification._all, prerelease
    end

load(file) click to toggle source

Loads Ruby format gemspec from `file`.

    # File lib/rubygems/specification.rb, line 1174
    def self.load file
      return unless file

      _spec = LOAD_CACHE[file]
      return _spec if _spec

      file = file.dup.untaint
      return unless File.file?(file)

      code = if defined? Encoding
               File.read file, :mode => 'r:UTF-8:-'
             else
               File.read file
             end

      code.untaint

      begin
        _spec = eval code, binding, file

        if Gem::Specification === _spec
          _spec.loaded_from = File.expand_path file.to_s
          LOAD_CACHE[file] = _spec
          return _spec
        end

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

      nil
    end

load_defaults() click to toggle source

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

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

new(name = nil, version = nil) { |self| ... } click to toggle source

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

    # File lib/rubygems/specification.rb, line 2070
    def initialize name = nil, version = nil
      super()
      @gems_dir              = nil
      @base_dir              = nil
      @loaded = false
      @activated = false
      @loaded_from = nil
      @original_platform = nil
      @installed_by_version = nil

      set_nil_attributes_to_nil
      set_not_nil_attributes_to_default_values

      @new_platform = Gem::Platform::RUBY

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

      yield self if block_given?
    end

non_nil_attributes() click to toggle source

Specification attributes that must be non-nil

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

normalize_yaml_input(input) click to toggle source

Make sure the YAML specification is properly formatted with dashes

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

outdated() click to toggle source

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.

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

outdated_and_latest_version() { |local_spec, latest_remote| ... } click to toggle source

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.

    # File lib/rubygems/specification.rb, line 1249
    def self.outdated_and_latest_version
      return enum_for __method__ unless block_given?

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

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

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

        latest_remote = remotes.sort.last

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

      nil
    end

remove_spec(spec) click to toggle source

Removes `spec` from the known specs.

    # File lib/rubygems/specification.rb, line 1274
    def self.remove_spec spec
      warn "Gem::Specification.remove_spec is deprecated and will be removed in RubyGems 3.0" unless Gem::Deprecate.skip
      _all.delete spec
      stubs.delete_if { |s| s.full_name == spec.full_name }
      (@@stubs_by_name[spec.name] || []).delete_if { |s| s.full_name == spec.full_name }
      reset
    end

required_attribute?(name) click to toggle source

Is `name` a required attribute?

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

required_attributes() click to toggle source

Required specification attributes

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

reset() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1300
    def self.reset
      @@dirs = nil
      Gem.pre_reset_hooks.each { |hook| hook.call }
      @@all = nil
      @@stubs = nil
      @@stubs_by_name = {}
      @@spec_with_requirable_file          = {}
      @@active_stub_with_requirable_file   = {}
      _clear_load_cache
      unresolved = unresolved_deps
      unless unresolved.empty? then
        w = "W" + "ARN"
        warn "#{w}: Unresolved specs during Gem::Specification.reset:"
        unresolved.values.each do |dep|
          warn "      #{dep}"
        end
        warn "#{w}: Clearing out unresolved specs."
        warn "Please report a bug if this causes problems."
        unresolved.clear
      end
      Gem.post_reset_hooks.each { |hook| hook.call }
    end

stubs() click to toggle source

Returns a Gem::StubSpecification for every installed gem

    # File lib/rubygems/specification.rb, line 845
    def self.stubs
      @@stubs ||= begin
        pattern = "*.gemspec"
        stubs = default_stubs(pattern).concat installed_stubs(dirs, pattern)
        stubs = uniq_by(stubs) { |stub| stub.full_name }

        _resort!(stubs)
        @@stubs_by_name = stubs.group_by(&:name)
        stubs
      end
    end

stubs_for(name) click to toggle source

Returns a Gem::StubSpecification for installed gem named `name`

    # File lib/rubygems/specification.rb, line 862
    def self.stubs_for name
      if @@stubs
        @@stubs_by_name[name] || []
      else
        pattern = "#{name}-*.gemspec"
        stubs = default_stubs(pattern) + installed_stubs(dirs, pattern)
        stubs = uniq_by(stubs) { |stub| stub.full_name }.group_by(&:name)
        stubs.each_value { |v| _resort!(v) }

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

unresolved_deps() click to toggle source

DOC: This method needs documented or nodoc'd

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

### Private Class Methods

default_stubs(pattern) click to toggle source

    # File lib/rubygems/specification.rb, line 770
    def self.default_stubs pattern
      base_dir = Gem.default_dir
      gems_dir = File.join base_dir, "gems"
      gemspec_stubs_in(default_specifications_dir, pattern) do |path|
        Gem::StubSpecification.default_gemspec_stub(path, base_dir, gems_dir)
      end
    end

gemspec_stubs_in(dir, pattern) { |path| ... } click to toggle source

    # File lib/rubygems/specification.rb, line 765
    def self.gemspec_stubs_in dir, pattern
      Dir[File.join(dir, pattern)].map { |path| yield path }.select(&:valid?)
    end

installed_stubs(dirs, pattern) click to toggle source

    # File lib/rubygems/specification.rb, line 779
    def self.installed_stubs dirs, pattern
      map_stubs(dirs, pattern) do |path, base_dir, gems_dir|
        Gem::StubSpecification.gemspec_stub(path, base_dir, gems_dir)
      end
    end

sort_by!(list, &block) click to toggle source

    # File lib/rubygems/specification.rb, line 825
    def self.sort_by! list, &block
      list.sort_by!(&block)
    end

### Public Instance Methods

_dump(limit) click to toggle source

Dump only crucial instance variables.

    # File lib/rubygems/specification.rb, line 1399
    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() click to toggle source

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.

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

activate() click to toggle source

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.

    # File lib/rubygems/specification.rb, line 1429
    def activate
      other = Gem.loaded_specs[self.name]
      if other then
        check_version_conflict other
        return false
      end

      raise_if_conflicts

      activate_dependencies
      add_self_to_load_path

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

      return true
    end

activate_dependencies() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1453
    def activate_dependencies
      unresolved = Gem::Specification.unresolved_deps

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

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

          raise e
        end

        specs = spec_dep.to_specs

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

      unresolved.delete self.name
    end

add_bindir(executables) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1528
    def add_bindir(executables)
      return nil if executables.nil?

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

add_dependency(gem, *requirements)
Alias for: add_runtime_dependency
add_self_to_load_path() click to toggle source

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

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

      paths = full_require_paths

      # gem directories must come after -I and ENV['RUBYLIB']
      insert_index = Gem.load_path_insert_index

      if insert_index then
        # gem directories must come after -I and ENV['RUBYLIB']
        $LOAD_PATH.insert(insert_index, *paths)
      else
        # we are probably testing in core, -I and RUBYLIB don't apply
        $LOAD_PATH.unshift(*paths)
      end
    end

author() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1587
    def author
      val = authors and val.first
    end

authors() click to toggle source

The list of author names who wrote this gem.

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

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

base_dir() click to toggle source

    # File lib/rubygems/specification.rb, line 2116
    def base_dir
      return Gem.dir unless loaded_from
      @base_dir ||= if default_gem? then
                      File.dirname File.dirname File.dirname loaded_from
                    else
                      File.dirname File.dirname loaded_from
                    end
    end

bin_dir() click to toggle source

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.

    # File lib/rubygems/specification.rb, line 1606
    def bin_dir
      @bin_dir ||= File.join gem_dir, bindir # TODO: this is unfortunate
    end

bin_file(name) click to toggle source

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

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

build_args() click to toggle source

Returns the #build_args used to install the gem

    # File lib/rubygems/specification.rb, line 1620
    def build_args
      if File.exist? build_info_file
        build_info = File.readlines build_info_file
        build_info = build_info.map { |x| x.strip }
        build_info.delete ""
        build_info
      else
        []
      end
    end

build_info_dir() click to toggle source

Returns the full path to the build info directory

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

build_info_file() click to toggle source

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

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

bundled_gem_in_old_ruby?() click to toggle source

Used to detect if the gem is bundled in older version of Ruby, but not detectable as default gem (see BasicSpecification#default_gem?).

    # File lib/rubygems/specification.rb, line 1683
    def bundled_gem_in_old_ruby?
      !default_gem? &&
        RUBY_VERSION < "2.0.0" &&
        summary == "This #{name} is bundled with Ruby"
    end

cache_dir() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1693
    def cache_dir
      @cache_dir ||= File.join base_dir, "cache"
    end

cache_file() click to toggle source

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

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

conflicts() click to toggle source

Return any possible conflicts against the currently loaded specs.

    # File lib/rubygems/specification.rb, line 1707
    def conflicts
      conflicts = {}
      self.runtime_dependencies.each { |dep|
        spec = Gem.loaded_specs[dep.name]
        if spec and not spec.satisfies_requirement? dep
          (conflicts[spec] ||= []) << dep
        end
      }
      env_req = Gem.env_requirement(name)
      (conflicts[self] ||= []) << env_req unless env_req.satisfied_by? version
      conflicts
    end

date() click to toggle source

The date this gem was created. Lazily defaults to the current UTC date.

There is no need to set this in your gem specification.

    # File lib/rubygems/specification.rb, line 1750
    def date
      @date ||= TODAY
    end

date=(date) click to toggle source

The date this gem was created

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

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

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

default_value(name) click to toggle source

The default value for specification attribute `name`

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

dependencies() click to toggle source

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

Use add_dependency or add_development_dependency to add dependencies to a gem.

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

dependent_gems() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1835
    def dependent_gems
      out = []
      Gem::Specification.each do |spec|
        spec.dependencies.each do |dep|
          if self.satisfies_requirement?(dep) then
            sats = []
            find_all_satisfiers(dep) do |sat|
              sats << sat
            end
            out << [spec, dep, sats]
          end
        end
      end
      out
    end

dependent_specs() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1854
    def dependent_specs
      runtime_dependencies.map { |dep| dep.to_specs }.flatten
    end

description=(str) click to toggle source

A detailed description of this gem. See also summary

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

development_dependencies() click to toggle source

List of dependencies that are used for development

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

doc_dir(type = nil) click to toggle source

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"

    # File lib/rubygems/specification.rb, line 1880
    def doc_dir type = nil
      @doc_dir ||= File.join base_dir, 'doc', full_name

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

executable() click to toggle source

Singular accessor for executables

    # File lib/rubygems/specification.rb, line 1918
    def executable
      val = executables and val.first
    end

executable=(o) click to toggle source

Singular accessor for executables

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

executables=(value) click to toggle source

Sets executables to `value`, ensuring it is an array. Don't use this, push onto the array instead.

    # File lib/rubygems/specification.rb, line 1933
    def executables= value
      # TODO: warn about setting instead of pushing
      @executables = Array(value)
    end

extensions=(extensions) click to toggle source

Sets extensions to `extensions`, ensuring it is an array. Don't use this, push onto the array instead.

    # File lib/rubygems/specification.rb, line 1942
    def extensions= extensions
      # TODO: warn about setting instead of pushing
      @extensions = Array extensions
    end

extra_rdoc_files=(files) click to toggle source

Sets #extra_rdoc_files to `files`, ensuring it is an array. Don't use this, push onto the array instead.

    # File lib/rubygems/specification.rb, line 1951
    def extra_rdoc_files= files
      # TODO: warn about setting instead of pushing
      @extra_rdoc_files = Array files
    end

file_name() click to toggle source

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

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

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

files=(files) click to toggle source

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

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

for_cache() click to toggle source

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

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

      spec.files = nil
      spec.test_files = nil

      spec
    end

full_name() click to toggle source
Calls superclass method Gem::BasicSpecification#full_name

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

gems_dir() click to toggle source

    # File lib/rubygems/specification.rb, line 2006
    def gems_dir
      # TODO: this logic seems terribly broken, but tests fail if just base_dir
      @gems_dir ||= File.join(loaded_from && base_dir || Gem.dir, "gems")
    end

has_conflicts?() click to toggle source

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

    # File lib/rubygems/specification.rb, line 1733
    def has_conflicts?
      return true unless Gem.env_requirement(name).satisfied_by?(version)
      self.dependencies.any? { |dep|
        if dep.runtime? then
          spec = Gem.loaded_specs[dep.name]
          spec and not spec.satisfies_requirement? dep
        else
          false
        end
      }
    end

initialize_copy(other_spec) click to toggle source

Duplicates ::array_attributes from `other_spec` so state isn't shared.

    # File lib/rubygems/specification.rb, line 2094
    def initialize_copy other_spec
      self.class.array_attributes.each do |name|
        name = :"@#{name}"
        next unless other_spec.instance_variable_defined? name

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

          e.file_path = loaded_from
          raise e
        end
      end
    end

lib_files() click to toggle source

Files in the Gem under one of the require_paths

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

license() click to toggle source

Singular accessor for licenses

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

licenses() click to toggle source

Plural accessor for setting licenses

See license= for details

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

mark_version() click to toggle source

Sets the #rubygems_version to the current RubyGems version.

    # File lib/rubygems/specification.rb, line 2185
    def mark_version
      @rubygems_version = Gem::VERSION
    end

missing_extensions?() click to toggle source

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

    # File lib/rubygems/specification.rb, line 2205
    def missing_extensions?
      return false if default_gem?
      return false if extensions.empty?
      return false if installed_by_version < Gem::Version.new('2.2.0.preview.2')
      return false if File.exist? gem_build_complete_path

      true
    end

name_tuple() click to toggle source

Return a NameTuple that represents this Specification

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

normalize() click to toggle source

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.

    # File lib/rubygems/specification.rb, line 2220
    def normalize
      if defined?(@extra_rdoc_files) and @extra_rdoc_files then
        @extra_rdoc_files.uniq!
        @files ||= []
        @files.concat(@extra_rdoc_files)
      end

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

platform() click to toggle source

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

    # File lib/rubygems/specification.rb, line 2263
    def platform
      @new_platform ||= Gem::Platform::RUBY
    end

rdoc_options=(options) click to toggle source

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

    # File lib/rubygems/specification.rb, line 2331
    def rdoc_options= options
      # TODO: warn about setting instead of pushing
      @rdoc_options = Array options
    end

require_path() click to toggle source

Singular accessor for require_paths

    # File lib/rubygems/specification.rb, line 2339
    def require_path
      val = require_paths and val.first
    end

require_path=(path) click to toggle source

Singular accessor for require_paths

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

requirements=(req) click to toggle source

Set requirements to `req`, ensuring it is an array. Don't use this, push onto the array instead.

    # File lib/rubygems/specification.rb, line 2354
    def requirements= req
      # TODO: warn about setting instead of pushing
      @requirements = Array req
    end

reset_nil_attributes_to_default() click to toggle source

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

    # File lib/rubygems/specification.rb, line 3046
    def reset_nil_attributes_to_default
      nil_attributes = self.class.non_nil_attributes.find_all do |name|
        !instance_variable_defined?("@#{name}") || instance_variable_get("@#{name}").nil?
      end

      nil_attributes.each do |attribute|
        default = self.default_value attribute

        value = case default
                when Time, Numeric, Symbol, true, false, nil then default
                else default.dup
                end

        instance_variable_set "@#{attribute}", value
      end

      @installed_by_version ||= nil
    end

ri_dir() click to toggle source

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

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

runtime_dependencies() click to toggle source

List of dependencies that will automatically be activated at runtime.

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

sanitize() click to toggle source

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.

    # File lib/rubygems/specification.rb, line 1499
    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) click to toggle source

Sanitize a single string.

    # File lib/rubygems/specification.rb, line 1509
    def sanitize_string(string)
      return string unless string

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

      begin
        Builder::XChar.encode string
      rescue NameError, NoMethodError
        string.to_xs
      end
    end

satisfies_requirement?(dependency) click to toggle source

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

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

sort_obj() click to toggle source

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

    # File lib/rubygems/specification.rb, line 2423
    def sort_obj
      [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1]
    end

spec_dir() click to toggle source

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

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

spec_file() click to toggle source

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

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

spec_name() click to toggle source

The default name of the gemspec. See also file_name

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

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

stubbed?() click to toggle source

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

summary=(str) click to toggle source

A short summary of this gem's description.

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

to_ruby() click to toggle source

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.

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

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

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

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

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

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

      unless dependencies.empty? then
        result << nil
        result << "  if s.respond_to? :specification_version then"
        result << "    s.specification_version = #{specification_version}"
        result << nil

        result << "    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then"

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

        result << "    else"

        dependencies.each do |dep|
          version_reqs_param = dep.requirements_list.inspect
          result << "      s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})"
        end

        result << '    end'

        result << "  else"
        dependencies.each do |dep|
          version_reqs_param = dep.requirements_list.inspect
          result << "    s.add_dependency(%q<#{dep.name}>.freeze, #{version_reqs_param})"
        end
        result << "  end"
      end

      result << "end"
      result << nil

      result.join "\n"
    end

to_ruby_for_cache() click to toggle source

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

See to_ruby.

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

to_spec() click to toggle source

Returns self

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

traverse(trail = [], visited = {}) click to toggle source

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

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

validate(packaging = true) click to toggle source

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

    # File lib/rubygems/specification.rb, line 2679
      def validate packaging = true
        @warnings = 0
        require 'rubygems/user_interaction'
        extend Gem::UserInteraction
        normalize

        nil_attributes = self.class.non_nil_attributes.find_all do |attrname|
          instance_variable_get("@#{attrname}").nil?
        end

        unless nil_attributes.empty? then
          raise Gem::InvalidSpecificationException,
            "#{nil_attributes.join ', '} must not be nil"
        end

        if packaging and rubygems_version != Gem::VERSION then
          raise Gem::InvalidSpecificationException,
                "expected RubyGems version #{Gem::VERSION}, was #{rubygems_version}"
        end

        @@required_attributes.each do |symbol|
          unless self.send symbol then
            raise Gem::InvalidSpecificationException,
                  "missing value for attribute #{symbol}"
          end
        end

        if !name.is_a?(String) then
          raise Gem::InvalidSpecificationException,
                "invalid value for attribute name: \"#{name.inspect}\" must be a string"
        elsif name !~ /[a-zA-Z]/ then
          raise Gem::InvalidSpecificationException,
                "invalid value for attribute name: #{name.dump} must include at least one letter"
        elsif name !~ VALID_NAME_PATTERN then
          raise Gem::InvalidSpecificationException,
                "invalid value for attribute name: #{name.dump} can only include letters, numbers, dashes, and underscores"
        end

        if raw_require_paths.empty? then
          raise Gem::InvalidSpecificationException,
                'specification must have at least one require_path'
        end

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

        non_files = files.reject { |x| File.file?(x) || File.symlink?(x) }

        unless not packaging or non_files.empty? then
          raise Gem::InvalidSpecificationException,
                "[\"#{non_files.join "\", \""}\"] are not files"
        end

        if files.include? file_name then
          raise Gem::InvalidSpecificationException,
                "#{full_name} contains itself (#{file_name}), check your files list"
        end

        unless specification_version.is_a?(Integer)
          raise Gem::InvalidSpecificationException,
                'specification_version must be an Integer (did you mean version?)'
        end

        case platform
        when Gem::Platform, Gem::Platform::RUBY then # ok
        else
          raise Gem::InvalidSpecificationException,
                "invalid platform #{platform.inspect}, see Gem::Platform"
        end

        self.class.array_attributes.each do |field|
          val = self.send field
          klass = case field
                  when :dependencies
                    Gem::Dependency
                  else
                    String
                  end

          unless Array === val and val.all? { |x| x.kind_of?(klass) } then
            raise(Gem::InvalidSpecificationException,
                  "#{field} must be an Array of #{klass}")
          end
        end

        [:authors].each do |field|
          val = self.send field
          raise Gem::InvalidSpecificationException, "#{field} may not be empty" if
            val.empty?
        end

        unless Hash === metadata
          raise Gem::InvalidSpecificationException,
                  'metadata must be a hash'
        end

        validate_metadata

        licenses.each { |license|
          if license.length > 64
            raise Gem::InvalidSpecificationException,
              "each license must be 64 characters or less"
          end

          if !Gem::Licenses.match?(license)
            suggestions = Gem::Licenses.suggestions(license)
            message = <<-warning
    license value '#{license}' is invalid.  Use a license identifier from
    http://spdx.org/licenses or '#{Gem::Licenses::NONSTANDARD}' for a nonstandard license.
            warning
            message += "Did you mean #{suggestions.map { |s| "'#{s}'"}.join(', ')}?\n" unless suggestions.nil?
            warning(message)
          end
        }

        warning <<-warning if licenses.empty?
    licenses is empty, but is recommended.  Use a license identifier from
    http://spdx.org/licenses or '#{Gem::Licenses::NONSTANDARD}' for a nonstandard license.
        warning

        validate_permissions

        # reject lazy developers:

        lazy = '"FIxxxXME" or "TOxxxDO"'.gsub(/xxx/, '')

        unless authors.grep(/FI XME|TO DO/x).empty? then
          raise Gem::InvalidSpecificationException, "#{lazy} is not an author"
        end

        unless Array(email).grep(/FI XME|TO DO/x).empty? then
          raise Gem::InvalidSpecificationException, "#{lazy} is not an email"
        end

        if description =~ /FI XME|TO DO/x then
          raise Gem::InvalidSpecificationException, "#{lazy} is not a description"
        end

        if summary =~ /FI XME|TO DO/x then
          raise Gem::InvalidSpecificationException, "#{lazy} is not a summary"
        end

        # Make sure a homepage is valid HTTP/HTTPS URI
        if homepage and not homepage.empty?
          begin
            homepage_uri = URI.parse(homepage)
            unless [URI::HTTP, URI::HTTPS].member? homepage_uri.class
              raise Gem::InvalidSpecificationException, "\"#{homepage}\" is not a valid HTTP URI"
            end
          rescue URI::InvalidURIError
            raise Gem::InvalidSpecificationException, "\"#{homepage}\" is not a valid HTTP URI"
          end
        end

        # Warnings

        %w[author homepage summary files].each do |attribute|
          value = self.send attribute
          warning "no #{attribute} specified" if value.nil? or value.empty?
        end

        if description == summary then
          warning 'description and summary are identical'
        end

        # TODO: raise at some given date
        warning "deprecated autorequire specified" if autorequire

        executables.each do |executable|
          executable_path = File.join(bindir, executable)
          shebang = File.read(executable_path, 2) == '#!'

          warning "#{executable_path} is missing #! line" unless shebang
        end

        files.each do |file|
          next unless File.symlink?(file)
          warning "#{file} is a symlink, which is not supported on all platforms"
        end

        validate_dependencies

        true
      ensure
        if $! or @warnings > 0 then
          alert_warning "See http://guides.rubygems.org/specification-reference/ for help"
        end
      end

validate_metadata() click to toggle source

    # File lib/rubygems/specification.rb, line 2871
    def validate_metadata
      url_validation_regex = %r{\Ahttps?:\/\/([^\s:@]+:[^\s:@]*@)?[A-Za-z\d\-]+(\.[A-Za-z\d\-]+)+\.?(:\d{1,5})?([\/?]\S*)?\z}
      link_keys = %w(
        bug_tracker_uri
        changelog_uri
        documentation_uri
        homepage_uri
        mailing_list_uri
        source_code_uri
        wiki_uri
      )

      metadata.each do|key, value|
        if !key.kind_of?(String)
          raise Gem::InvalidSpecificationException,
                  "metadata keys must be a String"
        end

        if key.size > 128
          raise Gem::InvalidSpecificationException,
                  "metadata key too large (#{key.size} > 128)"
        end

        if !value.kind_of?(String)
          raise Gem::InvalidSpecificationException,
                  "metadata values must be a String"
        end

        if value.size > 1024
          raise Gem::InvalidSpecificationException,
                  "metadata value too large (#{value.size} > 1024)"
        end

        if link_keys.include? key
          if value !~ url_validation_regex
            raise Gem::InvalidSpecificationException,
                   "metadata['#{key}'] has invalid link: #{value.inspect}"
          end
        end
      end
    end

validate_permissions() click to toggle source

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

    # File lib/rubygems/specification.rb, line 2994
    def validate_permissions
      return if Gem.win_platform?

      files.each do |file|
        next unless File.file?(file)
        next if File.stat(file).mode & 0444 == 0444
        warning "#{file} is not world-readable"
      end

      executables.each do |name|
        exec = File.join @bindir, name
        next unless File.file?(exec)
        next if File.stat(exec).executable?
        warning "#{exec} is not executable"
      end
    end

version=(version) click to toggle source

Set the version to `version`, potentially also setting #required_rubygems_version if `version` indicates it is a prerelease.

    # File lib/rubygems/specification.rb, line 3016
    def version= version
      @version = Gem::Version.create(version)
      self.required_rubygems_version = '> 1.3.1' if @version.prerelease?
      invalidate_memoized_attributes

      return @version
    end

### Private Instance Methods

add_dependency_with_type(dependency, type, requirements) click to toggle source

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

    # File lib/rubygems/specification.rb, line 1545
    def add_dependency_with_type(dependency, type, requirements)
      requirements = if requirements.empty? then
                       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

find_all_satisfiers(dep) { |spec| ... } click to toggle source

Finds all gems that satisfy `dep`

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

invalidate_memoized_attributes() click to toggle source

Expire memoized instance variables that can incorrectly generate, replace or miss files due changes in certain attributes used to compute them.

    # File lib/rubygems/specification.rb, line 2129
    def invalidate_memoized_attributes
      @full_name = nil
      @cache_file = nil
    end

ruby_code(obj) click to toggle source

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

    # File lib/rubygems/specification.rb, line 2374
    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 obj.to_s.dump
      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(#{obj.to_a.inspect})"
      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

same_attributes?(spec) click to toggle source

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

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