123456789_123456789_123456789_123456789_123456789_

Class: Gem::NameTuple

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Comparable
Inherits: Object
Defined in: lib/rubygems/name_tuple.rb

Overview

Represents a gem of name #name at #version of #platform. These wrap the data returned from the indexes.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name, version, platform = "ruby") ⇒ NameTuple

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 9

def initialize(name, version, platform="ruby")
  @name = name
  @version = version

  unless platform.kind_of? Gem::Platform
    platform = "ruby" if !platform || platform.empty?
  end

  @platform = platform
end

Class Method Details

.from_list(list)

Turn an array of [name, version, platform] into an array of NameTuple objects.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 26

def self.from_list(list)
  list.map {|t| new(*t) }
end

.null

A null NameTuple, ie name=nil, version=0

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 41

def self.null
  new nil, Gem::Version.new(0), nil
end

.to_basic(list)

Turn an array of NameTuple objects back into an array of

name, version, platform

tuples.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 34

def self.to_basic(list)
  list.map {|t| t.to_a }
end

Instance Attribute Details

#match_platform?Boolean (readonly)

Indicate if this NameTuple matches the current platform.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 62

def match_platform?
  Gem::Platform.match_gem? @platform, @name
end

#name (readonly)

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 20

attr_reader :name, :version, :platform

#platform (readonly)

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 20

attr_reader :name, :version, :platform

#prerelease?Boolean (readonly)

Indicate if this NameTuple is for a prerelease version.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 68

def prerelease?
  @version.prerelease?
end

#version (readonly)

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 20

attr_reader :name, :version, :platform

Instance Method Details

#<=>(other)

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 92

def <=>(other)
  [@name, @version, Gem::Platform.sort_priority(@platform)] <=>
    [other.name, other.version, Gem::Platform.sort_priority(other.platform)]
end

#==(other) Also known as: #eql?

Compare with other. Supports another NameTuple or an Array in the [name, version, platform] format.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 103

def ==(other)
  case other
  when self.class
    @name == other.name &&
      @version == other.version &&
      @platform == other.platform
  when Array
    to_a == other
  else
    false
  end
end

#eql?(other)

Alias for #==.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 116

alias_method :eql?, :==

#full_name

Returns the full name (name-version) of this ::Gem. Platform information is included if it is not the default Ruby platform. This mimics the behavior of Specification#full_name.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 50

def full_name
  case @platform
  when nil, "ruby", ""
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{@platform}"
  end.dup.tap(&Gem::UNTAINT)
end

#hash

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 118

def hash
  to_a.hash
end

#inspect Also known as: #to_s

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 86

def inspect # :nodoc:
  "#<Gem::NameTuple #{@name}, #{@version}, #{@platform}>"
end

#spec_name

Return the name that the gemspec file would be

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 75

def spec_name
  "#{full_name}.gemspec"
end

#to_a

Convert back to the [name, version, platform] tuple

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 82

def to_a
  [@name, @version, @platform]
end

#to_s

This method is for internal use only.

Alias for #inspect.

[ GitHub ]

  
# File 'lib/rubygems/name_tuple.rb', line 90

alias to_s inspect # :nodoc: