Class: Gem::NameTuple

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/rubygems/name_tuple.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, version, platform = "ruby") ⇒ NameTuple

Returns a new instance of NameTuple.


11
12
13
14
15
16
17
18
19
20
# File 'lib/rubygems/name_tuple.rb', line 11

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

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

  @platform = platform
end

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name


22
23
24
# File 'lib/rubygems/name_tuple.rb', line 22

def name
  @name
end

#platformObject (readonly)

Returns the value of attribute platform


22
23
24
# File 'lib/rubygems/name_tuple.rb', line 22

def platform
  @platform
end

#versionObject (readonly)

Returns the value of attribute version


22
23
24
# File 'lib/rubygems/name_tuple.rb', line 22

def version
  @version
end

Class Method Details

.from_list(list) ⇒ Object

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


28
29
30
# File 'lib/rubygems/name_tuple.rb', line 28

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

.nullObject

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


43
44
45
# File 'lib/rubygems/name_tuple.rb', line 43

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.


36
37
38
# File 'lib/rubygems/name_tuple.rb', line 36

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

Instance Method Details

#<=>(other) ⇒ Object


94
95
96
97
98
# File 'lib/rubygems/name_tuple.rb', line 94

def <=>(other)
  [@name, @version, @platform == Gem::Platform::RUBY ? -1 : 1] <=>
    [other.name, other.version,
     other.platform == Gem::Platform::RUBY ? -1 : 1]
end

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

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


106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/rubygems/name_tuple.rb', line 106

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

#full_nameObject

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.


52
53
54
55
56
57
58
59
# File 'lib/rubygems/name_tuple.rb', line 52

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

#hashObject


121
122
123
# File 'lib/rubygems/name_tuple.rb', line 121

def hash
  to_a.hash
end

#inspectObject Also known as: to_s

:nodoc:


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

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

#match_platform?Boolean

Indicate if this NameTuple matches the current platform.

Returns:

  • (Boolean)

64
65
66
# File 'lib/rubygems/name_tuple.rb', line 64

def match_platform?
  Gem::Platform.match @platform
end

#prerelease?Boolean

Indicate if this NameTuple is for a prerelease version.

Returns:

  • (Boolean)

70
71
72
# File 'lib/rubygems/name_tuple.rb', line 70

def prerelease?
  @version.prerelease?
end

#spec_nameObject

Return the name that the gemspec file would be


77
78
79
# File 'lib/rubygems/name_tuple.rb', line 77

def spec_name
  "#{full_name}.gemspec"
end

#to_aObject

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


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

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