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


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

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


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

def name
  @name
end

#platformObject (readonly)

Returns the value of attribute platform


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

def platform
  @platform
end

#versionObject (readonly)

Returns the value of attribute version


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

def version
  @version
end

Class Method Details

.from_list(list) ⇒ Object

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


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

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

.nullObject

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


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

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.


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

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

Instance Method Details

#<=>(other) ⇒ Object


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

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.


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

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.


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

def full_name
  case @platform
  when nil, 'ruby', ''
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{@platform}"
  end.dup.untaint
end

#hashObject


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

def hash
  to_a.hash
end

#inspectObject Also known as: to_s

:nodoc:


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

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

#match_platform?Boolean

Indicate if this NameTuple matches the current platform.


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

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

#prerelease?Boolean

Indicate if this NameTuple is for a prerelease version.


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

def prerelease?
  @version.prerelease?
end

#spec_nameObject

Return the name that the gemspec file would be


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

def spec_name
  "#{full_name}.gemspec"
end

#to_aObject

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


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

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