# module Gem

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

For user documentation, see:

- `gem help` and `gem help [command]`

- RubyGems User Guide

- Frequently Asked Questions

For gem developer documentation see:

- Creating Gems

- `Gem::Specification`

- `Gem::Version` for version dependency notes

Further RubyGems documentation can be found at:

- RubyGems Guides

- RubyGems API (also available from `gem server`)

## RubyGems Plugins¶ ↑

RubyGems will load plugins in the latest version of each installed gem 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 installed at a special location and loaded on boot.

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 `Gem::pre_install`, `Gem::pre_uninstall`, `Gem::post_install`, `Gem::post_uninstall`.

## Bugs¶ ↑

You can submit bugs to the RubyGems 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

### Constants

DEFAULT_HOST
GEM_DEP_FILES
LOADED_SPECS_MUTEX
MARSHAL_SPEC_DIR

  Location of `Marshal` quick gemspecs on remote repositories

RDoc

  `Gem::RDoc` provides methods to generate `RDoc` and ri data for installed gems upon gem installation.

  This file is automatically required by RubyGems 1.9 and newer.

REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES

  Subdirectories in a gem repository for default gems

REPOSITORY_SUBDIRECTORIES

  Subdirectories in a gem repository

RUBYGEMS_DIR
UNTAINT

  Taint support is deprecated in Ruby 2.7. This allows switching “.untaint” to “.tap(&Gem::UNTAINT)”, to avoid deprecation warnings in Ruby 2.7.

VERSION
WIN_PATTERNS

  An `Array` of Regexps that match windows Ruby platforms.

### Attributes

disable_system_update_message[RW]

RubyGems distributors (like operating system package managers) can disable RubyGems update by setting this to error message printed to end-users on gem update –system instead of actual update.

discover_gems_on_require[RW]

