# REFACTOR: Consider breaking out this version stuff into a separate

# module. There's enough special stuff around it that it may justify

# a separate class.

##

# The version number of a specification that does not specify one

# (i.e. RubyGems 0.7 or earlier).

NONEXISTENT_SPECIFICATION_VERSION = -1

##

# The specification version applied to any new Specification instances

# created. This should be bumped whenever something in the spec format

# changes.

#

# Specification Version History:

#

# spec ruby

# ver ver yyyy-mm-dd description

# -1 <0.8.0 pre-spec-version-history

# 1 0.8.0 2004-08-01 Deprecated "test_suite_file" for "test_files"

# "test_file=x" is a shortcut for "test_files=[x]"

# 2 0.9.5 2007-10-01 Added "required_rubygems_version"

# Now forward-compatible with future versions

# 3 1.3.2 2009-01-03 Added Fixnum validation to specification_version

# 4 1.9.0 2011-06-07 Added metadata

#--

# When updating this number, be sure to also update #to_ruby.

#

# NOTE RubyGems < 1.2 cannot load specification versions > 2.

CURRENT_SPECIFICATION_VERSION = 4 # :nodoc:

##

# An informal list of changes to the specification. The highest-valued

# key should be equal to the CURRENT_SPECIFICATION_VERSION.

SPECIFICATION_VERSION_HISTORY = { # :nodoc:

-1 => ['(RubyGems versions up to and including 0.7 did not have versioned specifications)'],

1 => [

'Deprecated "test_suite_file" in favor of the new, but equivalent, "test_files"',

'"test_file=x" is a shortcut for "test_files=[x]"'

],

2 => [

'Added "required_rubygems_version"',

'Now forward-compatible with future versions',

],

3 => [

'Added Fixnum validation to the specification_version'

],

4 => [

'Added sandboxed freeform metadata to the specification version.'

]

}

MARSHAL_FIELDS = { # :nodoc:

-1 => 16,

1 => 16,

2 => 16,

3 => 17,

4 => 18,

}

today = Time.now.utc

TODAY = Time.utc(today.year, today.month, today.day) # :nodoc:

LOAD_CACHE = {} # :nodoc:

private_constant :LOAD_CACHE if defined? private_constant

# :startdoc:

##

# List of attribute names: [:name, :version, ...]

@@required_attributes = [:rubygems_version,

:specification_version,

:name,

:version,

:date,

:summary,

:require_paths]

##

# Map of attribute names to default values.

@@default_value = {

:authors => [],

:autorequire => nil,

:bindir => 'bin',

:cert_chain => [],

:date => TODAY,

:dependencies => [],

:description => nil,

:email => nil,

:executables => [],

:extensions => [],

:extra_rdoc_files => [],

:files => [],

:homepage => nil,

:licenses => [],

:metadata => {},

:name => nil,

:platform => Gem::Platform::RUBY,

:post_install_message => nil,

:rdoc_options => [],

:require_paths => ['lib'],

:required_ruby_version => Gem::Requirement.default,

:required_rubygems_version => Gem::Requirement.default,

:requirements => [],

:rubyforge_project => nil,

:rubygems_version => Gem::VERSION,

:signing_key => nil,

:specification_version => CURRENT_SPECIFICATION_VERSION,

:summary => nil,

:test_files => [],

:version => nil,

}

Dupable = { } # :nodoc:

@@default_value.each do |k,v|

case v

when Time, Numeric, Symbol, true, false, nil

Dupable[k] = false

else

Dupable[k] = true

end

end

@@attributes = @@default_value.keys.sort_by { |s| s.to_s }

@@array_attributes = @@default_value.reject { |k,v| v != [] }.keys

@@nil_attributes, @@non_nil_attributes = @@default_value.keys.partition { |k|

@@default_value[k].nil?

}

@@stubs_by_name = {}

######################################################################

# :section: Required gemspec attributes

##

# This gem's name.

#

# Usage:

#

# spec.name = 'rake'

attr_accessor :name

##

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

attr_reader :version

##

