Module: Gem

Defined in:
lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/errors.rb,
lib/rubygems/openssl.rb,
lib/rubygems/defaults.rb,
lib/rubygems/safe_yaml.rb,
lib/rubygems/util/list.rb,
lib/rubygems/psych_tree.rb,
lib/rubygems/safe_marshal.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/yaml_serializer.rb,
lib/rubygems/safe_marshal/reader.rb,
lib/rubygems/safe_marshal/elements.rb

Overview

– This file contains all sorts of little compatibility hacks that we’ve had to introduce over the years. Quarantining them into one file helps us know when we can get rid of them.

Ruby 1.9.x has introduced some things that are awkward, and we need to support them, so we define some constants to use later.

TODO remove at RubyGems 4 ++

Defined Under Namespace

Modules: BundlerVersionFinder, Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, InstallUpdateOptions, InstallerUninstallerUtils, LocalRemoteOptions, QueryUtils, SafeMarshal, SafeYAML, Security, SecurityOption, TSort, Text, UpdateSuggestion, UserInteraction, Util, VersionOption, YAMLSerializer Classes: AvailableSet, BasicSpecification, Command, CommandLineError, CommandManager, ConfigFile, ConflictError, ConsoleUI, Dependency, DependencyError, DependencyInstaller, DependencyList, DependencyRemovalException, DependencyResolutionError, Doctor, DocumentError, EndOfYAMLException, ErrorReason, Exception, FilePermissionError, FormatException, GemNotFoundException, GemNotInHomeException, GemRunner, ImpossibleDependenciesError, Indexer, InstallError, Installer, InvalidSpecificationException, Licenses, List, LoadError, MissingSpecError, MissingSpecVersionError, NameTuple, NoAliasYAMLTree, OperationNotSupportedError, OptionParser, Package, PackageTask, PathSupport, Platform, PlatformMismatch, RemoteError, RemoteFetcher, RemoteInstallationCancelled, RemoteInstallationSkipped, RemoteSourceException, Request, RequestSet, Requirement, Resolver, RubyVersionMismatch, RuntimeRequirementNotMetError, S3URISigner, SilentUI, Source, SourceFetchProblem, SourceList, SpecFetcher, SpecificGemNotFoundException, Specification, SpecificationPolicy, StreamUI, StubSpecification, SystemExitException, UninstallError, Uninstaller, UnknownCommandError, UnknownCommandSpellChecker, UnsatisfiableDependencyError, Uri, UriFormatter, Validator, VerificationError, Version, WebauthnVerificationError

Constant Summary collapse

VERSION = 
"3.5.0.dev"
RUBYGEMS_DIR = 
__dir__
UNTAINT =

Taint support is deprecated in Ruby 2.7. This allows switching “.untaint” to “.tap(&Gem::UNTAINT)”, to avoid deprecation warnings in Ruby 2.7.

RUBY_VERSION < "2.7" ? :untaint.to_sym : proc {}
WIN_PATTERNS =

An Array of Regexps that match windows Ruby platforms.

[
  /bccwin/i,
  /cygwin/i,
  /djgpp/i,
  /mingw/i,
  /mswin/i,
  /wince/i,
].freeze
GEM_DEP_FILES = 
%w[
  gem.deps.rb
  gems.rb
  Gemfile
  Isolate
].freeze
REPOSITORY_SUBDIRECTORIES =

Subdirectories in a gem repository

%w[
  build_info
  cache
  doc
  extensions
  gems
  plugins
  specifications
].freeze
REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES =

Subdirectories in a gem repository for default gems

%w[
  gems
  specifications/default
].freeze
LOADED_SPECS_MUTEX = 
Thread::Mutex.new
MARSHAL_SPEC_DIR =

Location of Marshal quick gemspecs on remote repositories

"quick/Marshal.#{Gem.marshal_version}/"
HAVE_OPENSSL =

:nodoc:

defined? OpenSSL::SSL # :nodoc:
DEFAULT_HOST = 
"https://rubygems.org"
UnsatisfiableDepedencyError =

Backwards compatible typo’d exception class for early RubyGems 2.0.x

Gem::UnsatisfiableDependencyError
RubyGemsVersion =

:stopdoc:

VERSION
RbConfigPriorities = 
%w[
  MAJOR
  MINOR
  TEENY
  EXEEXT RUBY_SO_NAME arch bindir datadir libdir ruby_install_name
  ruby_version rubylibprefix sitedir sitelibdir vendordir vendorlibdir
  rubylibdir
].freeze
ConfigMap =

Configuration settings from ::RbConfig

Hash.new do |cm, key|
  cm[key] = RbConfig::CONFIG[key.to_s]
end
@@win_platform = 
nil

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.disable_system_update_message ⇒ Object

RubyGems distributors (like operating system package managers) can disable RubyGems update by setting this to error message printed to end-users on gem update –system instead of actual update.



1162
1163
1164
 
# File 'lib/rubygems.rb', line 1162

def disable_system_update_message
  @disable_system_update_message
end

.discover_gems_on_require ⇒ Object

