Module: Gem

Extended by:
Deprecate
Defined in:
lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/defaults.rb,
lib/rubygems/deprecate.rb,
lib/rubygems/syck_hack.rb,
lib/rubygems/test_case.rb,
lib/rubygems/gem_openssl.rb,
lib/rubygems/source_index.rb,
lib/rubygems.rb

Overview

:stopdoc:

Defined Under Namespace

Modules: Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, InstallUpdateOptions, LocalRemoteOptions, Package, RequirePathsBuilder, SSL, Security, Text, UserInteraction, VersionOption Classes: Builder, Command, CommandLineError, CommandManager, ConfigFile, ConsoleUI, Dependency, DependencyError, DependencyInstaller, DependencyList, DependencyRemovalException, DocManager, DocumentError, EndOfYAMLException, ErrorReason, Exception, FakeFetcher, FilePermissionError, Format, FormatException, GemNotFoundException, GemNotInHomeException, GemPathSearcher, GemRunner, Indexer, InstallError, Installer, InstallerTestCase, InvalidSpecificationException, LoadError, MockGemUi, OldFormat, OperationNotSupportedError, PackageTask, PathSupport, Platform, PlatformMismatch, RemoteError, RemoteFetcher, RemoteInstallationCancelled, RemoteInstallationSkipped, RemoteSourceException, Requirement, Server, SilentUI, SourceIndex, SpecFetcher, Specification, StreamUI, SystemExitException, TestCase, Uninstaller, Validator, VerificationError, Version

Constant Summary collapse

QUICKLOADER_SUCKAGE = 
RUBY_VERSION =~ /^1\.9\.1/
GEM_PRELUDE_SUCKAGE = 
RUBY_VERSION =~ /^1\.9\.2/
VERSION = 
'1.8.15'
RubyGemsVersion =

:stopdoc:

VERSION
RbConfigPriorities = 
%w[
  EXEEXT RUBY_SO_NAME arch bindir datadir libdir ruby_install_name
  ruby_version rubylibprefix sitedir sitelibdir vendordir vendorlibdir
]
ConfigMap =

Configuration settings from ::RbConfig

Hash.new do |cm, key|
  cm[key] = RbConfig::CONFIG[key.to_s]
end
RubyGemsPackageVersion = 
VERSION
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,
]
MARSHAL_SPEC_DIR =

Location of Marshal quick gemspecs on remote repositories

"quick/Marshal.#{Gem.marshal_version}/"
SyckDefaultKey = 
YAML::Syck::DefaultKey
Cache =

Cache is an alias for SourceIndex to allow older YAMLized source index objects to load properly.

SourceIndex
@@source_index = 
nil
@@win_platform = 
nil

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Deprecate

deprecate, skip, skip=, skip_during

Class Attribute Details

.loaded_specs ⇒ Object (readonly)

Hash of loaded Gem::Specification keyed by name



1111
1112
1113
 
# File 'lib/rubygems.rb', line 1111

def loaded_specs
  @loaded_specs
end

.post_build_hooks ⇒ Object (readonly)

The list of hooks to be run before Gem::Install#install finishes installation



1117
1118
1119
 
# File 'lib/rubygems.rb', line 1117

def post_build_hooks
  @post_build_hooks
end

.post_install_hooks ⇒ Object (readonly)

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



1122
1123
1124
 
# File 'lib/rubygems.rb', line 1122

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.



1127
1128
1129
 
# File 'lib/rubygems.rb', line 1127

def post_reset_hooks
  @post_reset_hooks
end

.post_uninstall_hooks ⇒ Object (readonly)

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



1133
1134
1135
 
# File 'lib/rubygems.rb', line 1133

def post_uninstall_hooks
  @post_uninstall_hooks
end

.pre_install_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::Install#install is finished



1138
1139
1140
 
# File 'lib/rubygems.rb', line 1138

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.



1143
1144
1145
 
# File 'lib/rubygems.rb', line 1143

def pre_reset_hooks
  @pre_reset_hooks
end

.pre_uninstall_hooks ⇒ Object (readonly)

The list of hooks to be run after Gem::Uninstall#uninstall is finished



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

def pre_uninstall_hooks
  @pre_uninstall_hooks
end

.ssl_available=(value) ⇒ Object (writeonly)

Is SSL available?



26
27
28
 
# File 'lib/rubygems/gem_openssl.rb', line 26

def ssl_available=(value)
  @ssl_available = value
end

Class Method Details

.activate(dep, *requirements) ⇒ Object

Activates an installed gem matching dep. The gem must satisfy requirements.

Returns true if the gem is activated, false if it is already loaded, or an exception otherwise.

