Module: Gem

Defined in:
lib/rubygems/errors.rb,
lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/defaults.rb,
lib/rubygems/syck_hack.rb,
lib/rubygems/test_case.rb,
lib/rubygems/psych_tree.rb,
lib/rubygems/request_set.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/dependency_resolver.rb

Overview

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

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

Defined Under Namespace

Modules: Commands, DefaultUserInteraction, Deprecate, Ext, GemcutterUtilities, InstallUpdateOptions, LocalRemoteOptions, Security, Text, UserInteraction, VersionOption Classes: AvailableSet, Command, CommandLineError, CommandManager, ConfigFile, ConsoleUI, Dependency, DependencyError, DependencyInstaller, DependencyList, DependencyRemovalException, DependencyResolutionError, DependencyResolver, Doctor, DocumentError, EndOfYAMLException, ErrorReason, Exception, FakeFetcher, FilePermissionError, FormatException, GemNotFoundException, GemNotInHomeException, GemRunner, ImpossibleDependenciesError, Indexer, InstallError, Installer, InstallerTestCase, InvalidSpecificationException, LoadError, MockGemUi, NameTuple, NoAliasYAMLTree, OperationNotSupportedError, Package, PackageTask, PathSupport, Platform, PlatformMismatch, RDoc, RemoteError, RemoteFetcher, RemoteInstallationCancelled, RemoteInstallationSkipped, RemoteSourceException, RequestSet, Requirement, Server, SilentUI, Source, SourceFetchProblem, SourceList, SpecFetcher, SpecificGemNotFoundException, Specification, StreamUI, SystemExitException, TestCase, Uninstaller, UnsatisfiableDepedencyError, Validator, VerificationError, Version

Constant Summary collapse

VERSION = 
'2.0.15'
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
  gems
  specifications
]
MARSHAL_SPEC_DIR =

Location of Marshal quick gemspecs on remote repositories

"quick/Marshal.#{Gem.marshal_version}/"
DEFAULT_HOST = 
"https://rubygems.org"
SyckDefaultKey = 
YAML::Syck::DefaultKey
RubyGemsVersion = 
VERSION
RbConfigPriorities = 
%w[
  EXEEXT RUBY_SO_NAME arch bindir datadir libdir ruby_install_name
  ruby_version rubylibprefix sitedir sitelibdir vendordir vendorlibdir
  rubylibdir
]
ConfigMap =

Configuration settings from ::RbConfig

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

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.done_installing_hooks ⇒ Object (readonly)

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



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

def done_installing_hooks
  @done_installing_hooks
end

.loaded_specs ⇒ Object (readonly)

Hash of loaded Gem::Specification keyed by name



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

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



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

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



1020
1021
1022
 
# File 'lib/rubygems.rb', line 1020

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.



1031
1032
1033
 
# File 'lib/rubygems.rb', line 1031

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



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

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



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

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.



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

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



1053
1054
1055
 
# File 'lib/rubygems.rb', line 1053

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) 


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/rubygems.rb', line 258

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.



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

def self.binary_mode
  'rb'
end

.bindir(install_dir = Gem.dir) ⇒ Object

The path where gem executables are to be installed.



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

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

.clear_default_specs ⇒ Object

Clear default gem related varibles. It is for test



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

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.



306
307
308
309
310
311
 
# File 'lib/rubygems.rb', line 306

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.



316
317
318
 
# File 'lib/rubygems.rb', line 316

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

.configuration ⇒ Object

The standard configuration object for gems.



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

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.



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

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.



339
340
341
342
343
344
345
 
# File 'lib/rubygems.rb', line 339

def self.datadir(gem_name)
# TODO: deprecate and move to Gem::Specification
#       and drop the extra ", gem_name" which is uselessly redundant
  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



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

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

.default_cert_path ⇒ Object

The default signing certificate chain path



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

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



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



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/rubygems/defaults.rb', line 83

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

The default signing key path



119
120
121
 
# File 'lib/rubygems/defaults.rb', line 119

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

.default_path ⇒ Object

Default gem load path



72
73
74
75
76
77
78
 
# File 'lib/rubygems/defaults.rb', line 72

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

.default_rubygems_dirs ⇒ Object

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



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