# Paths in the gem to add to <code>$LOAD_PATH</code> when this gem is

# activated.

#

# See also #require_paths

#

# If you have an extension you do not need to add <code>"ext"</code> to the

# require path, the extension build process will copy the extension files

# into "lib" for you.

#

# The default value is <code>"lib"</code>

#

# Usage:

#

# # If all library files are in the root directory...

# spec.require_paths = ['.']

def require_paths=(val)

@require_paths = Array(val)

end

##

# The version of RubyGems used to create this gem.

#

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

attr_accessor :rubygems_version

##

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

attr_reader :summary

##

# Singular writer for #authors

#

# Usage:

#

# spec.author = 'John Jones'

def author= o

self.authors = [o]

end

##

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

#

# Usage:

#

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

def authors= value

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

end

##

# The platform this gem runs on.

#

# This is usually Gem::Platform::RUBY or Gem::Platform::CURRENT.

#

# Most gems contain pure Ruby code; they should simply leave the default

# value in place. Some gems contain C (or other) code to be compiled into a

# Ruby "extension". The gem should leave the default value in place unless

# the code will only compile on a certain type of system. Some gems consist

# of pre-compiled code ("binary gems"). It's especially important that they

# set the platform attribute appropriately. A shortcut is to set the

# platform to Gem::Platform::CURRENT, which will cause the gem builder to set

# the platform to the appropriate value for the system on which the build is

# being performed.

#

# If this attribute is set to a non-default value, it will be included in

# the filename of the gem when it is built such as:

# nokogiri-1.6.0-x86-mingw32.gem

#

# Usage:

#

# spec.platform = Gem::Platform.local

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

##

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

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

######################################################################

# :section: Optional gemspec attributes

##

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

#

# Usage:

#

# spec.bindir = 'bin'

attr_accessor :bindir

##

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

# details.

attr_accessor :cert_chain

##

# 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

attr_reader :description

##

# :category: Recommended gemspec attributes

#

# A contact email address (or addresses) for this gem

#

# Usage:

#

# spec.email = 'john.jones@example.com'

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

attr_accessor :email

##

# :category: Recommended gemspec attributes

#

# The URL of this gem's home page

#

# Usage:

#

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

attr_accessor :homepage

##

# A message that gets displayed after the gem is installed.

#

# Usage:

#

# spec.post_install_message = "Thanks for installing!"

attr_accessor :post_install_message

##

# The version of Ruby required by this gem

attr_reader :required_ruby_version

##

# The RubyGems version required by this gem

attr_reader :required_rubygems_version

##

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

attr_accessor :signing_key

##

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

attr_accessor :metadata

##

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

def add_development_dependency(gem, *requirements)

add_dependency_with_type(gem, :development, *requirements)

end

##

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

#

# Usage:

#

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

def add_runtime_dependency(gem, *requirements)

add_dependency_with_type(gem, :runtime, *requirements)

end

##

# Executables included in the gem.

#

# For example, the rake gem has rake as an executable. You don’t specify the

# full path (as in bin/rake); all application-style files are expected to be

# found in bindir. These files must be executable Ruby files. Files that

# use bash or other interpreters will not work.

#

# Executables included may only be ruby scripts, not scripts for other

# languages or compiled binaries.

#

# Usage:

#

# spec.executables << 'rake'

def executables

@executables ||= []

end

##

# Extensions to build when installing the gem, specifically the paths to

# extconf.rb-style files used to compile extensions.

#

# These files will be run when the gem is installed, causing the C (or

# whatever) code to be compiled on the user’s machine.

#

# Usage:

#

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

#

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

def extensions

@extensions ||= []

end

##

# Extra files to add to RDoc such as README or doc/examples.txt

#

# When the user elects to generate the RDoc documentation for a gem (typically

# at install time), all the library files are sent to RDoc for processing.

# This option allows you to have some non-code files included for a more

# complete set of documentation.

#

# Usage:

#

# spec.extra_rdoc_files = ['README', 'doc/user-guide.txt']

def extra_rdoc_files

