Class: Gem::Platform

Inherits:
Object
  • Object
show all
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 collapse

RUBY =

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

"ruby".freeze
CURRENT =

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

"current".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arch) ⇒ Platform

Returns a new instance of Platform.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/rubygems/platform.rb', line 67

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

    if arch.length > 2 && arch.last !~ /\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 =~ /^\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-?(\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? && 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

Instance Attribute Details

#cpu ⇒ Object

Returns the value of attribute cpu.



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

def cpu
  @cpu
end

#os ⇒ Object

Returns the value of attribute os.



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

def os
  @os
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.installable?(spec) ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
51
52
53
54
 
# File 'lib/rubygems/platform.rb', line 48

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

.local ⇒ Object 



14
15
16
17
18
 
# 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) ⇒ Object 



20
21
22
 
# File 'lib/rubygems/platform.rb', line 20

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

.match_gem?(platform, gem_name) ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
41
42
 
# File 'lib/rubygems/platform.rb', line 38

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) ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/rubygems/platform.rb', line 34

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

.new(arch) ⇒ Object

:nodoc:



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/rubygems/platform.rb', line 56

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

.sort_priority(platform) ⇒ Object 



44
45
46
 
# File 'lib/rubygems/platform.rb', line 44

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

Instance Method Details

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

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



142
143
144
 
# File 'lib/rubygems/platform.rb', line 142

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

#===(other) ⇒ Object

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 “arm” (for generic 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 disinguish these, the method receiver is the gem platform, while the argument is the runtime platform.

– NOTE: Until it can be removed, changes to this method must also be reflected in `bundler/lib/bundler/rubygems_ext.rb`



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/rubygems/platform.rb', line 170

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?("arm"))) &&

    # 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) ⇒ Object

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/rubygems/platform.rb', line 208

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

#hash ⇒ Object

:nodoc:



148
149
150
 
# File 'lib/rubygems/platform.rb', line 148

def hash # :nodoc:
  to_a.hash
end

#normalized_linux_version ⇒ Object

– NOTE: Until it can be removed, changes to this method must also be reflected in `bundler/lib/bundler/rubygems_ext.rb`



195
196
197
198
199
200
201
202
 
# File 'lib/rubygems/platform.rb', line 195

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 ⇒ Object 



130
131
132
 
# File 'lib/rubygems/platform.rb', line 130

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

#to_s ⇒ Object 



134
135
136
 
# File 'lib/rubygems/platform.rb', line 134

def to_s
  to_a.compact.join "-"
end