Module: Gem

Defined in:
lib/rubygems.rb,
lib/rubygems.rb

Constant Summary collapse

VERSION =
'2.5.1'
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,
]
GEM_DEP_FILES =
%w[
gem.deps.rb
Gemfile
Isolate
REPOSITORY_SUBDIRECTORIES =

Subdirectories in a gem repository

%w[
build_info
cache
doc
extensions
gems
specifications
REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES =

Subdirectories in a gem repository for default gems

%w[
gems
specifications/default
LOADED_SPECS_MUTEX =
Mutex.new
MARSHAL_SPEC_DIR =

Location of Marshal quick gemspecs on remote repositories

"quick/Marshal.#{Gem.marshal_version}/"
@@win_platform =
nil

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.done_installing_hooksObject (readonly)

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


1177
1178
1179
# File 'lib/rubygems.rb', line 1177

def done_installing_hooks
  @done_installing_hooks
end

.gemdepsObject (readonly)

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


1101
1102
1103
# File 'lib/rubygems.rb', line 1101

def gemdeps
  @gemdeps
end

.loaded_specsObject (readonly)

Hash of loaded Gem::Specification keyed by name


1095
1096
1097
# File 'lib/rubygems.rb', line 1095

def loaded_specs
  @loaded_specs
end

.post_build_hooksObject (readonly)

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


1165
1166
1167
# File 'lib/rubygems.rb', line 1165

def post_build_hooks
  @post_build_hooks
end

.post_install_hooksObject (readonly)

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


1171
1172
1173
# File 'lib/rubygems.rb', line 1171

def post_install_hooks
  @post_install_hooks
end

.post_reset_hooksObject (readonly)

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


1182
1183
1184
# File 'lib/rubygems.rb', line 1182

def post_reset_hooks
  @post_reset_hooks
end

.post_uninstall_hooksObject (readonly)

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


1188
1189
1190
# File 'lib/rubygems.rb', line 1188

def post_uninstall_hooks
  @post_uninstall_hooks
end

.pre_install_hooksObject (readonly)

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


1193
1194
1195
# File 'lib/rubygems.rb', line 1193

def pre_install_hooks
  @pre_install_hooks
end

.pre_reset_hooksObject (readonly)

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


1198
1199
1200
# File 'lib/rubygems.rb', line 1198

def pre_reset_hooks
  @pre_reset_hooks
end

.pre_uninstall_hooksObject (readonly)

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


1204
1205
1206
# File 'lib/rubygems.rb', line 1204

def pre_uninstall_hooks
  @pre_uninstall_hooks
end

Class Method Details

.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, the gem's default_executable is chosen, otherwise the specified executable's path is returned. requirements allows you to specify specific gem versions.

Raises:

  • (ArgumentError)

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/rubygems.rb', line 224

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?

  dep = Gem::Dependency.new name, requirements

  loaded = Gem.loaded_specs[name]

  return loaded.bin_file exec_name if loaded && dep.matches_spec?(loaded)

  specs = dep.matching_specs(true)

  raise Gem::GemNotFoundException,
        "can't find gem #{name} (#{requirements})" if specs.empty?

  specs = specs.find_all { |spec|
    spec.executables.include? exec_name
  } if exec_name

  unless spec = specs.last
    msg = "can't find gem #{name} (#{requirements}) with executable #{exec_name}"
    raise Gem::GemNotFoundException, msg
  end

  spec.bin_file exec_name
end

.binary_modeObject

The mode needed to read a file as straight binary.


259
260
261
# File 'lib/rubygems.rb', line 259

def self.binary_mode
  'rb'
end

.bindir(install_dir = Gem.dir) ⇒ Object

The path where gem executables are to be installed.


266
267
268
269
270
# File 'lib/rubygems.rb', line 266

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_specsObject

Clear default gem related variables. It is for test


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

def clear_default_specs
  @path_to_default_spec_map.clear
end

.clear_pathsObject

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.


277
278
279
280
281
282
# File 'lib/rubygems.rb', line 277

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

.config_fileObject

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


287
288
289
# File 'lib/rubygems.rb', line 287

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

.configurationObject

The standard configuration object for gems.


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

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.


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

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.


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

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

.deflate(data) ⇒ Object

A Zlib::Deflate.deflate wrapper


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

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

.dirObject

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


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

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


703
704
705
# File 'lib/rubygems.rb', line 703

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.


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

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.


368
369
370
# File 'lib/rubygems.rb', line 368

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

.ensure_subdirectories(dir, mode, subdirs) ⇒ Object

:nodoc:


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/rubygems.rb', line 385

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

.extension_api_versionObject

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


408
409
410
411
412
413
414
# File 'lib/rubygems.rb', line 408

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


428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'lib/rubygems.rb', line 428

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

  files = find_files_from_load_path glob if check_load_path

  files.concat Gem::Specification.stubs.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:


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

def self.find_files_from_load_path glob # :nodoc:
  $LOAD_PATH.map { |load_path|
    Dir["#{File.expand_path glob, load_path}#{Gem.suffix_pattern}"]
  }.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.


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

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


1136
1137
1138
1139
1140
1141
1142
# File 'lib/rubygems.rb', line 1136

def find_unresolved_default_spec(path)
  Gem.suffixes.each do |suffix|
    spec = @path_to_default_spec_map["#{path}#{suffix}"]
    return spec if spec
  end
  nil
end

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


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

def self.finish_resolve(request_set=Gem::RequestSet.new)
  request_set.import Gem::Specification.unresolved_deps.values

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

.gunzip(data) ⇒ Object

Zlib::GzipReader wrapper that unzips data.


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

def self.gunzip(data)
  require 'rubygems/util'
  Gem::Util.gunzip data
end

.gzip(data) ⇒ Object

Zlib::GzipWriter wrapper that zips data.


531
532
533
534
# File 'lib/rubygems.rb', line 531

def self.gzip(data)
  require 'rubygems/util'
  Gem::Util.gzip data
end

.hostObject

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


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

def self.host
  # TODO: move to utils
  @host ||= Gem::DEFAULT_HOST
end

.host=(host) ⇒ Object

Set the default RubyGems API host.


570
571
572
573
# File 'lib/rubygems.rb', line 570

def self.host= host
  # TODO: move to utils
  @host = host
end

.inflate(data) ⇒ Object

A Zlib::Inflate#inflate wrapper


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

def self.inflate(data)
  require 'rubygems/util'
  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", ...>]

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

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

.latest_rubygems_versionObject

Returns the latest release version of RubyGems.


831
832
833
834
# File 'lib/rubygems.rb', line 831

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.


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

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


839
840
841
842
# File 'lib/rubygems.rb', line 839

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

.load_env_pluginsObject

Find all 'rubygems_plugin' files in $LOAD_PATH and load them


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
# File 'lib/rubygems.rb', line 1002

def self.load_env_plugins
  path = "rubygems_plugin"

  files = []
  $LOAD_PATH.each do |load_path|
    globbed = Dir["#{File.expand_path path, load_path}#{Gem.suffix_pattern}"]

    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_indexObject

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


579
580
581
582
583
584
585
586
587
# File 'lib/rubygems.rb', line 579

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


969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
# File 'lib/rubygems.rb', line 969

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_pluginsObject

Find the 'rubygems_plugin' files in the latest installed gems and load them


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

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_yamlObject

Loads YAML, preferring Psych


594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'lib/rubygems.rb', line 594

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

  test_syck = ENV['TEST_SYCK']

  # Only Ruby 1.8 and 1.9 have syck
  test_syck = false unless /^1\./ =~ RUBY_VERSION

  unless test_syck
    begin
      gem 'psych', '>= 1.2.1'
    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
  end

  require 'yaml'

  # If we're supposed to be using syck, then we may have to force
  # activate it via the YAML::ENGINE API.
  if test_syck and defined?(YAML::ENGINE)
    YAML::ENGINE.yamler = "syck" unless YAML::ENGINE.syck?
  end

  # 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_callerObject

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


646
647
648
649
650
651
652
# File 'lib/rubygems.rb', line 646

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

  [file, lineno]
end

.marshal_versionObject

The version of the Marshal format for your Ruby.


657
658
659
# File 'lib/rubygems.rb', line 657

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

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

Yields:

  • (rs)

202
203
204
205
206
207
208
# File 'lib/rubygems.rb', line 202

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

  yield rs

  finish_resolve rs
end

.pathObject


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

def self.path
  paths.path
end

.pathsObject

Retrieve the PathSupport object that RubyGems uses to lookup files.


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

def self.paths
  @paths ||= Gem::PathSupport.new
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'


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

def self.paths=(env)
  clear_paths
  @paths = Gem::PathSupport.new env
  Gem::Specification.dirs = @paths.path
end

.platformsObject

Array of platforms this RubyGems supports.


671
672
673
674
675
676
677
# File 'lib/rubygems.rb', line 671

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


664
665
666
# File 'lib/rubygems.rb', line 664

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.


686
687
688
# File 'lib/rubygems.rb', line 686

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


694
695
696
# File 'lib/rubygems.rb', line 694

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.


711
712
713
# File 'lib/rubygems.rb', line 711

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


720
721
722
# File 'lib/rubygems.rb', line 720

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.


729
730
731
# File 'lib/rubygems.rb', line 729

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.


737
738
739
# File 'lib/rubygems.rb', line 737

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


746
747
748
# File 'lib/rubygems.rb', line 746

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

.prefixObject

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.


755
756
757
758
759
760
761
762
763
# File 'lib/rubygems.rb', line 755

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) then
    prefix
  end
end

.read_binary(path) ⇒ Object

Safely read a file in binary mode on all platforms.


775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
# File 'lib/rubygems.rb', line 775

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

.refreshObject

Refresh available gems from disk.


768
769
770
# File 'lib/rubygems.rb', line 768

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.


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

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

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

    @path_to_default_spec_map[file] = spec
  end
end

.remove_unresolved_default_spec(spec) ⇒ Object

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


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

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

.rubyObject

The path to the running Ruby interpreter.


797
798
799
800
801
802
803
804
805
806
# File 'lib/rubygems.rb', line 797

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

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

  @ruby
end

.ruby_api_versionObject

Returns a String containing the API compatibility version of Ruby


811
812
813
# File 'lib/rubygems.rb', line 811

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

.ruby_versionObject

A Gem::Version for the currently running Ruby.


847
848
849
850
851
852
853
854
855
856
857
858
# File 'lib/rubygems.rb', line 847

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

  if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1 then
    version << ".#{RUBY_PATCHLEVEL}"
  elsif defined?(RUBY_REVISION) then
    version << ".dev.#{RUBY_REVISION}"
  end

  @ruby_version = Gem::Version.new version
end

.rubygems_versionObject

A Gem::Version for the currently running RubyGems


863
864
865
866
# File 'lib/rubygems.rb', line 863

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

.sourcesObject

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


872
873
874
# File 'lib/rubygems.rb', line 872

def self.sources
  @sources ||= Gem::SourceList.from(default_sources)
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.


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

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

.spec_cache_dirObject


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

def self.spec_cache_dir
  paths.spec_cache_dir
end

.suffix_patternObject

Glob pattern for require-able path suffixes.


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

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

.suffixesObject

Suffixes for require-able paths.


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

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.


916
917
918
919
920
921
922
923
924
925
926
# File 'lib/rubygems.rb', line 916

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.


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

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 # this could fail due to gem dep collisions, go lax
    Gem::Specification.find_by_name(spec.name).activate
  end

  return true
end

.uiObject

Lazily loads DefaultUserInteraction and returns the default UI.


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

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.


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'lib/rubygems.rb', line 1037

def self.use_gemdeps path = nil
  raise_exception = path

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

  path = path.dup

  if path == "-" then
    require 'rubygems/util'

    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 then
    return unless raise_exception

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

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

  rs.resolve_current.map do |s|
    sp = s.full_spec
    sp.activate
    sp
  end
rescue Gem::LoadError, Gem::UnsatisfiableDependencyError => e
  warn e.message
  warn "You may need to `gem install -g` to install missing gems"
  warn ""
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.


941
942
943
944
945
# File 'lib/rubygems.rb', line 941

def self.use_paths(home, *paths)
  paths = nil if paths == [nil]
  paths = paths.first if Array === Array(paths).first
  self.paths = { "GEM_HOME" => home, "GEM_PATH" => paths }
end

.user_homeObject

The home directory for the user.


950
951
952
# File 'lib/rubygems.rb', line 950

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

.win_platform?Boolean

Is this a windows platform?

Returns:

  • (Boolean)

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

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

  @@win_platform
end