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

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

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.

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
KERNEL_WARN_IGNORES_INTERNAL_ENTRIES: When bugs.ruby-lang.org/issues/17259 is available, there is no need to override Kernel#warn
LOADED_SPECS_MUTEX
MARSHAL_SPEC_DIR: Location of Marshal quick gemspecs on remote repositories
READ_BINARY_ERRORS: Exception classes used in a Gem.read_binary rescue statement
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.
WRITE_BINARY_ERRORS: Exception classes used in Gem.write_binary rescue statement

Public Class Methods

activated_gem_paths

() → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 158
def self.activated_gem_paths: () -> Integer

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

add_to_load_path

(*String paths) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 166
def self.add_to_load_path: (*String paths) -> Array[String]

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

bin_path

(String name, String exec_name, ?Array[Requirement] requirements) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 176
def self.bin_path: (String name, String exec_name, ?Array[Requirement] requirements) -> String

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.

binary_mode

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 184
def self.binary_mode: () -> String

The mode needed to read a file as straight binary.

bindir

(?String install_dir) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 192
def self.bindir: (?String install_dir) -> String

The path where gem executables are to be installed.

cache_home

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 200
def self.cache_home: () -> String

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

clear_default_specs

() → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 208
def self.clear_default_specs: () -> void

Clear default gem related variables. It is for test

clear_paths

() → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 218
def self.clear_paths: () -> void

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.

config_file

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 226
def self.config_file: () -> String

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

config_home

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 234
def self.config_home: () -> String

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

configuration

() → ConfigFile

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 242
def self.configuration: () -> ConfigFile

The standard configuration object for gems.

configuration=

(ConfigFile config) → ConfigFile

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 251
def self.configuration=: (ConfigFile config) -> ConfigFile

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

data_home

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 259
def self.data_home: () -> String

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

default_bindir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 267
def self.default_bindir: () -> String

The default directory for binaries

default_cert_path

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 275
def self.default_cert_path: () -> String

The default signing certificate chain path

default_dir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 284
def self.default_dir: () -> String

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

default_exec_format

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 292
def self.default_exec_format: () -> String

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

default_ext_dir_for

(String base_dir) → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 304
def self.default_ext_dir_for: (String base_dir) -> String?

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

default_key_path

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 312
def self.default_key_path: () -> String

The default signing key path

default_path

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 320
def self.default_path: () -> Array[String]

Default gem load path

default_rubygems_dirs

() → Array[String]?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 328
def self.default_rubygems_dirs: () -> Array[String]?

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

default_sources

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 336
def self.default_sources: () -> Array[String]

An Array of the default sources that come with RubyGems

default_spec_cache_dir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 345
def self.default_spec_cache_dir: () -> String

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

default_specifications_dir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 353
def self.default_specifications_dir: () -> String

Path to specification files of default gems.

deflate

(String data) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 361
def self.deflate: (String data) -> String

A Zlib::Deflate.deflate wrapper

dir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 369
def self.dir: () -> String

The path where gems are to be installed.

disable_system_update_message

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 376
def self.disable_system_update_message: () -> String?

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.

disable_system_update_message=

(String?) → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 383
def self.disable_system_update_message=: (String?) -> String?

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.

done_installing

() { (DependencyInstaller, Array[Specification]) → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 393
def self.done_installing: () { (DependencyInstaller, Array[Specification]) -> untyped } -> Array[Proc]

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

done_installing_hooks

() → Array[Proc?]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 399
def self.done_installing_hooks: () -> Array[Proc?]

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

ensure_default_gem_subdirectories

(?String dir, ?Integer | String mode) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 413
def self.ensure_default_gem_subdirectories: (?String dir, ?Integer | String mode) -> Array[String]

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.

ensure_gem_subdirectories

(?String dir, ?Integer | String mode) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 427
def self.ensure_gem_subdirectories: (?String dir, ?Integer | String mode) -> Array[String]

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.

env_requirement

(String gem_name) → Requirement

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 434
def self.env_requirement: (String gem_name) -> Requirement

find_config_file

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 442
def self.find_config_file: () -> String

Finds the user’s config file

find_files

(String glob, ?boolish check_load_path) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 459
def self.find_files: (String glob, ?boolish check_load_path) -> Array[String]

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

find_latest_files

(String glob, ?boolish check_load_path) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 476
def self.find_latest_files: (String glob, ?boolish check_load_path) -> Array[String]

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.

find_unresolved_default_spec

(String path) → Specification?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 484
def self.find_unresolved_default_spec: (String path) -> Specification?

Find an unresolved Gem::Specification of default gem from path

finish_resolve

(?RequestSet request_set) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 491
def self.finish_resolve: (?RequestSet request_set) -> void

gemdeps

() → RequestSet::GemDependencyAPI?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 497
def self.gemdeps: () -> RequestSet::GemDependencyAPI?

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

host

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 506
def self.host: () -> String

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

host=

(String host) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 514
def self.host=: (String host) -> String

Set the default RubyGems API host.

install

(String name, ?Gem::Requirement version, *DependencyInstaller::options options) → Array[Specification]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 527
def self.install: (String name, ?Gem::Requirement version, *DependencyInstaller::options options) -> Array[Specification]

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

java_platform?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 535
def self.java_platform?: () -> bool

Is this a java platform?

latest_rubygems_version

() → Version

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 543
def self.latest_rubygems_version: () -> Version

Returns the latest release version of RubyGems.

latest_spec_for

(String name) → Specification?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 551
def self.latest_spec_for: (String name) -> Specification?

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

latest_version_for

(String name) → Version?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 559
def self.latest_version_for: (String name) -> Version?

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

load_env_plugins

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 567
def self.load_env_plugins: () -> Array[String]

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

load_path_insert_index

() → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 576
def self.load_path_insert_index: () -> Integer

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

load_plugins

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 584
def self.load_plugins: () -> Array[String]

Find rubygems plugin files in the standard location and load them

load_yaml

() → bool?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 592
def self.load_yaml: () -> bool?

Loads YAML, preferring Psych

loaded_specs

() → Hash[String, BasicSpecification]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 597
def self.loaded_specs: () -> Hash[String, BasicSpecification]

Hash of loaded Gem::Specification keyed by name

location_of_caller

(?Integer depth) → [ String, Integer ]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 615
def self.location_of_caller: (?Integer depth) -> [ String, Integer ]

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)

marshal_version

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 623
def self.marshal_version: () -> String

The version of the Marshal format for your Ruby.

needs

() { (RequestSet) → void } → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 630
def self.needs: () { (RequestSet) -> void } -> void

operating_system_defaults

