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/compatibility.rb,
lib/rubygems/tsort/lib/tsort.rb

Overview

Gem::TSort implements topological sorting using Tarjan’s algorithm for strongly connected components.

Gem::TSort is designed to be able to be used with any object which can be interpreted as a directed graph.

Gem::TSort requires two methods to interpret an object as a graph, tsort_each_node and tsort_each_child.

  • tsort_each_node is used to iterate for all nodes over a graph.

  • tsort_each_child is used to iterate for child nodes of a given node.

The equality of nodes are defined by eql? and hash since Gem::TSort uses Hash internally.

A Simple Example

The following example demonstrates how to mix the Gem::TSort module into an existing class (in this case, Hash). Here, we’re treating each key in the hash as a node in the graph, and so we simply alias the required #tsort_each_node method to Hash’s #each_key method. For each key in the hash, the associated value is an array of the node’s child nodes. This choice in turn leads to our implementation of the required #tsort_each_child method, which fetches the array of child nodes and then iterates over that array using the user-supplied block.

require 'rubygems/tsort/lib/tsort'

class Hash
  include Gem::TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

{1=>[2, 3], 2=>[3], 3=>[], 4=>[]}.tsort
#=> [3, 2, 1, 4]

{1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}.strongly_connected_components
#=> [[4], [2, 3], [1]]

A More Realistic Example

A very simple ‘make’ like tool can be implemented as follows:

require 'rubygems/tsort/lib/tsort'

class Make
  def initialize
    @dep = {}
    @dep.default = []
  end

  def rule(outputs, inputs=[], &block)
    triple = [outputs, inputs, block]
    outputs.each {|f| @dep[f] = [triple]}
    @dep[triple] = inputs
  end

  def build(target)
    each_strongly_connected_component_from(target) {|ns|
      if ns.length != 1
        fs = ns.delete_if {|n| Array === n}
        raise Gem::TSort::Cyclic.new("cyclic dependencies: #{fs.join ', '}")
      end
      n = ns.first
      if Array === n
        outputs, inputs, block = n
        inputs_time = inputs.map {|f| File.mtime f}.max
        begin
          outputs_time = outputs.map {|f| File.mtime f}.min
        rescue Errno::ENOENT
          outputs_time = nil
        end
        if outputs_time == nil ||
           inputs_time != nil && outputs_time <= inputs_time
          sleep 1 if inputs_time != nil && inputs_time.to_i == Time.now.to_i
          block.call
        end
      end
    }
  end

  def tsort_each_child(node, &block)
    @dep[node].each(&block)
  end
  include Gem::TSort
end

def command(arg)
  print arg, "\n"
  system arg
end

m = Make.new
m.rule(%w[t1]) { command 'date > t1' }
m.rule(%w[t2]) { command 'date > t2' }
m.rule(%w[t3]) { command 'date > t3' }
m.rule(%w[t4], %w[t1 t3]) { command 'cat t1 t3 > t4' }
m.rule(%w[t5], %w[t4 t2]) { command 'cat t4 t2 > t5' }
m.build('t5')

Bugs

  • ‘tsort.rb’ is wrong name because this library uses Tarjan’s algorithm for strongly connected components. Although ‘strongly_connected_components.rb’ is correct but too long.

References

    1. Tarjan, “Depth First Search and Linear Graph Algorithms”,

SIAM Journal on Computing, Vol. 1, No. 2, pp. 146-160, June 1972.

Defined Under Namespace

Modules: BundlerVersionFinder, Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, InstallUpdateOptions, InstallerUninstallerUtils, LocalRemoteOptions, QueryUtils, SafeYAML, Security, SecurityOption, TSort, Text, UserInteraction, Util, VersionOption 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, MockGemUi, 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

Constant Summary collapse

VERSION = 
"3.3.11".freeze
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{}
KERNEL_WARN_IGNORES_INTERNAL_ENTRIES =

When bugs.ruby-lang.org/issues/17259 is available, there is no need to override Kernel#warn

RUBY_ENGINE == "truffleruby" ||
(RUBY_ENGINE == "ruby" && RUBY_VERSION >= '3.0')
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}/".freeze
HAVE_OPENSSL =

:nodoc:

defined? OpenSSL::SSL # :nodoc:
DEFAULT_HOST = 
"https://rubygems.org".freeze
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.



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