@extra_rdoc_files ||= []

end

##

# The version of RubyGems that installed this gem. Returns

# <code>Gem::Version.new(0)</code> for gems installed by versions earlier

# than RubyGems 2.2.0.

def installed_by_version # :nodoc:

@installed_by_version ||= Gem::Version.new(0)

end

##

# Sets the version of RubyGems that installed this gem. See also

# #installed_by_version.

def installed_by_version= version # :nodoc:

@installed_by_version = Gem::Version.new version

end

##

# :category: Recommended gemspec attributes

#

# 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

# https://spdx.org/licenses/ for the license.

# Ideally you should pick one that is OSI (Open Source Initiative)

# http://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 http://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'

def license=o

self.licenses = [o]

end

##

# :category: Recommended gemspec attributes

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

def licenses= licenses

@licenses = Array licenses

end

##

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

#

# Usage:

#

# spec.rdoc_options << '--title' << 'Rake -- Ruby Make' <<

# '--main' << 'README' <<

# '--line-numbers'

def rdoc_options

@rdoc_options ||= []

end

##

# The version of Ruby required by this gem. The ruby version can be

# specified to the patch-level:

#

# $ ruby -v -e 'p Gem.ruby_version'

# ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-darwin12.4.0]

# #<Gem::Version "2.0.0.247">

#

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

def required_ruby_version= req

@required_ruby_version = Gem::Requirement.create req

end

##

# The RubyGems version required by this gem

def required_rubygems_version= req

@required_rubygems_version = Gem::Requirement.create req

end

##

# Lists the external (to RubyGems) requirements that must be met for this gem

# to work. It's simply information for the user.

#

# Usage:

#

# spec.requirements << 'libmagick, v6.0'

# spec.requirements << 'A good graphics card'

def requirements

@requirements ||= []

end

##

# A collection of unit test files. They will be loaded as unit tests when

# the user requests a gem to be unit tested.

#

# Usage:

# spec.test_files = Dir.glob('test/tc_*.rb')

# spec.test_files = ['tests/test-suite.rb']

def test_files= files # :nodoc:

@test_files = Array files

end

######################################################################

# :section: Specification internals

##

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

attr_accessor :activated

alias :activated? :activated

##

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

#

# Deprecated: It is neither supported nor functional.

attr_accessor :autorequire # :nodoc:

##

# Sets the default executable for this gem.

#

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

attr_writer :default_executable

##

# Allows deinstallation of gems with legacy platforms.

attr_writer :original_platform # :nodoc:

##

# The rubyforge project this gem lives under. i.e. RubyGems'

# rubyforge_project is "rubygems".

#

# This option is deprecated.

attr_accessor :rubyforge_project

##

# The Gem::Specification version of this gemspec.

#

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

attr_accessor :specification_version

def self._all # :nodoc:

unless defined?(@@all) && @@all then

@@all = stubs.map(&:to_spec)

# After a reset, make sure already loaded specs

# are still marked as activated.

specs = {}

Gem.loaded_specs.each_value{|s| specs[s] = true}

@@all.each{|s| s.activated = true if specs[s]}

end

@@all

end

def self._clear_load_cache # :nodoc:

LOAD_CACHE.clear

end

def self.each_gemspec(dirs) # :nodoc:

dirs.each do |dir|

Dir[File.join(dir, "*.gemspec")].each do |path|

yield path.untaint

end

end

end

def self.gemspec_stubs_in dir, pattern

Dir[File.join(dir, pattern)].map { |path|

if dir == default_specifications_dir

Gem::StubSpecification.default_gemspec_stub(path)

else

Gem::StubSpecification.gemspec_stub(path)

end

}.select(&:valid?)

end

private_class_method :gemspec_stubs_in

if [].respond_to? :flat_map

def self.map_stubs(dirs, pattern) # :nodoc:

dirs.flat_map { |dir| gemspec_stubs_in(dir, pattern) }

end

else # FIXME: remove when 1.8 is dropped

def self.map_stubs(dirs, pattern) # :nodoc:

