123456789_123456789_123456789_123456789_123456789_

Module: Gem

Relationships & Source Files
Namespace Children
Modules:
Classes:
Exceptions:
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Deprecate
Defined in: lib/rubygems.rb,
lib/rubygems.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/compatibility.rb,
lib/rubygems/defaults.rb,
lib/rubygems/errors.rb,
lib/rubygems/psych_tree.rb,
lib/rubygems/safe_yaml.rb,
lib/rubygems/syck_hack.rb,
lib/rubygems/test_case.rb,
lib/rubygems/util/list.rb

Overview

RubyGems is the Ruby standard for publishing and managing third party libraries.

For user documentation, see:

For gem developer documentation see:

Further RubyGems documentation can be found at:

RubyGems Plugins

As of RubyGems 1.3.2, RubyGems will load plugins installed in gems or $LOAD_PATH. Plugins must be named 'rubygems_plugin' (.rb, .so, etc) and placed at the root of your gem's #require_path. Plugins are discovered via .find_files and then loaded.

For an example plugin, see the Graph gem which adds a gem graph command.

RubyGems Defaults, Packaging

RubyGems defaults are stored in lib/rubygems/defaults.rb. If you're packaging RubyGems or implementing Ruby you can change RubyGems' defaults.

For RubyGems packagers, provide lib/rubygems/defaults/operating_system.rb and override any defaults from lib/rubygems/defaults.rb.

For Ruby implementers, provide lib/rubygems/defaults/#RUBY_ENGINE.rb and override any defaults from lib/rubygems/defaults.rb.

If you need RubyGems to perform extra work on install or uninstall, your defaults override file can set pre/post install and uninstall hooks. See .pre_install, .pre_uninstall, .post_install, .post_uninstall.

Bugs

You can submit bugs to the Rubys bug tracker on GitHub

Credits

RubyGems is currently maintained by Eric Hodel.

RubyGems was originally developed at RubyConf 2003 by:

  • Rich Kilmer – rich(at)infoether.com

  • Chad Fowler – chad(at)chadfowler.com

  • David Black – dblack(at)wobblini.net

  • Paul Brannan – paul(at)atdesk.com

  • Jim Weirich – jim(at)weirichhouse.org

Contributors:

  • Gavin Sinclair – gsinclair(at)soyabean.com.au

  • George Marrows – george.marrows(at)ntlworld.com

  • Dick Davies – rasputnik(at)hellooperator.net

  • Mauricio Fernandez – batsman.geo(at)yahoo.com

  • Simon Strandgaard – neoneye(at)adslhome.dk

  • Dave Glasser – glasser(at)mit.edu

  • Paul Duncan – pabs(at)pablotron.org

  • Ville Aine – vaine(at)cs.helsinki.fi

  • Eric Hodel – drbrain(at)segment7.net

  • Daniel Berger – djberg96(at)gmail.com

  • Phil Hagelberg – technomancy(at)gmail.com

  • Ryan Davis – ryand-ruby(at)zenspider.com

  • Evan Phoenix – evan(at)fallingsnow.net

  • Steve Klabnik – steve(at)steveklabnik.com

(If your name is missing, PLEASE let us know!)

License

See {LICENSE.txt} for permissions.

Thanks!

-The RubyGems Team

Constant Summary

Class Attribute Summary

Class Method Summary

Deprecate - Extended

deprecate

Simple deprecation method that deprecates name by wrapping it up in a dummy method.

skip_during

Temporarily turn off warnings.

Class Attribute Details

.configuration (rw)

The standard configuration object for gems.

[ GitHub ]

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

def self.configuration
  @configuration ||= Gem::ConfigFile.new []
end

.configuration=(config) (rw)

Use the given configuration object (which implements the ::Gem::ConfigFile protocol) as the standard configuration object.

[ GitHub ]

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

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

.default_gems_use_full_paths?Boolean (readonly)

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

[ GitHub ]

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

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

.done_installing_hooks (readonly)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1317

attr_reader :done_installing_hooks

.gemdeps (readonly)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1242

attr_reader :gemdeps

.host (rw)

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

[ GitHub ]

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

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

.host=(host) (rw)

Set the default RubyGems API host.

[ GitHub ]

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

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

.loaded_specs (readonly)

Hash of loaded ::Gem::Specification keyed by name

[ GitHub ]

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

