Class: Gem::Specification

Inherits:
Object
  • Object
show all
Extended by:
Enumerable, Deprecate
Defined in:
lib/rubygems/specification.rb

Overview

:startdoc:

Constant Summary collapse

NONEXISTENT_SPECIFICATION_VERSION =

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

-1
CURRENT_SPECIFICATION_VERSION =

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.

4
SPECIFICATION_VERSION_HISTORY =

An informal list of changes to the specification. The highest-valued key should be equal to the CURRENT_SPECIFICATION_VERSION.

{
  -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 = 
{ -1 => 16, 1 => 16, 2 => 16, 3 => 17, 4 => 18 }
TODAY = 
Time.utc(today.year, today.month, today.day)
DateTimeFormat = 
/\A
  (\d{4})-(\d{2})-(\d{2})
  (\s+ \d{2}:\d{2}:\d{2}\.\d+ \s* (Z | [-+]\d\d:\d\d) )?
\Z/x
@@required_attributes =

List of attribute names: [:name, :version, …]

[:rubygems_version,
:specification_version,
:name,
:version,
:date,
:summary,
:require_paths]
@@default_value =

Map of attribute names to default values.

{
  :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,
}
@@attributes = 
@@default_value.keys.sort_by { |s| s.to_s }
@@array_attributes = 
@@default_value.reject { |k,v| v != [] }.keys

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Deprecate

deprecate, skip, skip=, skip_during

Constructor Details

#initialize(name = nil, version = nil) {|_self| ... } ⇒ Specification

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

Yields:

  • (_self)

Yield Parameters:



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'lib/rubygems/specification.rb', line 1722

def initialize name = nil, version = nil
  @loaded = false
  @activated = false
  @loaded_from = nil
  @original_platform = nil

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

  @@non_nil_attributes.each do |key|
    default = default_value(key)
    value = case default
            when Time, Numeric, Symbol, true, false, nil then default
            else default.dup
            end

    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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *a, &b) ⇒ Object

Warn about unknown attributes while loading a spec.



1874
1875
1876
1877
1878
1879
1880
1881
 
# File 'lib/rubygems/specification.rb', line 1874

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

Instance Attribute Details

#activated ⇒ Object Also known as: activated?

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



570
571
572
 
# File 'lib/rubygems/specification.rb', line 570

def activated
  @activated
end

#autorequire ⇒ Object

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

Deprecated: It is neither supported nor functional.



579
580
581
 
# File 'lib/rubygems/specification.rb', line 579

def autorequire
  @autorequire
end

#bindir ⇒ Object

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

Usage:

spec.bindir = 'bin'



321
322
323
 
# File 'lib/rubygems/specification.rb', line 321

def bindir
  @bindir
end

#cert_chain ⇒ Object

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



327
328
329
 
# File 'lib/rubygems/specification.rb', line 327

def cert_chain
  @cert_chain
end

#default_executable ⇒ Object

The default executable for this gem.

Deprecated: The name of the gem is assumed to be the name of the executable now. See Gem.bin_path.



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/rubygems/specification.rb', line 1433

def default_executable
  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
end

#description ⇒ Object

A long description of this gem

The description should be more detailed than the summary.

Usage:

spec.description = <<-EOF
  Rake is a Make-like program implemented in Ruby. Tasks and
  dependencies are specified in standard Ruby syntax.
EOF



341
342
343
 
# File 'lib/rubygems/specification.rb', line 341

def description
  @description
end

#email ⇒ Object

A contact email for this gem

Usage:

spec.email = '[email protected]'
spec.email = ['[email protected]', '[email protected]']



351
352
353
 
# File 'lib/rubygems/specification.rb', line 351

def email
  @email
end

#homepage ⇒ Object

The URL of this gem’s home page

Usage:

spec.homepage = 'http://rake.rubyforge.org'



360
361
362
 
# File 'lib/rubygems/specification.rb', line 360

def homepage
  @homepage
end

#loaded_from ⇒ Object

Path this gemspec was loaded from. This attribute is not persisted.



591
592
593
 
# File 'lib/rubygems/specification.rb', line 591

def loaded_from
  @loaded_from
end

#metadata ⇒ Object

:attr_accessor: metadata

Arbitrary metadata for this gem. An instance of Hash.

metadata is simply a Symbol => String association that contains arbitary data that could be useful to other consumers.



384
385
386
 
# File 'lib/rubygems/specification.rb', line 384

def metadata
  @metadata
end

#name ⇒ Object

This gem’s name.

Usage:

spec.name = 'rake'



177
178
179
 
# File 'lib/rubygems/specification.rb', line 177

def name
  @name
end

#original_platform ⇒ Object

Cruft. Use platform.



1925
1926
1927
 
# File 'lib/rubygems/specification.rb', line 1925

def original_platform # :nodoc:
  @original_platform ||= platform
end

#post_install_message ⇒ Object

A message that gets displayed after the gem is installed.

Usage:

spec.post_install_message = "Thanks for installing!"



369
370
371
 
# File 'lib/rubygems/specification.rb', line 369

def post_install_message
  @post_install_message
