Class: Gem::NameTuple (Ruby 2.3.4)

Home Classes Methods

In Files

rubygems/name_tuple.rb

Parent

Object

Methods

::from_list
::new
::null
::to_basic
#<=>
#==
#eql?
#full_name
#hash
#match_platform?
#prerelease?
#spec_name
#to_a

Included Modules

Comparable

Class/Module Index

Gem::NameTuple

Attributes

name[R]

platform[R]

version[R]

Public Class Methods

from_list(list)

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

 
               # File rubygems/name_tuple.rb, line 27
def self.from_list list
  list.map { |t| new(*t) }
end

new(name, version, platform="ruby")

 
               # File 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

null()

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

 
               # File rubygems/name_tuple.rb, line 42
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.

 
               # File rubygems/name_tuple.rb, line 35
def self.to_basic list
  list.map { |t| t.to_a }
end

Public Instance Methods

<=>(other)

 
               # File 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)

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

 
               # File 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

Also aliased as: eql?

eql?(other)

Alias for: ==

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

 
               # File rubygems/name_tuple.rb, line 51
def full_name
  case @platform
  when nil, 'ruby', ''
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{@platform}"
  end.dup.untaint
end

hash()

 
               # File rubygems/name_tuple.rb, line 120
def hash
  to_a.hash
end

match_platform?()

Indicate if this NameTuple matches the current platform.

 
               # File rubygems/name_tuple.rb, line 63
def match_platform?
  Gem::Platform.match @platform
end

prerelease?()

Indicate if this NameTuple is for a prerelease version.

 
               # File rubygems/name_tuple.rb, line 69
def prerelease?
  @version.prerelease?
end

spec_name()

Return the name that the gemspec file would be

 
               # File rubygems/name_tuple.rb, line 76
def spec_name
  "#{full_name}.gemspec"
end

to_a()

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

 
               # File rubygems/name_tuple.rb, line 83
def to_a
  [@name, @version, @platform]
end