dirs.map { |dir| gemspec_stubs_in(dir, pattern) }.flatten 1

end

end

private_class_method :map_stubs

uniq_takes_a_block = false

[1,2].uniq { uniq_takes_a_block = true }

if uniq_takes_a_block

def self.uniq_by(list, &block) # :nodoc:

list.uniq(&block)

end

else # FIXME: remove when 1.8 is dropped

def self.uniq_by(list) # :nodoc:

values = {}

list.each { |item|

value = yield item

values[value] ||= item

}

values.values

end

end

private_class_method :uniq_by

if [].respond_to? :sort_by!

def self.sort_by! list, &block

list.sort_by!(&block)

end

else # FIXME: remove when 1.8 is dropped

def self.sort_by! list, &block

list.replace list.sort_by(&block)

end

end

private_class_method :sort_by!

def self.each_spec(dirs) # :nodoc:

each_gemspec(dirs) do |path|

spec = self.load path

yield spec if spec

end

end

##

# Returns a Gem::StubSpecification for every installed gem

def self.stubs

@@stubs ||= begin

stubs = map_stubs([default_specifications_dir] + dirs, "*.gemspec")

stubs = uniq_by(stubs) { |stub| stub.full_name }

_resort!(stubs)

@@stubs_by_name = stubs.group_by(&:name)

stubs

end

end

EMPTY = [].freeze # :nodoc:

##

# Returns a Gem::StubSpecification for installed gem named +name+

def self.stubs_for name

if @@stubs || @@stubs_by_name[name]

@@stubs_by_name[name] || []

else

stubs = map_stubs([default_specifications_dir] + dirs, "#{name}-*.gemspec")

stubs = uniq_by(stubs) { |stub| stub.full_name }.group_by(&:name)

stubs.each_value { |v| sort_by!(v) { |i| i.version } }

@@stubs_by_name.merge! stubs

@@stubs_by_name[name] ||= EMPTY

end

end

def self._resort!(specs) # :nodoc:

specs.sort! { |a, b|

names = a.name <=> b.name

next names if names.nonzero?

b.version <=> a.version

}

end

##

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

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

##

# Adds +spec+ to the known specifications, keeping the collection

# properly sorted.

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

##

# Adds multiple specs to the known specifications.

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

##

# Returns all specifications. This method is discouraged from use.

# You probably want to use one of the Enumerable methods instead.

def self.all

warn "NOTE: Specification.all called from #{caller.first}" unless

Gem::Deprecate.skip

_all

end

##

# Sets the known specs to +specs+. Not guaranteed to work for you in

# the future. Use at your own risk. Caveat emptor. Doomy doom doom.

# Etc etc.

#

#--

# Makes +specs+ the known specs

# Listen, time is a river

# Winter comes, code breaks

#

# -- wilsonb

def self.all= specs

@@stubs_by_name = specs.group_by(&:name)

@@all = @@stubs = specs

end

##

# Return full names of all specs in sorted order.

def self.all_names

self._all.map(&:full_name)

end

##

# Return the list of all array-oriented instance variables.

#--

# Not sure why we need to use so much stupid reflection in here...

def self.array_attributes

@@array_attributes.dup

end

##

# Return the list of all instance variables.

#--

# Not sure why we need to use so much stupid reflection in here...

def self.attribute_names

@@attributes.dup

end

##

# Return the directories that Specification uses to find specs.

def self.dirs

@@dirs ||= Gem.path.collect { |dir|

File.join dir.dup.untaint, "specifications"

}

end

##

# Set the directories that Specification uses to find specs. Setting

# this resets the list of known specs.

def self.dirs= dirs

self.reset

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

end

extend Enumerable

##

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

# specs.

def self.each

return enum_for(:each) unless block_given?

self._all.each do |x|

yield x

end

end

##

# Returns every spec that matches +name+ and optional +requirements+.

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 the best specification matching a +name+ and +requirements+. Raises

# if the dependency doesn't resolve to a valid specification.

def self.find_by_name name, *requirements

requirements = Gem::Requirement.default if requirements.empty?

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