end

#require_paths ⇒ Object

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

Usage:

# If all library files are in the root directory...
spec.require_path = '.'

# If you have 'lib' and 'ext' directories...
spec.require_paths << 'ext'



203
204
205
 
# File 'lib/rubygems/specification.rb', line 203

def require_paths
  @require_paths
end

#required_ruby_version ⇒ Object

The version of ruby required by this gem



601
602
603
 
# File 'lib/rubygems/specification.rb', line 601

def required_ruby_version
  @required_ruby_version
end

#required_rubygems_version ⇒ Object

The RubyGems version required by this gem



606
607
608
 
# File 'lib/rubygems/specification.rb', line 606

def required_rubygems_version
  @required_rubygems_version
end

#rubyforge_project ⇒ Object

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



611
612
613
 
# File 'lib/rubygems/specification.rb', line 611

def rubyforge_project
  @rubyforge_project
end

#rubygems_version ⇒ Object

The version of RubyGems used to create this gem.

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



210
211
212
 
# File 'lib/rubygems/specification.rb', line 210

def rubygems_version
  @rubygems_version
end

#signing_key ⇒ Object

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



374
375
376
 
# File 'lib/rubygems/specification.rb', line 374

def signing_key
  @signing_key
end

#specification_version ⇒ Object

The Gem::Specification version of this gemspec.

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



618
619
620
 
# File 'lib/rubygems/specification.rb', line 618

def specification_version
  @specification_version
end

#summary ⇒ Object

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"



221
222
223
 
# File 'lib/rubygems/specification.rb', line 221

def summary
  @summary
end

#version ⇒ Object

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'



190
191
192
 
# File 'lib/rubygems/specification.rb', line 190

def version
  @version
end

Class Method Details

._all ⇒ Object

:nodoc:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/rubygems/specification.rb', line 646

def self._all # :nodoc:
  unless defined?(@@all) && @@all then

    specs = {}
    each_default do |spec|
      specs[spec.full_name] ||= spec
    end
    each_normal do |spec|
      specs[spec.full_name] ||= spec
    end

    @@all = specs.values

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

    _resort!
  end
  @@all
end

._load(str) ⇒ Object

Load custom marshal format, re-initializing defaults as needed



1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'lib/rubygems/specification.rb', line 1064

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

._resort! ⇒ Object

:nodoc:



670
671
672
673
674
675
676
 
# File 'lib/rubygems/specification.rb', line 670

def self._resort! # :nodoc:
  @@all.sort! { |a, b|
    names = a.name <=> b.name
    next names if names.nonzero?
    b.version <=> a.version
  }
end

.add_spec(spec) ⇒ Object

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



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/rubygems/specification.rb', line 691

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
  _resort!
end

.add_specs(*specs) ⇒ Object

Adds multiple specs to the known specifications.



711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/rubygems/specification.rb', line 711

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 ⇒ Object

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



727
728
729
730
731
 
# File 'lib/rubygems/specification.rb', line 727

def self.all
  warn "NOTE: Specification.all called from #{caller.first}" unless
    Gem::Deprecate.skip
  _all
end

.all=(specs) ⇒ Object

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



745
746
747
 
# File 'lib/rubygems/specification.rb', line 745

def self.all= specs
  @@all = specs
end

.all_names ⇒ Object

Return full names of all specs in sorted order.



752
753
754
 
# File 'lib/rubygems/specification.rb', line 752

def self.all_names
  self._all.map(&:full_name)
end

.array_attributes ⇒ Object

Return the list of all array-oriented instance variables. – Not sure why we need to use so much stupid reflection in here…



761
762
763
 
# File 'lib/rubygems/specification.rb', line 761

def self.array_attributes
  @@array_attributes.dup
end

.attribute_names ⇒ Object

Return the list of all instance variables. – Not sure why we need to use so much stupid reflection in here…



770
771
772
 
# File 'lib/rubygems/specification.rb', line 770

def self.attribute_names
  @@attributes.dup
end

.default_specifications_dir ⇒ Object 



621
622
623
 
# File 'lib/rubygems/specification.rb', line 621

def default_specifications_dir
  File.join(Gem.default_dir, "specifications", "default")
end

.dirs ⇒ Object

Return the directories that Specification uses to find specs.



777
778
779
780
781
 
# File 'lib/rubygems/specification.rb', line 777

def self.dirs
  @@dirs ||= Gem.path.collect { |dir|
    File.join dir.dup.untaint, "specifications"
  }
end

.dirs=(dirs) ⇒ Object

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



787
788
789
790
791
792
793
794
795
 
# File 'lib/rubygems/specification.rb', line 787

def self.dirs= dirs
  # TODO: find extra calls to dir=
  # warn "NOTE: dirs= called from #{caller.first} for #{dirs.inspect}"

  self.reset

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

.each ⇒ Object

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



803
804
805
806
807
808
809
 
# File 'lib/rubygems/specification.rb', line 803

def self.each
  return enum_for(:each) unless block_given?

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

.each_default(&block) ⇒ Object

:nodoc:



636
637
638
639
 
