Module: Gem

Extended by:
Deprecate
Defined in:
lib/rubygems/errors.rb,
lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/defaults.rb,
lib/rubygems/safe_yaml.rb,
lib/rubygems/syck_hack.rb,
lib/rubygems/test_case.rb,
lib/rubygems/util/list.rb,
lib/rubygems/psych_tree.rb

Overview

Now that we’ve got Syck setup in all the right places, store a reference to the DefaultKey class inside Gem. We do this so that if later on YAML, etc are redefined, we’ve still got a consistent place to find the DefaultKey class for comparison.

Defined Under Namespace

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

Constant Summary collapse

VERSION = 
"3.0.5".freeze
RUBYGEMS_DIR = 
File.dirname File.expand_path(__FILE__)
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
  specifications
].freeze
REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES =

Subdirectories in a gem repository for default gems

%w[
  gems
  specifications/default
].freeze
READ_BINARY_ERRORS =

Exception classes used in a Gem.read_binary rescue statement. Not all of these are defined in Ruby 1.8.7, hence the need for this convoluted setup.

begin
  read_binary_errors = [Errno::EACCES, Errno::EROFS, Errno::ENOSYS]
  read_binary_errors << Errno::ENOTSUP if Errno.const_defined?(:ENOTSUP)
  read_binary_errors
end.freeze
WRITE_BINARY_ERRORS =

Exception classes used in Gem.write_binary rescue statement. Not all of these are defined in Ruby 1.8.7.

begin
  write_binary_errors = [Errno::ENOSYS]
  write_binary_errors << Errno::ENOTSUP if Errno.const_defined?(:ENOTSUP)
  write_binary_errors
end.freeze
USE_BUNDLER_FOR_GEMDEPS =

:nodoc:

!ENV['DONT_USE_BUNDLER_FOR_GEMDEPS'] # :nodoc:
LOADED_SPECS_MUTEX = 
Mutex.new
MARSHAL_SPEC_DIR =

Location of Marshal quick gemspecs on remote repositories

"quick/Marshal.#{Gem.marshal_version}/".freeze
DEFAULT_HOST = 
"https://rubygems.org".freeze
SyckDefaultKey = 
YAML::Syck::DefaultKey
UnsatisfiableDepedencyError =

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

Gem::UnsatisfiableDependencyError
@@win_platform = 
nil

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Deprecate

deprecate, skip, skip=, skip_during

Class Attribute Details

.done_installing_hooks ⇒ Object (readonly)

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



1309
1310
1311
 
# File 'lib/rubygems.rb', line 1309

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.



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

def gemdeps
  @gemdeps
end

.loaded_specs ⇒ Object (readonly)

Hash of loaded Gem::Specification keyed by name



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

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



1297
1298
1299
 
# File 'lib/rubygems.rb', line 1297

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



1303
1304
1305
 
# File 'lib/rubygems.rb', line 1303

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.



1314
1315
1316
 
# File 'lib/rubygems.rb', line 1314

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



1320
1321
1322
 
# File 'lib/rubygems.rb', line 1320

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



1325
1326
1327
 
# File 'lib/rubygems.rb', line 1325

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.



1330
1331
1332
 
# File 'lib/rubygems.rb', line 1330

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



1336
1337
1338
 
# File 'lib/rubygems.rb', line 1336

def pre_uninstall_hooks
  @pre_uninstall_hooks
end

Class Method Details

.activate_bin_path(name, exec_name, requirement) ⇒ 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.



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

def self.activate_bin_path(name, exec_name, requirement) # :nodoc:
  spec = find_spec_for_exe name, exec_name, [requirement]
  Gem::LOADED_SPECS_MUTEX.synchronize do
    spec.activate
    finish_resolve
  end
  spec.bin_file exec_name
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.

Raises:

  • (ArgumentError) 


254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rubygems.rb', line 254