attr_reader :loaded_specs

.paths (rw)

Retrieve the ::Gem::PathSupport object that RubyGems uses to lookup files.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 387

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

.paths=(env) (rw)

Initialize the filesystem paths to use from env. env is a hash-like object (typically ENV) that is queried for 'GEM_HOME', 'GEM_PATH', and 'GEM_SPEC_CACHE' Keys for the env hash should be Strings, and values of the hash should be Strings or nil.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 397

def self.paths=(env)
  clear_paths
  target = {}
  env.each_pair do |k,v|
    case k
    when 'GEM_HOME', 'GEM_PATH', 'GEM_SPEC_CACHE'
      case v
      when nil, String
        target[k] = v
      when Array
        unless Gem::Deprecate.skip
          warn <<-eowarn
Array values in the parameter to `Gem.paths=` are deprecated.
Please use a String or nil.
An Array (#{env.inspect}) was passed in from #{caller[3]}
          eowarn
        end
        target[k] = v.join File::PATH_SEPARATOR
      end
    else
      target[k] = v
    end
  end
  @paths = Gem::PathSupport.new ENV.to_hash.merge(target)
  Gem::Specification.dirs = @paths.path
end

.platforms (rw)

Array of platforms this RubyGems supports.

[ GitHub ]

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

def self.platforms
  @platforms ||= []
  if @platforms.empty?
    @platforms = [Gem::Platform::RUBY, Gem::Platform.local]
  end
  @platforms
end

.platforms=(platforms) (rw)

Set array of platforms this RubyGems supports (primarily for testing).

[ GitHub ]

  
# File 'lib/rubygems.rb', line 757

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

.post_build_hooks (readonly)

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

[ GitHub ]

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

attr_reader :post_build_hooks

.post_install_hooks (readonly)

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

[ GitHub ]

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

attr_reader :post_install_hooks

.post_reset_hooks (readonly)

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

[ GitHub ]

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

attr_reader :post_reset_hooks

.post_uninstall_hooks (readonly)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1328

attr_reader :post_uninstall_hooks

.pre_install_hooks (readonly)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1333

attr_reader :pre_install_hooks

.pre_reset_hooks (readonly)

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

[ GitHub ]

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

attr_reader :pre_reset_hooks

.pre_uninstall_hooks (readonly)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1344

attr_reader :pre_uninstall_hooks

.ruby (rw)

The path to the running Ruby interpreter.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 910

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=(ruby) (rw)

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

[ GitHub ]

  
# File 'lib/rubygems/test_case.rb', line 68

def self.ruby= ruby
  @ruby = ruby
end

.searcher=(searcher) (writeonly)

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

[ GitHub ]

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

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

.sources (rw)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 994

def self.sources
  source_list = configuration.sources || default_sources
  @sources ||= Gem::SourceList.from(source_list)
end

.sources=(new_sources) (rw)

Need to be able to set the sources without calling .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.

[ GitHub ]

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

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

.win_platform=(val) (rw)

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

[ GitHub ]

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

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

.win_platform?Boolean (rw)

Is this a windows platform?

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1082

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

Class Method Details

.activate_bin_path(name, exec_name, requirement)

This method is for internal use only.

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.

A side effect of this method is that it will activate the gem that contains the executable.

This method should only be used in bin stub files.

[ GitHub ]

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

def self.activate_bin_path name, exec_name, requirement # :nodoc:
  spec = find_spec_for_exe name, exec_name, [requirement]
  Gem::LOADED_SPECS_MUTEX.synchronize do
    spec.activate
    finish_resolve
  end
  spec.bin_file exec_name
end

.bin_path(name, exec_name = nil, *requirements)

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)
[ GitHub ]

  
# File 'lib/rubygems.rb', line 254

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

  raise ArgumentError, "you must supply exec_name" unless exec_name

  requirements = Gem::Requirement.default if
    requirements.empty?

  find_spec_for_exe(name, exec_name, requirements).bin_file exec_name
end

.binary_mode

The mode needed to read a file as straight binary.

[ GitHub ]

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

def self.binary_mode
  'rb'
end

.bindir(install_dir = Gem.dir)

The path where gem executables are to be installed.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 321

def self.bindir(install_dir=Gem.dir)
  return File.join install_dir, 'bin' unless
    install_dir.to_s == Gem.default_dir.to_s
  Gem.default_bindir