# File 'lib/rubygems/specification.rb', line 636

def each_default(&block) # :nodoc:
  each_spec([default_specifications_dir],
            &block)
end

.each_normal(&block) ⇒ Object

:nodoc:



641
642
643
 
# File 'lib/rubygems/specification.rb', line 641

def each_normal(&block) # :nodoc:
  each_spec(dirs, &block)
end

.each_spec(search_dirs) ⇒ Object

:nodoc:



625
626
627
628
629
630
631
632
633
634
 
# File 'lib/rubygems/specification.rb', line 625

def each_spec(search_dirs) # :nodoc:
  search_dirs.each { |dir|
    Dir[File.join(dir, "*.gemspec")].each { |path|
      spec = Gem::Specification.load path.untaint
      # #load returns nil if the spec is bad, so we just ignore
      # it at this stage
      yield(spec) if spec
    }
  }
end

.find_all_by_name(name, *requirements) ⇒ Object

Returns every spec that matches name and optional requirements.



814
815
816
817
818
819
820
 
# File 'lib/rubygems/specification.rb', line 814

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) ⇒ Object

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



826
827
828
829
830
831
832
 
# File 'lib/rubygems/specification.rb', line 826

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) ⇒ Object

Return the best specification that contains the file matching path.



837
838
839
840
841
 
# File 'lib/rubygems/specification.rb', line 837

def self.find_by_path path
  self.find { |spec|
    spec.contains_requirable_file? path
  }
end

.find_in_unresolved(path) ⇒ Object

Return currently unresolved specs that contain the file matching path.



856
857
858
859
860
861
 
# File 'lib/rubygems/specification.rb', line 856

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) ⇒ Object

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



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/rubygems/specification.rb', line 867

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) ⇒ Object

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



847
848
849
850
851
 
# File 'lib/rubygems/specification.rb', line 847

def self.find_inactive_by_path path
  self.find { |spec|
    spec.contains_requirable_file? path unless spec.activated?
  }
end

.from_yaml(input) ⇒ Object

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.



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/rubygems/specification.rb', line 893

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) ⇒ Object

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



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/rubygems/specification.rb', line 917

def self.latest_specs prerelease = false
  result = Hash.new { |h,k| h[k] = {} }
  native = {}

  Gem::Specification._all.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
  }
end

.load(file) ⇒ Object

Loads Ruby format gemspec from file.



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/rubygems/specification.rb', line 937

def self.load file
  return unless file
  file = file.dup.untaint
  return unless File.file?(file)

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

  code.untaint

  begin
    spec = eval code, binding, file

    if Gem::Specification === spec
      spec.loaded_from = file.to_s
      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 ⇒ Object

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



681
682
683
684
685
 
# File 'lib/rubygems/specification.rb', line 681

def self.load_defaults
  each_default do |spec|
    Gem.register_default_spec(spec)
  end
end

.non_nil_attributes ⇒ Object

Specification attributes that must be non-nil



971
972
973
 
# File 'lib/rubygems/specification.rb', line 971

def self.non_nil_attributes
  @@non_nil_attributes.dup
end

.normalize_yaml_input(input) ⇒ Object

Make sure the YAML specification is properly formatted with dashes



978
979
980
981
982
983
984
985
986
 
# File 'lib/rubygems/specification.rb', line 978

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 ⇒ Object

Return a list of all outdated specifications. This method is HEAVY as it must go fetch specifications from the server.



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/rubygems/specification.rb', line 992

def self.outdated
  outdateds = []

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

  latest_specs.each do |local|
    dependency = Gem::Dependency.new local.name, ">= #{local.version}"
    remotes, _   = fetcher.search_for_dependency dependency
    remotes      = remotes.map { |n, _| n.version }
    latest       = remotes.sort.last

    outdateds << local.name if latest and local.version < latest
  end

  outdateds
end

.remove_spec(spec) ⇒ Object

Removes spec from the known specs.



1013
1014
1015
1016
1017
1018
 
# File 'lib/rubygems/specification.rb', line 1013

def self.remove_spec spec
  # TODO: beat on the tests
  raise "wtf: #{spec.full_name} not in #{all_names.inspect}" unless
    _all.include? spec
  _all.delete spec
end

.required_attribute?(name) ⇒ Boolean

Is name a required attribute?

Returns:

  • (Boolean) 


1023
1024
1025
 
# File 'lib/rubygems/specification.rb', line 1023

def self.required_attribute?(name)
  @@required_attributes.include? name.to_sym
end

.required_attributes ⇒ Object

Required specification attributes



1030
1031
1032
 
# File 'lib/rubygems/specification.rb', line 1030

def self.required_attributes
  @@required_attributes.dup
end

.reset ⇒ Object

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



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/rubygems/specification.rb', line 1038

def self.reset
  @@dirs = nil
  Gem.pre_reset_hooks.each { |hook| hook.call }
  @@all = nil
  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

.unresolved_deps ⇒ Object

DOC: This method needs documented or nodoc’d



1057
1058
1059
 
# File 'lib/rubygems/specification.rb', line 1057

