Class: Gem::NameTuple

Inherits:
Object
  • Object
show all
Includes:
Comparable
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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, version, platform = Gem::Platform::RUBY) ⇒ NameTuple

Returns a new instance of NameTuple.



9
10
11
12
13
14
15
16
 
# File 'lib/rubygems/name_tuple.rb', line 9

def initialize(name, version, platform=Gem::Platform::RUBY)
  @name = name
  @version = version

  platform &&= platform.to_s
  platform = Gem::Platform::RUBY if !platform || platform.empty?
  @platform = platform
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#platform ⇒ Object (readonly)

Returns the value of attribute platform.



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

def platform
  @platform
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.from_list(list) ⇒ Object

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



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

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

.null ⇒ Object

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



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

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

.to_basic(list) ⇒ Object

Turn an array of NameTuple objects back into an array of

name, version, platform

tuples.



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

def self.to_basic(list)
  list.map(&:to_a)
end

Instance Method Details

#<=>(other) ⇒ Object 



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

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

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

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



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/rubygems/name_tuple.rb', line 101

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

#full_name ⇒ Object

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 Gem::Specification#full_name.



48
49
50
51
52
53
54
55
 
# File 'lib/rubygems/name_tuple.rb', line 48

def full_name
  case @platform
  when nil, "", Gem::Platform::RUBY
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{@platform}"
  end
end

#hash ⇒ Object 



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

def hash
  to_a.hash
end

#inspect ⇒ Object Also known as: to_s

:nodoc:



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

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

#match_platform? ⇒ Boolean

Indicate if this NameTuple matches the current platform.

Returns:

  • (Boolean) 


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

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

#prerelease? ⇒ Boolean

Indicate if this NameTuple is for a prerelease version.

Returns:

  • (Boolean) 


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

def prerelease?
  @version.prerelease?
end

#spec_name ⇒ Object

Return the name that the gemspec file would be



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

def spec_name
  "#{full_name}.gemspec"
end

#to_a ⇒ Object

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



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

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