class Gem::Platform - Documentation for Ruby 4.0
Description: class Gem::Platform: Available list of platforms for targeting Gem installations. See `gem help platform` for information on platform matching.
Keywords: ruby,class,Gem::Platform

🔍

No recent searches

# 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

generic (platform)
Source

    # File lib/rubygems/platform.rb, line 300
    def generic(platform)
      return Gem::Platform::RUBY if platform.nil? || platform == Gem::Platform::RUBY

      GENERIC_CACHE[platform] ||= begin
        found = GENERICS.find do |match|
          platform === match
        end
        found || Gem::Platform::RUBY
      end
    end

Returns the generic platform for the given platform.

installable? (spec)
Source

    # File lib/rubygems/platform.rb, line 56
    def self.installable?(spec)
      if spec.respond_to? :installable_platform?
        spec.installable_platform?
      else
        match_spec? spec
      end
    end

local (refresh: false)
Source

    # File lib/rubygems/platform.rb, line 13
    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_gem? (platform, gem_name)
Source

    # File lib/rubygems/platform.rb, line 37
    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_spec? (spec)
Source

    # File lib/rubygems/platform.rb, line 32
    def self.match_spec?(spec)
      match_gem?(spec.platform, spec.name)
    end

new (arch)
Source

    # File lib/rubygems/platform.rb, line 75
    def initialize(arch)
      case arch
      when Array then
        @cpu, @os, @version = arch
      when String then
        cpu, os = arch.sub(/-+$/, "").split("-", 2)

        @cpu = if cpu&.match?(/i\d86/)
          "x86"
        else
          cpu
        end

        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 /^macruby-?(\d+(?:\.\d+)*)?/ then ["macruby", $1]
                        when /freebsd-?(\d+)?/ then            ["freebsd", $1]
                        when "java", "jruby" then              ["java",    nil]
                        when /^java-?(\d+(?:\.\d+)*)?/ then    ["java",    $1]
                        when /^dalvik-?(\d+)?$/ then           ["dalvik",  $1]
                        when /^dotnet$/ then                   ["dotnet",  nil]
                        when /^dotnet-?(\d+(?:\.\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 = $2
                          @cpu = "x86" if @cpu.nil? && os.end_with?("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

platform_specificity_match (spec_platform, user_platform)
Source

    # File lib/rubygems/platform.rb, line 314
    def platform_specificity_match(spec_platform, user_platform)
      return -1 if spec_platform == user_platform
      return 1_000_000 if spec_platform.nil? || spec_platform == Gem::Platform::RUBY || user_platform == Gem::Platform::RUBY

      os_match(spec_platform, user_platform) +
        cpu_match(spec_platform, user_platform) * 10 +
        version_match(spec_platform, user_platform) * 100
    end

Returns the platform specificity match for the given spec platform and user platform.

sort_and_filter_best_platform_match (matching, platform)
Source

    # File lib/rubygems/platform.rb, line 326
    def sort_and_filter_best_platform_match(matching, platform)
      return matching if matching.one?

      exact = matching.select {|spec| spec.platform == platform }
      return exact if exact.any?

      sorted_matching = sort_best_platform_match(matching, platform)
      exemplary_spec = sorted_matching.first

      sorted_matching.take_while {|spec| same_specificity?(platform, spec, exemplary_spec) && same_deps?(spec, exemplary_spec) }
    end

Sorts and filters the best platform match for the given matching specs and platform.

sort_best_platform_match (matching, platform)
Source

    # File lib/rubygems/platform.rb, line 341
    def sort_best_platform_match(matching, platform)
      matching.sort_by.with_index do |spec, i|
        [
          platform_specificity_match(spec.platform, platform),
          i, # for stable sort
        ]
      end
    end

Sorts the best platform match for the given matching specs and platform.

sort_priority (platform)
Source

    # File lib/rubygems/platform.rb, line 52
    def self.sort_priority(platform)
      platform == Gem::Platform::RUBY ? -1 : 1
    end

### Private Class Methods

cpu_match (spec_platform, user_platform)
Source

    # File lib/rubygems/platform.rb, line 370
    def cpu_match(spec_platform, user_platform)
      if spec_platform.cpu == user_platform.cpu
        0
      elsif spec_platform.cpu == "arm" && user_platform.cpu.to_s.start_with?("arm")
        0
      elsif spec_platform.cpu.nil? || spec_platform.cpu == "universal"
        1
      else
        2
      end
    end

match_platforms? (platform, platforms)
Source

    # File lib/rubygems/platform.rb, line 22
    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

os_match (spec_platform, user_platform)
Source

    # File lib/rubygems/platform.rb, line 362
    def os_match(spec_platform, user_platform)
      if spec_platform.os == user_platform.os
        0
      else
        1
      end
    end

same_deps? (spec, exemplary_spec)
Source

    # File lib/rubygems/platform.rb, line 356
    def same_deps?(spec, exemplary_spec)
      spec.required_ruby_version == exemplary_spec.required_ruby_version &&
        spec.required_rubygems_version == exemplary_spec.required_rubygems_version &&
        spec.dependencies.sort == exemplary_spec.dependencies.sort
    end

same_specificity? (platform, spec, exemplary_spec)
Source

    # File lib/rubygems/platform.rb, line 352
    def same_specificity?(platform, spec, exemplary_spec)
      platform_specificity_match(spec.platform, platform) == platform_specificity_match(exemplary_spec.platform, platform)
    end

version_match (spec_platform, user_platform)
Source

    # File lib/rubygems/platform.rb, line 382
    def version_match(spec_platform, user_platform)
      if spec_platform.version == user_platform.version
        0
      elsif spec_platform.version.nil?
        1
      else
        2
      end
    end

### Public Instance Methods

== (other)
Source

    # File lib/rubygems/platform.rb, line 173
    def ==(other)
      self.class === other && to_a == other.to_a
    end

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

Also aliased as: eql?
=== (other)
Source

    # File lib/rubygems/platform.rb, line 201
    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

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.

=~ (other)
Source

    # File lib/rubygems/platform.rb, line 239
    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

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

deconstruct ()

Deconstructs the platform into an array for pattern matching. Returns [cpu, os, version].

    Gem::Platform.new("x86_64-linux").deconstruct  #=> ["x86_64", "linux", nil]

This enables array pattern matching:

    case Gem::Platform.new("arm64-darwin-21")
    in ["arm64", "darwin", version]
      # version => "21"
    end

Alias for: to_a
deconstruct_keys (keys)
Source

    # File lib/rubygems/platform.rb, line 165
    def deconstruct_keys(keys)
      { cpu: @cpu, os: @os, version: @version }
    end

Deconstructs the platform into a hash for pattern matching. Returns a hash with keys `:cpu`, `:os`, and `:version`.

    Gem::Platform.new("x86_64-darwin-20").deconstruct_keys(nil)
    #=> { cpu: "x86_64", os: "darwin", version: "20" }

This enables hash pattern matching:

    case Gem::Platform.new("x86_64-linux")
    in cpu: "x86_64", os: "linux"
      # Matches Linux on x86_64
    end

eql? (other)
Alias for: ==
normalized_linux_version ()
Source

    # File lib/rubygems/platform.rb, line 226
    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 ()
Source

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

Also aliased as: deconstruct
to_s ()
Source

    # File lib/rubygems/platform.rb, line 134
    def to_s
      to_a.compact.join(@cpu.nil? ? "" : "-")
    end