def self.unresolved_deps
  @unresolved_deps ||= Hash.new { |h, n| h[n] = Gem::Dependency.new n }
end

Instance Method Details

#<=>(other) ⇒ Object

:nodoc:



1115
1116
1117
 
# File 'lib/rubygems/specification.rb', line 1115

def <=>(other) # :nodoc:
  sort_obj <=> other.sort_obj
end

#==(other) ⇒ Object

:nodoc:



1119
1120
1121
1122
1123
1124
 
# File 'lib/rubygems/specification.rb', line 1119

def == other # :nodoc:
  self.class === other &&
    name == other.name &&
    version == other.version &&
    platform == other.platform
end

#_dump(limit) ⇒ Object

Dump only crucial instance variables. – MAINTAIN ORDER! (down with the man)



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/rubygems/specification.rb', line 1132

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 ⇒ Object

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.



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/rubygems/specification.rb', line 1162

def activate
  raise_if_conflicts

  return false if Gem.loaded_specs[self.name]

  activate_dependencies
  add_self_to_load_path

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

  return true
end

#activate_dependencies ⇒ Object

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



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/rubygems/specification.rb', line 1182

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) ⇒ Object

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



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'lib/rubygems/specification.rb', line 1213

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_development_dependency(gem, *requirements) ⇒ Object

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.



397
398
399
 
# File 'lib/rubygems/specification.rb', line 397

def add_development_dependency(gem, *requirements)
  add_dependency_with_type(gem, :development, *requirements)
end

#add_runtime_dependency(gem, *requirements) ⇒ Object Also known as: add_dependency

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

Usage:

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



408
409
410
 
# File 'lib/rubygems/specification.rb', line 408

def add_runtime_dependency(gem, *requirements)
  add_dependency_with_type(gem, :runtime, *requirements)
end

#add_self_to_load_path ⇒ Object

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



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
 
# File 'lib/rubygems/specification.rb', line 1252

def add_self_to_load_path
  return if default_gem?

  paths = require_paths.map do |path|
    File.join full_gem_path, path
  end

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

Singular reader for #authors



1274
1275
1276
 
# File 'lib/rubygems/specification.rb', line 1274

def author
  val = authors and val.first
end

#author=(o) ⇒ Object

Singular writer for #authors

Usage:

spec.author = 'John Jones'



419
420
421
 
# File 'lib/rubygems/specification.rb', line 419

def author= o
  self.authors = [o]
end

#authors ⇒ Object

The list of author names who wrote this gem.



1281
1282
1283
 
# File 'lib/rubygems/specification.rb', line 1281

def authors
  @authors ||= []
end

#authors=(value) ⇒ Object

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

Usage:

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



430
431
432
 
# File 'lib/rubygems/specification.rb', line 430

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

#base_dir ⇒ Object

Returns the full path to the base gem directory.

eg: /usr/local/lib/ruby/gems/1.8



1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/rubygems/specification.rb', line 1290

def base_dir
  return Gem.dir unless loaded_from
  @base_dir ||= if default_gem? then
                  File.dirname File.dirname File.dirname loaded_from
                else
                  File.dirname File.dirname loaded_from
                end
end

#bin_dir ⇒ Object

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.



1305
1306
1307
 
# File 'lib/rubygems/specification.rb', line 1305

def bin_dir
  @bin_dir ||= File.join gem_dir, bindir # TODO: this is unfortunate
end

#bin_file(name) ⇒ Object

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



1312
1313
1314
 
# File 'lib/rubygems/specification.rb', line 1312

def bin_file name
  File.join bin_dir, name
end

#build_args ⇒ Object

Returns the build_args used to install the gem



1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/rubygems/specification.rb', line 1319

def build_args
  if File.exists? build_info_file
    File.readlines(build_info_file).map { |x| x.strip }
  else
    []
  end
end

#build_info_dir ⇒ Object

Returns the full path to the build info directory



1330
1331
1332
 
# File 'lib/rubygems/specification.rb', line 1330

def build_info_dir
  File.join base_dir, "build_info"
end

#build_info_file ⇒ Object

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



1338
1339
1340
 
# File 'lib/rubygems/specification.rb', line 1338

def build_info_file
  File.join build_info_dir, "#{full_name}.info"
end

#cache_dir ⇒ Object

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



1346
1347
1348
 
# File 'lib/rubygems/specification.rb', line 1346

def cache_dir
  @cache_dir ||= File.join base_dir, "cache"
end

#cache_file ⇒ Object

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



1353
1354
1355
 
# File 'lib/rubygems/specification.rb', line 1353

def cache_file
  @cache_file ||= File.join cache_dir, "#{full_name}.gem"
end

#conflicts ⇒ Object

Return any possible conflicts against the currently loaded specs.



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/rubygems/specification.rb', line 1360

def conflicts
  conflicts = {}
  Gem.loaded_specs.values.each do |spec|
    bad = self.runtime_dependencies.find_all { |dep|
      spec.name == dep.name and not spec.satisfies_requirement? dep
    }

    conflicts[spec] = bad unless bad.empty?
  end
  conflicts
end

#contains_requirable_file?(file) ⇒ Boolean