def self.bin_path(name, exec_name = nil, *requirements)
  # TODO: fails test_self_bin_path_bin_file_gone_in_latest
  # Gem::Specification.find_by_name(name, *requirements).bin_file exec_name

  raise ArgumentError, "you must supply exec_name" unless exec_name

  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.



314
315
316
 
# File 'lib/rubygems.rb', line 314

def self.binary_mode
  'rb'
end

.bindir(install_dir = Gem.dir) ⇒ Object

The path where gem executables are to be installed.



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

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

.clear_default_specs ⇒ Object

Clear default gem related variables. It is for test



1289
1290
1291
 
# File 'lib/rubygems.rb', line 1289

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.



332
333
334
335
336
337
 
# File 'lib/rubygems.rb', line 332

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.



342
343
344
 
# File 'lib/rubygems.rb', line 342

def self.config_file
  @config_file ||= File.join Gem.user_home, '.gemrc'
end

.configuration ⇒ Object

The standard configuration object for gems.



349
350
351
 
# File 'lib/rubygems.rb', line 349

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.



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

def self.configuration=(config)
  @configuration = config
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.



365
366
367
368
369
 
# File 'lib/rubygems.rb', line 365

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



117
118
119
120
121
122
123
 
# File 'lib/rubygems/defaults.rb', line 117

def self.default_bindir
  if defined? RUBY_FRAMEWORK_VERSION  # mac framework support
    '/usr/bin'
  else # generic install
    RbConfig::CONFIG['bindir']
  end
end

.default_cert_path ⇒ Object

The default signing certificate chain path



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

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

.default_dir ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rubygems/defaults.rb', line 30

def self.default_dir
  path = if defined? RUBY_FRAMEWORK_VERSION
           [
             File.dirname(RbConfig::CONFIG['sitedir']),
             'Gems',
             RbConfig::CONFIG['ruby_version']
           ]
         elsif RbConfig::CONFIG['rubylibprefix']
           [
             RbConfig::CONFIG['rubylibprefix'],
             'gems',
             RbConfig::CONFIG['ruby_version']
           ]
         else
           [
             RbConfig::CONFIG['libdir'],
             ruby_engine,
             'gems',
             RbConfig::CONFIG['ruby_version']
           ]
         end

  @default_dir ||= File.join(*path)
end

.default_exec_format ⇒ Object

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



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

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



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

def self.default_ext_dir_for(base_dir)
  nil
end

.default_gems_use_full_paths? ⇒ Boolean

Whether to expect full paths in default gems - true for non-MRI ruby implementations

Returns:

  • (Boolean) 


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

def self.default_gems_use_full_paths?
  ruby_engine != 'ruby'
end

.default_key_path ⇒ Object

The default signing key path



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

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

.default_path ⇒ Object

Default gem load path



92
93
94
95
96
97
98
 
# File 'lib/rubygems/defaults.rb', line 92

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



69
70
71
 
# File 'lib/rubygems/defaults.rb', line 69

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

def self.default_spec_cache_dir
  File.join Gem.user_home, '.gem', 'specs'
end

.deflate(data) ⇒ Object

A Zlib::Deflate.deflate wrapper



374
375
376
377
 
# File 'lib/rubygems.rb', line 374

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

.dir ⇒ Object

The path where gems are to be installed. – FIXME deprecate these once everything else has been done -ebh



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

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



779
780
781
 
# File 'lib/rubygems.rb', line 779

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.



458
459
460
 
# File 'lib/rubygems.rb', line 458

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.



445
446
447
 
# File 'lib/rubygems.rb', line 445

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

.ensure_subdirectories(dir, mode, subdirs) ⇒ Object

:nodoc:



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/rubygems.rb', line 462

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
    FileUtils.mkdir_p subdir, options rescue nil
  end
ensure
  File.umask old_umask
end

.env_requirement(gem_name) ⇒ Object 



911
912
913
914
915
916
917
 
# File 'lib/rubygems.rb', line 911

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.



485
486
487
488
489
490
491
 
# File 'lib/rubygems.rb', line 485