Whether RubyGems should enhance builtin ‘require` to automatically check whether the path required is present in installed gems, and automatically activate them and add them to `$LOAD_PATH`.

done_installing_hooks[R]

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

gemdeps[R]

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

loaded_specs[R]

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

post_build_hooks[R]

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

post_install_hooks[R]

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

post_reset_hooks[R]

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

post_uninstall_hooks[R]

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

pre_install_hooks[R]

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

pre_reset_hooks[R]

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

pre_uninstall_hooks[R]

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

### Public Class Methods

activated_gem_paths() click to toggle source

The number of paths in the +$LOAD_PATH+ from activated gems. Used to prioritize `-I` and +ENV+ entries during `require`.

    # File lib/rubygems.rb, line 587
    def self.activated_gem_paths
      @activated_gem_paths ||= 0
    end

add_to_load_path(*paths) click to toggle source

Add a list of paths to the $LOAD_PATH at the proper place.

    # File lib/rubygems.rb, line 594
    def self.add_to_load_path(*paths)
      @activated_gem_paths = activated_gem_paths + paths.size

      # gem directories must come after -I and ENV['RUBYLIB']
      $LOAD_PATH.insert(Gem.load_path_insert_index, *paths)
    end

bin_path(name, exec_name = nil, *requirements) click to toggle source

`Find` the full path to the executable for gem `name`. If the `exec_name` is not given, an exception will be raised, otherwise the specified executable’s path is returned. `requirements` allows you to specify specific gem versions.

    # File lib/rubygems.rb, line 240
    def self.bin_path(name, exec_name = nil, *requirements)
      requirements = Gem::Requirement.default if
        requirements.empty?

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

binary_mode() click to toggle source

The mode needed to read a file as straight binary.

    # File lib/rubygems.rb, line 294
    def self.binary_mode
      "rb"
    end

bindir(install_dir=Gem.dir) click to toggle source

The path where gem executables are to be installed.

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

cache_home() click to toggle source

The path to standard location of the user’s cache directory.

    # File lib/rubygems/defaults.rb, line 147
    def self.cache_home
      @cache_home ||= (ENV["XDG_CACHE_HOME"] || File.join(Gem.user_home, ".cache"))
    end

clear_default_specs() click to toggle source

Clear default gem related variables. It is for test

    # File lib/rubygems.rb, line 1234
    def clear_default_specs
      @path_to_default_spec_map.clear
    end

clear_paths() click to toggle source

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.

    # File lib/rubygems.rb, line 319
    def self.clear_paths
      @paths         = nil
      @user_home     = nil
      Gem::Specification.reset
      Gem::Security.reset if defined?(Gem::Security)
    end

config_file() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 133
    def self.config_file
      @config_file ||= find_config_file.tap(&Gem::UNTAINT)
    end

config_home() click to toggle source

The path to standard location of the user’s configuration directory.

    # File lib/rubygems/defaults.rb, line 114
    def self.config_home
      @config_home ||= (ENV["XDG_CONFIG_HOME"] || File.join(Gem.user_home, ".config"))
    end

configuration() click to toggle source

The standard configuration object for gems.

    # File lib/rubygems.rb, line 329
    def self.configuration
      @configuration ||= Gem::ConfigFile.new []
    end

configuration=(config) click to toggle source

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

    # File lib/rubygems.rb, line 337
    def self.configuration=(config)
      @configuration = config
    end

data_home() click to toggle source

The path to standard location of the user’s data directory.

    # File lib/rubygems/defaults.rb, line 154
    def self.data_home
      @data_home ||= (ENV["XDG_DATA_HOME"] || File.join(Gem.user_home, ".local", "share"))
    end

datadir(gem_name) click to toggle source

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

    # File lib/rubygems.rb, line 345
    def self.datadir(gem_name)
      spec = @loaded_specs[gem_name]
      return nil if spec.nil?
      spec.datadir
    end

default_bindir() click to toggle source

The default directory for binaries

    # File lib/rubygems/defaults.rb, line 200
    def self.default_bindir
      RbConfig::CONFIG["bindir"]
    end

default_cert_path() click to toggle source

The default signing certificate chain path

    # File lib/rubygems/defaults.rb, line 224
    def self.default_cert_path
      default_cert_path = File.join Gem.user_home, ".gem", "gem-public_cert.pem"

      unless File.exist?(default_cert_path)
        default_cert_path = File.join Gem.data_home, "gem", "gem-public_cert.pem"
      end

      default_cert_path
    end

default_dir() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 37
    def self.default_dir
      @default_dir ||= File.join(RbConfig::CONFIG["rubylibprefix"], "gems", RbConfig::CONFIG["ruby_version"])
    end

default_exec_format() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 186
    def self.default_exec_format
      exec_format = RbConfig::CONFIG["ruby_install_name"].sub("ruby", "%s") rescue "%s"

      unless exec_format.include?("%s")
        raise Gem::Exception,
          "[BUG] invalid exec_format #{exec_format.inspect}, no %s"
      end

      exec_format
    end

default_ext_dir_for(base_dir) click to toggle source

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

    # File lib/rubygems/defaults.rb, line 48
    def self.default_ext_dir_for(base_dir)
      nil
    end

default_key_path() click to toggle source

The default signing key path

    # File lib/rubygems/defaults.rb, line 211
    def self.default_key_path
      default_key_path = File.join Gem.user_home, ".gem", "gem-private_key.pem"

      unless File.exist?(default_key_path)
        default_key_path = File.join Gem.data_home, "gem", "gem-private_key.pem"
      end

      default_key_path
    end

default_path() click to toggle source

Default gem load path

    # File lib/rubygems/defaults.rb, line 175
    def self.default_path
      path = []
      path << user_dir if user_home && File.exist?(user_home)
      path << default_dir
      path << vendor_dir if vendor_dir && File.directory?(vendor_dir)
      path
    end

default_rubygems_dirs() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 55
    def self.default_rubygems_dirs
      nil # default to standard layout
    end

default_sources() click to toggle source

An `Array` of the default sources that come with RubyGems

    # File lib/rubygems/defaults.rb, line 15
    def self.default_sources
      %w[https://rubygems.org/]
    end

default_spec_cache_dir() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 23
    def self.default_spec_cache_dir
      default_spec_cache_dir = File.join Gem.user_home, ".gem", "specs"

      unless File.exist?(default_spec_cache_dir)
        default_spec_cache_dir = File.join Gem.data_home, "gem", "specs"
      end

      default_spec_cache_dir
    end

default_specifications_dir() click to toggle source

Path to specification files of default gems.

    # File lib/rubygems/defaults.rb, line 62
    def self.default_specifications_dir
      @default_specifications_dir ||= File.join(Gem.default_dir, "specifications", "default")
    end

deflate(data) click to toggle source

A `Zlib::Deflate.deflate` wrapper

    # File lib/rubygems.rb, line 354
    def self.deflate(data)
      require "zlib"
      Zlib::Deflate.deflate data
    end

dir() click to toggle source

The path where gems are to be installed.

    # File lib/rubygems.rb, line 402
    def self.dir
      paths.home
    end

done_installing(&hook) click to toggle source

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

    # File lib/rubygems.rb, line 688
    def self.done_installing(&hook)
      @done_installing_hooks << hook
    end

ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil) click to toggle source

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.

    # File lib/rubygems.rb, line 436
    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) click to toggle source

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.

    # File lib/rubygems.rb, line 423
    def self.ensure_gem_subdirectories(dir = Gem.dir, mode = nil)
      ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES)
    end

env_requirement(gem_name) click to toggle source

    # File lib/rubygems.rb, line 825
    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"
        Gem::Requirement.create(req)
      end
    end

find_config_file() click to toggle source

Finds the user’s config file

    # File lib/rubygems/defaults.rb, line 121
    def self.find_config_file
      gemrc = File.join Gem.user_home, ".gemrc"
      if File.exist? gemrc
        gemrc
      else
        File.join Gem.config_home, "gem", "gemrc"
      end
    end

find_files(glob, check_load_path=true) click to toggle source

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`

    # File lib/rubygems.rb, line 487
    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_latest_files(glob, check_load_path=true) click to toggle source

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.

    # File lib/rubygems.rb, line 524
    def self.find_latest_files(glob, check_load_path=true)
      files = []

      files = find_files_from_load_path glob if check_load_path

      files.concat Gem::Specification.latest_specs(true).map {|spec|
        spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
      }.flatten

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

      return files
    end

find_unresolved_default_spec(path) click to toggle source

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

    # File lib/rubygems.rb, line 1226
    def find_unresolved_default_spec(path)
      default_spec = @path_to_default_spec_map[path]
      return default_spec if default_spec && loaded_specs[default_spec.name] != default_spec
    end

finish_resolve(request_set=Gem::RequestSet.new) click to toggle source

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

host() click to toggle source

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

    # File lib/rubygems.rb, line 559
    def self.host
      @host ||= Gem::DEFAULT_HOST
    end

host=(host) click to toggle source

`Set` the default RubyGems API host.

    # File lib/rubygems.rb, line 565
    def self.host=(host)
      @host = host
    end

install(name, version = Gem::Requirement.default, *options) click to toggle source

Top level install helper method. Allows you to install gems interactively:

    % irb
    >> Gem.install "minitest"
    Fetching: minitest-5.14.0.gem (100%)
    => [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]

    # File lib/rubygems.rb, line 548
    def self.install(name, version = Gem::Requirement.default, *options)
      require_relative "rubygems/dependency_installer"
      inst = Gem::DependencyInstaller.new(*options)
      inst.install name, version
      inst.installed_gems
    end

java_platform?() click to toggle source

Is this a java platform?

    # File lib/rubygems.rb, line 1007
    def self.java_platform?
      RUBY_PLATFORM == "java"
    end

latest_rubygems_version() click to toggle source

Returns the latest release version of RubyGems.

    # File lib/rubygems.rb, line 850
    def self.latest_rubygems_version
      latest_version_for("rubygems-update") ||
        raise("Can't find 'rubygems-update' in any repo. Check `gem source list`.")
    end

latest_spec_for(name) click to toggle source

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

    # File lib/rubygems.rb, line 837
    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.last

      spec
    end

latest_version_for(name) click to toggle source

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

    # File lib/rubygems.rb, line 858
    def self.latest_version_for(name)
      latest_spec_for(name)&.version
    end

load_env_plugins() click to toggle source

`Find` all ‘rubygems_plugin’ files in $LOAD_PATH and load them

    # File lib/rubygems.rb, line 1049
    def self.load_env_plugins
      load_plugin_files find_files_from_load_path("rubygems_plugin")
    end

load_path_insert_index() click to toggle source

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

    # File lib/rubygems.rb, line 573
    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 || 0
    end

load_plugins() click to toggle source

`Find` rubygems plugin files in the standard location and load them

    # File lib/rubygems.rb, line 1040
    def self.load_plugins
      Gem.path.each do |gem_path|
        load_plugin_files Gem::Util.glob_files_in_dir("*#{Gem.plugin_suffix_pattern}", plugindir(gem_path))
      end
    end

load_yaml() click to toggle source

Loads `YAML`, preferring `Psych`

    # File lib/rubygems.rb, line 606
    def self.load_yaml
      return if @yaml_loaded

      require "psych"
      require_relative "rubygems/psych_tree"

      require_relative "rubygems/safe_yaml"

      @yaml_loaded = true
    end

location_of_caller(depth = 1) click to toggle source

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

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

e.g.,

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

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

    # File lib/rubygems.rb, line 631
    def self.location_of_caller(depth = 1)
      caller[depth] =~ /(.*?):(\d+).*?$/i
      file = $1
      lineno = $2.to_i

      [file, lineno]
    end

marshal_version() click to toggle source

The version of the `Marshal` format for your Ruby.

    # File lib/rubygems.rb, line 642
    def self.marshal_version
      "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
    end

needs() { |rs| ... } click to toggle source

    # File lib/rubygems.rb, line 217
    def self.needs
      rs = Gem::RequestSet.new

      yield rs

      finish_resolve rs
    end

open_file(path, flags) { |io| ... } click to toggle source

Open a file with given flags, and on Windows protect access with flock

    # File lib/rubygems.rb, line 785
    def self.open_file(path, flags, &block)
      File.open(path, flags) do |io|
        if !java_platform? && win_platform?
          begin
            io.flock(File::LOCK_EX)
          rescue Errno::ENOSYS, Errno::ENOTSUP
          end
        end
        yield io
      end
    rescue Errno::ENOLCK # NFS
      if Thread.main != Thread.current
        raise
      else
        File.open(path, flags) do |io|
          yield io
        end
      end
    end

operating_system_defaults() click to toggle source

Default options for gem commands for Ruby packagers.

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

Example:

def self.operating_system_defaults

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

end

    # File lib/rubygems/defaults.rb, line 270
    def self.operating_system_defaults
      {}
    end

path() click to toggle source

    # File lib/rubygems.rb, line 406
    def self.path
      paths.path
    end

path_separator() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 168
    def self.path_separator
      File::PATH_SEPARATOR
    end

paths() click to toggle source

Retrieve the `PathSupport` object that RubyGems uses to lookup files.

    # File lib/rubygems.rb, line 362
    def self.paths
      @paths ||= Gem::PathSupport.new(ENV)
    end

paths=(env) click to toggle source

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

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

platform_defaults() click to toggle source

Default options for gem commands for Ruby implementers.

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

Example:

def self.platform_defaults

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

end

    # File lib/rubygems/defaults.rb, line 289
    def self.platform_defaults
      {}
    end

platforms() click to toggle source

`Array` of platforms this RubyGems supports.

    # File lib/rubygems.rb, line 656
    def self.platforms
      @platforms ||= []
      if @platforms.empty?
        @platforms = [Gem::Platform::RUBY, Gem::Platform.local]
      end
      @platforms
    end

platforms=(platforms) click to toggle source

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

    # File lib/rubygems.rb, line 649
    def self.platforms=(platforms)
      @platforms = platforms
    end

plugin_suffix_pattern() click to toggle source

Glob pattern for require-able plugin suffixes.

    # File lib/rubygems.rb, line 930
    def self.plugin_suffix_pattern
      @plugin_suffix_pattern ||= "_plugin#{suffix_pattern}"
    end

plugin_suffix_regexp() click to toggle source

`Regexp` for require-able plugin suffixes.

    # File lib/rubygems.rb, line 937
    def self.plugin_suffix_regexp
      @plugin_suffix_regexp ||= /_plugin#{suffix_regexp}\z/
    end

plugindir(install_dir=Gem.dir) click to toggle source

The path were rubygems plugins are to be installed.

    # File lib/rubygems.rb, line 310
    def self.plugindir(install_dir=Gem.dir)
      File.join install_dir, "plugins"
    end