Return true if this spec can require file.

Returns:

  • (Boolean) 


1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/rubygems/specification.rb', line 1375

def contains_requirable_file? file
  root     = full_gem_path
  suffixes = Gem.suffixes

  require_paths.any? do |lib|
    base = "#{root}/#{lib}/#{file}"
    suffixes.any? { |suf| File.file? "#{base}#{suf}" }
  end
end

#date ⇒ Object

The date this gem was created. Lazily defaults to TODAY.



1388
1389
1390
 
# File 'lib/rubygems/specification.rb', line 1388

def date
  @date ||= TODAY
end

#date=(date) ⇒ Object

The date this gem was created

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



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/rubygems/specification.rb', line 1402

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, Date then
            Time.utc(date.year, date.month, date.day)
          else
            TODAY
          end
end

#default_gem? ⇒ Boolean

Returns:

  • (Boolean) 


2564
2565
2566
2567
 
# File 'lib/rubygems/specification.rb', line 2564

def default_gem?
  loaded_from &&
    File.dirname(loaded_from) == self.class.default_specifications_dir
end

#default_value(name) ⇒ Object

The default value for specification attribute name



1447
1448
1449
 
# File 'lib/rubygems/specification.rb', line 1447

def default_value name
  @@default_value[name]
end

#dependencies ⇒ Object

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

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



1457
1458
1459
 
# File 'lib/rubygems/specification.rb', line 1457

def dependencies
  @dependencies ||= []
end

#dependent_gems ⇒ Object

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



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/rubygems/specification.rb', line 1467

def dependent_gems
  # REFACTOR: out = []; each; out; ? Really? No #collect love?
  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 ⇒ Object

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



1487
1488
1489
 
# File 'lib/rubygems/specification.rb', line 1487

def dependent_specs
  runtime_dependencies.map { |dep| dep.to_specs }.flatten
end

#development_dependencies ⇒ Object

List of dependencies that are used for development



1501
1502
1503
 
# File 'lib/rubygems/specification.rb', line 1501

def development_dependencies
  dependencies.select { |d| d.type == :development }
end

#doc_dir(type = nil) ⇒ Object

Returns the full path to this spec’s documentation directory. If type is given it will be appended to the end. For examlpe:

spec.doc_dir      # => "/path/to/gem_repo/doc/a-1"

spec.doc_dir 'ri' # => "/path/to/gem_repo/doc/a-1/ri"



1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/rubygems/specification.rb', line 1513

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

#encode_with(coder) ⇒ Object

:nodoc:



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/rubygems/specification.rb', line 1523

def encode_with coder # :nodoc:
  mark_version

  coder.add 'name', @name
  coder.add 'version', @version
  platform = case @original_platform
             when nil, '' then
               'ruby'
             when String then
               @original_platform
             else
               @original_platform.to_s
             end
  coder.add 'platform', platform

  attributes = @@attributes.map(&:to_s) - %w[name version platform]
  attributes.each do |name|
    coder.add name, instance_variable_get("@#{name}")
  end
end

#eql?(other) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


1544
1545
1546
 
# File 'lib/rubygems/specification.rb', line 1544

def eql? other # :nodoc:
  self.class === other && same_attributes?(other)
end

#executable ⇒ Object

Singular accessor for #executables



1551
1552
1553
 
# File 'lib/rubygems/specification.rb', line 1551

def executable
  val = executables and val.first
end

#executable=(o) ⇒ Object

Singular accessor for #executables



1558
1559
1560
 
# File 'lib/rubygems/specification.rb', line 1558

def executable=o
  self.executables = [o]
end

#executables ⇒ Object

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.

Usage:

spec.executables << 'rake'



446
447
448
 
# File 'lib/rubygems/specification.rb', line 446

def executables
  @executables ||= []
end

#executables=(value) ⇒ Object

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



1566
1567
1568
1569
 
# File 'lib/rubygems/specification.rb', line 1566

def executables= value
  # TODO: warn about setting instead of pushing
  @executables = Array(value)
end

#extensions ⇒ Object

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'



461
462
463
 
# File 'lib/rubygems/specification.rb', line 461

def extensions
  @extensions ||= []
end

#extensions=(extensions) ⇒ Object

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



1575
1576
1577
1578
 
# File 'lib/rubygems/specification.rb', line 1575

def extensions= extensions
  # TODO: warn about setting instead of pushing
  @extensions = Array extensions
end

#extra_rdoc_files ⇒ Object

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



477
478
479
 
# File 'lib/rubygems/specification.rb', line 477

def extra_rdoc_files
  @extra_rdoc_files ||= []
end

#extra_rdoc_files=(files) ⇒ Object

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



1584
1585
1586
1587
 
# File 'lib/rubygems/specification.rb', line 1584

def extra_rdoc_files= files
  # TODO: warn about setting instead of pushing
  @extra_rdoc_files = Array files
end

#file_name ⇒ Object

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

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



1594
1595
1596
 
# File 'lib/rubygems/specification.rb', line 1594

def file_name
  "#{full_name}.gem"
end

