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

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 = 'http://rake.rubyforge.org'
metadata[RW]

:attr_accessor: metadata

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

To add metadata for the location of a issue tracker:

s.metadata = { "issue_tracker" => "https://example/issues" }
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

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 459
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 470
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 489
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 506
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 522
def extra_rdoc_files
  @extra_rdoc_files ||= []
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 602
def rdoc_options
  @rdoc_options ||= []
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">

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'
# File lib/rubygems/specification.rb, line 622
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 629
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 642
def requirements
  @requirements ||= []
end

Recommended gemspec attributes

↑ top

Public Instance Methods

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 BSD-3-Clause and MIT. 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 571
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']
# File lib/rubygems/specification.rb, line 589
def licenses= licenses
  @licenses = Array licenses
end

Required gemspec attributes

↑ top

Attributes

name[RW]

This gem's name.

Usage:

spec.name = 'rake'
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.

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

author=(o) click to toggle source

Singular writer for authors

Usage:

spec.author = 'John Jones'
# File lib/rubygems/specification.rb, line 245
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 256
def authors= value
  @authors = Array(value).flatten.grep(String)
end
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 339
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.uniq.compact.sort
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 should leave the default value in place unless their 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 283
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
require_paths=(val) click to toggle source

Paths in the gem to add to $LOAD_PATH when this gem is activated.

See also require_paths

If you have an extension you do not need to add "ext" to the require path, the extension build process will copy the extension files into “lib” for you.

The default value is "lib"

Usage:

# If all library files are in the root directory...
spec.require_paths = ['.']
# File lib/rubygems/specification.rb, line 216
def require_paths=(val)
  @require_paths = Array(val)
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 1176
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 782
def self.add_spec spec
  # 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
  _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 804
def self.add_specs *specs
  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!

  specs.each do |spec| # TODO: slow
    add_spec spec
  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 820
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 838
def self.all= specs
  @@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 845
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 854
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 863
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 870
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 880
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 892
def self.each
  return enum_for(:each) unless block_given?

  self._all.each do |x|
    yield x
  end
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 903
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 915
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 926
def self.find_by_path path
  self.find { |spec|
    spec.contains_requirable_file? path
  }
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 946
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 957
def self.find_in_unresolved_tree path
  specs = unresolved_deps.values.map { |dep| dep.to_specs }.flatten

  specs.reverse_each do |spec|
    trails = []
    spec.traverse do |from_spec, dep, to_spec, trail|
      next unless to_spec.conflicts.empty?
      trails << trail if to_spec.contains_requirable_file? path
    end

    next if trails.empty?

    return trails.map(&:reverse).sort.first.reverse
  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 936
def self.find_inactive_by_path path
  stub = stubs.find { |s|
    s.contains_requirable_file? path unless s.activated?
  }
  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 983
def self.from_yaml(input)
  Gem.load_yaml

  input = normalize_yaml_input input
  spec = YAML.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 1007
def self.latest_specs prerelease = false
  result = Hash.new { |h,k| h[k] = {} }
  native = {}

  Gem::Specification.reverse_each do |spec|
    next if spec.version.prerelease? unless prerelease

    native[spec.name] = spec.version if spec.platform == Gem::Platform::RUBY
    result[spec.name][spec.platform] = spec
  end

  result.map(&:last).map(&:values).flatten.reject { |spec|
    minimum = native[spec.name]
    minimum && spec.version < minimum
  }.sort_by{ |tup| tup.name }
end
load(file) click to toggle source

Loads Ruby format gemspec from file.

# File lib/rubygems/specification.rb, line 1027
def self.load file
  return unless file
  file = file.dup.untaint
  return unless File.file?(file)

  spec = LOAD_CACHE[file]
  return spec if spec

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

# File lib/rubygems/specification.rb, line 1823
def initialize name = nil, version = nil
  @loaded = false
  @activated = false
  self.loaded_from = nil
  @original_platform = nil
  @installed_by_version = nil

  @@nil_attributes.each do |key|
    instance_variable_set "@#{key}", nil
  end

  @@non_nil_attributes.each do |key|
    default = default_value(key)
    value = Dupable[key] ? default.dup : default
    instance_variable_set "@#{key}", value
  end

  @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 1065
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 1072
def self.normalize_yaml_input(input)
  result = input.respond_to?(:read) ? input.read : input
  result = "--- " + result unless result =~ /\A--- /
  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 1089
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 1100
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 1125
def self.remove_spec spec
  _all.delete spec
  stubs.delete_if { |s| s.full_name == spec.full_name }
end
required_attribute?(name) click to toggle source

Is name a required attribute?

# File lib/rubygems/specification.rb, line 1133
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 1140
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 1148
def self.reset
  @@dirs = nil
  Gem.pre_reset_hooks.each { |hook| hook.call }
  @@all = nil
  @@stubs = nil
  _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 746
def self.stubs
  @@stubs ||= begin
    stubs = {}
    each_stub([default_specifications_dir] + dirs) do |stub|
      stubs[stub.full_name] ||= stub
    end

    stubs = stubs.values
    _resort!(stubs)
    stubs
  end
end
unresolved_deps() click to toggle source

DOC: This method needs documented or nodoc'd

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

Public Instance Methods

_dump(limit) click to toggle source

Dump only crucial instance variables.