post_build(&hook) click to toggle source

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.

    # File lib/rubygems.rb, line 671
    def self.post_build(&hook)
      @post_build_hooks << hook
    end

post_install(&hook) click to toggle source

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

    # File lib/rubygems.rb, line 679
    def self.post_install(&hook)
      @post_install_hooks << hook
    end

post_reset(&hook) click to toggle source

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

    # File lib/rubygems.rb, line 696
    def self.post_reset(&hook)
      @post_reset_hooks << hook
    end

post_uninstall(&hook) click to toggle source

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

    # File lib/rubygems.rb, line 705
    def self.post_uninstall(&hook)
      @post_uninstall_hooks << hook
    end

pre_install(&hook) click to toggle source

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.

    # File lib/rubygems.rb, line 714
    def self.pre_install(&hook)
      @pre_install_hooks << hook
    end

pre_reset(&hook) click to toggle source

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

    # File lib/rubygems.rb, line 722
    def self.pre_reset(&hook)
      @pre_reset_hooks << hook
    end

pre_uninstall(&hook) click to toggle source

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

    # File lib/rubygems.rb, line 731
    def self.pre_uninstall(&hook)
      @pre_uninstall_hooks << hook
    end

prefix() click to toggle source

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.

    # File lib/rubygems.rb, line 740
    def self.prefix
      prefix = File.dirname RUBYGEMS_DIR

      if prefix != File.expand_path(RbConfig::CONFIG["sitelibdir"]) &&
         prefix != File.expand_path(RbConfig::CONFIG["libdir"]) &&
         "lib" == File.basename(RUBYGEMS_DIR)
        prefix
      end
    end

read_binary(path) click to toggle source

Safely read a file in binary mode on all platforms.

    # File lib/rubygems.rb, line 760
    def self.read_binary(path)
      open_file(path, "rb+") do |io|
        io.read
      end
    rescue Errno::EACCES, Errno::EROFS
      open_file(path, "rb") do |io|
        io.read
      end
    end

refresh() click to toggle source

Refresh available gems from disk.

    # File lib/rubygems.rb, line 753
    def self.refresh
      Gem::Specification.reset
    end

