123456789_123456789_123456789_123456789_123456789_

Class: Gem::Resolver::IndexSpecification

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: Gem::Resolver::Specification
Defined in: lib/rubygems/resolver/index_specification.rb

Overview

Represents a possible Specification object returned from IndexSet. Used to delay needed to download full Specification objects when only the name and version are needed.

Class Method Summary

Specification - Inherited

.new

Sets default instance variables for the specification.

Instance Attribute Summary

Specification - Inherited

#dependencies

The dependencies of the gem for this specification.

#installable_platform?

Returns true if this specification is installable on this platform.

#name

The name of the gem for this specification.

#platform

The platform this gem works on.

#required_ruby_version

The required_ruby_version constraint for this specification.

#required_rubygems_version

The required_ruby_version constraint for this specification.

#set

The set this specification came from.

#source

The source for this specification.

#spec
#version

The version of the gem for this specification.

#local?

Instance Method Summary

Specification - Inherited

#download,
#full_name

The name and version of the specification.

#install

Installs this specification using the ::Gem::Installer options.

#fetch_development_dependencies

Fetches development dependencies if the source does not provide them by default (see APISpecification).

Constructor Details

.new(set, name, version, source, platform) ⇒ IndexSpecification

An IndexSpecification is created from the index format described in ‘gem help generate_index`.

The set contains other specifications for this (URL) source.

The name, version and platform are the name, version and platform of the gem.

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 17

def initialize(set, name, version, source, platform)
  super()

  @set = set
  @name = name
  @version = version
  @source = source
  @platform = Gem::Platform.new(platform.to_s)
  @original_platform = platform.to_s

  @spec = nil
end

Instance Method Details

#==(other)

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 58

def ==(other)
  self.class === other &&
    @name == other.name &&
    @version == other.version &&
    @platform == other.platform
end

#dependencies

The dependencies of the gem for this specification

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 33

def dependencies
  spec.dependencies
end

#hash

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 65

def hash
  @name.hash ^ @version.hash ^ @platform.hash
end

#inspect

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 69

def inspect # :nodoc:
  "#<%s %s source %s>" % [self.class, full_name, @source]
end

#pretty_print(q)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 73

def pretty_print(q) # :nodoc:
  q.group 2, "[Index specification", "]" do
    q.breakable
    q.text full_name

    unless Gem::Platform::RUBY == @platform
      q.breakable
      q.text @platform.to_s
    end

    q.breakable
    q.text "source "
    q.pp @source
  end
end

#required_ruby_version

The required_ruby_version constraint for this specification

A fallback is included because when generated, some marshalled specs have it set to nil.

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 43

def required_ruby_version
  spec.required_ruby_version || Gem::Requirement.default
end

#required_rubygems_version

The required_rubygems_version constraint for this specification

A fallback is included because the original version of the specification API didn’t include that field, so some marshalled specs in the index have it set to nil.

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 54

def required_rubygems_version
  spec.required_rubygems_version || Gem::Requirement.default
end

#spec

This method is for internal use only.

Fetches a ::Gem::Specification for this IndexSpecification from the #source.

[ GitHub ]

  
# File 'lib/rubygems/resolver/index_specification.rb', line 92

def spec # :nodoc:
  @spec ||=
    begin
      tuple = Gem::NameTuple.new @name, @version, @original_platform

      @source.fetch_spec tuple
    end
end