# File lib/rubygems/specification.rb, line 1244
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
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 1274
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 1298
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 1329
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)
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 1368
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 1388
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 1397
def authors
  @authors ||= []
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 1407
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 1414
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 1421
def build_args
  if File.exist? build_info_file
    File.readlines(build_info_file).map { |x| x.strip }
  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 1463
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 1471
def build_info_file
  File.join build_info_dir, "#{full_name}.info"
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 1479
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 1486
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 1493
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
  }
  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 1509
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 1529
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 1574
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 1584
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 1594
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 1613
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 1620
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 1627
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 1639
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 1677
def executable
  val = executables and val.first
end
executable=(o) click to toggle source

Singular accessor for executables

# File lib/rubygems/specification.rb, line 1684
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 1692
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 1701
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 1710
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 1720
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 1727
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 1745
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 1759
def full_name
  @full_name ||= super
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 1851
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_dirs_glob() click to toggle source

Returns a string usable in Dir.glob to match all requirable paths for this spec.

# File lib/rubygems/specification.rb, line 1896
def lib_dirs_glob
  dirs = if self.require_paths.size > 1 then
           "{#{self.require_paths.join(',')}}"
         else
           self.require_paths.first
         end

  "#{self.full_gem_path}/#{dirs}"
end
lib_files() click to toggle source

Files in the Gem under one of the require_paths

# File lib/rubygems/specification.rb, line 1909
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 1920
def license
  val = licenses and val.first
end
licenses() click to toggle source

Plural accessor for setting licenses

See license= for details

# File lib/rubygems/specification.rb, line 1929
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 1948
def mark_version
  @rubygems_version = Gem::VERSION
end
matches_for_glob(glob) click to toggle source

Return all files in this gem that match for glob.

# File lib/rubygems/specification.rb, line 1955
def matches_for_glob glob # TODO: rename?
  # TODO: do we need these?? Kill it
  glob = File.join(self.lib_dirs_glob, glob)

  Dir[glob].map { |f| f.untaint } # FIX our tests are broken, run w/ SAFE=1
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 1978
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 2010
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 1993
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 2036
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 2106
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 2114
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 2121
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 2129
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 2747
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 2141
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 2174
def runtime_dependencies
  dependencies.select { |d| d.type == :runtime }
end
satisfies_requirement?(dependency) click to toggle source

Checks if this specification meets the requirement of dependency.

# File lib/rubygems/specification.rb, line 2190
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 2198
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 2213
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 2221
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 2230
def spec_name
  "#{full_name}.gemspec"
end
stubbed?() click to toggle source
# File lib/rubygems/specification.rb, line 2725
def stubbed?
  false
end
summary=(str) click to toggle source

A short summary of this gem's description.

# File lib/rubygems/specification.rb, line 2237
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 2280
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}>, #{req})"
    end

    result << "    else"

    dependencies.each do |dep|
      version_reqs_param = dep.requirements_list.inspect
      result << "      s.add_dependency(%q<#{dep.name}>, #{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}>, #{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 2373
def to_ruby_for_cache
  for_cache.to_ruby
end
to_spec() click to toggle source

Returns self

# File lib/rubygems/specification.rb, line 2384
def to_spec
  self
end
traverse(trail = [], &block) click to toggle source

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

# File lib/rubygems/specification.rb, line 2421
def traverse trail = [], &block
  trail = trail + [self]
  runtime_dependencies.each do |dep|
    dep.to_specs.each do |dep_spec|
      block[self, dep, dep_spec, trail + [dep_spec]]
      dep_spec.traverse(trail, &block) unless
        trail.map(&:name).include? dep_spec.name
    end
  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 2439
  def validate packaging = true
    @warnings = 0
    require 'rubygems/user_interaction'
    extend Gem::UserInteraction
    normalize

    nil_attributes = self.class.non_nil_attributes.find_all do |name|
      instance_variable_get("@#{name}").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

    unless String === name then
      raise Gem::InvalidSpecificationException,
            "invalid value for attribute name: \"#{name.inspect}\""
    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) }
    @test_files.delete_if       { |x| File.directory?(x) }
    @executables.delete_if      { |x| File.directory?(File.join(@bindir, x)) }
    @extra_rdoc_files.delete_if { |x| File.directory?(x) }
    @extensions.delete_if       { |x| File.directory?(x) }

    non_files = files.reject { |x| File.file?(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?(Fixnum)
      raise Gem::InvalidSpecificationException,
            'specification_version must be a Fixnum (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

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

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

    metadata.values.each do |k|
      if !k.kind_of?(String)
        raise Gem::InvalidSpecificationException,
                'metadata values must be a String'
      end

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

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

    warning "licenses is empty, but is recommended.  Use a license abbreviation from:
http://opensource.org/licenses/alphabetical
" if licenses.empty?

    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

    if homepage and not homepage.empty? and
       homepage !~ /\A[a-z][a-z\d+.-]*:/i then
      raise Gem::InvalidSpecificationException,
            "\"#{homepage}\" is not a URI"
    end

    # Warnings

    %w[author description email homepage summary].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

    validate_dependencies

    true
  ensure
    if $! or @warnings > 0 then
      alert_warning "See http://guides.rubygems.org/specification-reference/ for help"
    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 2697
def validate_permissions
  return if Gem.win_platform?

  files.each do |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 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 2717
def version= version
  @version = Gem::Version.create(version)
  self.required_rubygems_version = '> 1.3.1' if @version.prerelease?
  invalidate_memoized_attributes

  return @version
end