class Gem::Platform

Available list of platforms for targeting Gem installations.

See `gem help platform` for information on platform matching.

Constants

CURRENT

A platform-specific gem that is built for the packaging Ruby's platform. This will be replaced with Gem::Platform::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

installable?(spec) click to toggle source
# File lib/rubygems/platform.rb, line 47
def self.installable?(spec)
  if spec.respond_to? :installable_platform?
    spec.installable_platform?
  else
    match_spec? spec
  end
end
local() click to toggle source
# File lib/rubygems/platform.rb, line 14
def self.local
  arch = RbConfig::CONFIG['arch']
  arch = "#{arch}_60" if arch =~ /mswin(?:32|64)$/
  @local ||= new(arch)
end
match(platform) click to toggle source
# File lib/rubygems/platform.rb, line 20
def self.match(platform)
  match_platforms?(platform, Gem.platforms)
end
match_gem?(platform, gem_name) click to toggle source
# File lib/rubygems/platform.rb, line 37
def self.match_gem?(platform, gem_name)
  # Note: this method might be redefined by Ruby implementations to
  # customize behavior per RUBY_ENGINE, gem_name or other criteria.
  match_platforms?(platform, Gem.platforms)
end
match_spec?(spec) click to toggle source
# File lib/rubygems/platform.rb, line 33
def self.match_spec?(spec)
  match_gem?(spec.platform, spec.name)
end
new(arch) click to toggle source
# File lib/rubygems/platform.rb, line 66
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/ # 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+)?$/ # 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 /^dalvik(\d+)?$/ then        [ 'dalvik',    $1  ]
                    when /^dotnet$/ then              [ 'dotnet',    nil ]
                    when /^dotnet([\d.]*)/ then       [ 'dotnet',    $1  ]
                    when /linux-?((?!gnu)\w+)?/ then  [ 'linux',     $1  ]
                    when /mingw32/ then               [ 'mingw32',   nil ]
                    when /mingw-?(\w+)?/ then         [ 'mingw',     $1  ]
                    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 /bitrig(\d+\.\d+)?/ then     [ 'bitrig',    $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
sort_priority(platform) click to toggle source
# File lib/rubygems/platform.rb, line 43
def self.sort_priority(platform)
  platform == Gem::Platform::RUBY ? -1 : 1
end

Private Class Methods

match_platforms?(platform, platforms) click to toggle source
# File lib/rubygems/platform.rb, line 24
def self.match_platforms?(platform, platforms)
  platforms.any? do |local_platform|
    platform.nil? or
      local_platform == platform or
      (local_platform != Gem::Platform::RUBY and local_platform =~ platform)
  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 lib/rubygems/platform.rb, line 141
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.

Additionally, the platform will match if the local CPU is 'arm' and the other CPU starts with “arm” (for generic ARM family support).

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

  # cpu
  ([nil,'universal'].include?(@cpu) or [nil, 'universal'].include?(other.cpu) or @cpu == other.cpu or
  (@cpu == 'arm' and other.cpu.start_with?("arm"))) 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 lib/rubygems/platform.rb, line 177
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 /^dalvik(\d+)?$/       then [nil,         'dalvik',  $1    ]
            when /dotnet(\-(\d+\.\d+))?/ then ['universal','dotnet',  $2    ]
            when /mswin32(\_(\d+))?/    then ['x86',       'mswin32', $2    ]
            when /mswin64(\_(\d+))?/    then ['x64',       'mswin64', $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
eql?(other)
Alias for: ==
to_a() click to toggle source
# File lib/rubygems/platform.rb, line 129
def to_a
  [@cpu, @os, @version]
end
to_s() click to toggle source
# File lib/rubygems/platform.rb, line 133
def to_s
  to_a.compact.join '-'
end