Class: Gem::NameTuple
- 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
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#platform ⇒ Object
readonly
Returns the value of attribute platform.
-
#version ⇒ Object
readonly
Returns the value of attribute version.
Class Method Summary collapse
-
.from_list(list) ⇒ Object
Turn an array of [name, version, platform] into an array of NameTuple objects.
-
.null ⇒ Object
A null NameTuple, ie name=nil, version=0.
-
.to_basic(list) ⇒ Object
Turn an array of NameTuple objects back into an array of [name, version, platform] tuples.
Instance Method Summary collapse
- #<=>(other) ⇒ Object
-
#==(other) ⇒ Object
(also: #eql?)
Compare with
other
. -
#full_name ⇒ Object
Returns the full name (name-version) of this Gem.
- #hash ⇒ Object
-
#initialize(name, version, platform = "ruby") ⇒ NameTuple
constructor
A new instance of NameTuple.
-
#inspect ⇒ Object
(also: #to_s)
:nodoc:.
-
#match_platform? ⇒ Boolean
Indicate if this NameTuple matches the current platform.
-
#prerelease? ⇒ Boolean
Indicate if this NameTuple is for a prerelease version.
-
#spec_name ⇒ Object
Return the name that the gemspec file would be.
-
#to_a ⇒ Object
Convert back to the [name, version, platform] tuple.
Constructor Details
#initialize(name, version, platform = "ruby") ⇒ NameTuple
Returns a new instance of NameTuple.
8 9 10 11 12 13 14 15 16 17 |
# File 'lib/rubygems/name_tuple.rb', line 8 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
#name ⇒ Object (readonly)
Returns the value of attribute name.
19 20 21 |
# File 'lib/rubygems/name_tuple.rb', line 19 def name @name end |
#platform ⇒ Object (readonly)
Returns the value of attribute platform.
19 20 21 |
# File 'lib/rubygems/name_tuple.rb', line 19 def platform @platform end |
#version ⇒ Object (readonly)
Returns the value of attribute version.
19 20 21 |
# File 'lib/rubygems/name_tuple.rb', line 19 def version @version end |
Class Method Details
.from_list(list) ⇒ Object
Turn an array of [name, version, platform] into an array of NameTuple objects.
25 26 27 |
# File 'lib/rubygems/name_tuple.rb', line 25 def self.from_list(list) list.map {|t| new(*t) } end |
.null ⇒ Object
A null NameTuple, ie name=nil, version=0
40 41 42 |
# File 'lib/rubygems/name_tuple.rb', line 40 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.
33 34 35 |
# File 'lib/rubygems/name_tuple.rb', line 33 def self.to_basic(list) list.map {|t| t.to_a } end |
Instance Method Details
#<=>(other) ⇒ Object
91 92 93 94 95 |
# File 'lib/rubygems/name_tuple.rb', line 91 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.
103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/rubygems/name_tuple.rb', line 103 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_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.
49 50 51 52 53 54 55 56 |
# File 'lib/rubygems/name_tuple.rb', line 49 def full_name case @platform when nil, 'ruby', '' "#{@name}-#{@version}" else "#{@name}-#{@version}-#{@platform}" end.dup.tap(&Gem::UNTAINT) end |
#hash ⇒ Object
118 119 120 |
# File 'lib/rubygems/name_tuple.rb', line 118 def hash to_a.hash end |
#inspect ⇒ Object Also known as: to_s
:nodoc:
85 86 87 |
# File 'lib/rubygems/name_tuple.rb', line 85 def inspect # :nodoc: "#<Gem::NameTuple #{@name}, #{@version}, #{@platform}>" end |
#match_platform? ⇒ Boolean
Indicate if this NameTuple matches the current platform.
61 62 63 |
# File 'lib/rubygems/name_tuple.rb', line 61 def match_platform? Gem::Platform.match_gem? @platform, @name end |
#prerelease? ⇒ Boolean
Indicate if this NameTuple is for a prerelease version.
67 68 69 |
# File 'lib/rubygems/name_tuple.rb', line 67 def prerelease? @version.prerelease? end |
#spec_name ⇒ Object
Return the name that the gemspec file would be
74 75 76 |
# File 'lib/rubygems/name_tuple.rb', line 74 def spec_name "#{full_name}.gemspec" end |
#to_a ⇒ Object
Convert back to the [name, version, platform] tuple
81 82 83 |
# File 'lib/rubygems/name_tuple.rb', line 81 def to_a [@name, @version, @platform] end |