Class: Gem::Platform

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Deprecate`
Inherits:	Object
Defined in:	lib/rubygems/platform.rb

Overview

Available list of platforms for targeting ::Gem installations.

See gem help platform for information on platform matching.

Constant Summary

CURRENT =

A platform-specific gem that is built for the packaging Ruby’s platform. This will be replaced with .local.

# File 'lib/rubygems/platform.rb', line 268
```
"current"
```
RUBY =

A pure-Ruby gem that may use Specification#extensions to build binary files.

# File 'lib/rubygems/platform.rb', line 262
```
"ruby"
```

Class Method Summary

.installable?(spec) ⇒ Boolean
.local(refresh: false)
.match(platform)
.match_gem?(platform, gem_name)

See additional method definition at line 48.
.match_spec?(spec) ⇒ Boolean
.sort_priority(platform)
.match_platforms?(platform, platforms) ⇒ Boolean private
.new(arch) ⇒ Platform constructor Internal use only

`Deprecate` - Extended

deprecate	Simple deprecation method that deprecates `name` by wrapping it up in a dummy method.
rubygems_deprecate	Simple deprecation method that deprecates `name` by wrapping it up in a dummy method.
rubygems_deprecate_command	Deprecation method to deprecate Rubygems commands.
skip_during	Temporarily turn off warnings.

Instance Attribute Summary

#cpu rw
#os rw
#version rw

Instance Method Summary

#==(other) (also: #eql?)

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

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 one has no version.
#=~(other)

Does other match this platform? If other is a String it will be converted to a Platform first.
#eql?(other)

Alias for #==.
#initialize(arch) ⇒ Platform constructor
#normalized_linux_version
#to_a
#to_s
#hash Internal use only

Constructor Details

.new(arch) ⇒ `Platform`

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 75


def self.new(arch) # :nodoc:
  case arch
  when Gem::Platform::CURRENT then
    Gem::Platform.local
  when Gem::Platform::RUBY, nil, "" then
    Gem::Platform::RUBY
  else
    super
  end
end

#initialize(arch) ⇒ `Platform`

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 86


def initialize(arch)
  case arch
  when Array then
    @cpu, @os, @version = arch
  when String then
    arch = arch.split "-"

    if arch.length > 2 && !arch.last.match?(/\d(\.\d)?$/) # reassemble x86-linux-{libc}
      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 && arch.last.match?(/^\d(\.\d)?$/) # for command-line
      @os, @version = arch
      return
    end

    os, = arch
    if os.nil?
      @cpu = nil
      os = cpu
    end # 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 /^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-?(\w+)?/ then         ["linux",     $1]
                    when /mingw32/ then               ["mingw32",   nil]
                    when /mingw-?(\w+)?/ then         ["mingw",     $1]
                    when /(mswin\d)(\_(\d))?/ then
                      os = $1
                      version = $3
                      @cpu = "x86" if @cpu.nil? && os =~ /32$/
                      [os, version]
                    when /netbsdelf/ then             ["netbsdelf", nil]
                    when /openbsd(\d\.\d)?/ then    ["openbsd",   $1]
                    when /solaris(\d\.\d)?/ then    ["solaris",   $1]
                    when /wasi/ then                  ["wasi",      nil]
                    # 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

Class Method Details

.installable?(spec) ⇒ `Boolean`

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 67


def self.installable?(spec)
  if spec.respond_to? :installable_platform?
    spec.installable_platform?
  else
    match_spec? spec
  end
end

.local(refresh: false)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 15


def self.local(refresh: false)
  return @local if @local && !refresh
  @local = begin
    arch = Gem.target_rbconfig["arch"]
    arch = "#{arch}_60" if /mswin(?:32|64)$/.match?(arch)
    new(arch)
  end
end

.match(platform)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 24


def self.match(platform)
  match_platforms?(platform, Gem.platforms)
end

.match_gem?(platform, gem_name)

See additional method definition at line 48.

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 58


def self.match_gem?(platform, gem_name)
  raise "Not a string: #{gem_name.inspect}" unless String === gem_name

  if REUSE_AS_BINARY_ON_TRUFFLERUBY.include?(gem_name)
    match_platforms?(platform, [Gem::Platform::RUBY, Gem::Platform.local])
  else
    match_platforms?(platform, Gem.platforms)
  end
end

.match_platforms?(platform, platforms) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 33


def self.match_platforms?(platform, platforms)
  platform = Gem::Platform.new(platform) unless platform.is_a?(Gem::Platform)
  platforms.any? do |local_platform|
    platform.nil? ||
      local_platform == platform ||
      (local_platform != Gem::Platform::RUBY && platform =~ local_platform)
  end
end

.match_spec?(spec) ⇒ `Boolean`

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 43


def self.match_spec?(spec)
  match_gem?(spec.platform, spec.name)
end

.sort_priority(platform)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 63


def self.sort_priority(platform)
  platform == Gem::Platform::RUBY ? -1 : 1
end

Instance Attribute Details

#cpu (rw)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 13


attr_accessor :cpu, :os, :version

#os (rw)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 13


attr_accessor :cpu, :os, :version

#version (rw)

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 13


attr_accessor :cpu, :os, :version

Instance Method Details

#==(other) Also known as: #eql?

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

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 164


def ==(other)
  self.class === other && to_a == other.to_a
end

#===(other)

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 one has no version

Additionally, the platform will match if the local CPU is ‘arm’ and the other CPU starts with “armv” (for generic 32-bit ARM family support).

Of note, this method is not commutative. Indeed the OS ‘linux’ has a special case: the version is the libc name, yet while “no version” stands as a wildcard for a binary gem platform (as for other OSes), for the runtime platform “no version” stands for ‘gnu’. To be able to distinguish these, the method receiver is the gem platform, while the argument is the runtime platform.

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 192


def ===(other)
  return nil unless Gem::Platform === other

  # universal-mingw32 matches x64-mingw-ucrt
  return true if (@cpu == "universal" || other.cpu == "universal") &&
                 @os.start_with?("mingw") && other.os.start_with?("mingw")

  # cpu
  ([nil,"universal"].include?(@cpu) || [nil, "universal"].include?(other.cpu) || @cpu == other.cpu ||
  (@cpu == "arm" && other.cpu.start_with?("armv"))) &&

    # os
    @os == other.os &&

    # version
    (
      (@os != "linux" && (@version.nil? || other.version.nil?)) ||
      (@os == "linux" && (normalized_linux_version == other.normalized_linux_version || ["musl#{@version}", "musleabi#{@version}", "musleabihf#{@version}"].include?(other.version))) ||
      @version == other.version
    )
end

#=~(other)

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

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 230


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 #==.

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 168


alias_method :eql?, :==

#hash

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 170


def hash # :nodoc:
  to_a.hash
end

#normalized_linux_version

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 217


def normalized_linux_version
  return nil unless @version

  without_gnu_nor_abi_modifiers = @version.sub(/\Agnu/, "").sub(/eabi(hf)?\Z/, "")
  return nil if without_gnu_nor_abi_modifiers.empty?

  without_gnu_nor_abi_modifiers
end

#to_a

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 152


def to_a
  [@cpu, @os, @version]
end

#to_s

[ GitHub ]

# File 'lib/rubygems/platform.rb', line 156


def to_s
  to_a.compact.join "-"
end

Class: Gem::Platform

Overview

Constant Summary

Class Method Summary

Deprecate - Extended

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(arch) ⇒ Platform

#initialize(arch) ⇒ Platform

Class Method Details

.installable?(spec) ⇒ Boolean

.local(refresh: false)

.match(platform)

.match_gem?(platform, gem_name)

.match_platforms?(platform, platforms) ⇒ Boolean (private)

.match_spec?(spec) ⇒ Boolean

.sort_priority(platform)

Instance Attribute Details

#cpu (rw)

#os (rw)

#version (rw)

Instance Method Details

#==(other) Also known as: #eql?

#===(other)

#=~(other)

#eql?(other)

#hash

#normalized_linux_version

#to_a

#to_s

`Deprecate` - Extended

.new(arch) ⇒ `Platform`

#initialize(arch) ⇒ `Platform`

.installable?(spec) ⇒ `Boolean`

.match_platforms?(platform, platforms) ⇒ `Boolean` (private)

.match_spec?(spec) ⇒ `Boolean`