module Gem
RubyGems is the Ruby standard for publishing and managing third party libraries.
For user documentation, see:
-
gem helpandgem help [command]
For gem developer documentation see:
-
Gem::Versionfor version dependency notes
Further RubyGems documentation can be found at:
-
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
Workaround for directly loading Gem::Version in some cases
Constants
- DEFAULT_HOST
- DEFAULT_SOURCE_DATE_EPOCH
-
The default value for SOURCE_DATE_EPOCH if not specified. We want a date after 1980-01-01, to prevent issues with Zip files. This particular timestamp is for 1980-01-02 00:00:00 GMT.
- GEM_DEP_FILES
- LOADED_SPECS_MUTEX
- MARSHAL_SPEC_DIR
-
Location of
Marshalquick gemspecs on remote repositories - RDoc
- REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES
-
Subdirectories in a gem repository for default gems
- REPOSITORY_SUBDIRECTORIES
-
Subdirectories in a gem repository
- RUBYGEMS_DIR
- VERSION
- WIN_PATTERNS
-
An
Arrayof Regexps that match windows Ruby platforms.
Attributes
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.
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`.
() → Array[Proc?]
The list of hooks to be run after Gem::DependencyInstaller installs a set of gems
() → RequestSet::GemDependencyAPI?
GemDependencyAPI object, which is set when .use_gemdeps is called. This contains all the information from the Gemfile.
Hash of loaded Gem::Specification keyed by name
() → Array[Proc]
The list of hooks to be run after Gem::Installer#install extracts files and builds extensions
() → Array[Proc]
The list of hooks to be run after Gem::Installer#install completes installation
() → Array[Proc?]
The list of hooks to be run after Gem::Specification.reset is run.
() → Array[Proc?]
The list of hooks to be run after Gem::Uninstaller#uninstall completes installation
() → Array[Proc?]
The list of hooks to be run before Gem::Installer#install does any work
() → Array[Proc?]
The list of hooks to be run before Gem::Specification.reset is run.
() → Array[Proc?]
The list of hooks to be run before Gem::Uninstaller#uninstall does any work
Public Class Methods
# File lib/rubygems.rb, line 283 def self.activate_and_load_bin_path(name, exec_name = nil, *requirements) spec = find_and_activate_spec_for_exe name, exec_name, requirements if spec.name == "bundler" # Old versions of Bundler need a workaround to support nested `bundle # exec` invocations by overriding `Gem.activate_bin_path`. However, # RubyGems now uses this new `Gem.activate_and_load_bin_path` helper in # binstubs, which is of course not overridden in Bundler since it didn't # exist at the time. So, include the override here to workaround that. load ENV["BUNDLE_BIN_PATH"] if ENV["BUNDLE_BIN_PATH"] && spec.version <= Gem::Version.create("2.5.22") # Make sure there's no version of Bundler in `$LOAD_PATH` that's different # from the version we just activated. If that was the case (it happens # when testing Bundler from ruby/ruby), we would load Bundler extensions # to RubyGems from the copy in `$LOAD_PATH` but then load the binstub from # an installed copy, causing those copies to be mixed and yet more # redefinition warnings. # require_path = $LOAD_PATH.resolve_feature_path("bundler").last.delete_suffix("/bundler.rb") Gem.load_bundler_extensions(spec.version) if spec.full_require_paths.include?(require_path) end load spec.bin_file(exec_name) end
Find and load 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.
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.
Source
# File lib/rubygems.rb, line 626 def self.activated_gem_paths @activated_gem_paths ||= 0 end
The number of paths in the +$LOAD_PATH+ from activated gems. Used to prioritize -I and ENV['RUBYLIB'] entries during require.
# File lib/rubygems.rb, line 633 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
Add a list of paths to the $LOAD_PATH at the proper place.
(String name, String exec_name, ?Array[Requirement] requirements) → String
Source
# File lib/rubygems.rb, line 231 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
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.
() → String
Source
# File lib/rubygems.rb, line 326 def self.binary_mode "rb" end
The mode needed to read a file as straight binary.
# File lib/rubygems.rb, line 333 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
The path where gem executables are to be installed.
() → String
Source
# File lib/rubygems/defaults.rb, line 147 def self.cache_home @cache_home ||= ENV["XDG_CACHE_HOME"] || File.join(Gem.user_home, ".cache") end
The path to standard location of the userās cache directory.
() → void
Source
# File lib/rubygems.rb, line 1326 def clear_default_specs @path_to_default_spec_map.clear end
Clear default gem related variables. It is for test
() → void
Source
# File lib/rubygems.rb, line 351 def self.clear_paths @paths = nil @user_home = nil Gem::Specification.reset Gem::Security.reset if defined?(Gem::Security) end
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.
() → String
Source
# File lib/rubygems/defaults.rb, line 133 def self.config_file @config_file ||= find_config_file end
The path to standard location of the userās .gemrc file.
() → String
Source
# File lib/rubygems/defaults.rb, line 114 def self.config_home @config_home ||= ENV["XDG_CONFIG_HOME"] || File.join(Gem.user_home, ".config") end
The path to standard location of the userās configuration directory.
Source
# File lib/rubygems.rb, line 361 def self.configuration @configuration ||= Gem::ConfigFile.new [] end
The standard configuration object for gems.
(ConfigFile config) → ConfigFile
Source
# File lib/rubygems.rb, line 369 def self.configuration=(config) @configuration = config end
Use the given configuration object (which implements the ConfigFile protocol) as the standard configuration object.
() → String
Source
# 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
The path to standard location of the userās data directory.
() → String
Source
# File lib/rubygems/defaults.rb, line 204 def self.default_bindir RbConfig::CONFIG["bindir"] end
The default directory for binaries
Source
# File lib/rubygems/defaults.rb, line 228 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
The default signing certificate chain path
() → String
Source
# 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 home directory path to be used if an alternate value is not specified in the environment
Source
# File lib/rubygems/defaults.rb, line 186 def self.default_exec_format exec_format = begin RbConfig::CONFIG["ruby_install_name"].sub("ruby", "%s") rescue StandardError "%s" end unless exec_format.include?("%s") raise Gem::Exception, "[BUG] invalid exec_format #{exec_format.inspect}, no %s" end exec_format end
Deduce Rubyās āprogram-prefix and āprogram-suffix from its install name
# File lib/rubygems/defaults.rb, line 48 def self.default_ext_dir_for(base_dir) nil end
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
Source
# File lib/rubygems/defaults.rb, line 215 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
The default signing key 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 gem load path
# File lib/rubygems/defaults.rb, line 55 def self.default_rubygems_dirs nil # default to standard layout end
Paths where RubyGemsā .rb files and bin files are installed
# File lib/rubygems/defaults.rb, line 15 def self.default_sources @default_sources ||= %w[https://rubygems.org/] end
An Array of the default sources that come with RubyGems
Source
# 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.cache_home, "gem", "specs" end default_spec_cache_dir end
Default spec directory path to be used if an alternate value is not specified in the environment
Source
# File lib/rubygems/defaults.rb, line 62 def self.default_specifications_dir @default_specifications_dir ||= File.join(Gem.default_dir, "specifications", "default") end
Path to specification files of default gems.
# File lib/rubygems.rb, line 376 def self.deflate(data) require "zlib" Zlib::Deflate.deflate data end
A Zlib::Deflate.deflate wrapper
# File lib/rubygems.rb, line 424 def self.dir paths.home end
The path where gems are to be installed.
() { (DependencyInstaller, Array[Specification]) → untyped } → Array[Proc]
Source
# File lib/rubygems.rb, line 761 def self.done_installing(&hook) @done_installing_hooks << hook end
Adds a post-installs hook that will be passed a Gem::DependencyInstaller and a list of installed specifications when Gem::DependencyInstaller#install is complete
Source
# File lib/rubygems.rb, line 1042 def self.dynamic_library_suffixes @dynamic_library_suffixes ||= suffixes - [".rb"] end
Suffixes for dynamic library require-able paths.
# File lib/rubygems.rb, line 475 def self.ensure_default_gem_subdirectories(dir = Gem.dir, mode = nil) ensure_subdirectories(dir, mode, REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES) end
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 462 def self.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES) end
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.
(String gem_name) → Requirement
Source
# File lib/rubygems.rb, line 910 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
Source
# 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
Finds the userās config file
Source
# File lib/rubygems.rb, line 1311 def find_default_spec(path) @path_to_default_spec_map[path] end
Find a Gem::Specification of default gem from path
# File lib/rubygems.rb, line 526 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.flat_map {|spec| spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}") } # $LOAD_PATH might contain duplicate entries or reference # the spec dirs directly, so we prune. files.uniq! if check_load_path files end
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 563 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).flat_map {|spec| spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}") } # $LOAD_PATH might contain duplicate entries or reference # the spec dirs directly, so we prune. files.uniq! if check_load_path files end
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.
(String path) → Specification?
Source
# File lib/rubygems.rb, line 1318 def find_unresolved_default_spec(path) default_spec = @path_to_default_spec_map[path] default_spec if default_spec && loaded_specs[default_spec.name] != default_spec end
Find an unresolved Gem::Specification of default gem from path
(?RequestSet request_set) → void
Source
# File lib/rubygems.rb, line 216 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
Source
# File lib/rubygems.rb, line 1100 def self.freebsd_platform? RbConfig::CONFIG["host_os"].to_s.include?("bsd") end
Is this platform FreeBSD
# File lib/rubygems.rb, line 598 def self.host @host ||= Gem::DEFAULT_HOST end
Get the default RubyGems API host. This is normally https://rubygems.org.
# File lib/rubygems.rb, line 604 def self.host=(host) @host = host end
Set the default RubyGems API host.
(String name, ?Gem::Requirement version, *DependencyInstaller::options options) → Array[Specification]
Source
# File lib/rubygems.rb, line 587 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
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", ...>]
() → bool
Source
# File lib/rubygems.rb, line 1086 def self.java_platform? RUBY_PLATFORM == "java" end
Is this a java platform?
Source
# File lib/rubygems.rb, line 935 def self.latest_rubygems_version latest_version_for("rubygems-update") || raise("Can't find 'rubygems-update' in any repo. Check `gem source list`.") end
Returns the latest release version of RubyGems.
(String name) → Specification?
Source
# File lib/rubygems.rb, line 922 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
Returns the latest release-version specification for the gem name.
# File lib/rubygems.rb, line 943 def self.latest_version_for(name) latest_spec_for(name)&.version end
Returns the version of the latest release-version of gem name
# File lib/rubygems.rb, line 670 def self.load_bundler_extensions(version) return unless version <= Gem::Version.create("2.6.9") previous_platforms = {} platform_const_list = ["JAVA", "MSWIN", "MSWIN64", "MINGW", "X64_MINGW_LEGACY", "X64_MINGW", "UNIVERSAL_MINGW", "WINDOWS", "X64_LINUX", "X64_LINUX_MUSL"] platform_const_list.each do |platform| previous_platforms[platform] = Gem::Platform.const_get(platform) Gem::Platform.send(:remove_const, platform) end require "bundler/rubygems_ext" platform_const_list.each do |platform| Gem::Platform.send(:remove_const, platform) if Gem::Platform.const_defined?(platform) Gem::Platform.const_set(platform, previous_platforms[platform]) end end
Load Bundler extensions to RubyGems, making sure to avoid redefinition warnings in platform constants
# File lib/rubygems.rb, line 1135 def self.load_env_plugins load_plugin_files find_files_from_load_path("rubygems_plugin") end
Find all ārubygems_pluginā files in $LOAD_PATH and load them
Source
# File lib/rubygems.rb, line 612 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
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 1126 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
Find rubygems plugin files in the standard location and load them
Source
# File lib/rubygems.rb, line 658 def self.load_safe_marshal return if @safe_marshal_loaded require_relative "rubygems/safe_marshal" @safe_marshal_loaded = true end
() → bool?
Source
# File lib/rubygems.rb, line 645 def self.load_yaml return if @yaml_loaded require "psych" require_relative "rubygems/psych_tree" require_relative "rubygems/safe_yaml" @yaml_loaded = true end
# File lib/rubygems.rb, line 704 def self.location_of_caller(depth = 1) caller[depth] =~ /(.*?):(\d+).*?$/i file = $1 lineno = $2.to_i [file, lineno] end
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)
() → String
Source
# File lib/rubygems.rb, line 715 def self.marshal_version "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}" end
The version of the Marshal format for your Ruby.
() { (RequestSet) → void } → void
Source
# File lib/rubygems.rb, line 208 def self.needs rs = Gem::RequestSet.new yield rs finish_resolve rs end
# File lib/rubygems.rb, line 851 def self.open_file(path, flags, &block) File.open(path, flags, &block) end
Open a file with given flags
# File lib/rubygems.rb, line 869 def self.open_file_with_flock(path, &block) # read-write mode is used rather than read-only in order to support NFS mode = IO::RDWR | IO::APPEND | IO::CREAT | IO::BINARY mode |= IO::SHARE_DELETE if IO.const_defined?(:SHARE_DELETE) File.open(path, mode) do |io| begin # Try to get a lock without blocking. # If we do, the file is locked. # Otherwise, explain why we're waiting and get a lock, but block this time. if io.flock(File::LOCK_EX | File::LOCK_NB) != 0 warn "Waiting for another process to let go of lock: #{path}" io.flock(File::LOCK_EX) end io.puts(Process.pid) rescue Errno::ENOSYS, Errno::ENOTSUP end yield io end end
Open a file with given flags, and protect access with flock
# File lib/rubygems.rb, line 858 def self.open_file_with_lock(path, &block) file_lock = "#{path}.lock" open_file_with_flock(file_lock, &block) ensure require "fileutils" FileUtils.rm_f file_lock end
Open a file with given flags, and protect access with a file lock
Source
# File lib/rubygems/defaults.rb, line 286 def self.operating_system_defaults {} end
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
() → String
Source
# File lib/rubygems/defaults.rb, line 168 def self.path_separator File::PATH_SEPARATOR end
() → PathSupport
Source
# File lib/rubygems.rb, line 384 def self.paths @paths ||= Gem::PathSupport.new(ENV) end
Retrieve the PathSupport object that RubyGems uses to lookup files.
# File lib/rubygems.rb, line 394 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
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/defaults.rb, line 305 def self.platform_defaults {} end
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.rb, line 729 def self.platforms @platforms ||= [] if @platforms.empty? @platforms = [Gem::Platform::RUBY, Gem::Platform.local] end @platforms end
Array of platforms this RubyGems supports.
# File lib/rubygems.rb, line 722 def self.platforms=(platforms) @platforms = platforms end
Set array of platforms this RubyGems supports (primarily for testing).
Source
# File lib/rubygems.rb, line 1015 def self.plugin_suffix_pattern @plugin_suffix_pattern ||= "_plugin#{suffix_pattern}" end
Glob pattern for require-able plugin suffixes.
Source
# File lib/rubygems.rb, line 1022 def self.plugin_suffix_regexp @plugin_suffix_regexp ||= /_plugin#{suffix_regexp}\z/ end
Regexp for require-able plugin suffixes.
# File lib/rubygems.rb, line 342 def self.plugindir(install_dir = Gem.dir) File.join install_dir, "plugins" end
The path were rubygems plugins are to be installed.
# File lib/rubygems.rb, line 744 def self.post_build(&hook) @post_build_hooks << hook end
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 752 def self.post_install(&hook) @post_install_hooks << hook end
Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called
# File lib/rubygems.rb, line 769 def self.post_reset(&hook) @post_reset_hooks << hook end
Adds a hook that will get run after Gem::Specification.reset is run.
() { (Uninstaller) → untyped } → Array[Proc]
Source
# File lib/rubygems.rb, line 778 def self.post_uninstall(&hook) @post_uninstall_hooks << hook end
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 787 def self.pre_install(&hook) @pre_install_hooks << hook end
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 795 def self.pre_reset(&hook) @pre_reset_hooks << hook end
Adds a hook that will get run before Gem::Specification.reset is run.
() { (Uninstaller) → untyped } → Array[Proc]
Source
# File lib/rubygems.rb, line 804 def self.pre_uninstall(&hook) @pre_uninstall_hooks << hook end
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 813 def self.prefix prefix = File.dirname RUBYGEMS_DIR if prefix != File.expand_path(RbConfig::CONFIG["sitelibdir"]) && prefix != File.expand_path(RbConfig::CONFIG["libdir"]) && File.basename(RUBYGEMS_DIR) == "lib" prefix end end
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/rdoc.rb, line 13 def self.rdoc_hooks_defined_via_plugin? Gem::Version.new(::RDoc::VERSION) >= Gem::Version.new("6.9.0") end
Returns whether RDoc defines its own install hooks through a RubyGems plugin. This and whatever is guarded by it can be removed once no supported Ruby ships with RDoc older than 6.9.0.