def disable_system_update_message
  @disable_system_update_message
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.



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

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` entries during `require`.



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

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.



594
595
596
597
598
599
 
# File 'lib/rubygems.rb', line 594

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.



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

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.



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

def self.binary_mode
  'rb'
end

.bindir(install_dir = Gem.dir) ⇒ Object

The path where gem executables are to be installed.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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

.data_home ⇒ Object

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



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

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

.datadir(gem_name) ⇒ Object

The path to the data directory specified by the gem name. If the package is not available as a gem, return nil.



346
347
348
349
350
 
# File 'lib/rubygems.rb', line 346

def self.datadir(gem_name)
  spec = @loaded_specs[gem_name]
  return nil if spec.nil?
  spec.datadir
end

.default_bindir ⇒ Object

The default directory for binaries



185
186
187
 
# File 'lib/rubygems/defaults.rb', line 185

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

.default_cert_path ⇒ Object

The default signing certificate chain path



209
210
211
212
213
214
215
216
217
 
# File 'lib/rubygems/defaults.rb', line 209

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



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

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



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/rubygems/defaults.rb', line 171

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

  unless exec_format =~ /%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



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

def self.default_ext_dir_for(base_dir)
  nil
end

.default_key_path ⇒ Object

The default signing key path



196
197
198
199
200
201
202
203
204
 
# File 'lib/rubygems/defaults.rb', line 196

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



160
161
162
163
164
165
166
 
# File 'lib/rubygems/defaults.rb', line 160

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

.default_rubygems_dirs ⇒ Object

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



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

def self.default_rubygems_dirs
  nil # default to standard layout
end

.default_sources ⇒ Object

An Array of the default sources that come with RubyGems



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

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



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

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.



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

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

.deflate(data) ⇒ Object

A Zlib::Deflate.deflate wrapper



355
356
357
358
 
# File 'lib/rubygems.rb', line 355

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

.dir ⇒ Object

The path where gems are to be installed.



403
404
405
 
# File 'lib/rubygems.rb', line 403

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



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

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.



437
438
439
 
# File 'lib/rubygems.rb', line 437

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.



424
425
426
 
# File 'lib/rubygems.rb', line 424

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

.ensure_subdirectories(dir, mode, subdirs) ⇒ Object

:nodoc:



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/rubygems.rb', line 441

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

  require 'fileutils'

  options = {}

  options[:mode] = mode if mode

  subdirs.each do |name|
    subdir = File.join dir, name
    next if File.exist? subdir
    begin
      FileUtils.mkdir_p subdir, **options
    rescue SystemCallError
    end
  end
ensure
  File.umask old_umask
end

.env_requirement(gem_name) ⇒ Object 



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

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'.freeze
    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.



467
468
469
470
471
472
473
 
# File 'lib/rubygems.rb', line 467

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

.find_config_file ⇒ Object

Finds the user’s config file



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

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



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/rubygems.rb', line 487

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

  return files
end

.find_files_from_load_path(glob) ⇒ Object

:nodoc:



505
506
507
508
509
510
 
# File 'lib/rubygems.rb', line 505

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.



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/rubygems.rb', line 524

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

  return 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 



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

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.



559
560
561
 
# File 'lib/rubygems.rb', line 559

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

.host=(host) ⇒ Object

Set the default RubyGems API host.



565
566
567
 
# File 'lib/rubygems.rb', line 565

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", ...>]



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

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.



222
223
224
 
# File 'lib/rubygems/defaults.rb', line 222

def self.install_extension_in_lib # :nodoc:
  true
end

.java_platform? ⇒ Boolean

Is this a java platform?

Returns:

  • (Boolean) 


1007
1008
1009
 
# File 'lib/rubygems.rb', line 1007

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

.latest_rubygems_version ⇒ Object

Returns the latest release version of RubyGems.



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

def self.latest_rubygems_version
  latest_version_for('rubygems-update') or
    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.



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

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



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

def self.latest_version_for(name)
  spec = latest_spec_for name
  spec and spec.version
end

.load_env_plugins ⇒ Object

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



1050
1051
1052
 
# File 'lib/rubygems.rb', line 1050

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.



573
574
575
576
577
578
579
580
581
 
# File 'lib/rubygems.rb', line 573

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



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/rubygems.rb', line 1021

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 plugin =~ /gemcutter-0\.[0-3]/

    begin
      load plugin
    rescue ::Exception => 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



1041
1042
1043
1044
1045
 
# File 'lib/rubygems.rb', line 1041

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

Loads YAML, preferring Psych



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

def self.load_yaml
  return if @yaml_loaded

  require 'psych'
  require_relative 'rubygems/psych_additions'
  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)



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

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.



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

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

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

Yields:

  • (rs) 


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

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



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

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



255
256
257
 
# File 'lib/rubygems/defaults.rb', line 255

def self.operating_system_defaults
  {}
end

.path ⇒ Object 



407
408
409
 
# File 'lib/rubygems.rb', line 407

def self.path
  paths.path
end

.path_separator ⇒ Object

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



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

def self.path_separator
  File::PATH_SEPARATOR
end

.paths ⇒ Object

Retrieve the PathSupport object that RubyGems uses to lookup files.



363
364
365
 
# File 'lib/rubygems.rb', line 363

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.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/rubygems.rb', line 373

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 "Array values in the parameter to `Gem.paths=` are deprecated.\nPlease use a String or nil.\nAn Array (\#{env.inspect}) was passed in from \#{caller[3]}\n          EOWARN\n        end\n        target[k] = v.join File::PATH_SEPARATOR\n      end\n    else\n      target[k] = v\n    end\n  end\n  @paths = Gem::PathSupport.new ENV.to_hash.merge(target)\n  Gem::Specification.dirs = @paths.path\nend\n"

.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



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

def self.platform_defaults
  {}
end

.platforms ⇒ Object

Array of platforms this RubyGems supports.



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

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).



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

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

.plugin_suffix_pattern ⇒ Object

Glob pattern for require-able plugin suffixes.



930
931
932
 
# File 'lib/rubygems.rb', line 930

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

.plugin_suffix_regexp ⇒ Object

Regexp for require-able plugin suffixes.



937
938
939
 
# File 'lib/rubygems.rb', line 937

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.



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

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.



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

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



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

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.



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

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



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

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.



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

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.



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

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



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

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.



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

def self.prefix
  prefix = File.dirname RUBYGEMS_DIR

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

.read_binary(path) ⇒ Object

Safely read a file in binary mode on all platforms.



761
762
763
764
765
766
767
768
769
 
# File 'lib/rubygems.rb', line 761

def self.read_binary(path)
  open_file(path, 'rb+') do |io|
    io.read
  end
rescue Errno::EACCES, Errno::EROFS
  open_file(path, 'rb') do |io|
    io.read
  end
end

.refresh ⇒ Object

Refresh available gems from disk.



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

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.



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

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

    @ruby = "\"#{@ruby}\"" if @ruby =~ /\s/
  end

  @ruby
end

.ruby_api_version ⇒ Object

Returns a String containing the API compatibility version of Ruby



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

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

.ruby_engine ⇒ Object 



189
190
191
 
# File 'lib/rubygems/defaults.rb', line 189

def self.ruby_engine
  RUBY_ENGINE
end

.ruby_version ⇒ Object

A Gem::Version for the currently running Ruby.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/rubygems.rb', line 863

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

  if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1
    version << ".#{RUBY_PATCHLEVEL}"
  elsif defined?(RUBY_DESCRIPTION)
    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



884
885
886
887
 
# File 'lib/rubygems.rb', line 884

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) 


1014
1015
1016
 
# File 'lib/rubygems.rb', line 1014

def self.solaris_platform?
  RUBY_PLATFORM =~ /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.



1157
1158
1159
 
# File 'lib/rubygems.rb', line 1157

def self.source_date_epoch
  Time.at(self.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/



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/rubygems.rb', line 1138

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.



893
894
895
896
 
# File 'lib/rubygems.rb', line 893

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.



905
906
907
908
909
910
911
 
# File 'lib/rubygems.rb', line 905

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

.spec_cache_dir ⇒ Object 



411
412
413
 
# File 'lib/rubygems.rb', line 411

def self.spec_cache_dir
  paths.spec_cache_dir
end

.suffix_pattern ⇒ Object

Glob pattern for require-able path suffixes.



916
917
918
 
# File 'lib/rubygems.rb', line 916

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

.suffix_regexp ⇒ Object

Regexp for require-able path suffixes.



923
924
925
 
# File 'lib/rubygems.rb', line 923

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

.suffixes ⇒ Object

Suffixes for require-able paths.



944
945
946
947
948
949
950
951
952
953
 
# File 'lib/rubygems.rb', line 944

def self.suffixes
  @suffixes ||= ['',
                 '.rb',
                 *%w[DLEXT DLEXT2].map do |key|
                   val = RbConfig::CONFIG[key]
                   next unless val and not 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.



959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/rubygems.rb', line 959

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

  value = yield

  elapsed = Time.now - now

  ui.say "%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.



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

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

  return true
end

.ui ⇒ Object

Lazily loads DefaultUserInteraction and returns the default UI.



974
975
976
977
978
 
# File 'lib/rubygems.rb', line 974

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.



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
1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/rubygems.rb', line 1074

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
      begin
        Bundler.ui.silence do
          @gemdeps = Bundler.setup
        end
      ensure
        Gem::DefaultUserInteraction.ui.close
      end
    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.



984
985
986
987
988
989
990
 
# File 'lib/rubygems.rb', line 984

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



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

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.



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

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

.vendor_dir ⇒ Object

Directory where vendor gems are installed.



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

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) 


995
996
997
998
999
1000
1001
1002
 
# File 'lib/rubygems.rb', line 995

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

  @@win_platform
end

.write_binary(path, data) ⇒ Object

Safely write a file in binary mode on all platforms.



773
774
775
776
777
 
# File 'lib/rubygems.rb', line 773

def self.write_binary(path, data)
  open_file(path, 'wb') do |io|
    io.write data
  end
end