Gem#activate adds the library paths in dep to $LOAD_PATH. Before a Gem is activated its required Gems are activated. If the version information is omitted, the highest version Gem of the supplied name is loaded. If a Gem is not found that meets the version requirements or a required Gem is not found, a Gem::LoadError is raised.

More information on version requirements can be found in the Gem::Requirement and Gem::Version documentation.

Raises:

  • (ArgumentError) 


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

def self.activate(dep, *requirements)
  raise ArgumentError, "Deprecated use of Gem.activate(dep)" if
    Gem::Dependency === dep

  Gem::Specification.find_by_name(dep, *requirements).activate
end

.activate_dep(dep, *requirements) ⇒ Object

:nodoc:



238
239
240
 
# File 'lib/rubygems.rb', line 238

def self.activate_dep dep, *requirements # :nodoc:
  dep.to_spec.activate
end

.activate_spec(spec) ⇒ Object

:nodoc:



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

def self.activate_spec spec # :nodoc:
  spec.activate
end

.all_load_paths ⇒ Object

An Array of all possible load paths for all versions of all gems in the Gem installation.



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

def self.all_load_paths
  result = []

  Gem.path.each do |gemdir|
    each_load_path all_partials(gemdir) do |load_path|
      result << gemdir.add(load_path).expand_path
    end
  end

  result
end

.available?(dep, *requirements) ⇒ Boolean

See if a given gem is available.

Returns:

  • (Boolean) 


278
279
280
281
282
283
284
285
286
 
# File 'lib/rubygems.rb', line 278

def self.available?(dep, *requirements)
  requirements = Gem::Requirement.default if requirements.empty?

  unless dep.respond_to?(:name) and dep.respond_to?(:requirement) then
    dep = Gem::Dependency.new dep, requirements
  end

  not dep.matching_specs(true).empty?
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, 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) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/rubygems.rb', line 294

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?

  specs = Gem::Dependency.new(name, requirements).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_mode ⇒ Object

The mode needed to read a file as straight binary.



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

def self.binary_mode
  'rb'
end

.bindir(install_dir = Gem.dir) ⇒ Object

The path where gem executables are to be installed.



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

def self.bindir(install_dir=Gem.dir)
  # TODO: move to Gem::Dirs
  return File.join install_dir, 'bin' unless
    install_dir.to_s == Gem.default_dir.to_s
  Gem.default_bindir
end

.cache ⇒ Object

:nodoc:



1151
1152
1153
 
# File 'lib/rubygems.rb', line 1151

def self.cache # :nodoc:
  source_index
end

.cache_dir(custom_dir = false) ⇒ Object

Get the appropriate cache path.

Pass a string to use a different base path, or nil/false (default) for Gem.dir.



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

def self.cache_dir(custom_dir=false)
  File.join(custom_dir || Gem.dir, "cache")
end

.cache_gem(filename, user_dir = false) ⇒ Object

Given a gem path, find the gem in cache.

Pass a string as the second argument to use a different base path, or nil/false (default) for Gem.dir.



708
709
710
 
# File 'lib/rubygems.rb', line 708

def self.cache_gem(filename, user_dir=false)
  cache_dir(user_dir).add(filename)
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.



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

def self.clear_paths
  @@source_index = nil
  @paths         = nil
  @user_home     = nil
  @searcher      = nil
  Gem::Specification.reset
end

.config_file ⇒ Object

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



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

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

.configuration ⇒ Object

The standard configuration object for gems.



360
361
362
 
# File 'lib/rubygems.rb', line 360

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.



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

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

.datadir(gem_name) ⇒ Object

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



376
377
378
379
380
381
 
# File 'lib/rubygems.rb', line 376

def self.datadir(gem_name)
# TODO: deprecate
  spec = @loaded_specs[gem_name]
  return nil if spec.nil?
  File.join spec.full_gem_path, "data", gem_name
end

.default_bindir ⇒ Object

The default directory for binaries



81
82
83
84
85
86
87
 
# File 'lib/rubygems/defaults.rb', line 81

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

.default_dir ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rubygems/defaults.rb', line 21