def self.default_rubygems_dirs
  nil # default to standard layout
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[https://rubygems.org/]
end

.deflate(data) ⇒ Object

A Zlib::Deflate.deflate wrapper



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

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

.detect_gemdeps ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
 
# File 'lib/rubygems.rb', line 208

def self.detect_gemdeps
  if path = ENV['RUBYGEMS_GEMDEPS']
    path = path.dup.untaint

    if path == "-"
      here = Dir.pwd.untaint
      start = here

      begin
        while true
          path = GEM_DEP_FILES.find { |f| File.file?(f) }

          if path
            path = File.join here, path
            break
          end

          Dir.chdir ".."

          # If we're at a toplevel, stop.
          return if Dir.pwd == here

          here = Dir.pwd
        end
      ensure
        Dir.chdir start
      end
    end

    path.untaint

    return unless File.file? path

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

    rs.resolve_current.map do |s|
      sp = s.full_spec
      sp.activate
      sp
    end
  end
end

.dir ⇒ Object

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



372
373
374
375
 
# File 'lib/rubygems.rb', line 372

def self.dir
  # TODO: raise "no"
  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



676
677
678
 
# File 'lib/rubygems.rb', line 676

def self.done_installing(&hook)
  @done_installing_hooks << hook
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.



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/rubygems.rb', line 391

def self.ensure_gem_subdirectories dir = Gem.dir, mode = nil
  old_umask = File.umask
  File.umask old_umask | 002

  require 'fileutils'

  options = {}

  options[:mode] = mode if mode

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

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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/rubygems.rb', line 422

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

.find_unresolved_default_spec(path) ⇒ Object

Find a Gem::Specification of default gem from path



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

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 



200
201
202
203
204
205
206
 
# File 'lib/rubygems.rb', line 200

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.



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

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

  unzipped = Zlib::GzipReader.new(data).read
  unzipped.force_encoding Encoding::BINARY if Object.const_defined? :Encoding
  unzipped
end

.gzip(data) ⇒ Object

Zlib::GzipWriter wrapper that zips data.



499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/rubygems.rb', line 499

def self.gzip(data)
  # TODO: move to utils
  require 'stringio'
  require 'zlib'
  zipped = StringIO.new
  zipped.set_encoding Encoding::BINARY if Object.const_defined? :Encoding

  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.



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

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

.host=(host) ⇒ Object

Set the default RubyGems API host.



546
547
548
549
 
# File 'lib/rubygems.rb', line 546

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

.inflate(data) ⇒ Object

A Zlib::Inflate#inflate wrapper



514
515
516
517
518
 
# File 'lib/rubygems.rb', line 514

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

.install(name, version = Gem::Requirement.default) ⇒ 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", ...>]



528
529
530
531
532
533
 
# File 'lib/rubygems.rb', line 528

def self.install name, version = Gem::Requirement.default
  require "rubygems/dependency_installer"
  inst = Gem::DependencyInstaller.new
  inst.install name, version
  inst.installed_gems
end

.latest_rubygems_version ⇒ Object

Returns the latest release version of RubyGems.



782
783
784
785
 
# File 'lib/rubygems.rb', line 782

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.



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

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



790
791
792
793
 
# File 'lib/rubygems.rb', line 790

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



948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/rubygems.rb', line 948

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.



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

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

  index
end

.load_plugin_files(plugins) ⇒ Object

Load plugins as ruby files



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/rubygems.rb', line 921

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



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

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

.load_yaml ⇒ Object

Loads YAML, preferring Psych



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/rubygems.rb', line 569

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

  test_syck = ENV['TEST_SYCK']

  unless test_syck
    begin
      gem 'psych', '~> 1.2', '>= 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_caller ⇒ Object

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



618
619
620
621
622
623
624
625
 
# File 'lib/rubygems.rb', line 618

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.



630
631
632
 
# File 'lib/rubygems.rb', line 630

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

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

Yields:

  • (rs) 


192
193
194
195
196
197
198
 
# File 'lib/rubygems.rb', line 192

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

  yield rs

  finish_resolve rs
end

.path ⇒ Object 



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

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

.path_separator ⇒ Object

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



65
66
67
 
# File 'lib/rubygems/defaults.rb', line 65

def self.path_separator
  File::PATH_SEPARATOR
end

.paths ⇒ Object

DOC: needs doc’d or :nodoc’d



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

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

.paths=(env) ⇒ Object

DOC: needs doc’d or :nodoc’d



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

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.



644
645
646
647
648
649
650
 
# File 'lib/rubygems.rb', line 644

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



637
638
639
 
# File 'lib/rubygems.rb', line 637

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.



659
660
661
 
# File 'lib/rubygems.rb', line 659

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



667
668
669
 
# File 'lib/rubygems.rb', line 667

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.



684
685
686
 
# File 'lib/rubygems.rb', line 684

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



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

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.



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

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.



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

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



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

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.



728
729
730
731
732
733
734
735
736
 
# File 'lib/rubygems.rb', line 728

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

.read_binary(path) ⇒ Object

Safely read a file in binary mode on all platforms.



748
749
750
 
# File 'lib/rubygems.rb', line 748

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

.refresh ⇒ Object

Refresh available gems from disk.



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

def self.refresh
  Gem::Specification.reset
end

.register_default_spec(spec) ⇒ Object

Register a Gem::Specification for default gem



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

def register_default_spec(spec)
  spec.files.each do |file|
    @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



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

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.



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

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’



64
65
66
 
# File 'lib/rubygems/test_case.rb', line 64

def self.ruby= ruby
  @ruby = ruby
end

.ruby_engine ⇒ Object

A wrapper around RUBY_ENGINE const that may not be defined



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

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.



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

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

A Gem::Version for the currently running RubyGems



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

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’



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

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.



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

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.



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

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

.suffix_pattern ⇒ Object

Glob pattern for require-able path suffixes.



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

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

.suffixes ⇒ Object

Suffixes for require-able paths.



852
853
854
855
856
857
858
859
860
861
 
# File 'lib/rubygems.rb', line 852

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.



867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/rubygems.rb', line 867

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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/rubygems.rb', line 168

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 alreaby be activated
  # or if it was ambigious (and thus unresolved) the code in our custom
  # require will try to activate the more specific version.

  spec = Gem::Specification.find_inactive_by_path path

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

  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.



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

def self.ui
  require 'rubygems/user_interaction'

  Gem::DefaultUserInteraction.ui
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.



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

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



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

def self.user_dir
  parts = [Gem.user_home, '.gem', ruby_engine]
  parts << ConfigMap[:ruby_version] unless ConfigMap[:ruby_version].empty?
  File.join parts
end

.user_home ⇒ Object

The home directory for the user.



902
903
904
 
# File 'lib/rubygems.rb', line 902

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

.win_platform=(val) ⇒ Object

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



56
57
58
 
# File 'lib/rubygems/test_case.rb', line 56

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

.win_platform? ⇒ Boolean

Is this a windows platform?

Returns:

  • (Boolean) 


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

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