diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2009-06-09 21:38:59 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2009-06-09 21:38:59 +0000 |
commit | 31c94ffeb5f09d09ac2c86fc9e6614e38251a43d (patch) | |
tree | 10e44506238c7af3d7c9d822111996731726e38d /lib/rubygems/specification.rb | |
parent | a6afbaeb3be396c0fdea3b9077d9256c59edcfca (diff) | |
download | ruby-31c94ffeb5f09d09ac2c86fc9e6614e38251a43d.tar.gz |
Update to RubyGems 1.3.4 r2223
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23659 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rubygems/specification.rb')
-rw-r--r-- | lib/rubygems/specification.rb | 2080 |
1 files changed, 1130 insertions, 950 deletions
diff --git a/lib/rubygems/specification.rb b/lib/rubygems/specification.rb index 634b88f1f0..3630b4adf5 100644 --- a/lib/rubygems/specification.rb +++ b/lib/rubygems/specification.rb @@ -4,1260 +4,1440 @@ # See LICENSE.txt for permissions. #++ -require 'rubygems' require 'rubygems/version' require 'rubygems/requirement' require 'rubygems/platform' # :stopdoc: -# Time::today has been deprecated in 0.9.5 and will be removed. -if RUBY_VERSION < '1.9' then - def Time.today - t = Time.now - t - ((t.to_f + t.gmt_offset) % 86400) - end unless defined? Time.today -end - class Date; end # for ruby_code if date.rb wasn't required - # :startdoc: -module Gem +## +# The Specification class contains the metadata for a Gem. Typically +# defined in a .gemspec file or a Rakefile, and looks like this: +# +# spec = Gem::Specification.new do |s| +# s.name = 'rfoo' +# s.version = '1.0' +# s.summary = 'Example gem specification' +# ... +# end +# +# For a great way to package gems, use Hoe. + +class Gem::Specification ## - # == Gem::Specification - # - # The Specification class contains the metadata for a Gem. Typically - # defined in a .gemspec file or a Rakefile, and looks like this: + # Allows deinstallation of gems with legacy platforms. + + attr_accessor :original_platform # :nodoc: + + ## + # The 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. + #-- + # When updating this number, be sure to also update #to_ruby. # - # spec = Gem::Specification.new do |s| - # s.name = 'rfoo' - # s.version = '1.0' - # s.summary = 'Example gem specification' - # ... - # end + # NOTE RubyGems < 1.2 cannot load specification versions > 2. + + CURRENT_SPECIFICATION_VERSION = 3 + + ## + # An informal list of changes to the specification. The highest-valued + # key should be equal to the CURRENT_SPECIFICATION_VERSION. + + SPECIFICATION_VERSION_HISTORY = { + -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' + ] + } + + # :stopdoc: + MARSHAL_FIELDS = { -1 => 16, 1 => 16, 2 => 16, 3 => 17 } + + now = Time.at(Time.now.to_i) + TODAY = now - ((now.to_i + now.gmt_offset) % 86400) + # :startdoc: + + ## + # Optional block used to gather newly defined instances. + + @@gather = nil + + ## + # List of attribute names: [:name, :version, ...] + + @@required_attributes = [] + + ## + # List of _all_ attributes and default values: # - # There are many <em>gemspec attributes</em>, and the best place to learn - # about them in the "Gemspec Reference" linked from the RubyGems wiki. - - class Specification - - ## - # Allows deinstallation of gems with legacy platforms. - - attr_accessor :original_platform # :nodoc: - - ## - # The 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. - #-- - # When updating this number, be sure to also update #to_ruby. - # - # NOTE RubyGems < 1.2 cannot load specification versions > 2. - - CURRENT_SPECIFICATION_VERSION = 2 - - ## - # An informal list of changes to the specification. The highest-valued - # key should be equal to the CURRENT_SPECIFICATION_VERSION. - - SPECIFICATION_VERSION_HISTORY = { - -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', - ], - } + # [[:name, nil], + # [:bindir, 'bin'], + # ...] - # :stopdoc: - MARSHAL_FIELDS = { -1 => 16, 1 => 16, 2 => 16 } + @@attributes = [] - now = Time.at(Time.now.to_i) - TODAY = now - ((now.to_i + now.gmt_offset) % 86400) - # :startdoc: + @@nil_attributes = [] + @@non_nil_attributes = [:@original_platform] - ## - # List of Specification instances. + ## + # List of array attributes - @@list = [] + @@array_attributes = [] - ## - # Optional block used to gather newly defined instances. + ## + # Map of attribute names to default values. - @@gather = nil + @@default_value = {} - ## - # List of attribute names: [:name, :version, ...] - @@required_attributes = [] + ## + # Names of all specification attributes - ## - # List of _all_ attributes and default values: - # - # [[:name, nil], - # [:bindir, 'bin'], - # ...] + def self.attribute_names + @@attributes.map { |name, default| name } + end - @@attributes = [] + ## + # Default values for specification attributes - @@nil_attributes = [] - @@non_nil_attributes = [:@original_platform] + def self.attribute_defaults + @@attributes.dup + end - ## - # List of array attributes + ## + # The default value for specification attribute +name+ - @@array_attributes = [] + def self.default_value(name) + @@default_value[name] + end - ## - # Map of attribute names to default values. + ## + # Required specification attributes - @@default_value = {} + def self.required_attributes + @@required_attributes.dup + end - ## - # Names of all specification attributes + ## + # Is +name+ a required attribute? - def self.attribute_names - @@attributes.map { |name, default| name } - end + def self.required_attribute?(name) + @@required_attributes.include? name.to_sym + end - ## - # Default values for specification attributes + ## + # Specification attributes that are arrays (appendable and so-forth) - def self.attribute_defaults - @@attributes.dup - end + def self.array_attributes + @@array_attributes.dup + end - ## - # The default value for specification attribute +name+ + ## + # Specifies the +name+ and +default+ for a specification attribute, and + # creates a reader and writer method like Module#attr_accessor. + # + # The reader method returns the default if the value hasn't been set. - def self.default_value(name) - @@default_value[name] + def self.attribute(name, default=nil) + ivar_name = "@#{name}".intern + if default.nil? then + @@nil_attributes << ivar_name + else + @@non_nil_attributes << [ivar_name, default] end - ## - # Required specification attributes + @@attributes << [name, default] + @@default_value[name] = default + attr_accessor(name) + end + + ## + # Same as :attribute, but ensures that values assigned to the attribute + # are array values by applying :to_a to the value. + + def self.array_attribute(name) + @@non_nil_attributes << ["@#{name}".intern, []] + + @@array_attributes << name + @@attributes << [name, []] + @@default_value[name] = [] + code = %{ + def #{name} + @#{name} ||= [] + end + def #{name}=(value) + @#{name} = Array(value) + end + } - def self.required_attributes - @@required_attributes.dup - end + module_eval code, __FILE__, __LINE__ - 9 + end - ## - # Is +name+ a required attribute? + ## + # Same as attribute above, but also records this attribute as mandatory. - def self.required_attribute?(name) - @@required_attributes.include? name.to_sym - end + def self.required_attribute(*args) + @@required_attributes << args.first + attribute(*args) + end - ## - # Specification attributes that are arrays (appendable and so-forth) + ## + # Sometimes we don't want the world to use a setter method for a + # particular attribute. + # + # +read_only+ makes it private so we can still use it internally. - def self.array_attributes - @@array_attributes.dup + def self.read_only(*names) + names.each do |name| + private "#{name}=" end + end - ## - # A list of Specification instances that have been defined in this Ruby - # instance. + # Shortcut for creating several attributes at once (each with a default + # value of +nil+). - def self.list - @@list + def self.attributes(*args) + args.each do |arg| + attribute(arg, nil) end + end - ## - # Specifies the +name+ and +default+ for a specification attribute, and - # creates a reader and writer method like Module#attr_accessor. - # - # The reader method returns the default if the value hasn't been set. + ## + # Some attributes require special behaviour when they are accessed. This + # allows for that. - def self.attribute(name, default=nil) - ivar_name = "@#{name}".intern - if default.nil? then - @@nil_attributes << ivar_name - else - @@non_nil_attributes << [ivar_name, default] - end + def self.overwrite_accessor(name, &block) + remove_method name + define_method(name, &block) + end - @@attributes << [name, default] - @@default_value[name] = default - attr_accessor(name) - end + ## + # Defines a _singular_ version of an existing _plural_ attribute (i.e. one + # whose value is expected to be an array). This means just creating a + # helper method that takes a single value and appends it to the array. + # These are created for convenience, so that in a spec, one can write + # + # s.require_path = 'mylib' + # + # instead of: + # + # s.require_paths = ['mylib'] + # + # That above convenience is available courtesy of: + # + # attribute_alias_singular :require_path, :require_paths + + def self.attribute_alias_singular(singular, plural) + define_method("#{singular}=") { |val| + send("#{plural}=", [val]) + } + define_method("#{singular}") { + val = send("#{plural}") + val.nil? ? nil : val.first + } + end + + ## + # Dump only crucial instance variables. + #-- + # MAINTAIN ORDER! + + def _dump(limit) + Marshal.dump [ + @rubygems_version, + @specification_version, + @name, + @version, + (Time === @date ? @date : (require 'time'; Time.parse(@date.to_s))), + @summary, + @required_ruby_version, + @required_rubygems_version, + @original_platform, + @dependencies, + @rubyforge_project, + @email, + @authors, + @description, + @homepage, + @has_rdoc, + @new_platform, + @licenses + ] + end - ## - # Same as :attribute, but ensures that values assigned to the attribute - # are array values by applying :to_a to the value. + ## + # Load custom marshal format, re-initializing defaults as needed + + 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 + + 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.instance_variable_set :@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 :@loaded, false + + spec + end - def self.array_attribute(name) - @@non_nil_attributes << ["@#{name}".intern, []] + ## + # List of depedencies that will automatically be activated at runtime. - @@array_attributes << name - @@attributes << [name, []] - @@default_value[name] = [] - code = %{ - def #{name} - @#{name} ||= [] - end - def #{name}=(value) - @#{name} = Array(value) - end - } + def runtime_dependencies + dependencies.select { |d| d.type == :runtime || d.type == nil } + end - module_eval code, __FILE__, __LINE__ - 9 - end + ## + # List of dependencies that are used for development - ## - # Same as attribute above, but also records this attribute as mandatory. + def development_dependencies + dependencies.select { |d| d.type == :development } + end - def self.required_attribute(*args) - @@required_attributes << args.first - attribute(*args) - end + def test_suite_file # :nodoc: + warn 'test_suite_file deprecated, use test_files' + test_files.first + end - ## - # Sometimes we don't want the world to use a setter method for a - # particular attribute. - # - # +read_only+ makes it private so we can still use it internally. + def test_suite_file=(val) # :nodoc: + warn 'test_suite_file= deprecated, use test_files=' + @test_files = [] unless defined? @test_files + @test_files << val + end - def self.read_only(*names) - names.each do |name| - private "#{name}=" - end + ## + # true when this gemspec has been loaded from a specifications directory. + # This attribute is not persisted. + + attr_accessor :loaded + + ## + # Path this gemspec was loaded from. This attribute is not persisted. + + attr_accessor :loaded_from + + ## + # Returns an array with bindir attached to each executable in the + # executables list + + 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 - # Shortcut for creating several attributes at once (each with a default - # value of +nil+). + ## + # Files in the Gem under one of the require_paths - def self.attributes(*args) - args.each do |arg| - attribute(arg, nil) + def lib_files + @files.select do |file| + require_paths.any? do |path| + file.index(path) == 0 end end + end - ## - # Some attributes require special behaviour when they are accessed. This - # allows for that. + ## + # True if this gem was loaded from disk - def self.overwrite_accessor(name, &block) - remove_method name - define_method(name, &block) - end + alias :loaded? :loaded - ## - # Defines a _singular_ version of an existing _plural_ attribute (i.e. one - # whose value is expected to be an array). This means just creating a - # helper method that takes a single value and appends it to the array. - # These are created for convenience, so that in a spec, one can write - # - # s.require_path = 'mylib' - # - # instead of: - # - # s.require_paths = ['mylib'] - # - # That above convenience is available courtesy of: - # - # attribute_alias_singular :require_path, :require_paths - - def self.attribute_alias_singular(singular, plural) - define_method("#{singular}=") { |val| - send("#{plural}=", [val]) - } - define_method("#{singular}") { - val = send("#{plural}") - val.nil? ? nil : val.first - } - end + ## + # True if this gem has files in test_files - ## - # Dump only crucial instance variables. - #-- - # MAINTAIN ORDER! - - def _dump(limit) - Marshal.dump [ - @rubygems_version, - @specification_version, - @name, - @version, - (Time === @date ? @date : (require 'time'; Time.parse(@date.to_s))), - @summary, - @required_ruby_version, - @required_rubygems_version, - @original_platform, - @dependencies, - @rubyforge_project, - @email, - @authors, - @description, - @homepage, - @has_rdoc, - @new_platform, - ] - end + def has_unit_tests? + not test_files.empty? + end - ## - # Load custom marshal format, re-initializing defaults as needed + # :stopdoc: + alias has_test_suite? has_unit_tests? + # :startdoc: - def self._load(str) - array = Marshal.load str + ## + # Specification constructor. Assigns the default values to the attributes + # and yields itself for further initialization. - spec = Gem::Specification.new - spec.instance_variable_set :@specification_version, array[1] + def initialize + @new_platform = nil + assign_defaults + @loaded = false + @loaded_from = nil - current_version = CURRENT_SPECIFICATION_VERSION + yield self if block_given? - 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 + @@gather.call(self) if @@gather + end - if array.size < field_count then - raise TypeError, "invalid Gem::Specification format #{array.inspect}" - end + ## + # Duplicates array_attributes from +other_spec+ so state isn't shared. + + def initialize_copy(other_spec) + other_ivars = other_spec.instance_variables + other_ivars = other_ivars.map { |ivar| ivar.intern } if # for 1.9 + other_ivars.any? { |ivar| String === ivar } - 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.instance_variable_set :@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 :@loaded, false - - spec + self.class.array_attributes.each do |name| + name = :"@#{name}" + next unless other_ivars.include? name + instance_variable_set name, other_spec.instance_variable_get(name).dup end + end - ## - # List of depedencies that will automatically be activated at runtime. + ## + # Each attribute has a default value (possibly nil). Here, we initialize + # all attributes to their default value. This is done through the + # accessor methods, so special behaviours will be honored. Furthermore, + # we take a _copy_ of the default so each specification instance has its + # own empty arrays, etc. - def runtime_dependencies - dependencies.select { |d| d.type == :runtime || d.type == nil } + def assign_defaults + @@nil_attributes.each do |name| + instance_variable_set name, nil end - ## - # List of dependencies that are used for development + @@non_nil_attributes.each do |name, default| + value = case default + when Time, Numeric, Symbol, true, false, nil then default + else default.dup + end - def development_dependencies - dependencies.select { |d| d.type == :development } + instance_variable_set name, value end - def test_suite_file # :nodoc: - warn 'test_suite_file deprecated, use test_files' - test_files.first + # HACK + instance_variable_set :@new_platform, Gem::Platform::RUBY + end + + ## + # Special loader for YAML files. When a Specification object is loaded + # from a YAML file, it bypasses the normal Ruby object initialization + # routine (#initialize). This method makes up for that and deals with + # gems of different ages. + # + # 'input' can be anything that YAML.load() accepts: String or IO. + + def self.from_yaml(input) + input = normalize_yaml_input input + spec = YAML.load input + + if spec && spec.class == FalseClass then + raise Gem::EndOfYAMLException end - def test_suite_file=(val) # :nodoc: - warn 'test_suite_file= deprecated, use test_files=' - @test_files = [] unless defined? @test_files - @test_files << val + unless Gem::Specification === spec then + raise Gem::Exception, "YAML data doesn't evaluate to gem specification" end - ## - # true when this gemspec has been loaded from a specifications directory. - # This attribute is not persisted. + unless (spec.instance_variables.include? '@specification_version' or + spec.instance_variables.include? :@specification_version) and + spec.instance_variable_get :@specification_version + spec.instance_variable_set :@specification_version, + NONEXISTENT_SPECIFICATION_VERSION + end - attr_accessor :loaded + spec + end - ## - # Path this gemspec was loaded from. This attribute is not persisted. + ## + # Loads ruby format gemspec from +filename+ + + def self.load(filename) + gemspec = nil + fail "NESTED Specification.load calls not allowed!" if @@gather + @@gather = proc { |gs| gemspec = gs } + data = File.read(filename) + eval(data) + gemspec + ensure + @@gather = nil + end - attr_accessor :loaded_from + ## + # Make sure the YAML specification is properly formatted with dashes - ## - # Returns an array with bindir attached to each executable in the - # executables list + def self.normalize_yaml_input(input) + result = input.respond_to?(:read) ? input.read : input + result = "--- " + result unless result =~ /^--- / + result + end - def add_bindir(executables) - return nil if executables.nil? + ## + # Sets the rubygems_version to the current RubyGems version - if @bindir then - Array(executables).map { |e| File.join(@bindir, e) } - else - executables - end - rescue - return nil - end + def mark_version + @rubygems_version = Gem::RubyGemsVersion + end - ## - # Files in the Gem under one of the require_paths + ## + # Ignore unknown attributes while loading - def lib_files - @files.select do |file| - require_paths.any? do |path| - file.index(path) == 0 - end - end + def method_missing(sym, *a, &b) # :nodoc: + if @specification_version > CURRENT_SPECIFICATION_VERSION and + sym.to_s =~ /=$/ then + warn "ignoring #{sym} loading #{full_name}" if $DEBUG + else + super end + end - ## - # True if this gem was loaded from disk + ## + # Adds a development dependency named +gem+ with +requirements+ to this + # Gem. For example: + # + # spec.add_development_dependency 'jabber4r', '> 0.1', '<= 0.5' + # + # Development dependencies aren't installed by default and aren't + # activated when a gem is required. - alias :loaded? :loaded + def add_development_dependency(gem, *requirements) + add_dependency_with_type(gem, :development, *requirements) + end - ## - # True if this gem has files in test_files + ## + # Adds a runtime dependency named +gem+ with +requirements+ to this Gem. + # For example: + # + # spec.add_runtime_dependency 'jabber4r', '> 0.1', '<= 0.5' - def has_unit_tests? - not test_files.empty? - end + def add_runtime_dependency(gem, *requirements) + add_dependency_with_type(gem, :runtime, *requirements) + end - alias has_test_suite? has_unit_tests? # :nodoc: deprecated + ## + # Adds a runtime dependency - ## - # Specification constructor. Assigns the default values to the - # attributes, adds this spec to the list of loaded specs (see - # Specification.list), and yields itself for further initialization. + alias add_dependency add_runtime_dependency - def initialize - @new_platform = nil - assign_defaults - @loaded = false - @loaded_from = nil - @@list << self + ## + # Returns the full name (name-version) of this Gem. Platform information + # is included (name-version-platform) if it is specified and not the + # default Ruby platform. + + def full_name + if platform == Gem::Platform::RUBY or platform.nil? then + "#{@name}-#{@version}" + else + "#{@name}-#{@version}-#{platform}" + end + end - yield self if block_given? + ## + # Returns the full name (name-version) of this gemspec using the original + # platform. For use with legacy gems. - @@gather.call(self) if @@gather + def original_name # :nodoc: + if platform == Gem::Platform::RUBY or platform.nil? then + "#{@name}-#{@version}" + else + "#{@name}-#{@version}-#{@original_platform}" end + end - ## - # Each attribute has a default value (possibly nil). Here, we initialize - # all attributes to their default value. This is done through the - # accessor methods, so special behaviours will be honored. Furthermore, - # we take a _copy_ of the default so each specification instance has its - # own empty arrays, etc. + ## + # The full path to the gem (install path + full name). - def assign_defaults - @@nil_attributes.each do |name| - instance_variable_set name, nil - end + def full_gem_path + path = File.join installation_path, 'gems', full_name + return path if File.directory? path + File.join installation_path, 'gems', original_name + end - @@non_nil_attributes.each do |name, default| - value = case default - when Time, Numeric, Symbol, true, false, nil then default - else default.dup - end + ## + # The default (generated) file name of the gem. - instance_variable_set name, value - end + def file_name + full_name + ".gem" + end - # HACK - instance_variable_set :@new_platform, Gem::Platform::RUBY + ## + # The directory that this gem was installed into. + + def installation_path + unless @loaded_from then + raise Gem::Exception, "spec #{full_name} is not from an installed gem" end - ## - # Special loader for YAML files. When a Specification object is loaded - # from a YAML file, it bypasses the normal Ruby object initialization - # routine (#initialize). This method makes up for that and deals with - # gems of different ages. - # - # 'input' can be anything that YAML.load() accepts: String or IO. + File.expand_path File.dirname(File.dirname(@loaded_from)) + end - def self.from_yaml(input) - input = normalize_yaml_input input - spec = YAML.load input + ## + # Checks if this specification meets the requirement of +dependency+. - if spec && spec.class == FalseClass then - raise Gem::EndOfYAMLException - end + def satisfies_requirement?(dependency) + return @name == dependency.name && + dependency.version_requirements.satisfied_by?(@version) + end - unless Gem::Specification === spec then - raise Gem::Exception, "YAML data doesn't evaluate to gem specification" - end + ## + # Returns an object you can use to sort specifications in #sort_by. - unless (spec.instance_variables.include? '@specification_version' or - spec.instance_variables.include? :@specification_version) and - spec.instance_variable_get :@specification_version - spec.instance_variable_set :@specification_version, - NONEXISTENT_SPECIFICATION_VERSION - end + def sort_obj + [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1] + end - spec - end + def <=>(other) # :nodoc: + sort_obj <=> other.sort_obj + end - ## - # Loads ruby format gemspec from +filename+ - - def self.load(filename) - gemspec = nil - fail "NESTED Specification.load calls not allowed!" if @@gather - @@gather = proc { |gs| gemspec = gs } - data = File.read(filename) - eval(data) - gemspec - ensure - @@gather = nil - end + ## + # Tests specs for equality (across all attributes). - ## - # Make sure the YAML specification is properly formatted with dashes + def ==(other) # :nodoc: + self.class === other && same_attributes?(other) + end - def self.normalize_yaml_input(input) - result = input.respond_to?(:read) ? input.read : input - result = "--- " + result unless result =~ /^--- / - result - end + alias eql? == # :nodoc: - ## - # Sets the rubygems_version to the current RubyGems version + ## + # True if this gem has the same attributes as +other+. - def mark_version - @rubygems_version = RubyGemsVersion + def same_attributes?(other) + @@attributes.each do |name, default| + return false unless self.send(name) == other.send(name) end + true + end - ## - # Ignore unknown attributes while loading + private :same_attributes? - def method_missing(sym, *a, &b) # :nodoc: - if @specification_version > CURRENT_SPECIFICATION_VERSION and - sym.to_s =~ /=$/ then - warn "ignoring #{sym} loading #{full_name}" if $DEBUG - else - super + def hash # :nodoc: + @@attributes.inject(0) { |hash_code, (name, default_value)| + n = self.send(name).hash + hash_code + n + } + end + + def to_yaml(opts = {}) # :nodoc: + mark_version + + attributes = @@attributes.map { |name,| name.to_s }.sort + attributes = attributes - %w[name version platform] + + yaml = YAML.quick_emit object_id, opts do |out| + out.map taguri, to_yaml_style do |map| + map.add 'name', @name + map.add 'version', @version + platform = case @original_platform + when nil, '' then + 'ruby' + when String then + @original_platform + else + @original_platform.to_s + end + map.add 'platform', platform + + attributes.each do |name| + map.add name, instance_variable_get("@#{name}") + end end end + end - ## - # Adds a development dependency named +gem+ with +requirements+ to this - # Gem. For example: - # - # spec.add_development_dependency 'jabber4r', '> 0.1', '<= 0.5' - # - # 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) + def yaml_initialize(tag, vals) # :nodoc: + vals.each do |ivar, val| + instance_variable_set "@#{ivar}", val end - ## - # Adds a runtime dependency named +gem+ with +requirements+ to this Gem. - # For example: - # - # spec.add_runtime_dependency 'jabber4r', '> 0.1', '<= 0.5' + @original_platform = @platform # for backwards compatibility + self.platform = Gem::Platform.new @platform + end - def add_runtime_dependency(gem, *requirements) - add_dependency_with_type(gem, :runtime, *requirements) + ## + # 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. + + def to_ruby + mark_version + result = [] + result << "# -*- encoding: utf-8 -*-" + 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=" + + handled = [ + :dependencies, + :name, + :platform, + :required_rubygems_version, + :specification_version, + :version, + ] + + attributes = @@attributes.sort_by { |attr_name,| attr_name.to_s } + + attributes.each do |attr_name, default| + next if handled.include? attr_name + current_value = self.send(attr_name) + if current_value != default or + self.class.required_attribute? attr_name then + result << " s.#{attr_name} = #{ruby_code current_value}" + end end - ## - # Adds a runtime dependency - - alias add_dependency add_runtime_dependency + result << nil + result << " if s.respond_to? :specification_version then" + result << " current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION" + result << " s.specification_version = #{specification_version}" + result << nil - ## - # Returns the full name (name-version) of this Gem. Platform information - # is included (name-version-platform) if it is specified and not the - # default Ruby platform. + result << " if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then" - def full_name - if platform == Gem::Platform::RUBY or platform.nil? then - "#{@name}-#{@version}" - else - "#{@name}-#{@version}-#{platform}" + unless dependencies.empty? then + dependencies.each do |dep| + version_reqs_param = dep.requirements_list.inspect + dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK + result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>, #{version_reqs_param})" end end - ## - # Returns the full name (name-version) of this gemspec using the original - # platform. For use with legacy gems. + result << " else" - def original_name # :nodoc: - if platform == Gem::Platform::RUBY or platform.nil? then - "#{@name}-#{@version}" - else - "#{@name}-#{@version}-#{@original_platform}" + unless dependencies.empty? then + dependencies.each do |dep| + version_reqs_param = dep.requirements_list.inspect + result << " s.add_dependency(%q<#{dep.name}>, #{version_reqs_param})" end end - ## - # The full path to the gem (install path + full name). + result << ' end' - def full_gem_path - path = File.join installation_path, 'gems', full_name - return path if File.directory? path - File.join installation_path, 'gems', original_name - 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" - ## - # The default (generated) file name of the gem. + result << "end" + result << nil - def file_name - full_name + ".gem" - end + result.join "\n" + end - ## - # The directory that this gem was installed into. + ## + # 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.. + + def validate + extend Gem::UserInteraction + normalize - def installation_path - path = File.dirname(@loaded_from).split(File::SEPARATOR)[0..-2] - path = path.join File::SEPARATOR - File.expand_path path + if rubygems_version != Gem::RubyGemsVersion then + raise Gem::InvalidSpecificationException, + "expected RubyGems version #{Gem::RubyGemsVersion}, was #{rubygems_version}" end - ## - # Checks if this specification meets the requirement of +dependency+. + @@required_attributes.each do |symbol| + unless self.send symbol then + raise Gem::InvalidSpecificationException, + "missing value for attribute #{symbol}" + end + end - def satisfies_requirement?(dependency) - return @name == dependency.name && - dependency.version_requirements.satisfied_by?(@version) + unless String === name then + raise Gem::InvalidSpecificationException, + "invalid value for attribute name: \"#{name.inspect}\"" end - ## - # Returns an object you can use to sort specifications in #sort_by. + if require_paths.empty? then + raise Gem::InvalidSpecificationException, + 'specification must have at least one require_path' + end - def sort_obj - [@name, @version.to_ints, @new_platform == Gem::Platform::RUBY ? -1 : 1] + @files.delete_if do |file| File.directory? file end + @test_files.delete_if do |file| File.directory? file end + @executables.delete_if do |file| + File.directory? File.join(bindir, file) end + @extra_rdoc_files.delete_if do |file| File.directory? file end + @extensions.delete_if do |file| File.directory? file end - def <=>(other) # :nodoc: - sort_obj <=> other.sort_obj + non_files = files.select do |file| + !File.file? file end - ## - # Tests specs for equality (across all attributes). + unless non_files.empty? then + non_files = non_files.map { |file| file.inspect } + raise Gem::InvalidSpecificationException, + "[#{non_files.join ", "}] are not files" + end - def ==(other) # :nodoc: - self.class === other && same_attributes?(other) + unless specification_version.is_a?(Fixnum) + raise Gem::InvalidSpecificationException, + 'specification_version must be a Fixnum (did you mean version?)' end - alias eql? == # :nodoc: + case platform + when Gem::Platform, Gem::Platform::RUBY then # ok + else + raise Gem::InvalidSpecificationException, + "invalid platform #{platform.inspect}, see Gem::Platform" + end - ## - # True if this gem has the same attributes as +other+. + unless Array === authors and + authors.all? { |author| String === author } then + raise Gem::InvalidSpecificationException, + 'authors must be Array of Strings' + end - def same_attributes?(other) - @@attributes.each do |name, default| - return false unless self.send(name) == other.send(name) + licenses.each { |license| + if license.length > 64 + raise Gem::InvalidSpecificationException, + "each license must be 64 characters or less" end - true - end + } - private :same_attributes? + # reject FIXME and TODO - def hash # :nodoc: - @@attributes.inject(0) { |hash_code, (name, default_value)| - n = self.send(name).hash - hash_code + n - } + unless authors.grep(/FIXME|TODO/).empty? then + raise Gem::InvalidSpecificationException, + '"FIXME" or "TODO" is not an author' end - def to_yaml(opts = {}) # :nodoc: - mark_version - - attributes = @@attributes.map { |name,| name.to_s }.sort - attributes = attributes - %w[name version platform] - - yaml = YAML.quick_emit object_id, opts do |out| - out.map taguri, to_yaml_style do |map| - map.add 'name', @name - map.add 'version', @version - platform = case @original_platform - when nil, '' then - 'ruby' - when String then - @original_platform - else - @original_platform.to_s - end - map.add 'platform', platform - - attributes.each do |name| - map.add name, instance_variable_get("@#{name}") - end - end - end + unless Array(email).grep(/FIXME|TODO/).empty? then + raise Gem::InvalidSpecificationException, + '"FIXME" or "TODO" is not an email address' end - def yaml_initialize(tag, vals) # :nodoc: - vals.each do |ivar, val| - instance_variable_set "@#{ivar}", val - end + if description =~ /FIXME|TODO/ then + raise Gem::InvalidSpecificationException, + '"FIXME" or "TODO" is not a description' + end - @original_platform = @platform # for backwards compatibility - self.platform = Gem::Platform.new @platform + if summary =~ /FIXME|TODO/ then + raise Gem::InvalidSpecificationException, + '"FIXME" or "TODO" is not a summary' end - ## - # Returns a Ruby code representation of this specification, such that it - # can be eval'ed and reconstruct the same specification later. Attributes - # that still have their default values are omitted. - - def to_ruby - mark_version - result = [] - result << "# -*- encoding: utf-8 -*-" - 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=" - - handled = [ - :dependencies, - :name, - :platform, - :required_rubygems_version, - :specification_version, - :version, - ] + 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 - attributes = @@attributes.sort_by { |attr_name,| attr_name.to_s } + # Warnings - attributes.each do |attr_name, default| - next if handled.include? attr_name - current_value = self.send(attr_name) - if current_value != default or - self.class.required_attribute? attr_name then - result << " s.#{attr_name} = #{ruby_code current_value}" - end - end + %w[author description email homepage rubyforge_project summary].each do |attribute| + value = self.send attribute + alert_warning "no #{attribute} specified" if value.nil? or value.empty? + end - result << nil - result << " if s.respond_to? :specification_version then" - result << " current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION" - result << " s.specification_version = #{specification_version}" - result << nil + if summary and not summary.empty? and description == summary then + alert_warning 'description and summary are identical' + end - result << " if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then" + alert_warning "deprecated autorequire specified" if autorequire - unless dependencies.empty? then - dependencies.each do |dep| - version_reqs_param = dep.requirements_list.inspect - dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK - result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>, #{version_reqs_param})" - end - end + executables.each do |executable| + executable_path = File.join bindir, executable + shebang = File.read(executable_path, 2) == '#!' - result << " else" + alert_warning "#{executable_path} is missing #! line" unless shebang + end - unless dependencies.empty? then - dependencies.each do |dep| - version_reqs_param = dep.requirements_list.inspect - result << " s.add_dependency(%q<#{dep.name}>, #{version_reqs_param})" - end - end + true + end - result << ' end' + ## + # Normalize the list of files so that: + # * All file lists have redundancies removed. + # * Files referenced in the extra_rdoc_files are included in the package + # file list. + + def normalize + if defined?(@extra_rdoc_files) and @extra_rdoc_files then + @extra_rdoc_files.uniq! + @files ||= [] + @files.concat(@extra_rdoc_files) + end + @files.uniq! if @files + end - result << " else" - dependencies.each do |dep| - version_reqs_param = dep.requirements_list.inspect - result << " s.add_dependency(%q<#{dep.name}>, #{version_reqs_param})" + ## + # 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]] + + def dependent_gems + out = [] + Gem.source_index.each do |name,gem| + gem.dependencies.each do |dep| + if self.satisfies_requirement?(dep) then + sats = [] + find_all_satisfiers(dep) do |sat| + sats << sat + end + out << [gem, dep, sats] end - result << " end" + end + end + out + end - result << "end" - result << nil + def to_s # :nodoc: + "#<Gem::Specification name=#{@name} version=#{@version}>" + end - result.join "\n" - end + def pretty_print(q) # :nodoc: + q.group 2, 'Gem::Specification.new do |s|', 'end' do + q.breakable - ## - # 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.. + attributes = @@attributes.sort_by { |attr_name,| attr_name.to_s } - def validate - extend Gem::UserInteraction - normalize + attributes.each do |attr_name, default| + current_value = self.send attr_name + if current_value != default or + self.class.required_attribute? attr_name then - if rubygems_version != RubyGemsVersion then - raise Gem::InvalidSpecificationException, - "expected RubyGems version #{RubyGemsVersion}, was #{rubygems_version}" - end + q.text "s.#{attr_name} = " - @@required_attributes.each do |symbol| - unless self.send symbol then - raise Gem::InvalidSpecificationException, - "missing value for attribute #{symbol}" - end - end + if attr_name == :date then + current_value = current_value.utc - if require_paths.empty? then - raise Gem::InvalidSpecificationException, - "specification must have at least one require_path" - end + q.text "Time.utc(#{current_value.year}, #{current_value.month}, #{current_value.day})" + else + q.pp current_value + end - case platform - when Gem::Platform, Platform::RUBY then # ok - else - raise Gem::InvalidSpecificationException, - "invalid platform #{platform.inspect}, see Gem::Platform" + q.breakable + end end + end + end - unless Array === authors and - authors.all? { |author| String === author } then - raise Gem::InvalidSpecificationException, - 'authors must be Array of Strings' - end + ## + # Adds a dependency on gem +dependency+ with type +type+ that requires + # +requirements+. Valid types are currently <tt>:runtime</tt> and + # <tt>:development</tt>. - # Warnings + def add_dependency_with_type(dependency, type, *requirements) + requirements = if requirements.empty? then + Gem::Requirement.default + else + requirements.flatten + end - %w[author email homepage rubyforge_project summary].each do |attribute| - value = self.send attribute - alert_warning "no #{attribute} specified" if value.nil? or value.empty? - end + unless dependency.respond_to?(:name) && + dependency.respond_to?(:version_requirements) - alert_warning "RDoc will not be generated (has_rdoc == false)" unless - has_rdoc + dependency = Gem::Dependency.new(dependency, requirements, type) + end - alert_warning "deprecated autorequire specified" if autorequire + dependencies << dependency + end - executables.each do |executable| - executable_path = File.join bindir, executable - shebang = File.read(executable_path, 2) == '#!' + private :add_dependency_with_type - alert_warning "#{executable_path} is missing #! line" unless shebang - end + ## + # Finds all gems that satisfy +dep+ - true + def find_all_satisfiers(dep) + Gem.source_index.each do |_, gem| + yield gem if gem.satisfies_requirement? dep end + end - ## - # Normalize the list of files so that: - # * All file lists have redundancies removed. - # * Files referenced in the extra_rdoc_files are included in the package - # file list. - # - # Also, the summary and description are converted to a normal format. - - def normalize - if defined?(@extra_rdoc_files) and @extra_rdoc_files then - @extra_rdoc_files.uniq! - @files ||= [] - @files.concat(@extra_rdoc_files) - end - @files.uniq! if @files - end + private :find_all_satisfiers - ## - # 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]] - - def dependent_gems - out = [] - Gem.source_index.each do |name,gem| - gem.dependencies.each do |dep| - if self.satisfies_requirement?(dep) then - sats = [] - find_all_satisfiers(dep) do |sat| - sats << sat - end - out << [gem, dep, sats] - end - end - end - out + ## + # Return a string containing a Ruby code representation of the given + # object. + + def ruby_code(obj) + case obj + when String then '%q{' + obj + '}' + when Array then obj.inspect + when Gem::Version then obj.to_s.inspect + when Date then '%q{' + obj.strftime('%Y-%m-%d') + '}' + when Time then '%q{' + obj.strftime('%Y-%m-%d') + '}' + 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 "Gem::Requirement.new(#{obj.to_s.inspect})" + else raise Gem::Exception, "ruby_code case not handled: #{obj.class}" end + end - def to_s - "#<Gem::Specification name=#{@name} version=#{@version}>" - end + private :ruby_code - def add_dependency_with_type(dependency, type, *requirements) - requirements = if requirements.empty? then - Gem::Requirement.default - else - requirements.flatten - end + # :section: Required gemspec attributes - unless dependency.respond_to?(:name) && - dependency.respond_to?(:version_requirements) + ## + # :attr_accessor: rubygems_version + # + # The version of RubyGems used to create this gem - dependency = Dependency.new(dependency, requirements, type) - end + required_attribute :rubygems_version, Gem::RubyGemsVersion - dependencies << dependency - end + ## + # :attr_accessor: specification_version + # + # The Gem::Specification version of this gemspec - private :add_dependency_with_type + required_attribute :specification_version, CURRENT_SPECIFICATION_VERSION - def find_all_satisfiers(dep) - Gem.source_index.each do |name,gem| - if(gem.satisfies_requirement?(dep)) then - yield gem - end - end - end + ## + # :attr_accessor: name + # + # This gem's name - private :find_all_satisfiers - - ## - # Return a string containing a Ruby code representation of the given - # object. - - def ruby_code(obj) - case obj - when String then '%q{' + obj + '}' - when Array then obj.inspect - when Gem::Version then obj.to_s.inspect - when Date then '%q{' + obj.strftime('%Y-%m-%d') + '}' - when Time then '%q{' + obj.strftime('%Y-%m-%d') + '}' - 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 "Gem::Requirement.new(#{obj.to_s.inspect})" - else raise Exception, "ruby_code case not handled: #{obj.class}" - end - end + required_attribute :name - private :ruby_code + ## + # :attr_accessor: version + # + # This gem's version - # :section: Required gemspec attributes + required_attribute :version - ## - # The version of RubyGems used to create this gem + ## + # :attr_accessor: date + # + # The date this gem was created - required_attribute :rubygems_version, Gem::RubyGemsVersion + required_attribute :date, TODAY - ## - # The Gem::Specification version of this gemspec + ## + # :attr_accessor: summary + # + # A short summary of this gem's description. Displayed in `gem list -d`. - required_attribute :specification_version, CURRENT_SPECIFICATION_VERSION + required_attribute :summary - ## - # This gem's name + ## + # :attr_accessor: require_paths + # + # Paths in the gem to add to $LOAD_PATH when this gem is activated - required_attribute :name + required_attribute :require_paths, ['lib'] - ## - # This gem's version + # :section: Optional gemspec attributes - required_attribute :version + ## + # :attr_accessor: email + # + # A contact email for this gem - ## - # The date this gem was created + attribute :email - required_attribute :date, TODAY + ## + # :attr_accessor: homepage + # + # The URL of this gem's home page - ## - # A short summary of this gem's description. Displayed in `gem list -d`. + attribute :homepage - required_attribute :summary + ## + # :attr_accessor: rubyforge_project + # + # The rubyforge project this gem lives under. i.e. RubyGems' + # rubyforge_project is "rubygems". - ## - # Paths in the gem to add to $LOAD_PATH when this gem is activated + attribute :rubyforge_project - required_attribute :require_paths, ['lib'] + ## + # :attr_accessor: description + # + # A long description of this gem - # :section: Optional gemspec attributes + attribute :description - ## - # A contact email for this gem + ## + # :attr_accessor: autorequire + # + # Autorequire was used by old RubyGems to automatically require a file. + # It no longer is supported. - attribute :email + attribute :autorequire - ## - # The URL of this gem's home page + ## + # :attr_accessor: default_executable + # + # The default executable for this gem. - attribute :homepage + attribute :default_executable - ## - # The rubyforge project this gem lives under. i.e. RubyGems' - # rubyforge_project is "rubygems". + ## + # :attr_accessor: bindir + # + # The path in the gem for executable scripts - attribute :rubyforge_project + attribute :bindir, 'bin' - ## - # A long description of this gem + ## + # :attr_accessor: has_rdoc + # + # Deprecated and ignored, defaults to true. + # + # Formerly used to indicate this gem was RDoc-capable. - attribute :description + attribute :has_rdoc, true - ## - # Autorequire was used by old RubyGems to automatically require a file. - # It no longer is supported. + ## + # True if this gem supports RDoc - attribute :autorequire + alias :has_rdoc? :has_rdoc - ## - # The default executable for this gem. + ## + # :attr_accessor: required_ruby_version + # + # The ruby of version required by this gem - attribute :default_executable + attribute :required_ruby_version, Gem::Requirement.default - ## - # The path in the gem for executable scripts + ## + # :attr_accessor: required_rubygems_version + # + # The RubyGems version required by this gem - attribute :bindir, 'bin' + attribute :required_rubygems_version, Gem::Requirement.default - ## - # True if this gem is RDoc-compliant + ## + # :attr_accessor: platform + # + # The platform this gem runs on. See Gem::Platform for details. - attribute :has_rdoc, false + attribute :platform, Gem::Platform::RUBY - ## - # True if this gem supports RDoc + ## + # :attr_accessor: signing_key + # + # The key used to sign this gem. See Gem::Security for details. - alias :has_rdoc? :has_rdoc + attribute :signing_key, nil - ## - # The ruby of version required by this gem + ## + # :attr_accessor: cert_chain + # + # The certificate chain used to sign this gem. See Gem::Security for + # details. - attribute :required_ruby_version, Gem::Requirement.default + attribute :cert_chain, [] - ## - # The RubyGems version required by this gem + ## + # :attr_accessor: post_install_message + # + # A message that gets displayed after the gem is installed - attribute :required_rubygems_version, Gem::Requirement.default + attribute :post_install_message, nil - ## - # The platform this gem runs on. See Gem::Platform for details. + ## + # :attr_accessor: authors + # + # The list of authors who wrote this gem - attribute :platform, Gem::Platform::RUBY + array_attribute :authors - ## - # The key used to sign this gem. See Gem::Security for details. + ## + # :attr_accessor: licenses + # + # The license(s) for the library. Each license must be a short name, no + # more than 64 characters. - attribute :signing_key, nil + array_attribute :licenses - ## - # The certificate chain used to sign this gem. See Gem::Security for - # details. + ## + # :attr_accessor: files + # + # 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. - attribute :cert_chain, [] + array_attribute :files - ## - # A message that gets displayed after the gem is installed + ## + # :attr_accessor: test_files + # + # Test files included in this gem. You cannot append to this accessor, you + # must assign to it. - attribute :post_install_message, nil + array_attribute :test_files - ## - # The list of authors who wrote this gem + ## + # :attr_accessor: rdoc_options + # + # An ARGV-style array of options to RDoc - array_attribute :authors + array_attribute :rdoc_options - ## - # Files included in this gem + ## + # :attr_accessor: extra_rdoc_files + # + # Extra files to add to RDoc - array_attribute :files + array_attribute :extra_rdoc_files - ## - # Test files included in this gem + ## + # :attr_accessor: executables + # + # Executables included in the gem - array_attribute :test_files + array_attribute :executables - ## - # An ARGV-style array of options to RDoc + ## + # :attr_accessor: extensions + # + # Extensions to build when installing the gem. See + # Gem::Installer#build_extensions for valid values. + + array_attribute :extensions - array_attribute :rdoc_options + ## + # :attr_accessor: requirements + # + # An array or things required by this gem. Not used by anything + # presently. - ## - # Extra files to add to RDoc + array_attribute :requirements - array_attribute :extra_rdoc_files + ## + # :attr_reader: dependencies + # + # A list of Gem::Dependency objects this gem depends on. - ## - # Executables included in the gem + array_attribute :dependencies - array_attribute :executables + read_only :dependencies - ## - # Extensions to build when installing the gem. See - # Gem::Installer#build_extensions for valid values. + # :section: Aliased gemspec attributes - array_attribute :extensions + ## + # Singular accessor for #executables - ## - # An array or things required by this gem. Not used by anything - # presently. + attribute_alias_singular :executable, :executables - array_attribute :requirements + ## + # Singular accessor for #authors - ## - # A list of Gem::Dependency objects this gem depends on. Only appendable. + attribute_alias_singular :author, :authors - array_attribute :dependencies + ## + # Singular accessor for #licenses - read_only :dependencies + attribute_alias_singular :license, :licenses - # :section: Aliased gemspec attributes + ## + # Singular accessor for #require_paths - ## - # Singular accessor for executables + attribute_alias_singular :require_path, :require_paths - attribute_alias_singular :executable, :executables + ## + # Singular accessor for #test_files - ## - # Singular accessor for authors + attribute_alias_singular :test_file, :test_files - attribute_alias_singular :author, :authors + ## + # has_rdoc is now ignored - ## - # Singular accessor for require_paths + overwrite_accessor :has_rdoc do + true + end - attribute_alias_singular :require_path, :require_paths + ## + # has_rdoc is now ignored - ## - # Singular accessor for test_files + overwrite_accessor :has_rdoc= do |value| + @has_rdoc = true + end - attribute_alias_singular :test_file, :test_files + overwrite_accessor :version= do |version| + @version = Gem::Version.create(version) + self.required_rubygems_version = '> 1.3.1' if @version.prerelease? + return @version + end - overwrite_accessor :version= do |version| - @version = Version.create(version) - end + overwrite_accessor :platform do + @new_platform + end - overwrite_accessor :platform do - @new_platform + overwrite_accessor :platform= do |platform| + if @original_platform.nil? or + @original_platform == Gem::Platform::RUBY then + @original_platform = platform end - overwrite_accessor :platform= do |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 'mswin64' then - @new_platform = Gem::Platform.new 'x86-mswin64' - 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 + case platform + when Gem::Platform::CURRENT then + @new_platform = Gem::Platform.local + @original_platform = @new_platform.to_s - @platform = @new_platform.to_s + when Gem::Platform then + @new_platform = platform - @new_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 - overwrite_accessor :required_ruby_version= do |value| - @required_ruby_version = Gem::Requirement.create(value) - end + @platform = @new_platform.to_s - overwrite_accessor :required_rubygems_version= do |value| - @required_rubygems_version = Gem::Requirement.create(value) - end + @new_platform + end - overwrite_accessor :date= do |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. - case date - when String then - @date = if /\A(\d{4})-(\d{2})-(\d{2})\Z/ =~ date then - Time.local($1.to_i, $2.to_i, $3.to_i) - else - require 'time' - Time.parse date - end - when Time then - @date = Time.local(date.year, date.month, date.day) - when Date then - @date = Time.local(date.year, date.month, date.day) - else - @date = TODAY - end - end + overwrite_accessor :required_ruby_version= do |value| + @required_ruby_version = Gem::Requirement.create(value) + end - overwrite_accessor :date do - self.date = nil if @date.nil? # HACK Sets the default value for date - @date - end + overwrite_accessor :required_rubygems_version= do |value| + @required_rubygems_version = Gem::Requirement.create(value) + end - overwrite_accessor :summary= do |str| - @summary = if str then - str.strip. - gsub(/(\w-)\n[ \t]*(\w)/, '\1\2'). - gsub(/\n[ \t]*/, " ") - end + overwrite_accessor :date= do |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. + case date + when String then + @date = if /\A(\d{4})-(\d{2})-(\d{2})\Z/ =~ date then + Time.local($1.to_i, $2.to_i, $3.to_i) + else + require 'time' + Time.parse date + end + when Time then + @date = Time.local(date.year, date.month, date.day) + when Date then + @date = Time.local(date.year, date.month, date.day) + else + @date = TODAY end + end - overwrite_accessor :description= do |str| - @description = if str then - str.strip. - gsub(/(\w-)\n[ \t]*(\w)/, '\1\2'). - gsub(/\n[ \t]*/, " ") - end - end + overwrite_accessor :date do + self.date = nil if @date.nil? # HACK Sets the default value for date + @date + end - overwrite_accessor :default_executable do - begin - if defined?(@default_executable) and @default_executable - result = @default_executable - elsif @executables and @executables.size == 1 - result = Array(@executables).first - else - result = nil - end - result - rescue - nil - end - end + overwrite_accessor :summary= do |str| + @summary = if str then + str.strip. + gsub(/(\w-)\n[ \t]*(\w)/, '\1\2'). + gsub(/\n[ \t]*/, " ") + end + end - overwrite_accessor :test_files do - # Handle the possibility that we have @test_suite_file but not - # @test_files. This will happen when an old gem is loaded via - # YAML. - if defined? @test_suite_file then - @test_files = [@test_suite_file].flatten - @test_suite_file = nil - end - if defined?(@test_files) and @test_files then - @test_files + overwrite_accessor :description= do |str| + @description = str.to_s + end + + overwrite_accessor :default_executable do + begin + if defined?(@default_executable) and @default_executable + result = @default_executable + elsif @executables and @executables.size == 1 + result = Array(@executables).first else - @test_files = [] + result = nil end + result + rescue + nil end + end - overwrite_accessor :files do - result = [] - result.push(*@files) if defined?(@files) - result.push(*@test_files) if defined?(@test_files) - result.push(*(add_bindir(@executables))) - result.push(*@extra_rdoc_files) if defined?(@extra_rdoc_files) - result.push(*@extensions) if defined?(@extensions) - result.uniq.compact + overwrite_accessor :test_files do + # Handle the possibility that we have @test_suite_file but not + # @test_files. This will happen when an old gem is loaded via + # YAML. + if defined? @test_suite_file then + @test_files = [@test_suite_file].flatten + @test_suite_file = nil end + if defined?(@test_files) and @test_files then + @test_files + else + @test_files = [] + end + end + overwrite_accessor :files do + result = [] + result.push(*@files) if defined?(@files) + result.push(*@test_files) if defined?(@test_files) + result.push(*(add_bindir(@executables))) + result.push(*@extra_rdoc_files) if defined?(@extra_rdoc_files) + result.push(*@extensions) if defined?(@extensions) + result.uniq.compact end end |