register_default_spec(spec) click to toggle source

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.

    # File lib/rubygems.rb, line 1201
    def register_default_spec(spec)
      extended_require_paths = spec.require_paths.map {|f| f + "/" }
      new_format = extended_require_paths.any? {|path| spec.files.any? {|f| f.start_with? path } }

      if new_format
        prefix_group = extended_require_paths.join("|")
        prefix_pattern = /^(#{prefix_group})/
      end

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

        spec.activate if already_loaded?(file)

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

ruby() click to toggle source

The path to the running Ruby interpreter.

    # File lib/rubygems.rb, line 808
    def self.ruby
      if @ruby.nil?
        @ruby = RbConfig.ruby

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

      @ruby
    end

ruby_api_version() click to toggle source

Returns a `String` containing the API compatibility version of Ruby

    # File lib/rubygems.rb, line 821
    def self.ruby_api_version
      @ruby_api_version ||= RbConfig::CONFIG["ruby_version"].dup
    end

ruby_engine() click to toggle source

    # File lib/rubygems/defaults.rb, line 204
    def self.ruby_engine
      RUBY_ENGINE
    end

ruby_version() click to toggle source

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

    # File lib/rubygems.rb, line 865
    def self.ruby_version
      return @ruby_version if defined? @ruby_version
      version = RUBY_VERSION.dup

      unless defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1
        if RUBY_ENGINE == "ruby"
          desc = RUBY_DESCRIPTION[/\Aruby #{Regexp.quote(RUBY_VERSION)}([^ ]+) /, 1]
        else
          desc = RUBY_DESCRIPTION[/\A#{RUBY_ENGINE} #{Regexp.quote(RUBY_ENGINE_VERSION)} \(#{RUBY_VERSION}([^ ]+)\) /, 1]
        end
        version << ".#{desc}" if desc
      end

      @ruby_version = Gem::Version.new version
    end

rubygems_version() click to toggle source

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

    # File lib/rubygems.rb, line 884
    def self.rubygems_version
      return @rubygems_version if defined? @rubygems_version
      @rubygems_version = Gem::Version.new Gem::VERSION
    end

solaris_platform?() click to toggle source

Is this platform Solaris?

    # File lib/rubygems.rb, line 1014
    def self.solaris_platform?
      RUBY_PLATFORM.include?("solaris")
    end

source_date_epoch() click to toggle source

Returns the value of `Gem.source_date_epoch_string`, as a `Time` object.

This is used throughout RubyGems for enabling reproducible builds.

    # File lib/rubygems.rb, line 1156
    def self.source_date_epoch
      Time.at(self.source_date_epoch_string.to_i).utc.freeze
    end

source_date_epoch_string() click to toggle source

If the SOURCE_DATE_EPOCH environment variable is set, returns it’s value. Otherwise, returns the time that `Gem.source_date_epoch_string` was first called in the same format as SOURCE_DATE_EPOCH.

NOTE(@duckinator): The implementation is a tad weird because we want to:

    1. Make builds reproducible by default, by having this function always
       return the same result during a given run.
    2. Allow changing ENV['SOURCE_DATE_EPOCH'] at runtime, since multiple
       tests that set this variable will be run in a single process.

If you simplify this function and a lot of tests fail, that is likely due to #2 above.

Details on SOURCE_DATE_EPOCH: reproducible-builds.org/specs/source-date-epoch/

    # File lib/rubygems.rb, line 1137
    def self.source_date_epoch_string
      # The value used if $SOURCE_DATE_EPOCH is not set.
      @default_source_date_epoch ||= Time.now.to_i.to_s

      specified_epoch = ENV["SOURCE_DATE_EPOCH"]

      # If it's empty or just whitespace, treat it like it wasn't set at all.
      specified_epoch = nil if !specified_epoch.nil? && specified_epoch.strip.empty?

      epoch = specified_epoch || @default_source_date_epoch

      epoch.strip
    end

sources() click to toggle source

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

    # File lib/rubygems.rb, line 893
    def self.sources
      source_list = configuration.sources || default_sources
      @sources ||= Gem::SourceList.from(source_list)
    end

sources=(new_sources) click to toggle source

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.

    # File lib/rubygems.rb, line 905
    def self.sources=(new_sources)
      if !new_sources
        @sources = nil
      else
        @sources = Gem::SourceList.from(new_sources)
      end
    end

spec_cache_dir() click to toggle source

    # File lib/rubygems.rb, line 410
    def self.spec_cache_dir
      paths.spec_cache_dir
    end

state_file() click to toggle source

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

    # File lib/rubygems/defaults.rb, line 140
    def self.state_file
      @state_file ||= File.join(Gem.state_home, "gem", "last_update_check").tap(&Gem::UNTAINT)
    end

state_home() click to toggle source

The path to standard location of the user’s state directory.

    # File lib/rubygems/defaults.rb, line 161
    def self.state_home
      @state_home ||= (ENV["XDG_STATE_HOME"] || File.join(Gem.user_home, ".local", "state"))
    end

suffix_pattern() click to toggle source

Glob pattern for require-able path suffixes.

    # File lib/rubygems.rb, line 916
    def self.suffix_pattern
      @suffix_pattern ||= "{#{suffixes.join(',')}}"
    end

suffix_regexp() click to toggle source

`Regexp` for require-able path suffixes.

    # File lib/rubygems.rb, line 923
    def self.suffix_regexp
      @suffix_regexp ||= /#{Regexp.union(suffixes)}\z/
    end

suffixes() click to toggle source

Suffixes for require-able paths.

    # File lib/rubygems.rb, line 944
    def self.suffixes
      @suffixes ||= ["",
                     ".rb",
                     *%w[DLEXT DLEXT2].map do |key|
                       val = RbConfig::CONFIG[key]
                       next unless val && !val.empty?
                       ".#{val}"
                     end,
                    ].compact.uniq
    end

time(msg, width = 0, display = Gem.configuration.verbose) { || ... } click to toggle source

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

    # File lib/rubygems.rb, line 959
    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) click to toggle source

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.

    # File lib/rubygems.rb, line 192
    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() click to toggle source

Lazily loads `DefaultUserInteraction` and returns the default UI.

    # File lib/rubygems.rb, line 974
    def self.ui
      require_relative "rubygems/user_interaction"

      Gem::DefaultUserInteraction.ui
    end

use_gemdeps(path = nil) click to toggle source

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.

    # File lib/rubygems.rb, line 1073
    def self.use_gemdeps(path = nil)
      raise_exception = path

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

      path = path.dup

      if path == "-"
        Gem::Util.traverse_parents Dir.pwd do |directory|
          dep_file = GEM_DEP_FILES.find {|f| File.file?(f) }

          next unless dep_file

          path = File.join directory, dep_file
          break
        end
      end

      path.tap(&Gem::UNTAINT)

      unless File.file? path
        return unless raise_exception

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

      ENV["BUNDLE_GEMFILE"] ||= File.expand_path(path)
      require_relative "rubygems/user_interaction"
      require "bundler"
      begin
        Gem::DefaultUserInteraction.use_ui(ui) do
          begin
            Bundler.ui.silence do
              @gemdeps = Bundler.setup
            end
          ensure
            Gem::DefaultUserInteraction.ui.close
          end
        end
      rescue Bundler::BundlerError => e
        warn e.message
        warn "You may need to `bundle install` to install missing gems"
        warn ""
      end
    end

use_paths(home, *paths) click to toggle source

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

    # File lib/rubygems.rb, line 984
    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() click to toggle source

Path for gems in the user’s home directory

    # File lib/rubygems/defaults.rb, line 103
    def self.user_dir
      gem_dir = File.join(Gem.user_home, ".gem")
      gem_dir = File.join(Gem.data_home, "gem") unless File.exist?(gem_dir)
      parts = [gem_dir, ruby_engine]
      parts << RbConfig::CONFIG["ruby_version"] unless RbConfig::CONFIG["ruby_version"].empty?
      File.join parts
    end

user_home() click to toggle source

The home directory for the user.

    # File lib/rubygems/defaults.rb, line 96
    def self.user_home
      @user_home ||= find_home.tap(&Gem::UNTAINT)
    end

win_platform?() click to toggle source

Is this a windows platform?

    # File lib/rubygems.rb, line 995
    def self.win_platform?
      if @@win_platform.nil?
        ruby_platform = RbConfig::CONFIG["host_os"]
        @@win_platform = !!WIN_PATTERNS.find {|r| ruby_platform =~ r }
      end

      @@win_platform
    end

write_binary(path, data) click to toggle source

Safely write a file in binary mode on all platforms.

    # File lib/rubygems.rb, line 772
    def self.write_binary(path, data)
      open_file(path, "wb") do |io|
        io.write data
      end
    rescue Errno::ENOSPC
      # If we ran out of space but the file exists, it's *guaranteed* to be corrupted.
      File.delete(path) if File.exist?(path)
      raise
    end

### Private Class Methods

already_loaded?(file) click to toggle source

    # File lib/rubygems.rb, line 1285
    def already_loaded?(file)
      $LOADED_FEATURES.any? do |feature_path|
        feature_path.end_with?(file) && default_gem_load_paths.any? {|load_path_entry| feature_path == "#{load_path_entry}/#{file}" }
      end
    end

default_gem_load_paths() click to toggle source

    # File lib/rubygems.rb, line 1291
    def default_gem_load_paths
      @default_gem_load_paths ||= $LOAD_PATH[load_path_insert_index..-1].map do |lp|
        expanded = File.expand_path(lp)
        next expanded unless File.exist?(expanded)

        File.realpath(expanded)
      end
    end

find_home() click to toggle source

Finds the user’s home directory.

    # File lib/rubygems/defaults.rb, line 81
    def self.find_home
      Dir.home.dup
    rescue
      if Gem.win_platform?
        File.expand_path File.join(ENV["HOMEDRIVE"] || ENV["SystemDrive"], "/")
      else
        File.expand_path "/"
      end
    end

find_spec_for_exe(name, exec_name, requirements) click to toggle source

    # File lib/rubygems.rb, line 247
    def self.find_spec_for_exe(name, exec_name, requirements)
      raise ArgumentError, "you must supply exec_name" unless exec_name

      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 do |spec|
        spec.executables.include? exec_name
      end if exec_name

      unless spec = specs.first
        msg = "can't find gem #{dep} with executable #{exec_name}"
        raise Gem::GemNotFoundException, msg
      end

      spec
    end