#files ⇒ Object

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



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/rubygems/specification.rb', line 300

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
end

#files=(files) ⇒ Object

Sets files to files, ensuring it is an array.



1601
1602
1603
 
# File 'lib/rubygems/specification.rb', line 1601

def files= files
  @files = Array files
end

#for_cache ⇒ Object

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



1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/rubygems/specification.rb', line 1619

def for_cache
  spec = dup

  spec.files = nil
  spec.test_files = nil

  spec
end

#full_gem_path ⇒ Object

The full path to the gem (install path + full name).



1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/rubygems/specification.rb', line 1631

def full_gem_path
  # TODO: This is a heavily used method by gems, so we'll need
  # to aleast just alias it to #gem_dir rather than remove it.

  # TODO: also, shouldn't it default to full_name if it hasn't been written?
  return @full_gem_path if defined?(@full_gem_path) && @full_gem_path

  @full_gem_path = File.expand_path File.join(gems_dir, full_name)
  @full_gem_path.untaint

  return @full_gem_path if File.directory? @full_gem_path

  @full_gem_path = File.expand_path File.join(gems_dir, original_name)
end

#full_name ⇒ Object

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.



1651
1652
1653
1654
1655
1656
1657
 
# File 'lib/rubygems/specification.rb', line 1651

def full_name
  @full_name ||= if platform == Gem::Platform::RUBY or platform.nil? then
                   "#{@name}-#{@version}".untaint
                 else
                   "#{@name}-#{@version}-#{platform}".untaint
                 end
end

#gem_dir ⇒ Object

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



1663
1664
1665
 
# File 'lib/rubygems/specification.rb', line 1663

def gem_dir
  @gem_dir ||= File.expand_path File.join(gems_dir, full_name)
end

#gems_dir ⇒ Object

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



1671
1672
1673
1674
 
# File 'lib/rubygems/specification.rb', line 1671

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

#has_rdoc ⇒ Object Also known as: has_rdoc?

Deprecated and ignored, defaults to true.

Formerly used to indicate this gem was RDoc-capable.



1681
1682
1683
 
# File 'lib/rubygems/specification.rb', line 1681

def has_rdoc
  true
end

#has_rdoc=(ignored) ⇒ Object

Deprecated and ignored.

Formerly used to indicate this gem was RDoc-capable.



1690
1691
1692
 
# File 'lib/rubygems/specification.rb', line 1690

def has_rdoc= ignored
  @has_rdoc = true
end

#has_unit_tests? ⇒ Boolean Also known as: has_test_suite?

True if this gem has files in test_files

Returns:

  • (Boolean) 


1699
1700
1701
 
# File 'lib/rubygems/specification.rb', line 1699

def has_unit_tests?
  not test_files.empty?
end

#hash ⇒ Object

:startdoc:



1707
1708
1709
1710
1711
 
# File 'lib/rubygems/specification.rb', line 1707

def hash # :nodoc:
  @@attributes.inject(0) { |hash_code, (name, _)|
    hash_code ^ self.send(name).hash
  }
end

#init_with(coder) ⇒ Object

:nodoc:



1713
1714
1715
 
# File 'lib/rubygems/specification.rb', line 1713

def init_with coder # :nodoc:
  yaml_initialize coder.tag, coder.map
end

#initialize_copy(other_spec) ⇒ Object

Duplicates array_attributes from other_spec so state isn’t shared.



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/rubygems/specification.rb', line 1753

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

#inspect ⇒ Object 



1786
1787
1788
1789
1790
1791
1792
 
# File 'lib/rubygems/specification.rb', line 1786

def inspect
  if $DEBUG
    super
  else
    "#<#{self.class}:0x#{__id__.to_s(16)} #{full_name}>"
  end
end

#lib_dirs_glob ⇒ Object

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



1798
1799
1800
1801
1802
1803
1804
1805
1806
 
# File 'lib/rubygems/specification.rb', line 1798

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 ⇒ Object

Files in the Gem under one of the require_paths



1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/rubygems/specification.rb', line 1811

def lib_files
  @files.select do |file|
    require_paths.any? do |path|
      file.start_with? path
    end
  end
end

#license ⇒ Object

Singular accessor for #licenses



1822
1823
1824
 
# File 'lib/rubygems/specification.rb', line 1822

def license
  val = licenses and val.first
end

#license=(o) ⇒ Object

The license for this gem.

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

Usage:

spec.license = 'MIT'



492
493
494
 
# File 'lib/rubygems/specification.rb', line 492

def license=o
  self.licenses = [o]
end

#licenses ⇒ Object

Plural accessor for setting licenses



1829
1830
1831
 
# File 'lib/rubygems/specification.rb', line 1829

def licenses
  @licenses ||= []
end

#licenses=(licenses) ⇒ Object

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.

Usage:

spec.licenses = ['MIT', 'GPL-2']



507
508
509
 
# File 'lib/rubygems/specification.rb', line 507

def licenses= licenses
  @licenses = Array licenses
end

#mark_version ⇒ Object

Sets the rubygems_version to the current RubyGems version.



1857
1858
1859
 