def self.default_dir
  path = if defined? RUBY_FRAMEWORK_VERSION then
           [
             File.dirname(ConfigMap[:sitedir]),
             'Gems',
             ConfigMap[:ruby_version]
           ]
         elsif ConfigMap[:rubylibprefix] then
           [
            ConfigMap[:rubylibprefix],
            'gems',
            ConfigMap[:ruby_version]
           ]
         else
           [
             ConfigMap[:libdir],
             ruby_engine,
             'gems',
             ConfigMap[: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



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/rubygems/defaults.rb', line 67

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

  unless exec_format =~ /%s/ then
    raise Gem::Exception,
      "[BUG] invalid exec_format #{exec_format.inspect}, no %s"
  end

  exec_format
end

.default_path ⇒ Object

Default gem load path



56
57
58
59
60
61
62
 
# File 'lib/rubygems/defaults.rb', line 56

def self.default_path
  if File.exist? Gem.user_home then
    [user_dir, default_dir]
  else
    [default_dir]
  end
end

.default_sources ⇒ Object

An Array of the default sources that come with RubyGems



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

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

.default_system_source_cache_dir ⇒ Object

The default system-wide source info cache directory



92
93
94
 
# File 'lib/rubygems/defaults.rb', line 92

def self.default_system_source_cache_dir
  File.join(Gem.dir, 'source_cache')
end

.default_user_source_cache_dir ⇒ Object

The default user-specific source info cache directory



99
100
101
102
103
104
105
 
# File 'lib/rubygems/defaults.rb', line 99

def self.default_user_source_cache_dir
  #
  # NOTE Probably an argument for moving this to per-ruby supported dirs like
  # user_dir
  #
  File.join(Gem.user_home, '.gem', 'source_cache')
end

.deflate(data) ⇒ Object

A Zlib::Deflate.deflate wrapper



386
387
388
389
 
# File 'lib/rubygems.rb', line 386

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



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

def self.dir
  # TODO: raise "no"
  paths.home
end

.ensure_gem_subdirectories(dir = Gem.dir) ⇒ Object

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/rubygems.rb', line 444

def self.ensure_gem_subdirectories dir = Gem.dir
  require 'fileutils'

  old_umask = File.umask
  File.umask old_umask | 022

  %w[cache doc gems specifications].each do |name|
    subdir = File.join dir, name
    next if File.exist? subdir
    FileUtils.mkdir_p subdir rescue nil # in case of perms issues -- lame
  end
ensure
  File.umask old_umask
end

.ensure_ssl_available ⇒ Object

Ensure that SSL is available. Throw an exception if it is not.



31
32
33
34
35
 
# File 'lib/rubygems/gem_openssl.rb', line 31

def ensure_ssl_available
  unless ssl_available?
    raise Gem::Exception, "SSL is not installed on this system"
  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.



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/rubygems.rb', line 471

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

  if check_load_path
    files = $LOAD_PATH.map { |load_path|
      Dir["#{File.expand_path glob, load_path}#{Gem.suffix_pattern}"]
    }.flatten.select { |file| File.file? file.untaint }
  end

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

.gunzip(data) ⇒ Object

Zlib::GzipReader wrapper that unzips data.



534
535
536
537
538
539
540
541
 
# File 'lib/rubygems.rb', line 534

def self.gunzip(data)
  # TODO: move to utils
  require 'stringio'
  require 'zlib'
  data = StringIO.new data

  Zlib::GzipReader.new(data).read
end

.gzip(data) ⇒ Object

Zlib::GzipWriter wrapper that zips data.



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

def self.gzip(data)
  # TODO: move to utils
  require 'stringio'
  require 'zlib'
  zipped = StringIO.new

  Zlib::GzipWriter.wrap zipped do |io| io.write data end

  zipped.string
end

.host ⇒ Object

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



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

def self.host
  # TODO: move to utils
  @host ||= "https://rubygems.org"
end

.host=(host) ⇒ Object

Set the default RubyGems API host.



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

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

.inflate(data) ⇒ Object

A Zlib::Inflate#inflate wrapper



560
561
562
563
564
 
# File 'lib/rubygems.rb', line 560

def self.inflate(data)
  # TODO: move to utils
  require 'zlib'
  Zlib::Inflate.inflate data
end

.latest_load_paths ⇒ Object

Return a list of all possible load paths for the latest version for all gems in the Gem installation.



586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/rubygems.rb', line 586

def self.latest_load_paths
  result = []

  Gem.path.each do |gemdir|
    each_load_path(latest_partials(gemdir)) do |load_path|
      result << load_path
    end
  end

  result
end

.latest_rubygems_version ⇒ Object 



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

def self.latest_rubygems_version
  latest_version_for "rubygems-update"
end

.latest_spec_for(name) ⇒ Object 



908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/rubygems.rb', line 908

def self.latest_spec_for name
  dependency  = Gem::Dependency.new name
  fetcher     = Gem::SpecFetcher.fetcher
  spec_tuples = fetcher.find_matching dependency

  match = spec_tuples.select { |(n, _, p), _|
    n == name and Gem::Platform.match p
  }.sort_by { |(_, version, _), _|
    version
  }.last

  match and fetcher.fetch_spec(*match)
end

.latest_version_for(name) ⇒ Object 



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

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



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/rubygems.rb', line 1091

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

The index to insert activated gem paths into the $LOAD_PATH.

Defaults to the site lib directory unless gem_prelude.rb has loaded paths, then it inserts the activated gem’s paths before the gem_prelude.rb paths so you can override the gem_prelude.rb default $LOAD_PATH paths.



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/rubygems.rb', line 626

def self.load_path_insert_index
  index = $LOAD_PATH.index ConfigMap[:sitelibdir]

  if QUICKLOADER_SUCKAGE then
    $LOAD_PATH.each_with_index do |path, i|
      if path.instance_variables.include?(:@gem_prelude_index) or
          path.instance_variables.include?('@gem_prelude_index') then
        index = i
        break
      end
    end
  end

  index
end

.load_plugin_files(plugins) ⇒ Object

Load plugins as ruby files



1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/rubygems.rb', line 1064

def self.load_plugin_files(plugins)
  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 all ‘rubygems_plugin’ files in installed gems and load them



1084
1085
1086
 
# File 'lib/rubygems.rb', line 1084

def self.load_plugins
  load_plugin_files find_files('rubygems_plugin', false)
end

.load_yaml ⇒ Object

Loads YAML, preferring Psych



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/rubygems.rb', line 647

def self.load_yaml
  return if @yaml_loaded

  begin
    gem 'psych', '~> 1.2', '>= 1.2.1' unless ENV['TEST_SYCK']
  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' unless ENV['TEST_SYCK']
  rescue ::LoadError
  ensure
    require 'yaml'
  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

.loaded_path?(path) ⇒ Boolean

Returns:

  • (Boolean) 


987
988
989
990
991
 
# File 'lib/rubygems.rb', line 987

def self.loaded_path? path
  # TODO: ruby needs a feature to let us query what's loaded in 1.8 and 1.9
  re = /(^|\/)#{Regexp.escape path}#{Regexp.union(*Gem.suffixes)}$/
  $LOADED_FEATURES.any? { |s| s =~ re }
end

.location_of_caller ⇒ Object

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



675
676
677
678
679
680
681
682
 
# File 'lib/rubygems.rb', line 675

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

  # TODO: it is ALWAYS joined! STUPID!
  [file, lineno]
end

.marshal_version ⇒ Object

The version of the Marshal format for your Ruby.



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

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

.path ⇒ Object 



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

def self.path
  # TODO: raise "no"
  paths.path
end

.paths ⇒ Object 



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

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

.paths=(env) ⇒ Object 



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

def self.paths=(env)
  clear_paths
  @paths = Gem::PathSupport.new env
  Gem::Specification.dirs = @paths.path # FIX: home is at end
end

.platforms ⇒ Object

Array of platforms this RubyGems supports.



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

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



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

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.



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

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



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

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.



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

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



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

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.



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

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.



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

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



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

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.



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

def self.prefix
  prefix = File.dirname RUBYGEMS_DIR

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

.promote_load_path(gem_name, over_name) ⇒ Object

Promotes the load paths of the gem_name over the load paths of over_name. Useful for allowing one gem to override features in another using #find_files.

Raises:

  • (ArgumentError) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/rubygems.rb', line 812

def self.promote_load_path(gem_name, over_name)
  gem = Gem.loaded_specs[gem_name]
  over = Gem.loaded_specs[over_name]

  raise ArgumentError, "gem #{gem_name} is not activated" if gem.nil?
  raise ArgumentError, "gem #{over_name} is not activated" if over.nil?

  last_gem_path = Gem::Path.path(gem.full_gem_path).add(gem.require_paths.last)

  over_paths = over.require_paths.map do |path|
    Gem::Path.path(over.full_gem_path).add(path).to_s
  end

  over_paths.each do |path|
    $LOAD_PATH.delete path
  end

  gem = $LOAD_PATH.index(last_gem_path) + 1

  $LOAD_PATH.insert(gem, *over_paths)
end

.read_binary(path) ⇒ Object

Safely read a file in binary mode on all platforms.



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

def self.read_binary(path)
  File.open path, binary_mode do |f| f.read end
end

.refresh ⇒ Object

Refresh source_index from disk and clear searcher.



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

def self.refresh
  Gem::Specification.reset
  @source_index = nil
  @searcher = nil
end

.required_location(gemname, libfile, *requirements) ⇒ Object

Full path to libfile in gemname. Searches for the latest gem unless requirements is given.



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/rubygems.rb', line 878

def self.required_location(gemname, libfile, *requirements)
  requirements = Gem::Requirement.default if requirements.empty?

  matches = Gem::Specification.find_all_by_name gemname, *requirements

  return nil if matches.empty?

  spec = matches.last
  spec.require_paths.each do |path|
    result = Gem::Path.path(spec.full_gem_path).add(path, libfile)
    return result if result.exist?
  end

  nil
end

.ruby ⇒ Object

The path to the running Ruby interpreter.



897
898
899
900
901
902
903
904
905
906
 
# File 'lib/rubygems.rb', line 897

def self.ruby
  if @ruby.nil? then
    @ruby = File.join(ConfigMap[:bindir],
                      "#{ConfigMap[:ruby_install_name]}#{ConfigMap[: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’



60
61
62
 
# File 'lib/rubygems/test_case.rb', line 60

def self.ruby= ruby
  @ruby = ruby
end

.ruby_engine ⇒ Object

A wrapper around RUBY_ENGINE const that may not be defined



110
111
112
113
114
115
116
 
# File 'lib/rubygems/defaults.rb', line 110

def self.ruby_engine
  if defined? RUBY_ENGINE then
    RUBY_ENGINE
  else
    'ruby'
  end
end

.ruby_version ⇒ Object

A Gem::Version for the currently running ruby.



934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/rubygems.rb', line 934

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

.searcher ⇒ Object

The GemPathSearcher object used to search for matching installed gems.



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

def self.searcher
  @searcher ||= Gem::GemPathSearcher.new
end

.searcher=(searcher) ⇒ Object

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



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

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

.source_index ⇒ Object

Returns the Gem::SourceIndex of specifications that are in the Gem.path



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

def self.source_index
  @@source_index ||= Gem::Deprecate.skip_during do
    SourceIndex.new Gem::Specification.dirs
  end
end

.source_index=(si) ⇒ Object

Allows setting the default SourceIndex. This method is available when requiring ‘rubygems/test_case’



42
43
44
45
46
 
# File 'lib/rubygems/test_case.rb', line 42

def self.source_index=(si)
  raise "This method is not supported"
  Gem::Specification.reset if si # HACK
  @@source_index = si
end

.sources ⇒ Object

Returns an Array of sources to fetch remote gems from. If the sources list is empty, attempts to load the “sources” gem, then uses default_sources if it is not installed.



968
969
970
 
# File 'lib/rubygems.rb', line 968

def self.sources
  @sources ||= 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.



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

def self.sources= new_sources
  @sources = new_sources
end

.ssl_available? ⇒ Boolean

Is SSL (used by the signing commands) available on this platform?

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/rubygems/gem_openssl.rb', line 19

def ssl_available?
  @ssl_available
end

.suffix_pattern ⇒ Object

Glob pattern for require-able path suffixes.



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

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

.suffixes ⇒ Object

Suffixes for require-able paths.



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

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.



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

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.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/rubygems.rb', line 197

def self.try_activate path
  # TODO: deprecate when 1.9.3 comes out.
  # finds the _latest_ version... regardless of loaded specs and their deps

  # TODO: use find_all and bork if ambiguous

  spec = Gem::Specification.find_by_path path
  return false unless spec

  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

.ui ⇒ Object

Lazily loads DefaultUserInteraction and returns the default UI.



1026
1027
1028
1029
1030
 
# File 'lib/rubygems.rb', line 1026

def self.ui
  require 'rubygems/user_interaction'

  Gem::DefaultUserInteraction.ui
end

.unresolved_deps ⇒ Object 



246
247
248
 
# File 'lib/rubygems.rb', line 246

def self.unresolved_deps
  @unresolved_deps ||= Hash.new { |h, n| h[n] = Gem::Dependency.new n }
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.



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

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 }
  # TODO: self.paths = home, paths
end

.user_dir ⇒ Object

Path for gems in the user’s home directory



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

def self.user_dir
  File.join Gem.user_home, '.gem', ruby_engine, ConfigMap[:ruby_version]
end

.user_home ⇒ Object

The home directory for the user.



1046
1047
1048
 
# File 'lib/rubygems.rb', line 1046

def self.user_home
  @user_home ||= find_home
end

.win_platform=(val) ⇒ Object

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



52
53
54
 
# File 'lib/rubygems/test_case.rb', line 52

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

.win_platform? ⇒ Boolean

Is this a windows platform?

Returns:

  • (Boolean) 


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

def self.win_platform?
  if @@win_platform.nil? then
    @@win_platform = !!WIN_PATTERNS.find { |r| RUBY_PLATFORM =~ r }
  end

  @@win_platform
end