() → Hash[String, String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 651
def self.operating_system_defaults: () -> Hash[String, String]

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

path

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 658
def self.path: () -> Array[String]

path_separator

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 666
def self.path_separator: () -> String

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

paths

() → PathSupport

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 674
def self.paths: () -> PathSupport

Retrieve the PathSupport object that RubyGems uses to lookup files.

paths=

(_HashLike[String, String?] env) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 685
def self.paths=: (_HashLike[String, String?] env) -> Array[String]

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.

platform_defaults

() → Hash[String, String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 706
def self.platform_defaults: () -> Hash[String, String]

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

platforms

() → Array[String | Platform]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 714
def self.platforms: () -> Array[String | Platform]

Array of platforms this RubyGems supports.

platforms=

(Array[String | Platform] platforms) → Array[String | Platform]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 722
def self.platforms=: (Array[String | Platform] platforms) -> Array[String | Platform]

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

plugin_suffix_pattern

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 730
def self.plugin_suffix_pattern: () -> String

Glob pattern for require-able plugin suffixes.

plugin_suffix_regexp

() → Regexp

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 738
def self.plugin_suffix_regexp: () -> Regexp

Regexp for require-able plugin suffixes.

plugindir

(?String install_dir) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 746
def self.plugindir: (?String install_dir) -> String

The path were rubygems plugins are to be installed.

post_build

() { (Installer) → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 758
def self.post_build: () { (Installer) -> untyped } -> Array[Proc]

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.

post_build_hooks

() → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 764
def self.post_build_hooks: () -> Array[Proc]

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

post_install

() { (Installer) → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 773
def self.post_install: () { (Installer) -> untyped } -> Array[Proc]

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

post_install_hooks

() → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 779
def self.post_install_hooks: () -> Array[Proc]

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

post_reset

() { () → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 787
def self.post_reset: () { () -> untyped } -> Array[Proc]

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

post_reset_hooks

() → Array[Proc?]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 792
def self.post_reset_hooks: () -> Array[Proc?]

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

post_uninstall

() { (Uninstaller) → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 801
def self.post_uninstall: () { (Uninstaller) -> untyped } -> Array[Proc]

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

post_uninstall_hooks

() → Array[Proc?]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 807
def self.post_uninstall_hooks: () -> Array[Proc?]

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

pre_install

() { (Installer) → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 817
def self.pre_install: () { (Installer) -> untyped } -> Array[Proc]

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.

pre_install_hooks

() → Array[Proc?]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 822
def self.pre_install_hooks: () -> Array[Proc?]

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

pre_reset

() { () → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 830
def self.pre_reset: () { () -> untyped } -> Array[Proc]

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

pre_reset_hooks

() → Array[Proc?]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 835
def self.pre_reset_hooks: () -> Array[Proc?]

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

pre_uninstall

() { (Uninstaller) → untyped } → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 844
def self.pre_uninstall: () { (Uninstaller) -> untyped } -> Array[Proc]

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

pre_uninstall_hooks

() → Array[Proc?]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 849
def self.pre_uninstall_hooks: () -> Array[Proc?]

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

prefix

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 859
def self.prefix: () -> String?

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.

read_binary

(String path) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 867
def self.read_binary: (String path) -> String

Safely read a file in binary mode on all platforms.

refresh

() → Array[Proc]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 875
def self.refresh: () -> Array[Proc]

Refresh available gems from disk.

register_default_spec

(Specification spec) → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 891
def self.register_default_spec: (Specification spec) -> Array[String]

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.

ruby

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 899
def self.ruby: () -> String

The path to the running Ruby interpreter.

ruby_api_version

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 907
def self.ruby_api_version: () -> String

Returns a String containing the API compatibility version of Ruby

ruby_engine

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 914
def self.ruby_engine: () -> String

ruby_version

() → Version

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 922
def self.ruby_version: () -> Version

A Gem::Version for the currently running Ruby.

rubygems_version

() → Version

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 930
def self.rubygems_version: () -> Version

A Gem::Version for the currently running RubyGems

source_date_epoch

() → Time

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 940
def self.source_date_epoch: () -> Time

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

This is used throughout RubyGems for enabling reproducible builds.

source_date_epoch_string

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 961
def self.source_date_epoch_string: () -> String

If the SOURCE_DATE_EPOCH environment variable is set, returns it’s value. Otherwise, returns DEFAULT_SOURCE_DATE_EPOCH as a string.

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

sources

() → SourceList

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 970
def self.sources: () -> SourceList

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

sources=

(SourceList? new_sources) → SourceList?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 982
def self.sources=: (SourceList? new_sources) -> SourceList?

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.

spec_cache_dir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 989
def self.spec_cache_dir: () -> String

suffix_pattern

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 997
def self.suffix_pattern: () -> String

Glob pattern for require-able path suffixes.

suffix_regexp

() → Regexp

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1005
def self.suffix_regexp: () -> Regexp

Regexp for require-able path suffixes.

suffixes

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1013
def self.suffixes: () -> Array[String]

Suffixes for require-able paths.

time

[T] (String msg, ?Integer width, ?boolish display) { () → T } → T

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1022
def self.time: [T] (String msg, ?Integer width, ?boolish display) { () -> T } -> T

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

try_activate

(String path) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1032
def self.try_activate: (String path) -> bool

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.

() → StreamUI

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1040
def self.ui: () -> StreamUI

Lazily loads DefaultUserInteraction and returns the default UI.

use_gemdeps

(?String path) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1063
def self.use_gemdeps: (?String path) -> void

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.

use_paths

(String home, *String paths) → Hash[String, String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1072
def self.use_paths: (String home, *String paths) -> Hash[String, String]

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

user_dir

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1080
def self.user_dir: () -> String

Path for gems in the user’s home directory

user_home

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1088
def self.user_home: () -> String

The home directory for the user.

win_platform?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1096
def self.win_platform?: () -> bool

Is this a windows platform?

write_binary

(String path, String data) → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/rubygems/rubygems.rbs, line 1104
def self.write_binary: (String path, String data) -> Integer

Safely write a file in binary mode on all platforms.