end

.clear_default_specs

Clear default gem related variables. It is for test

[ GitHub ]

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

def clear_default_specs
  @path_to_default_spec_map.clear
end

.clear_paths

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.

[ GitHub ]

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

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

.config_file

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

[ GitHub ]

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

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

.datadir(gem_name)

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

[ GitHub ]

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

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

.default_bindir

The default directory for binaries

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 117

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

.default_cert_path

The default signing certificate chain path

[ GitHub ]

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

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

.default_dir

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

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 30

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

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

.default_exec_format

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

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 103

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

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

  exec_format
end

.default_ext_dir_for(base_dir)

Returns binary extensions dir for specified RubyGems base dir or nil if such directory cannot be determined.

By default, the binary extensions are located side by side with their Ruby counterparts, therefore nil is returned

[ GitHub ]

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

def self.default_ext_dir_for base_dir
  nil
end

.default_key_path

The default signing key path

[ GitHub ]

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

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

.default_path

Default gem load path

[ GitHub ]

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

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

.default_rubygems_dirs

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

[ GitHub ]

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

def self.default_rubygems_dirs
  nil # default to standard layout
end

.default_sources

An Array of the default sources that come with RubyGems

[ GitHub ]

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

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

.default_spec_cache_dir

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

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 22

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

.deflate(data)

A Zlib::Deflate.deflate wrapper

[ GitHub ]

  
# File 'lib/rubygems.rb', line 379

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

.detect_gemdeps(path = nil)

This method is for internal use only.

TODO remove with RubyGems 3.0

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1225

alias detect_gemdeps use_gemdeps # :nodoc:

.dir

The path where gems are to be installed.

[ GitHub ]

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

def self.dir
  paths.home
end

.done_installing(&hook)

Adds a post-installs hook that will be passed a ::Gem::DependencyInstaller and a list of installed specifications when DependencyInstaller#install is complete

[ GitHub ]

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

def self.done_installing(&hook)
  @done_installing_hooks << hook
end

.ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil)

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.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 463

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)

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.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 450

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

.ensure_subdirectories(dir, mode, subdirs)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems.rb', line 467

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

  require 'fileutils'

  options = {}

  options[:mode] = mode if mode

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

.env_requirement(gem_name)

[ GitHub ]

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

def self.env_requirement(gem_name)
  @env_requirements_by_name ||= {}
  @env_requirements_by_name[gem_name] ||= begin
    req = ENV["GEM_REQUIREMENT_#{gem_name.upcase}"] || '>= 0'.freeze
    Gem::Requirement.create(req)
  end
end

.extension_api_version

This method is for internal use only.

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 490

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)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 510

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

  files = find_files_from_load_path glob if check_load_path

  gem_specifications = @gemdeps ? Gem.loaded_specs.values : Gem::Specification.stubs

  files.concat gem_specifications.map { |spec|
    spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
  }.flatten

  # $LOAD_PATH might contain duplicate entries or reference
  # the spec dirs directly, so we prune.
  files.uniq! if check_load_path

  return files
end

.find_files_from_load_path(glob)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems.rb', line 528

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_home (private)

Finds the user's home directory.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 579

def self.find_home
  windows = File::ALT_SEPARATOR
  if not windows or RUBY_VERSION >= '1.9' then
    File.expand_path "~"
  else
    ['HOME', 'USERPROFILE'].each do |key|
      return File.expand_path ENV[key] if ENV[key]
    end

    if ENV['HOMEDRIVE'] && ENV['HOMEPATH'] then
      File.expand_path "#{ENV['HOMEDRIVE']}#{ENV['HOMEPATH']}"
    end
  end
rescue
  if windows then
    File.expand_path File.join(ENV['HOMEDRIVE'] || ENV['SystemDrive'], '/')
  else
    File.expand_path "/"
  end
end

.find_latest_files(glob, check_load_path = true)

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.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 546

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_spec_for_exe(name, exec_name, requirements) (private)

[ GitHub ]

  
# File 'lib/rubygems.rb', line 266

def self.find_spec_for_exe name, exec_name, requirements
  dep = Gem::Dependency.new name, requirements

  loaded = Gem.loaded_specs[name]

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

  specs = dep.matching_specs(true)

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

  unless spec = specs.first
    msg = "can't find gem #{dep} with executable #{exec_name}"
    if name == "bundler" && bundler_message = Gem::BundlerVersionFinder.missing_version_message
      msg = bundler_message
    end
    raise Gem::GemNotFoundException, msg
  end

  spec