def self.extension_api_version # :nodoc:
  if 'no' == RbConfig::CONFIG['ENABLE_SHARED']
    "#{ruby_api_version}-static"
  else
    ruby_api_version
  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



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/rubygems.rb', line 505

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:



523
524
525
526
527
528
 
# File 'lib/rubygems.rb', line 523

def self.find_files_from_load_path(glob) # :nodoc:
  glob_with_suffixes = "#{glob}#{Gem.suffix_pattern}"
  $LOAD_PATH.map { |load_path|
    Gem::Util.glob_files_in_dir(glob_with_suffixes, load_path)
  }.flatten.select { |file| File.file? file.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.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/rubygems.rb', line 542

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



1272
1273
1274
 
# File 'lib/rubygems.rb', line 1272

def find_unresolved_default_spec(path)
  @path_to_default_spec_map[path]
end

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



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

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

.gunzip(data) ⇒ Object

Zlib::GzipReader wrapper that unzips data.



590
591
592
 
# File 'lib/rubygems.rb', line 590

def self.gunzip(data)
  Gem::Util.gunzip data
end

.gzip(data) ⇒ Object

Zlib::GzipWriter wrapper that zips data.



602
603
604
 
# File 'lib/rubygems.rb', line 602

def self.gzip(data)
  Gem::Util.gzip data
end

.host ⇒ Object

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



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

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

.host=(host) ⇒ Object

Set the default RubyGems API host.



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

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

.inflate(data) ⇒ Object

A Zlib::Inflate#inflate wrapper



614
615
616
 
# File 'lib/rubygems.rb', line 614

def self.inflate(data)
  Gem::Util.inflate data
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-3.0.1.gem (100%)
=> [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]



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

def self.install(name, version = Gem::Requirement.default, *options)
  require "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.



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

def self.install_extension_in_lib # :nodoc:
  true
end

.latest_rubygems_version ⇒ Object

Returns the latest release version of RubyGems.



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

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.



923
924
925
926
927
928
929
930
931
 
# File 'lib/rubygems.rb', line 923

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

  spec
end

.latest_version_for(name) ⇒ Object

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



944
945
946
947
 
# File 'lib/rubygems.rb', line 944

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



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/rubygems.rb', line 1115

def self.load_env_plugins
  path = "rubygems_plugin"

  files = []
  glob = "#{path}#{Gem.suffix_pattern}"
  $LOAD_PATH.each do |load_path|
    globbed = Gem::Util.glob_files_in_dir(glob, load_path)

    globbed.each do |load_path_file|
      files << load_path_file if File.file?(load_path_file.untaint)
    end
  end

  load_plugin_files files
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.



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

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
end

.load_plugin_files(plugins) ⇒ Object

Load plugins as Ruby files



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/rubygems.rb', line 1082

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 the ‘rubygems_plugin’ files in the latest installed gems and load them



1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/rubygems.rb', line 1103

def self.load_plugins
  # Remove this env var by at least 3.0
  if ENV['RUBYGEMS_LOAD_ALL_PLUGINS']
    load_plugin_files find_files('rubygems_plugin', false)
  else
    load_plugin_files find_latest_files('rubygems_plugin', false)
  end
end

.load_yaml ⇒ Object

Loads YAML, preferring Psych



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/rubygems.rb', line 671

def self.load_yaml
  return if @yaml_loaded
  return unless defined?(gem)

  begin
    gem 'psych', '>= 2.0.0'
  rescue Gem::LoadError
    # It's OK if the user does not have the psych gem installed.  We will
    # attempt to require the stdlib version
  end

  begin
    # Try requiring the gem version *or* stdlib version of psych.
    require 'psych'
  rescue ::LoadError
    # If we can't load psych, thats fine, go on.
  else
    # If 'yaml' has already been required, then we have to
    # be sure to switch it over to the newly loaded psych.
    if defined?(YAML::ENGINE) && YAML::ENGINE.yamler != "psych"
      YAML::ENGINE.yamler = "psych"
    end

    require 'rubygems/psych_additions'
    require 'rubygems/psych_tree'
  end

  require 'yaml'
  require 'rubygems/safe_yaml'

  # Now that we're sure some kind of yaml library is loaded, pull
  # in our hack to deal with Syck's DefaultKey ugliness.
  require 'rubygems/syck_hack'

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



722
723
724
725
726
727
728
 
# File 'lib/rubygems.rb', line 722

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.



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

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

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

Yields:

  • (rs) 


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

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

  yield rs

  finish_resolve rs
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



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

def self.operating_system_defaults
  {}
end

.path ⇒ Object 



428
429
430
 
# File 'lib/rubygems.rb', line 428

def self.path
  paths.path
end

.path_separator ⇒ Object

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



85
86
87
 
# File 'lib/rubygems/defaults.rb', line 85

def self.path_separator
  File::PATH_SEPARATOR
end

.paths ⇒ Object

Retrieve the PathSupport object that RubyGems uses to lookup files.



382
383
384
 
# File 'lib/rubygems.rb', line 382

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.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/rubygems.rb', line 392

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



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

def self.platform_defaults
  {}
end

.platforms ⇒ Object

Array of platforms this RubyGems supports.



747
748
749
750
751
752
753
 
# File 'lib/rubygems.rb', line 747

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



740
741
742
 
# File 'lib/rubygems.rb', line 740

def self.platforms=(platforms)
  @platforms = platforms
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.



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

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



770
771
772
 
# File 'lib/rubygems.rb', line 770

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.



787
788
789
 
# File 'lib/rubygems.rb', line 787

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



796
797
798
 
# File 'lib/rubygems.rb', line 796

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.



805
806
807
 
# File 'lib/rubygems.rb', line 805

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.



813
814
815
 
# File 'lib/rubygems.rb', line 813

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



822
823
824
 
# File 'lib/rubygems.rb', line 822

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.



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

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.



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/rubygems.rb', line 851

def self.read_binary(path)
  File.open path, 'rb+' do |f|
    f.flock(File::LOCK_EX)
    f.read
  end
rescue *READ_BINARY_ERRORS
  File.open path, 'rb' do |f|
    f.read
  end
rescue Errno::ENOLCK # NFS
  if Thread.main != Thread.current
    raise
  else
    File.open path, 'rb' do |f|
      f.read
    end
  end
end

.refresh ⇒ Object

Refresh available gems from disk.



844
845
846
 
# File 'lib/rubygems.rb', line 844

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.



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/rubygems.rb', line 1248

def register_default_spec(spec)
  new_format = Gem.default_gems_use_full_paths? || spec.require_paths.any? {|path| spec.files.any? {|f| f.start_with? path } }

  if new_format
    prefix_group = spec.require_paths.map {|f| f + "/"}.join("|")
    prefix_pattern = /^(#{prefix_group})/
  end

  suffix_pattern = /#{Regexp.union(Gem.suffixes)}\z/

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

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

.remove_unresolved_default_spec(spec) ⇒ Object

Remove needless Gem::Specification of default gem from unresolved default gem list



1280
1281
1282
1283
1284
 
# File 'lib/rubygems.rb', line 1280

def remove_unresolved_default_spec(spec)
  spec.files.each do |file|
    @path_to_default_spec_map.delete(file)
  end
end

.ruby ⇒ Object

The path to the running Ruby interpreter.



893
894
895
896
897
898
899
900
901
902
 
# File 'lib/rubygems.rb', line 893

def self.ruby
  if @ruby.nil?
    @ruby = File.join(RbConfig::CONFIG['bindir'],
                      "#{RbConfig::CONFIG['ruby_install_name']}#{RbConfig::CONFIG['EXEEXT']}")

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

  @ruby
end

.ruby=(ruby) ⇒ Object

Allows setting path to Ruby. This method is available when requiring ‘rubygems/test_case’



87
88
89
 
# File 'lib/rubygems/test_case.rb', line 87

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

.ruby_api_version ⇒ Object

Returns a String containing the API compatibility version of Ruby



907
908
909
 
# File 'lib/rubygems.rb', line 907

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

.ruby_engine ⇒ Object 



125
126
127
 
# File 'lib/rubygems/defaults.rb', line 125

def self.ruby_engine
  RUBY_ENGINE
end

.ruby_version ⇒ Object

A Gem::Version for the currently running Ruby.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/rubygems.rb', line 952

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



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

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

.searcher=(searcher) ⇒ Object

Allows setting the gem path searcher. This method is available when requiring ‘rubygems/test_case’



71
72
73
 
# File 'lib/rubygems/test_case.rb', line 71

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

.sources ⇒ Object

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



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

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.



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

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

.spec_cache_dir ⇒ Object 



432
433
434
 
# File 'lib/rubygems.rb', line 432

def self.spec_cache_dir
  paths.spec_cache_dir
end

.suffix_pattern ⇒ Object

Glob pattern for require-able path suffixes.



1005
1006
1007
 
# File 'lib/rubygems.rb', line 1005

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

.suffixes ⇒ Object

Suffixes for require-able paths.



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/rubygems.rb', line 1012

def self.suffixes
  @suffixes ||= ['',
                 '.rb',
                 *%w(DLEXT DLEXT2).map { |key|
                   val = RbConfig::CONFIG[key]
                   next unless val and not val.empty?
                   ".#{val}"
                 }
                ].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.



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/rubygems.rb', line 1027

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.



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

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.



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

def self.ui
  require 'rubygems/user_interaction'

  Gem::DefaultUserInteraction.ui
end

.use_gemdeps(path = nil) ⇒ Object Also known as: detect_gemdeps

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.



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/rubygems.rb', line 1151

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

  unless File.file? path
    return unless raise_exception

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

  if USE_BUNDLER_FOR_GEMDEPS

    ENV["BUNDLE_GEMFILE"] ||= File.expand_path(path)
    require 'rubygems/user_interaction'
    Gem::DefaultUserInteraction.use_ui(ui) do
      require "bundler"
      @gemdeps = Bundler.setup
      Bundler.ui = nil
      @gemdeps.requested_specs.map(&:to_spec).sort_by(&:name)
    end

  else

    rs = Gem::RequestSet.new
    @gemdeps = rs.load_gemdeps path

    rs.resolve_current.map do |s|
      s.full_spec.tap(&:activate)
    end

  end
rescue => e
  case e
  when Gem::LoadError, Gem::UnsatisfiableDependencyError, (defined?(Bundler::GemNotFound) ? Bundler::GemNotFound : Gem::LoadError)
    warn e.message
    warn "You may need to `gem install -g` to install missing gems"
    warn ""
  else
    raise
  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.



1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/rubygems.rb', line 1052

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



76
77
78
79
80
 
# File 'lib/rubygems/defaults.rb', line 76

def self.user_dir
  parts = [Gem.user_home, '.gem', 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.



1063
1064
1065
 
# File 'lib/rubygems.rb', line 1063

def self.user_home
  @user_home ||= find_home.untaint
end

.vendor_dir ⇒ Object

Directory where vendor gems are installed.



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

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=(val) ⇒ Object

Allows toggling Windows behavior. This method is available when requiring ‘rubygems/test_case’



79
80
81
 
# File 'lib/rubygems/test_case.rb', line 79

def self.win_platform=(val)
  @@win_platform = val
end

.win_platform? ⇒ Boolean

Is this a windows platform?

Returns:

  • (Boolean) 


1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/rubygems.rb', line 1070

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.



872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/rubygems.rb', line 872

def self.write_binary(path, data)
  open(path, 'wb') do |io|
    begin
      io.flock(File::LOCK_EX)
    rescue *WRITE_BINARY_ERRORS
    end
    io.write data
  end
rescue Errno::ENOLCK # NFS
  if Thread.main != Thread.current
    raise
  else
    open(path, 'wb') do |io|
      io.write data
    end
  end
end