# File 'lib/rubygems/specification.rb', line 1857

def mark_version
  @rubygems_version = Gem::VERSION
end

#matches_for_glob(glob) ⇒ Object

Return all files in this gem that match for glob.



1864
1865
1866
1867
1868
1869
 
# File 'lib/rubygems/specification.rb', line 1864

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

#name_tuple ⇒ Object

Return a NameTuple that represents this Specification



1906
1907
1908
 
# File 'lib/rubygems/specification.rb', line 1906

def name_tuple
  Gem::NameTuple.new name, version, original_platform
end

#normalize ⇒ Object

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.



1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/rubygems/specification.rb', line 1889

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

#original_name ⇒ Object

Returns the full name (name-version) of this gemspec using the original platform. For use with legacy gems.



1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/rubygems/specification.rb', line 1914

def original_name # :nodoc:
  if platform == Gem::Platform::RUBY or platform.nil? then
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{@original_platform}"
  end
end

#platform ⇒ Object

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



1932
1933
1934
 
# File 'lib/rubygems/specification.rb', line 1932

def platform
  @new_platform ||= Gem::Platform::RUBY
end

#platform=(platform) ⇒ Object

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, e.g. fxruby-1.2.0-win32.gem.

Usage:

spec.platform = Gem::Platform::Win32



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/rubygems/specification.rb', line 244

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

#pretty_print(q) ⇒ Object

:nodoc:



1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/rubygems/specification.rb', line 1936

def pretty_print(q) # :nodoc:
  q.group 2, 'Gem::Specification.new do |s|', 'end' do
    q.breakable

    # REFACTOR: each_attr - use in to_yaml as well
    @@attributes.each do |attr_name|
      current_value = self.send attr_name
      if current_value != default_value(attr_name) or
         self.class.required_attribute? attr_name then

        q.text "s.#{attr_name} = "

        if attr_name == :date then
          current_value = current_value.utc

          q.text "Time.utc(#{current_value.year}, #{current_value.month}, #{current_value.day})"
        else
          q.pp current_value
        end

        q.breakable
      end
    end
  end
end

#raise_if_conflicts ⇒ Object

Check the spec for possible conflicts and freak out if there are any.



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
 
# File 'lib/rubygems/specification.rb', line 1965

def raise_if_conflicts
  other = Gem.loaded_specs[self.name]

  if other and self.version != other.version then
    # This gem is already loaded.  If the currently loaded gem is not in the
    # list of candidate gems, then we have a version conflict.

    msg = "can't activate #{full_name}, already activated #{other.full_name}"

    e = Gem::LoadError.new msg
    e.name = self.name
    # TODO: e.requirement = dep.requirement

    raise e
  end

  conf = self.conflicts

  unless conf.empty? then
    y = conf.map { |act,con|
      "#{act.full_name} conflicts with #{con.join(", ")}"
    }.join ", "

    # TODO: improve message by saying who activated `con`

    raise Gem::LoadError, "Unable to activate #{self.full_name}, because #{y}"
  end
end

#rdoc_options ⇒ Object

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

Usage:

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



520
521
522
 
# File 'lib/rubygems/specification.rb', line 520

def rdoc_options
  @rdoc_options ||= []
end

#rdoc_options=(options) ⇒ Object

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



1998
1999
2000
2001
 
# File 'lib/rubygems/specification.rb', line 1998

def rdoc_options= options
  # TODO: warn about setting instead of pushing
  @rdoc_options = Array options
end

#require_path ⇒ Object

Singular accessor for #require_paths



2006
2007
2008
 
# File 'lib/rubygems/specification.rb', line 2006

def require_path
  val = require_paths and val.first
end

#require_path=(path) ⇒ Object

Singular accessor for #require_paths



2013
2014
2015
 
# File 'lib/rubygems/specification.rb', line 2013

def require_path= path
  self.require_paths = [path]
end

#requirements ⇒ Object

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'



548
549
550
 
# File 'lib/rubygems/specification.rb', line 548

def requirements
  @requirements ||= []
end

#requirements=(req) ⇒ Object

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



2028
2029
2030
2031
 
# File 'lib/rubygems/specification.rb', line 2028

def requirements= req
  # TODO: warn about setting instead of pushing
  @requirements = Array req
end

#reset_nil_attributes_to_default ⇒ Object

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



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
 
# File 'lib/rubygems/specification.rb', line 2547

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
end

#ri_dir ⇒ Object

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



2036
2037
2038
 
# File 'lib/rubygems/specification.rb', line 2036

def ri_dir
  @ri_dir ||= File.join base_dir, 'ri', full_name
end

#runtime_dependencies ⇒ Object

List of dependencies that will automatically be activated at runtime.



2069
2070
2071
 
# File 'lib/rubygems/specification.rb', line 2069

def runtime_dependencies
  dependencies.select { |d| d.type == :runtime }
end

#satisfies_requirement?(dependency) ⇒ Boolean

Checks if this specification meets the requirement of dependency.

Returns:

  • (Boolean) 


2085
2086
2087
2088
 
# File 'lib/rubygems/specification.rb', line 2085

