Gem::Specification

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

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

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

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

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

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

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

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

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

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

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

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

 
               # File rubygems/specification.rb, line 575
def test_files= files
  @test_files = Array files
end
            

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

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

 
               # File rubygems/specification.rb, line 1713
def initialize name = nil, version = nil
  @loaded = false
  @activated = false
  self.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 = Dupable[key] ? default.dup : default
    instance_variable_set "@#{key}", value
  end

  @new_platform = Gem::Platform::RUBY

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

  yield self if block_given?
end
            

 
               # File rubygems/specification.rb, line 1820
def filename= path
  super

  @bin_dir       = nil
  @cache_dir     = nil
  @cache_file    = nil
  @doc_dir       = nil
  @gem_dir       = nil
  @ri_dir        = nil
  @spec_dir      = nil
  @spec_file     = nil
end
            

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

 
               # File rubygems/specification.rb, line 1773
def inspect
  if $DEBUG
    super
  else
    "#<#{self.class}:0x#{__id__.to_s(16)} #{full_name}>"
  end
end
            

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

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

 
               # File rubygems/specification.rb, line 1809
def license
  val = licenses and val.first
end
            

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

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

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

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

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

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

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

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

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

 
               # File rubygems/specification.rb, line 2003
def require_path= path
  self.require_paths = [path]
end
            

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

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

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

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

 
               # File rubygems/specification.rb, line 2063
def runtime_dependencies
  dependencies.select { |d| d.type == :runtime }
end
            

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

 
               # File rubygems/specification.rb, line 2087
def sort_obj
  # TODO: this is horrible. Deprecate it.
  [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1]
end
            

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

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

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

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

 
               # File rubygems/specification.rb, line 2135
def test_file
  val = test_files and val.first
end
            

 
               # File rubygems/specification.rb, line 2142
def test_file= file
  self.test_files = [file]
end
            

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

 
               # File rubygems/specification.rb, line 2174
def to_ruby
  mark_version
  result = []
  result << "# -*- encoding: utf-8 -*-"
  result << "#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{require_paths.join("\0")}"
  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
            

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

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

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

 
               # File rubygems/specification.rb, line 2323
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/).empty? then
    raise Gem::InvalidSpecificationException, "#{lazy} is not an author"
  end

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

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

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

  if homepage and not homepage.empty? and
     homepage !~ /\A[a-z][a-z\d+.-]*:/ 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
            

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

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

  return @version
end