Gem::Platform

Available list of platforms for targeting Gem installations.

Constants

CURRENT: A platform-specific gem that is built for the packaging ruby’s platform. This will be replaced with ::local.
RUBY: A pure-ruby gem that may use Gem::Specification#extensions to build binary files.

Attributes

cpu[RW]

os[RW]

version[RW]

Public Class Methods

local() click to toggle source

 
               # File rubygems/platform.rb, line 16
def self.local
  arch = Gem::ConfigMap[:arch]
  arch = "#{arch}_60" if arch =~ /mswin32$/
  @local ||= new(arch)
end

match(platform) click to toggle source

 
               # File rubygems/platform.rb, line 22
def self.match(platform)
  Gem.platforms.any? do |local_platform|
    platform.nil? or local_platform == platform or
      (local_platform != Gem::Platform::RUBY and local_platform =~ platform)
  end
end

new(arch) click to toggle source

 
               # File rubygems/platform.rb, line 40
def initialize(arch)
  case arch
  when Array then
    @cpu, @os, @version = arch
  when String then
    arch = arch.split '-'

    if arch.length > 2 and arch.last !~ /\d/ then # reassemble x86-linux-gnu
      extra = arch.pop
      arch.last << "-#{extra}"
    end

    cpu = arch.shift

    @cpu = case cpu
           when /i\d86/ then 'x86'
           else cpu
           end

    if arch.length == 2 and arch.last =~ /^\d+(\.\d+)?$/ then # for command-line
      @os, @version = arch
      return
    end

    os, = arch
    @cpu, os = nil, cpu if os.nil? # legacy jruby

    @os, @version = case os
                    when /aix(\d+)/ then             [ 'aix',       $1  ]
                    when /cygwin/ then               [ 'cygwin',    nil ]
                    when /darwin(\d+)?/ then         [ 'darwin',    $1  ]
                    when /^macruby$/ then            [ 'macruby',   nil ]
                    when /freebsd(\d+)/ then         [ 'freebsd',   $1  ]
                    when /hpux(\d+)/ then            [ 'hpux',      $1  ]
                    when /^java$/, /^jruby$/ then    [ 'java',      nil ]
                    when /^java([\d.]*)/ then        [ 'java',      $1  ]
                    when /^dotnet$/ then             [ 'dotnet',    nil ]
                    when /^dotnet([\d.]*)/ then      [ 'dotnet',    $1  ]
                    when /linux/ then                [ 'linux',     $1  ]
                    when /mingw32/ then              [ 'mingw32',   nil ]
                    when /(mswin\d+)(\_(\d+))?/ then
                      os, version = $1, $3
                      @cpu = 'x86' if @cpu.nil? and os =~ /32$/
                      [os, version]
                    when /netbsdelf/ then            [ 'netbsdelf', nil ]
                    when /openbsd(\d+\.\d+)/ then    [ 'openbsd',   $1  ]
                    when /solaris(\d+\.\d+)/ then    [ 'solaris',   $1  ]
                    # test
                    when /^(\w+_platform)(\d+)/ then [ $1,          $2  ]
                    else                             [ 'unknown',   nil ]
                    end
  when Gem::Platform then
    @cpu = arch.cpu
    @os = arch.os
    @version = arch.version
  else
    raise ArgumentError, "invalid argument #{arch.inspect}"
  end
end

Public Instance Methods

==(other) click to toggle source

Is other equal to this platform? Two platforms are equal if they have the same CPU, OS and version.

 
               # File rubygems/platform.rb, line 120
def ==(other)
  self.class === other and to_a == other.to_a
end

Also aliased as: eql?

===(other) click to toggle source

Does other match this platform? Two platforms match if they have the same CPU, or either has a CPU of ‘universal’, they have the same OS, and they have the same version, or either has no version.

 
               # File rubygems/platform.rb, line 135
def ===(other)
  return nil unless Gem::Platform === other

  # cpu
  (@cpu == 'universal' or other.cpu == 'universal' or @cpu == other.cpu) and

  # os
  @os == other.os and

  # version
  (@version.nil? or other.version.nil? or @version == other.version)
end

=~(other) click to toggle source

Does other match this platform? If other is a String it will be converted to a Gem::Platform first. See === for matching rules.

 
               # File rubygems/platform.rb, line 152
def =~(other)
  case other
  when Gem::Platform then # nop
  when String then
    # This data is from http://gems.rubyforge.org/gems/yaml on 19 Aug 2007
    other = case other
            when /^i686-darwin(\d)/     then ['x86',       'darwin',  $1    ]
            when /^i\d86-linux/         then ['x86',       'linux',   nil   ]
            when 'java', 'jruby'        then [nil,         'java',    nil   ]
            when /dotnet(\-(\d+\.\d+))?/ then ['universal','dotnet',  $2    ]
            when /mswin32(\_(\d+))?/    then ['x86',       'mswin32', $2    ]
            when 'powerpc-darwin'       then ['powerpc',   'darwin',  nil   ]
            when /powerpc-darwin(\d)/   then ['powerpc',   'darwin',  $1    ]
            when /sparc-solaris2.8/     then ['sparc',     'solaris', '2.8' ]
            when /universal-darwin(\d)/ then ['universal', 'darwin',  $1    ]
            else                             other
            end

    other = Gem::Platform.new other
  else
    return nil
  end

  self === other
end

empty?() click to toggle source

 
               # File rubygems/platform.rb, line 112
def empty?
  to_s.empty?
end

eql?(other) click to toggle source

Alias for: ==

inspect() click to toggle source

 
               # File rubygems/platform.rb, line 100
def inspect
  "#<%s:0x%x @cpu=%p, @os=%p, @version=%p>" % [self.class, object_id, *to_a]
end

to_a() click to toggle source

 
               # File rubygems/platform.rb, line 104
def to_a
  [@cpu, @os, @version]
end

to_s() click to toggle source

 
               # File rubygems/platform.rb, line 108
def to_s
  to_a.compact.join '-'
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.