Whether RubyGems should enhance builtin ‘require` to automatically check whether the path required is present in installed gems, and automatically activate them and add them to `$LOAD_PATH`.



1169
1170
1171
 
# File 'lib/rubygems.rb', line 1169

def discover_gems_on_require
  @discover_gems_on_require
end

.done_installing_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::DependencyInstaller installs a set of gems



1247
1248
1249
 
# File 'lib/rubygems.rb', line 1247

def done_installing_hooks
  @done_installing_hooks
end

.gemdeps ⇒ Object (readonly)

GemDependencyAPI object, which is set when .use_gemdeps is called. This contains all the information from the Gemfile.



1180
1181
1182
 
# File 'lib/rubygems.rb', line 1180

def gemdeps
  @gemdeps
end

.loaded_specs ⇒ Object (readonly)

Hash of loaded Gem::Specification keyed by name



1174
1175
1176
 
# File 'lib/rubygems.rb', line 1174

def loaded_specs
  @loaded_specs
end

.post_build_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::Installer#install extracts files and builds extensions



1235
1236
1237
 
# File 'lib/rubygems.rb', line 1235

def post_build_hooks
  @post_build_hooks
end

.post_install_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::Installer#install completes installation



1241
1242
1243
 
# File 'lib/rubygems.rb', line 1241

def post_install_hooks
  @post_install_hooks
end

.post_reset_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::Specification.reset is run.



1252
1253
1254
 
# File 'lib/rubygems.rb', line 1252

def post_reset_hooks
  @post_reset_hooks
end

.post_uninstall_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::Uninstaller#uninstall completes installation



1258
1259
1260
 
# File 'lib/rubygems.rb', line 1258

def post_uninstall_hooks
  @post_uninstall_hooks
end

.pre_install_hooks ⇒ Object (readonly)

The list of hooks to be run before Gem::Installer#install does any work



1263
1264
1265
 
# File 'lib/rubygems.rb', line 1263

def pre_install_hooks
  @pre_install_hooks
end

.pre_reset_hooks ⇒ Object (readonly)

The list of hooks to be run before Gem::Specification.reset is run.



1268
1269
1270
 
# File 'lib/rubygems.rb', line 1268

def pre_reset_hooks
  @pre_reset_hooks
end

.pre_uninstall_hooks ⇒ Object (readonly)

The list of hooks to be run before Gem::Uninstaller#uninstall does any work



1274
1275
1276
 
# File 'lib/rubygems.rb', line 1274

def pre_uninstall_hooks
  @pre_uninstall_hooks
end

Class Method Details

.activate_bin_path(name, exec_name = nil, *requirements) ⇒ Object

Find the full path to the executable for gem name. If the exec_name is not given, an exception will be raised, otherwise the specified executable’s path is returned. requirements allows you to specify specific gem versions.

A side effect of this method is that it will activate the gem that contains the executable.

This method should only be used in bin stub files.



282
283
284
285
286
287
288
289
 
# File 'lib/rubygems.rb', line 282

def self.activate_bin_path(name, exec_name = nil, *requirements) # :nodoc:
  spec = find_spec_for_exe name, exec_name, requirements
  Gem::LOADED_SPECS_MUTEX.synchronize do
    spec.activate
    finish_resolve
  end
  spec.bin_file exec_name
end

.activated_gem_paths ⇒ Object

The number of paths in the $LOAD_PATH from activated gems. Used to prioritize -I and ENV['RUBYLIB'] entries during require.



577
578
579
 
# File 'lib/rubygems.rb', line 577

def self.activated_gem_paths
  @activated_gem_paths ||= 0
end

.add_to_load_path(*paths) ⇒ Object

Add a list of paths to the $LOAD_PATH at the proper place.



584
585
586
587
588
589
 
# File 'lib/rubygems.rb', line 584

def self.add_to_load_path(*paths)
  @activated_gem_paths = activated_gem_paths + paths.size

  # gem directories must come after -I and ENV['RUBYLIB']
  $LOAD_PATH.insert(Gem.load_path_insert_index, *paths)
end

.bin_path(name, exec_name = nil, *requirements) ⇒ Object

Find the full path to the executable for gem name. If the exec_name is not given, an exception will be raised, otherwise the specified executable’s path is returned. requirements allows you to specify specific gem versions.



240
241
242
243
244
245
 
# File 'lib/rubygems.rb', line 240

def self.bin_path(name, exec_name = nil, *requirements)
  requirements = Gem::Requirement.default if
    requirements.empty?

  find_spec_for_exe(name, exec_name, requirements).bin_file exec_name
end

.binary_mode ⇒ Object

The mode needed to read a file as straight binary.



294
295
296
 
# File 'lib/rubygems.rb', line 294

def self.binary_mode
  "rb"
end

.bindir(install_dir = Gem.dir) ⇒ Object

The path where gem executables are to be installed.



301
302
303
304
305
 
# File 'lib/rubygems.rb', line 301

def self.bindir(install_dir=Gem.dir)
  return File.join install_dir, "bin" unless
    install_dir.to_s == Gem.default_dir.to_s
  Gem.default_bindir
end

.cache_home ⇒ Object

The path to standard location of the user’s cache directory.



147
148
149
 
# File 'lib/rubygems/defaults.rb', line 147

def self.cache_home
  @cache_home ||= (ENV["XDG_CACHE_HOME"] || File.join(Gem.user_home, ".cache"))
end

.clear_default_specs ⇒ Object

Clear default gem related variables. It is for test



1227
1228
1229
 
# File 'lib/rubygems.rb', line 1227

def clear_default_specs
  @path_to_default_spec_map.clear
end

.clear_paths ⇒ Object

Reset the dir and path values. The next time dir or path is requested, the values will be calculated from scratch. This is mainly used by the unit tests to provide test isolation.



319
320
321
322
323
324
 
# File 'lib/rubygems.rb', line 319

def self.clear_paths
  @paths         = nil
  @user_home     = nil
  Gem::Specification.reset
  Gem::Security.reset if defined?(Gem::Security)
end

.config_file ⇒ Object

The path to standard location of the user’s .gemrc file.



133
134
135
 
# File 'lib/rubygems/defaults.rb', line 133

def self.config_file
  @config_file ||= find_config_file.tap(&Gem::UNTAINT)
end

.config_home ⇒ Object

The path to standard location of the user’s configuration directory.



114
115
116
 
# File 'lib/rubygems/defaults.rb', line 114

def self.config_home
  @config_home ||= (ENV["XDG_CONFIG_HOME"] || File.join(Gem.user_home, ".config"))
end

.configuration ⇒ Object

The standard configuration object for gems.



329
330
331
 
# File 'lib/rubygems.rb', line 329

def self.configuration
  @configuration ||= Gem::ConfigFile.new []
end

.configuration=(config) ⇒ Object

Use the given configuration object (which implements the ConfigFile protocol) as the standard configuration object.



337
338
339
 
# File 'lib/rubygems.rb', line 337

def self.configuration=(config)
  @configuration = config
end

.data_home ⇒ Object

The path to standard location of the user’s data directory.



154
155
156
 
# File 'lib/rubygems/defaults.rb', line 154

def self.data_home
  @data_home ||= (ENV["XDG_DATA_HOME"] || File.join(Gem.user_home, ".local", "share"))
end

.default_bindir ⇒ Object

The default directory for binaries



204
205
206
 
# File 'lib/rubygems/defaults.rb', line 204

def self.default_bindir
  RbConfig::CONFIG["bindir"]
end

.default_cert_path ⇒ Object

The default signing certificate chain path



228
229
230
231
232
233
234
235
236
 
# File 'lib/rubygems/defaults.rb', line 228

def self.default_cert_path
  default_cert_path = File.join Gem.user_home, ".gem", "gem-public_cert.pem"

  unless File.exist?(default_cert_path)
    default_cert_path = File.join Gem.data_home, "gem", "gem-public_cert.pem"
  end

  default_cert_path
end

.default_dir ⇒ Object

Default home directory path to be used if an alternate value is not specified in the environment



37
38
39
 
# File 'lib/rubygems/defaults.rb', line 37

def self.default_dir
  @default_dir ||= File.join(RbConfig::CONFIG["rubylibprefix"], "gems", RbConfig::CONFIG["ruby_version"])
end

.default_exec_format ⇒ Object

Deduce Ruby’s –program-prefix and –program-suffix from its install name



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/rubygems/defaults.rb', line 186

def self.default_exec_format
  exec_format = begin
                  RbConfig::CONFIG["ruby_install_name"].sub("ruby", "%s")
                rescue StandardError
                  "%s"
                end

  unless exec_format.include?("%s")
    raise Gem::Exception,
      "[BUG] invalid exec_format #{exec_format.inspect}, no %s"
  end

  exec_format
end

.default_ext_dir_for(base_dir) ⇒ Object

Returns binary extensions dir for specified RubyGems base dir or nil if such directory cannot be determined.

By default, the binary extensions are located side by side with their Ruby counterparts, therefore nil is returned



48
49
50
 
# File 'lib/rubygems/defaults.rb', line 48

def self.default_ext_dir_for(base_dir)
  nil
end

.default_key_path ⇒ Object

The default signing key path



215
216
217
218
219
220
221
222
223
 
# File 'lib/rubygems/defaults.rb', line 215

def self.default_key_path
  default_key_path = File.join Gem.user_home, ".gem", "gem-private_key.pem"

  unless File.exist?(default_key_path)
    default_key_path = File.join Gem.data_home, "gem", "gem-private_key.pem"
  end

  default_key_path
end

.default_path ⇒ Object

Default gem load path



175
176
177
178
179
180
181
 
# File 'lib/rubygems/defaults.rb', line 175

def self.default_path
  path = []
  path << user_dir if user_home && File.exist?(user_home)
  path << default_dir
  path << vendor_dir if vendor_dir && File.directory?(vendor_dir)
  path
end

.default_rubygems_dirs ⇒ Object

Paths where RubyGems’ .rb files and bin files are installed



55
56
57
 
# File 'lib/rubygems/defaults.rb', line 55

def self.default_rubygems_dirs
  nil # default to standard layout
end

.default_sources ⇒ Object

An Array of the default sources that come with RubyGems



15
16
17
 
# File 'lib/rubygems/defaults.rb', line 15

def self.default_sources
  %w[https://rubygems.org/]
end

.default_spec_cache_dir ⇒ Object

Default spec directory path to be used if an alternate value is not specified in the environment



23
24
25
26
27
28
29
30
31
 
# File 'lib/rubygems/defaults.rb', line 23

def self.default_spec_cache_dir
  default_spec_cache_dir = File.join Gem.user_home, ".gem", "specs"

  unless File.exist?(default_spec_cache_dir)
    default_spec_cache_dir = File.join Gem.data_home, "gem", "specs"
  end

  default_spec_cache_dir
end

.default_specifications_dir ⇒ Object

Path to specification files of default gems.



62
63
64
 
# File 'lib/rubygems/defaults.rb', line 62

def self.default_specifications_dir
  @default_specifications_dir ||= File.join(Gem.default_dir, "specifications", "default")
end

.deflate(data) ⇒ Object

A Zlib::Deflate.deflate wrapper



344
345
346
347
 
# File 'lib/rubygems.rb', line 344

def self.deflate(data)
  require "zlib"
  Zlib::Deflate.deflate data
end

.dir ⇒ Object

The path where gems are to be installed.



392
393
394
 
# File 'lib/rubygems.rb', line 392

def self.dir
  paths.home
end

.done_installing(&hook) ⇒ Object

Adds a post-installs hook that will be passed a Gem::DependencyInstaller and a list of installed specifications when Gem::DependencyInstaller#install is complete



688
689
690
 
# File 'lib/rubygems.rb', line 688

def self.done_installing(&hook)
  @done_installing_hooks << hook
end

.ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil) ⇒ Object

Quietly ensure the Gem directory dir contains all the proper subdirectories for handling default gems. If we can’t create a directory due to a permission problem, then we will silently continue.

If mode is given, missing directories are created with this mode.

World-writable directories will never be created.



426
427
428
 
# File 'lib/rubygems.rb', line 426

def self.ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil)
  ensure_subdirectories(dir, mode, REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES)
end

.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ⇒ Object

Quietly ensure the Gem directory dir contains all the proper subdirectories. If we can’t create a directory due to a permission problem, then we will silently continue.

If mode is given, missing directories are created with this mode.

World-writable directories will never be created.



413
414
415
 
# File 'lib/rubygems.rb', line 413

def self.ensure_gem_subdirectories(dir = Gem.dir, mode = nil)
  ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES)
end

.ensure_subdirectories(dir, mode, subdirs) ⇒ Object

:nodoc:



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/rubygems.rb', line 430

def self.ensure_subdirectories(dir, mode, subdirs) # :nodoc:
  old_umask = File.umask
  File.umask old_umask | 0o002

  options = {}

  options[:mode] = mode if mode

  subdirs.each do |name|
    subdir = File.join dir, name
    next if File.exist? subdir

    require "fileutils"

    begin
      FileUtils.mkdir_p subdir, **options
    rescue SystemCallError
    end
  end
ensure
  File.umask old_umask
end

.env_requirement(gem_name) ⇒ Object 



821
822
823
824
825
826
827
 
# File 'lib/rubygems.rb', line 821

def self.env_requirement(gem_name)
  @env_requirements_by_name ||= {}
  @env_requirements_by_name[gem_name] ||= begin
    req = ENV["GEM_REQUIREMENT_#{gem_name.upcase}"] || ">= 0"
    Gem::Requirement.create(req)
  end
end

.extension_api_version ⇒ Object

The extension API version of ruby. This includes the static vs non-static distinction as extensions cannot be shared between the two.



457
458
459
460
461
462
463
 
# File 'lib/rubygems.rb', line 457

def self.extension_api_version # :nodoc:
  if RbConfig::CONFIG["ENABLE_SHARED"] == "no"
    "#{ruby_api_version}-static"
  else
    ruby_api_version
  end
end

.find_config_file ⇒ Object

Finds the user’s config file



121
122
123
124
125
126
127
128
 
# File 'lib/rubygems/defaults.rb', line 121

def self.find_config_file
  gemrc = File.join Gem.user_home, ".gemrc"
  if File.exist? gemrc
    gemrc
  else
    File.join Gem.config_home, "gem", "gemrc"
  end
end

.find_files(glob, check_load_path = true) ⇒ Object

Returns a list of paths matching glob that can be used by a gem to pick up features from other gems. For example:

Gem.find_files('rdoc/discover').each do |path| load path end

if check_load_path is true (the default), then find_files also searches $LOAD_PATH for files as well as gems.

Note that find_files will return all files even if they are from different versions of the same gem. See also find_latest_files



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/rubygems.rb', line 477

def self.find_files(glob, check_load_path=true)
  files = []

  files = find_files_from_load_path glob if check_load_path

  gem_specifications = @gemdeps ? Gem.loaded_specs.values : Gem::Specification.stubs

  files.concat gem_specifications.map {|spec|
    spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
  }.flatten

  # $LOAD_PATH might contain duplicate entries or reference
  # the spec dirs directly, so we prune.
  files.uniq! if check_load_path

  files
end

.find_files_from_load_path(glob) ⇒ Object

:nodoc:



495
496
497
498
499
500
 
# File 'lib/rubygems.rb', line 495

def self.find_files_from_load_path(glob) # :nodoc:
  glob_with_suffixes = "#{glob}#{Gem.suffix_pattern}"
  $LOAD_PATH.map do |load_path|
    Gem::Util.glob_files_in_dir(glob_with_suffixes, load_path)
  end.flatten.select {|file| File.file? file.tap(&Gem::UNTAINT) }
end

.find_latest_files(glob, check_load_path = true) ⇒ Object

Returns a list of paths matching glob from the latest gems that can be used by a gem to pick up features from other gems. For example:

Gem.find_latest_files('rdoc/discover').each do |path| load path end

if check_load_path is true (the default), then find_latest_files also searches $LOAD_PATH for files as well as gems.

Unlike find_files, find_latest_files will return only files from the latest version of a gem.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/rubygems.rb', line 514

def self.find_latest_files(glob, check_load_path=true)
  files = []

  files = find_files_from_load_path glob if check_load_path

  files.concat Gem::Specification.latest_specs(true).map {|spec|
    spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
  }.flatten

  # $LOAD_PATH might contain duplicate entries or reference
  # the spec dirs directly, so we prune.
  files.uniq! if check_load_path

  files
end

.find_unresolved_default_spec(path) ⇒ Object

Find a Gem::Specification of default gem from path



1219
1220
1221
1222
 
# File 'lib/rubygems.rb', line 1219

def find_unresolved_default_spec(path)
  default_spec = @path_to_default_spec_map[path]
  return default_spec if default_spec && loaded_specs[default_spec.name] != default_spec
end

.finish_resolve(request_set = Gem::RequestSet.new) ⇒ Object 



225
226
227
228
229
230
231
232
 
# File 'lib/rubygems.rb', line 225

def self.finish_resolve(request_set=Gem::RequestSet.new)
  request_set.import Gem::Specification.unresolved_deps.values
  request_set.import Gem.loaded_specs.values.map {|s| Gem::Dependency.new(s.name, s.version) }

  request_set.resolve_current.each do |s|
    s.full_spec.activate
  end
end

.host ⇒ Object

Get the default RubyGems API host. This is normally https://rubygems.org.



549
550
551
 
# File 'lib/rubygems.rb', line 549

def self.host
  @host ||= Gem::DEFAULT_HOST
end

.host=(host) ⇒ Object

Set the default RubyGems API host.



555
556
557
 
# File 'lib/rubygems.rb', line 555

def self.host=(host)
  @host = host
end

.install(name, version = Gem::Requirement.default, *options) ⇒ Object

Top level install helper method. Allows you to install gems interactively:

% irb
>> Gem.install "minitest"
Fetching: minitest-5.14.0.gem (100%)
=> [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]



538
539
540
541
542
543
 
# File 'lib/rubygems.rb', line 538

def self.install(name, version = Gem::Requirement.default, *options)
  require_relative "rubygems/dependency_installer"
  inst = Gem::DependencyInstaller.new(*options)
  inst.install name, version
  inst.installed_gems
end

.install_extension_in_lib ⇒ Object

Install extensions into lib as well as into the extension directory.



241
242
243
 
# File 'lib/rubygems/defaults.rb', line 241

def self.install_extension_in_lib # :nodoc:
  true
end

.java_platform? ⇒ Boolean

Is this a java platform?

Returns:

  • (Boolean) 


1002
1003
1004
 
# File 'lib/rubygems.rb', line 1002

def self.java_platform?
  RUBY_PLATFORM == "java"
end

.latest_rubygems_version ⇒ Object

Returns the latest release version of RubyGems.



846
847
848
849
 
# File 'lib/rubygems.rb', line 846

def self.latest_rubygems_version
  latest_version_for("rubygems-update") ||
    raise("Can't find 'rubygems-update' in any repo. Check `gem source list`.")
end

.latest_spec_for(name) ⇒ Object

Returns the latest release-version specification for the gem name.



833
834
835
836
837
838
839
840
841
 
# File 'lib/rubygems.rb', line 833

def self.latest_spec_for(name)
  dependency   = Gem::Dependency.new name
  fetcher      = Gem::SpecFetcher.fetcher
  spec_tuples, = fetcher.spec_for_dependency dependency

  spec, = spec_tuples.last

  spec
end

.latest_version_for(name) ⇒ Object

Returns the version of the latest release-version of gem name



854
855
856
 
# File 'lib/rubygems.rb', line 854

def self.latest_version_for(name)
  latest_spec_for(name)&.version
end

.load_env_plugins ⇒ Object

Find all ‘rubygems_plugin’ files in $LOAD_PATH and load them



1044
1045
1046
 
# File 'lib/rubygems.rb', line 1044

def self.load_env_plugins
  load_plugin_files find_files_from_load_path("rubygems_plugin")
end

.load_path_insert_index ⇒ Object

The index to insert activated gem paths into the $LOAD_PATH. The activated gem’s paths are inserted before site lib directory by default.



563
564
565
566
567
568
569
570
571
 
# File 'lib/rubygems.rb', line 563

def self.load_path_insert_index
  $LOAD_PATH.each_with_index do |path, i|
    return i if path.instance_variable_defined?(:@gem_prelude_index)
  end

  index = $LOAD_PATH.index RbConfig::CONFIG["sitelibdir"]

  index || 0
end

.load_plugin_files(plugins) ⇒ Object

Load plugins as Ruby files



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/rubygems.rb', line 1016

def self.load_plugin_files(plugins) # :nodoc:
  plugins.each do |plugin|
    # Skip older versions of the GemCutter plugin: Its commands are in
    # RubyGems proper now.

    next if /gemcutter-0\.[0-3]/.match?(plugin)

    begin
      load plugin
    rescue ScriptError, StandardError => e
      details = "#{plugin.inspect}: #{e.message} (#{e.class})"
      warn "Error loading RubyGems plugin #{details}"
    end
  end
end

.load_plugins ⇒ Object

Find rubygems plugin files in the standard location and load them



1035
1036
1037
1038
1039
 
# File 'lib/rubygems.rb', line 1035

def self.load_plugins
  Gem.path.each do |gem_path|
    load_plugin_files Gem::Util.glob_files_in_dir("*#{Gem.plugin_suffix_pattern}", plugindir(gem_path))
  end
end

.load_safe_marshal ⇒ Object 



609
610
611
612
613
614
615
 
# File 'lib/rubygems.rb', line 609

def self.load_safe_marshal
  return if @safe_marshal_loaded

  require_relative "rubygems/safe_marshal"

  @safe_marshal_loaded = true
end

.load_yaml ⇒ Object

Loads YAML, preferring Psych



596
597
598
599
600
601
602
603
604
605
 
# File 'lib/rubygems.rb', line 596

def self.load_yaml
  return if @yaml_loaded

  require "psych"
  require_relative "rubygems/psych_tree"

  require_relative "rubygems/safe_yaml"

  @yaml_loaded = true
end

.location_of_caller(depth = 1) ⇒ Object

The file name and line number of the caller of the caller of this method.

depth is how many layers up the call stack it should go.

e.g.,

def a; Gem.location_of_caller; end a #=> [“x.rb”, 2] # (it’ll vary depending on file name and line number)

def b; c; end def c; Gem.location_of_caller(2); end b #=> [“x.rb”, 6] # (it’ll vary depending on file name and line number)



631
632
633
634
635
636
637
 
# File 'lib/rubygems.rb', line 631

def self.location_of_caller(depth = 1)
  caller[depth] =~ /(.*?):(\d+).*?$/i
  file = $1
  lineno = $2.to_i

  [file, lineno]
end

.marshal_version ⇒ Object

The version of the Marshal format for your Ruby.



642
643
644
 
# File 'lib/rubygems.rb', line 642

def self.marshal_version
  "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
end

.needs {|rs| ... } ⇒ Object

Yields:

  • (rs) 


217
218
219
220
221
222
223
 
# File 'lib/rubygems.rb', line 217

def self.needs
  rs = Gem::RequestSet.new

  yield rs

  finish_resolve rs
end

.open_file(path, flags, &block) ⇒ Object

Open a file with given flags, and on Windows protect access with flock



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/rubygems.rb', line 781

def self.open_file(path, flags, &block)
  File.open(path, flags) do |io|
    if !java_platform? && win_platform?
      begin
        io.flock(File::LOCK_EX)
      rescue Errno::ENOSYS, Errno::ENOTSUP
      end
    end
    yield io
  end
rescue Errno::ENOLCK # NFS
  if Thread.main != Thread.current
    raise
  else
    File.open(path, flags) do |io|
      yield io
    end
  end
end

.operating_system_defaults ⇒ Object

Default options for gem commands for Ruby packagers.

The options here should be structured as an array of string “gem” command names as keys and a string of the default options as values.

Example:

def self.operating_system_defaults

{
    'install' => '--no-rdoc --no-ri --env-shebang',
    'update' => '--no-rdoc --no-ri --env-shebang'
}

end



274
275
276
 
# File 'lib/rubygems/defaults.rb', line 274

def self.operating_system_defaults
  {}
end

.path ⇒ Object 



396
397
398
 
# File 'lib/rubygems.rb', line 396

def self.path
  paths.path
end

.path_separator ⇒ Object

How String Gem paths should be split. Overridable for esoteric platforms.



168
169
170
 
# File 'lib/rubygems/defaults.rb', line 168

def self.path_separator
  File::PATH_SEPARATOR
end

.paths ⇒ Object

Retrieve the PathSupport object that RubyGems uses to lookup files.



352
353
354
 
# File 'lib/rubygems.rb', line 352

def self.paths
  @paths ||= Gem::PathSupport.new(ENV)
end

.paths=(env) ⇒ Object

Initialize the filesystem paths to use from env. env is a hash-like object (typically ENV) that is queried for ‘GEM_HOME’, ‘GEM_PATH’, and ‘GEM_SPEC_CACHE’ Keys for the env hash should be Strings, and values of the hash should be Strings or nil.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/rubygems.rb', line 362

def self.paths=(env)
  clear_paths
  target = {}
  env.each_pair do |k,v|
    case k
    when "GEM_HOME", "GEM_PATH", "GEM_SPEC_CACHE"
      case v
      when nil, String
        target[k] = v
      when Array
        unless Gem::Deprecate.skip
          warn <<-EOWARN
Array values in the parameter to `Gem.paths=` are deprecated.
Please use a String or nil.
An Array (#{env.inspect}) was passed in from #{caller[3]}
          EOWARN
        end
        target[k] = v.join File::PATH_SEPARATOR
      end
    else
      target[k] = v
    end
  end
  @paths = Gem::PathSupport.new ENV.to_hash.merge(target)
  Gem::Specification.dirs = @paths.path
end

.platform_defaults ⇒ Object

Default options for gem commands for Ruby implementers.

The options here should be structured as an array of string “gem” command names as keys and a string of the default options as values.

Example:

def self.platform_defaults

{
    'install' => '--no-rdoc --no-ri --env-shebang',
    'update' => '--no-rdoc --no-ri --env-shebang'
}

end



293
294
295
 
# File 'lib/rubygems/defaults.rb', line 293

def self.platform_defaults
  {}
end

.platforms ⇒ Object

Array of platforms this RubyGems supports.



656
657
658
659
660
661
662
 
# File 'lib/rubygems.rb', line 656

def self.platforms
  @platforms ||= []
  if @platforms.empty?
    @platforms = [Gem::Platform::RUBY, Gem::Platform.local]
  end
  @platforms
end

.platforms=(platforms) ⇒ Object

Set array of platforms this RubyGems supports (primarily for testing).



649
650
651
 
# File 'lib/rubygems.rb', line 649

def self.platforms=(platforms)
  @platforms = platforms
end

.plugin_suffix_pattern ⇒ Object

Glob pattern for require-able plugin suffixes.



926
927
928
 
# File 'lib/rubygems.rb', line 926

def self.plugin_suffix_pattern
  @plugin_suffix_pattern ||= "_plugin#{suffix_pattern}"
end

.plugin_suffix_regexp ⇒ Object

Regexp for require-able plugin suffixes.



933
934
935
 
# File 'lib/rubygems.rb', line 933

def self.plugin_suffix_regexp
  @plugin_suffix_regexp ||= /_plugin#{suffix_regexp}\z/
end

.plugindir(install_dir = Gem.dir) ⇒ Object

The path were rubygems plugins are to be installed.



310
311
312
 
# File 'lib/rubygems.rb', line 310

def self.plugindir(install_dir=Gem.dir)
  File.join install_dir, "plugins"
end

.post_build(&hook) ⇒ Object

Adds a post-build hook that will be passed an Gem::Installer instance when Gem::Installer#install is called. The hook is called after the gem has been extracted and extensions have been built but before the executables or gemspec has been written. If the hook returns false then the gem’s files will be removed and the install will be aborted.



671
672
673
 
# File 'lib/rubygems.rb', line 671

def self.post_build(&hook)
  @post_build_hooks << hook
end

.post_install(&hook) ⇒ Object

Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called



679
680
681
 
# File 'lib/rubygems.rb', line 679

def self.post_install(&hook)
  @post_install_hooks << hook
end

.post_reset(&hook) ⇒ Object

Adds a hook that will get run after Gem::Specification.reset is run.



696
697
698
 
# File 'lib/rubygems.rb', line 696

def self.post_reset(&hook)
  @post_reset_hooks << hook
end

.post_uninstall(&hook) ⇒ Object

Adds a post-uninstall hook that will be passed a Gem::Uninstaller instance and the spec that was uninstalled when Gem::Uninstaller#uninstall is called



705
706
707
 
# File 'lib/rubygems.rb', line 705

def self.post_uninstall(&hook)
  @post_uninstall_hooks << hook
end

.pre_install(&hook) ⇒ Object

Adds a pre-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called. If the hook returns false then the install will be aborted.



714
715
716
 
# File 'lib/rubygems.rb', line 714

def self.pre_install(&hook)
  @pre_install_hooks << hook
end

.pre_reset(&hook) ⇒ Object

Adds a hook that will get run before Gem::Specification.reset is run.



722
723
724
 
# File 'lib/rubygems.rb', line 722

def self.pre_reset(&hook)
  @pre_reset_hooks << hook
end

.pre_uninstall(&hook) ⇒ Object

Adds a pre-uninstall hook that will be passed an Gem::Uninstaller instance and the spec that will be uninstalled when Gem::Uninstaller#uninstall is called



731
732
733
 
# File 'lib/rubygems.rb', line 731

def self.pre_uninstall(&hook)
  @pre_uninstall_hooks << hook
end

.prefix ⇒ Object

The directory prefix this RubyGems was installed at. If your prefix is in a standard location (ie, rubygems is installed where you’d expect it to be), then prefix returns nil.



740
741
742
743
744
745
746
747
748
 
# File 'lib/rubygems.rb', line 740

def self.prefix
  prefix = File.dirname RUBYGEMS_DIR

  if prefix != File.expand_path(RbConfig::CONFIG["sitelibdir"]) &&
     prefix != File.expand_path(RbConfig::CONFIG["libdir"]) &&
     File.basename(RUBYGEMS_DIR) == "lib"
    prefix
  end
end

.read_binary(path) ⇒ Object

Safely read a file in binary mode on all platforms.



760
761
762
763
764
 
# File 'lib/rubygems.rb', line 760

def self.read_binary(path)
  open_file(path, "rb+", &:read)
rescue Errno::EACCES, Errno::EROFS
  open_file(path, "rb", &:read)
end

.refresh ⇒ Object

Refresh available gems from disk.



753
754
755
 
# File 'lib/rubygems.rb', line 753

def self.refresh
  Gem::Specification.reset
end

.register_default_spec(spec) ⇒ Object

Register a Gem::Specification for default gem.

Two formats for the specification are supported:

  • MRI 2.0 style, where spec.files contains unprefixed require names. The spec’s filenames will be registered as-is.

  • New style, where spec.files contains files prefixed with paths from spec.require_paths. The prefixes are stripped before registering the spec’s filenames. Unprefixed files are omitted.



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/rubygems.rb', line 1194

def register_default_spec(spec)
  extended_require_paths = spec.require_paths.map {|f| f + "/" }
  new_format = extended_require_paths.any? {|path| spec.files.any? {|f| f.start_with? path } }

  if new_format
    prefix_group = extended_require_paths.join("|")
    prefix_pattern = /^(#{prefix_group})/
  end

  spec.files.each do |file|
    if new_format
      file = file.sub(prefix_pattern, "")
      next unless $~
    end

    spec.activate if already_loaded?(file)

    @path_to_default_spec_map[file] = spec
    @path_to_default_spec_map[file.sub(suffix_regexp, "")] = spec
  end
end

.ruby ⇒ Object

The path to the running Ruby interpreter.



804
805
806
807
808
809
810
811
812
 
# File 'lib/rubygems.rb', line 804

def self.ruby
  if @ruby.nil?
    @ruby = RbConfig.ruby

    @ruby = "\"#{@ruby}\"" if /\s/.match?(@ruby)
  end

  @ruby
end

.ruby_api_version ⇒ Object

Returns a String containing the API compatibility version of Ruby



817
818
819
 
# File 'lib/rubygems.rb', line 817

def self.ruby_api_version
  @ruby_api_version ||= RbConfig::CONFIG["ruby_version"].dup
end

.ruby_engine ⇒ Object 



208
209
210
 
# File 'lib/rubygems/defaults.rb', line 208

def self.ruby_engine
  RUBY_ENGINE
end

.ruby_version ⇒ Object

A Gem::Version for the currently running Ruby.



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/rubygems.rb', line 861

def self.ruby_version
  return @ruby_version if defined? @ruby_version
  version = RUBY_VERSION.dup

  if RUBY_PATCHLEVEL == -1
    if RUBY_ENGINE == "ruby"
      desc = RUBY_DESCRIPTION[/\Aruby #{Regexp.quote(RUBY_VERSION)}([^ ]+) /, 1]
    else
      desc = RUBY_DESCRIPTION[/\A#{RUBY_ENGINE} #{Regexp.quote(RUBY_ENGINE_VERSION)} \(#{RUBY_VERSION}([^ ]+)\) /, 1]
    end
    version << ".#{desc}" if desc
  end

  @ruby_version = Gem::Version.new version
end

.rubygems_version ⇒ Object

A Gem::Version for the currently running RubyGems



880
881
882
883
 
# File 'lib/rubygems.rb', line 880

def self.rubygems_version
  return @rubygems_version if defined? @rubygems_version
  @rubygems_version = Gem::Version.new Gem::VERSION
end

.solaris_platform? ⇒ Boolean

Is this platform Solaris?

Returns:

  • (Boolean) 


1009
1010
1011
 
# File 'lib/rubygems.rb', line 1009

def self.solaris_platform?
  RUBY_PLATFORM.include?("solaris")
end

.source_date_epoch ⇒ Object

Returns the value of Gem.source_date_epoch_string, as a Time object.

This is used throughout RubyGems for enabling reproducible builds.



1149
1150
1151
 
# File 'lib/rubygems.rb', line 1149

def self.source_date_epoch
  Time.at(source_date_epoch_string.to_i).utc.freeze
end

.source_date_epoch_string ⇒ Object

If the SOURCE_DATE_EPOCH environment variable is set, returns it’s value. Otherwise, returns the time that Gem.source_date_epoch_string was first called in the same format as SOURCE_DATE_EPOCH.

NOTE(@duckinator): The implementation is a tad weird because we want to:

1. Make builds reproducible by default, by having this function always
   return the same result during a given run.
2. Allow changing ENV['SOURCE_DATE_EPOCH'] at runtime, since multiple
   tests that set this variable will be run in a single process.

If you simplify this function and a lot of tests fail, that is likely due to #2 above.

Details on SOURCE_DATE_EPOCH: reproducible-builds.org/specs/source-date-epoch/



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/rubygems.rb', line 1130

def self.source_date_epoch_string
  # The value used if $SOURCE_DATE_EPOCH is not set.
  @default_source_date_epoch ||= Time.now.to_i.to_s

  specified_epoch = ENV["SOURCE_DATE_EPOCH"]

  # If it's empty or just whitespace, treat it like it wasn't set at all.
  specified_epoch = nil if !specified_epoch.nil? && specified_epoch.strip.empty?

  epoch = specified_epoch || @default_source_date_epoch

  epoch.strip
end

.sources ⇒ Object

Returns an Array of sources to fetch remote gems from. Uses default_sources if the sources list is empty.



889
890
891
892
 
# File 'lib/rubygems.rb', line 889

def self.sources
  source_list = configuration.sources || default_sources
  @sources ||= Gem::SourceList.from(source_list)
end

.sources=(new_sources) ⇒ Object

Need to be able to set the sources without calling Gem.sources.replace since that would cause an infinite loop.

DOC: This comment is not documentation about the method itself, it’s more of a code comment about the implementation.



901
902
903
904
905
906
907
 
# File 'lib/rubygems.rb', line 901

def self.sources=(new_sources)
  if !new_sources
    @sources = nil
  else
    @sources = Gem::SourceList.from(new_sources)
  end
end

.spec_cache_dir ⇒ Object 



400
401
402
 
# File 'lib/rubygems.rb', line 400

def self.spec_cache_dir
  paths.spec_cache_dir
end

.state_file ⇒ Object

The path to standard location of the user’s state file.



140
141
142
 
# File 'lib/rubygems/defaults.rb', line 140

def self.state_file
  @state_file ||= File.join(Gem.state_home, "gem", "last_update_check").tap(&Gem::UNTAINT)
end

.state_home ⇒ Object

The path to standard location of the user’s state directory.



161
162
163
 
# File 'lib/rubygems/defaults.rb', line 161

def self.state_home
  @state_home ||= (ENV["XDG_STATE_HOME"] || File.join(Gem.user_home, ".local", "state"))
end

.suffix_pattern ⇒ Object

Glob pattern for require-able path suffixes.



912
913
914
 
# File 'lib/rubygems.rb', line 912

def self.suffix_pattern
  @suffix_pattern ||= "{#{suffixes.join(",")}}"
end

.suffix_regexp ⇒ Object

Regexp for require-able path suffixes.



919
920
921
 
# File 'lib/rubygems.rb', line 919

def self.suffix_regexp
  @suffix_regexp ||= /#{Regexp.union(suffixes)}\z/
end

.suffixes ⇒ Object

Suffixes for require-able paths.



940
941
942
943
944
945
946
947
948
 
# File 'lib/rubygems.rb', line 940

def self.suffixes
  @suffixes ||= ["",
                 ".rb",
                 *%w[DLEXT DLEXT2].map do |key|
                   val = RbConfig::CONFIG[key]
                   next unless val && !val.empty?
                   ".#{val}"
                 end].compact.uniq
end

.time(msg, width = 0, display = Gem.configuration.verbose) ⇒ Object

Prints the amount of time the supplied block takes to run using the debug UI output.



954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/rubygems.rb', line 954

def self.time(msg, width = 0, display = Gem.configuration.verbose)
  now = Time.now

  value = yield

  elapsed = Time.now - now

  ui.say format("%2$*1$s: %3$3.3fs", -width, msg, elapsed) if display

  value
end

.try_activate(path) ⇒ Object

Try to activate a gem containing path. Returns true if activation succeeded or wasn’t needed because it was already activated. Returns false if it can’t find the path in a gem.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/rubygems.rb', line 192

def self.try_activate(path)
  # finds the _latest_ version... regardless of loaded specs and their deps
  # if another gem had a requirement that would mean we shouldn't
  # activate the latest version, then either it would already be activated
  # or if it was ambiguous (and thus unresolved) the code in our custom
  # require will try to activate the more specific version.

  spec = Gem::Specification.find_by_path path
  return false unless spec
  return true if spec.activated?

  begin
    spec.activate
  rescue Gem::LoadError => e # this could fail due to gem dep collisions, go lax
    spec_by_name = Gem::Specification.find_by_name(spec.name)
    if spec_by_name.nil?
      raise e
    else
      spec_by_name.activate
    end
  end

  true
end

.ui ⇒ Object

Lazily loads DefaultUserInteraction and returns the default UI.



969
970
971
972
973
 
# File 'lib/rubygems.rb', line 969

def self.ui
  require_relative "rubygems/user_interaction"

  Gem::DefaultUserInteraction.ui
end

.use_gemdeps(path = nil) ⇒ Object

Looks for a gem dependency file at path and activates the gems in the file if found. If the file is not found an ArgumentError is raised.

If path is not given the RUBYGEMS_GEMDEPS environment variable is used, but if no file is found no exception is raised.

If ‘-’ is given for path RubyGems searches up from the current working directory for gem dependency files (gem.deps.rb, Gemfile, Isolate) and activates the gems in the first one found.

You can run this automatically when rubygems starts. To enable, set the RUBYGEMS_GEMDEPS environment variable to either the path of your gem dependencies file or “-” to auto-discover in parent directories.

NOTE: Enabling automatic discovery on multiuser systems can lead to execution of arbitrary code when used from directories outside your control.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/rubygems.rb', line 1068

def self.use_gemdeps(path = nil)
  raise_exception = path

  path ||= ENV["RUBYGEMS_GEMDEPS"]
  return unless path

  path = path.dup

  if path == "-"
    Gem::Util.traverse_parents Dir.pwd do |directory|
      dep_file = GEM_DEP_FILES.find {|f| File.file?(f) }

      next unless dep_file

      path = File.join directory, dep_file
      break
    end
  end

  path.tap(&Gem::UNTAINT)

  unless File.file? path
    return unless raise_exception

    raise ArgumentError, "Unable to find gem dependencies file at #{path}"
  end

  ENV["BUNDLE_GEMFILE"] ||= File.expand_path(path)
  require_relative "rubygems/user_interaction"
  require "bundler"
  begin
    Gem::DefaultUserInteraction.use_ui(ui) do
      Bundler.ui.silence do
        @gemdeps = Bundler.setup
      end
    ensure
      Gem::DefaultUserInteraction.ui.close
    end
  rescue Bundler::BundlerError => e
    warn e.message
    warn "You may need to `bundle install` to install missing gems"
    warn ""
  end
end

.use_paths(home, *paths) ⇒ Object

Use the home and paths values for Gem.dir and Gem.path. Used mainly by the unit tests to provide environment isolation.



979
980
981
982
983
984
985
 
# File 'lib/rubygems.rb', line 979

def self.use_paths(home, *paths)
  paths.flatten!
  paths.compact!
  hash = { "GEM_HOME" => home, "GEM_PATH" => paths.empty? ? home : paths.join(File::PATH_SEPARATOR) }
  hash.delete_if {|_, v| v.nil? }
  self.paths = hash
end

.user_dir ⇒ Object

Path for gems in the user’s home directory



103
104
105
106
107
108
109
 
# File 'lib/rubygems/defaults.rb', line 103

def self.user_dir
  gem_dir = File.join(Gem.user_home, ".gem")
  gem_dir = File.join(Gem.data_home, "gem") unless File.exist?(gem_dir)
  parts = [gem_dir, ruby_engine]
  parts << RbConfig::CONFIG["ruby_version"] unless RbConfig::CONFIG["ruby_version"].empty?
  File.join parts
end

.user_home ⇒ Object

The home directory for the user.



96
97
98
 
# File 'lib/rubygems/defaults.rb', line 96

def self.user_home
  @user_home ||= find_home.tap(&Gem::UNTAINT)
end

.vendor_dir ⇒ Object

Directory where vendor gems are installed.



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/rubygems/defaults.rb', line 248

def self.vendor_dir # :nodoc:
  if vendor_dir = ENV["GEM_VENDOR"]
    return vendor_dir.dup
  end

  return nil unless RbConfig::CONFIG.key? "vendordir"

  File.join RbConfig::CONFIG["vendordir"], "gems",
            RbConfig::CONFIG["ruby_version"]
end

.win_platform? ⇒ Boolean

Is this a windows platform?

Returns:

  • (Boolean) 


990
991
992
993
994
995
996
997
 
# File 'lib/rubygems.rb', line 990

def self.win_platform?
  if @@win_platform.nil?
    ruby_platform = RbConfig::CONFIG["host_os"]
    @@win_platform = !WIN_PATTERNS.find {|r| ruby_platform =~ r }.nil?
  end

  @@win_platform
end

.write_binary(path, data) ⇒ Object

Safely write a file in binary mode on all platforms.



768
769
770
771
772
773
774
775
776
 
# File 'lib/rubygems.rb', line 768

def self.write_binary(path, data)
  open_file(path, "wb") do |io|
    io.write data
  end
rescue Errno::ENOSPC
  # If we ran out of space but the file exists, it's *guaranteed* to be corrupted.
  File.delete(path) if File.exist?(path)
  raise
end