def satisfies_requirement? dependency
  return @name == dependency.name &&
    dependency.requirement.satisfied_by?(@version)
end

#sort_obj ⇒ Object

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



2093
2094
2095
2096
 
# File 'lib/rubygems/specification.rb', line 2093

def sort_obj
  # TODO: this is horrible. Deprecate it.
  [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1]
end

#spec_dir ⇒ Object

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



2102
2103
2104
 
# File 'lib/rubygems/specification.rb', line 2102

def spec_dir
  @spec_dir ||= File.join base_dir, "specifications"
end

#spec_file ⇒ Object

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



2110
2111
2112
 
# File 'lib/rubygems/specification.rb', line 2110

def spec_file
  @spec_file ||= File.join spec_dir, "#{full_name}.gemspec"
end

#spec_name ⇒ Object

The default name of the gemspec. See also #file_name

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



2119
2120
2121
 
# File 'lib/rubygems/specification.rb', line 2119

def spec_name
  "#{full_name}.gemspec"
end

#test_file ⇒ Object

Singular accessor for #test_files



2134
2135
2136
 
# File 'lib/rubygems/specification.rb', line 2134

def test_file
  val = test_files and val.first
end

#test_file=(file) ⇒ Object

Singular mutator for #test_files



2141
2142
2143
 
# File 'lib/rubygems/specification.rb', line 2141

def test_file= file
  self.test_files = [file]
end

#test_files ⇒ Object

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



2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
 
# File 'lib/rubygems/specification.rb', line 2149

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

#test_files=(files) ⇒ Object

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



560
561
562
 
# File 'lib/rubygems/specification.rb', line 560

def test_files= files
  @test_files = Array files
end

#to_ruby ⇒ Object

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.

REFACTOR: This, plus stuff like #ruby_code and #pretty_print, should probably be extracted out into some sort of separate class. SRP, do you speak it!??!



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
 
# File 'lib/rubygems/specification.rb', line 2173

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

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

  handled = [
    :dependencies,
    :name,
    :platform,
    :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

  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 ⇒ Object

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

See #to_ruby.



2256
2257
2258
 
# File 'lib/rubygems/specification.rb', line 2256

def to_ruby_for_cache
  for_cache.to_ruby
end

#to_s ⇒ Object

:nodoc:



2260
2261
2262
 
# File 'lib/rubygems/specification.rb', line 2260

def to_s # :nodoc:
  "#<Gem::Specification name=#{@name} version=#{@version}>"
end

#to_yaml(opts = {}) ⇒ Object

:nodoc:



2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
 
# File 'lib/rubygems/specification.rb', line 2264

def to_yaml(opts = {}) # :nodoc:
  if YAML.const_defined?(:ENGINE) && !YAML::ENGINE.syck? then
    # Because the user can switch the YAML engine behind our
    # back, we have to check again here to make sure that our
    # psych code was properly loaded, and load it if not.
    unless Gem.const_defined?(:NoAliasYAMLTree)
      require 'rubygems/psych_tree'
    end

    builder = Gem::NoAliasYAMLTree.new({})
    builder << self
    ast = builder.tree

    io = StringIO.new
    io.set_encoding Encoding::UTF_8 if Object.const_defined? :Encoding

    Psych::Visitors::Emitter.new(io).accept(ast)

    io.string.gsub(/ !!null \n/, " \n")
  else
    YAML.quick_emit object_id, opts do |out|
      out.map taguri, to_yaml_style do |map|
        encode_with map
      end
    end
  end
end

#traverse(trail = [], &block) ⇒ Object

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



2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/rubygems/specification.rb', line 2296

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) ⇒ Object

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



2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
 
# File 'lib/rubygems/specification.rb', line 2314

def validate packaging = true
  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 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

  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

  # FIX: uhhhh single element array.each?
  [: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
  }

  alert_warning 'licenses is empty' if licenses.empty?

  validate_permissions

  # reject lazy developers:

  # FIX: Doesn't this just evaluate to "FIXME" or "TODO"?
  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
    alert_warning "no #{attribute} specified" if value.nil? or value.empty?
  end

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

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

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

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

  dependencies.each do |dep|
    prerelease_dep = dep.requirements_list.any? do |req|
      Gem::Requirement.new(req).prerelease?
    end

    alert_warning "prerelease dependency on #{dep} is not recommended" if
      prerelease_dep
  end

  true
end

#validate_permissions ⇒ Object

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



2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/rubygems/specification.rb', line 2500

def validate_permissions
  return if Gem.win_platform?

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

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

#yaml_initialize(tag, vals) ⇒ Object

FIX: have this handle the platform/new_platform/original_platform bullshit



2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
 
# File 'lib/rubygems/specification.rb', line 2529

def yaml_initialize(tag, vals) # :nodoc:
  vals.each do |ivar, val|
    case ivar
    when "date"
      # Force Date to go through the extra coerce logic in date=
      self.date = val.untaint
    else
      instance_variable_set "@#{ivar}", val.untaint
    end
  end

  @original_platform = @platform # for backwards compatibility
  self.platform = Gem::Platform.new @platform
end