end

.find_unresolved_default_spec(path)

Find a ::Gem::Specification of default gem from .path

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1280

def find_unresolved_default_spec(path)
  @path_to_default_spec_map[path]
end

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

[ GitHub ]

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

def self.finish_resolve(request_set=Gem::RequestSet.new)
  request_set.import Gem::Specification.unresolved_deps.values
  request_set.import Gem.loaded_specs.values.map {|s| Gem::Dependency.new(s.name, s.version) }

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

.gunzip(data)

Zlib::GzipReader wrapper that unzips data.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 607

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

.gzip(data)

Zlib::GzipWriter wrapper that zips data.

[ GitHub ]

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

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

.inflate(data)

A Zlib::Inflate#inflate wrapper

[ GitHub ]

  
# File 'lib/rubygems.rb', line 621

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

.install(name, version = Gem::Requirement.default, *options)

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

  
# File 'lib/rubygems.rb', line 633

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

.install_extension_in_lib

This method is for internal use only.

Install extensions into lib as well as into the extension directory.

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 160

def self.install_extension_in_lib # :nodoc:
  true
end

.latest_rubygems_version

Returns the latest release version of RubyGems.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 953

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)

Returns the latest release-version specification for the gem name.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 940

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)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 961

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

.load_env_plugins

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

[ GitHub ]

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

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

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

[ GitHub ]

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

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)

This method is for internal use only.

Load plugins as Ruby files

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1094

def self.load_plugin_files plugins # :nodoc:
  plugins.each do |plugin|

    # Skip older versions of the GemCutter plugin: Its commands are in
    # RubyGems proper now.

    next if plugin =~ /gemcutter-0\.[0-3]/

    begin
      load plugin
    rescue ::Exception => e
      details = "#{plugin.inspect}: #{e.message} (#{e.class})"
      warn "Error loading RubyGems plugin #{details}"
    end
  end
end

.load_plugins

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1115

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

.load_yaml

Loads YAML, preferring ::Psych

[ GitHub ]

  
# File 'lib/rubygems.rb', line 675

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', '>= 2.0.0'
    rescue Gem::LoadError
      # It's OK if the user does not have the psych gem installed.  We will
      # attempt to require the stdlib version
    end

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

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

  require 'yaml'
  require 'rubygems/safe_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(depth = 1)

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

depth is how many layers up the call stack it should go.

e.g.,

def a; Gem.location_of_caller; end a #=> [“x.rb”, 2] # (it'll vary depending on file name and line number)

def b; c; end def c; location_of_caller(2); end b #=> [“x.rb”, 6] # (it'll vary depending on file name and line number)

[ GitHub ]

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

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

  [file, lineno]
end

.marshal_version

The version of the Marshal format for your Ruby.

[ GitHub ]

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

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

.needs {|rs| ... }

Yields:

  • (rs)
[ GitHub ]

  
# File 'lib/rubygems.rb', line 231

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

  yield rs

  finish_resolve rs
end

.path

[ GitHub ]

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

def self.path
  paths.path
end

.path_separator

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

[ GitHub ]

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

def self.path_separator
  File::PATH_SEPARATOR
end

.platform_defaults

Default options for gem commands.

The options here should be structured as an array of string “gem” command names as keys and a string of the default options as values.

Example:

def self.platform_defaults

{
    'install' => '--no-rdoc --no-ri --env-shebang',
    'update' => '--no-rdoc --no-ri --env-shebang'
}

end

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 193

def self.platform_defaults
  {}
end

.post_build(&hook)

Adds a post-build hook that will be passed an ::Gem::Installer instance when 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.

[ GitHub ]

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

def self.post_build(&hook)
  @post_build_hooks << hook
end

.post_install(&hook)

Adds a post-install hook that will be passed an ::Gem::Installer instance when Installer#install is called

[ GitHub ]

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

def self.post_install(&hook)
  @post_install_hooks << hook
end

.post_reset(&hook)

Adds a hook that will get run after Specification.reset is run.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 804

def self.post_reset(&hook)
  @post_reset_hooks << hook
end

.post_uninstall(&hook)

Adds a post-uninstall hook that will be passed a ::Gem::Uninstaller instance and the spec that was uninstalled when Uninstaller#uninstall is called

[ GitHub ]

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

def self.post_uninstall(&hook)
  @post_uninstall_hooks << hook
end

.pre_install(&hook)

Adds a pre-install hook that will be passed an ::Gem::Installer instance when Installer#install is called. If the hook returns false then the install will be aborted.

[ GitHub ]

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

def self.pre_install(&hook)
  @pre_install_hooks << hook
end

.pre_reset(&hook)

Adds a hook that will get run before Specification.reset is run.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 830

def self.pre_reset(&hook)
  @pre_reset_hooks << hook
end

.pre_uninstall(&hook)

Adds a pre-uninstall hook that will be passed an ::Gem::Uninstaller instance and the spec that will be uninstalled when Uninstaller#uninstall is called

[ GitHub ]

  
# File 'lib/rubygems.rb', line 839

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

.prefix

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.

[ GitHub ]

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

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)

Safely read a file in binary mode on all platforms.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 868

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

.refresh

Refresh available gems from disk.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 861

def self.refresh
  Gem::Specification.reset
end

.register_default_spec(spec)

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.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1256

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

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

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

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

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

.remove_unresolved_default_spec(spec)

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

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1288

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

.ruby_api_version

Returns a String containing the API compatibility version of Ruby

[ GitHub ]

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

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

.ruby_engine

A wrapper around RUBY_ENGINE const that may not be defined

[ GitHub ]

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

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

.ruby_version

A ::Gem::Version for the currently running Ruby.

[ GitHub ]

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

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

A ::Gem::Version for the currently running RubyGems

[ GitHub ]

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

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

.spec_cache_dir

[ GitHub ]

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

def self.spec_cache_dir
  paths.spec_cache_dir
end

.suffix_pattern

Glob pattern for require-able path suffixes.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1017

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

.suffixes

Suffixes for require-able paths.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1024

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)

Prints the amount of time the supplied block takes to run using the debug UI output.

[ GitHub ]

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

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)

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.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 206

def self.try_activate path
  # finds the _latest_ version... regardless of loaded specs and their deps
  # if another gem had a requirement that would mean we shouldn't
  # activate the latest version, then either it would already be activated
  # or if it was ambiguous (and thus unresolved) the code in our custom
  # require will try to activate the more specific version.

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

  begin
    spec.activate
  rescue Gem::LoadError => e # this could fail due to gem dep collisions, go lax
    spec_by_name = Gem::Specification.find_by_name(spec.name)
    if spec_by_name.nil?
      raise e
    else
      spec_by_name.activate
    end
  end

  return true
end

.ui

Lazily loads ::Gem::DefaultUserInteraction and returns the default UI.

[ GitHub ]

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

def self.ui
  require 'rubygems/user_interaction'

  Gem::DefaultUserInteraction.ui
end

.use_gemdeps(path = nil) 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.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1162

def self.use_gemdeps path = nil
  raise_exception = path

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

  path = path.dup

  if path == "-" then
    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

  if USE_BUNDLER_FOR_GEMDEPS

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

  else

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

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

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

.use_paths(home, *paths)

Use the home and .paths values for .dir and .path. Used mainly by the unit tests to provide environment isolation.

[ GitHub ]

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

def self.use_paths(home, *paths)
  paths.flatten!
  paths.compact!
  hash = { "GEM_HOME" => home, "GEM_PATH" => paths.empty? ? home : paths.join(File::PATH_SEPARATOR) }
  hash.delete_if { |_, v| v.nil? }
  self.paths = hash
end

.user_dir

Path for gems in the user's home directory

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 76

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

.user_home

The home directory for the user.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 1075

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

.vendor_dir

This method is for internal use only.

Directory where vendor gems are installed.

[ GitHub ]

  
# File 'lib/rubygems/defaults.rb', line 167

def self.vendor_dir # :nodoc:
  if vendor_dir = ENV['GEM_VENDOR'] then
    return vendor_dir.dup
  end

  return nil unless RbConfig::CONFIG.key? 'vendordir'

  File.join RbConfig::CONFIG['vendordir'], 'gems',
            RbConfig::CONFIG['ruby_version']
end

.write_binary(path, data)

Safely write a file in binary mode on all platforms.

[ GitHub ]

  
# File 'lib/rubygems.rb', line 889

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