RubyGems is the Ruby standard for publishing and managing third party libraries.
For user documentation, see:
gem help
and gem help [command]
For gem developer documentation see:
Gem::Version
for version dependency notes
Further RubyGems documentation can be found at:
RubyGems API (also available from gem server
)
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 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
.
You can submit bugs to the RubyGems bug tracker on GitHub
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!)
See LICENSE.txt for permissions.
Thanks!
-The RubyGems Team
When bugs.ruby-lang.org/issues/17259 is available, there is no need to override Kernel#warn
Location of Marshal quick gemspecs on remote repositories
Exception
classes used in a Gem.read_binary
rescue
statement
Subdirectories in a gem repository for default gems
Subdirectories in a gem repository
Taint support is deprecated in Ruby 2.7. This allows switching “.untaint” to “.tap(&Gem::UNTAINT)”, to avoid deprecation warnings in Ruby 2.7.
An Array of Regexps that match windows Ruby platforms.
Exception
classes used in Gem.write_binary
rescue
statement
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.
The list of hooks to be run after Gem::DependencyInstaller
installs a set of gems
GemDependencyAPI object, which is set when .use_gemdeps is called. This contains all the information from the Gemfile.
The list of hooks to be run after Gem::Installer#install
extracts files and builds extensions
The list of hooks to be run after Gem::Installer#install
completes installation
The list of hooks to be run after Gem::Uninstaller#uninstall
completes installation
The number of paths in the `$LOAD_PATH` from activated gems. Used to prioritize `-I` and `ENV` entries during `require`.
# File rubygems.rb, line 603 def self.activated_gem_paths @activated_gem_paths ||= 0 end
Add a list of paths to the $LOAD_PATH at the proper place.
# File rubygems.rb, line 610 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
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 rubygems.rb, line 251 def self.bin_path(name, exec_name = nil, *requirements) # TODO: fails test_self_bin_path_bin_file_gone_in_latest # Gem::Specification.find_by_name(name, *requirements).bin_file exec_name requirements = Gem::Requirement.default if requirements.empty? find_spec_for_exe(name, exec_name, requirements).bin_file exec_name end
The mode needed to read a file as straight binary.
# File rubygems.rb, line 311 def self.binary_mode 'rb' end
The path where gem executables are to be installed.
# File rubygems.rb, line 318 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 to standard location of the user's cache directory.
# File rubygems/defaults.rb, line 153 def self.cache_home @cache_home ||= (ENV["XDG_CACHE_HOME"] || File.join(Gem.user_home, '.cache')) end
Clear default gem related variables. It is for test
# File rubygems.rb, line 1254 def clear_default_specs @path_to_default_spec_map.clear 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.
# File rubygems.rb, line 336 def self.clear_paths @paths = nil @user_home = nil Gem::Specification.reset Gem::Security.reset if defined?(Gem::Security) end
The path to standard location of the user's .gemrc file.
# File rubygems/defaults.rb, line 146 def self.config_file @config_file ||= find_config_file.tap(&Gem::UNTAINT) end
The path to standard location of the user's configuration directory.
# File rubygems/defaults.rb, line 127 def self.config_home @config_home ||= (ENV["XDG_CONFIG_HOME"] || File.join(Gem.user_home, '.config')) end
The standard configuration object for gems.
# File rubygems.rb, line 346 def self.configuration @configuration ||= Gem::ConfigFile.new [] end
Use the given configuration object (which implements the ConfigFile
protocol) as the standard configuration object.
# File rubygems.rb, line 354 def self.configuration=(config) @configuration = config end
The path to standard location of the user's data directory.
# File rubygems/defaults.rb, line 160 def self.data_home @data_home ||= (ENV["XDG_DATA_HOME"] || File.join(Gem.user_home, '.local', 'share')) end
The path to the data directory specified by the gem name. If the package is not available as a gem, return nil.
# File rubygems.rb, line 362 def self.datadir(gem_name) spec = @loaded_specs[gem_name] return nil if spec.nil? spec.datadir end
The default directory for binaries
# File rubygems/defaults.rb, line 199 def self.default_bindir if defined? RUBY_FRAMEWORK_VERSION # mac framework support '/usr/bin' else # generic install RbConfig::CONFIG['bindir'] end end
The default signing certificate chain path
# File rubygems/defaults.rb, line 227 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 home directory path to be used if an alternate value is not specified in the environment
# File rubygems/defaults.rb, line 36 def self.default_dir path = if defined? RUBY_FRAMEWORK_VERSION [ File.dirname(RbConfig::CONFIG['sitedir']), 'Gems', RbConfig::CONFIG['ruby_version'], ] else [ RbConfig::CONFIG['rubylibprefix'], 'gems', RbConfig::CONFIG['ruby_version'], ] end @default_dir ||= File.join(*path) end
Deduce Ruby's –program-prefix and –program-suffix from its install name
# File rubygems/defaults.rb, line 185 def self.default_exec_format exec_format = RbConfig::CONFIG['ruby_install_name'].sub('ruby', '%s') rescue '%s' unless exec_format =~ /%s/ raise Gem::Exception, "[BUG] invalid exec_format #{exec_format.inspect}, no %s" end exec_format 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
# File rubygems/defaults.rb, line 61 def self.default_ext_dir_for(base_dir) nil end
The default signing key path
# File rubygems/defaults.rb, line 214 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 gem load path
# File rubygems/defaults.rb, line 174 def self.default_path path = [] path << user_dir if user_home && File.exist?(user_home) path << default_dir path << vendor_dir if vendor_dir and File.directory? vendor_dir path end
Paths where RubyGems' .rb files and bin files are installed
# File rubygems/defaults.rb, line 68 def self.default_rubygems_dirs nil # default to standard layout end
An Array of the default sources that come with RubyGems
# File rubygems/defaults.rb, line 14 def self.default_sources %w[https://rubygems.org/] end
Default spec directory path to be used if an alternate value is not specified in the environment
# File rubygems/defaults.rb, line 22 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
Path to specification files of default gems.
# File rubygems/defaults.rb, line 75 def self.default_specifications_dir File.join(Gem.default_dir, "specifications", "default") end
A Zlib::Deflate.deflate wrapper
# File rubygems.rb, line 371 def self.deflate(data) require 'zlib' Zlib::Deflate.deflate data end
The path where gems are to be installed.
# File rubygems.rb, line 419 def self.dir paths.home 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
# File rubygems.rb, line 722 def self.done_installing(&hook) @done_installing_hooks << hook 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 rubygems.rb, line 453 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. 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 rubygems.rb, line 440 def self.ensure_gem_subdirectories(dir = Gem.dir, mode = nil) ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES) end
# File rubygems.rb, line 853 def self.env_requirement(gem_name) @env_requirements_by_name ||= {} @env_requirements_by_name[gem_name] ||= begin req = ENV["GEM_REQUIREMENT_#{gem_name.upcase}"] || '>= 0'.freeze Gem::Requirement.create(req) end end
Finds the user's config file
# File rubygems/defaults.rb, line 134 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
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 rubygems.rb, line 503 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
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 rubygems.rb, line 540 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 a Gem::Specification
of default gem from path
# File rubygems.rb, line 1246 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
# File rubygems.rb, line 236 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
Get the default RubyGems API host. This is normally https://rubygems.org
.
# File rubygems.rb, line 575 def self.host @host ||= Gem::DEFAULT_HOST end
Set the default RubyGems API host.
# File rubygems.rb, line 581 def self.host=(host) @host = host 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", ...>]
# File rubygems.rb, line 564 def self.install(name, version = Gem::Requirement.default, *options) require "rubygems/dependency_installer" inst = Gem::DependencyInstaller.new(*options) inst.install name, version inst.installed_gems end
Is this a java platform?
# File rubygems.rb, line 1038 def self.java_platform? RUBY_PLATFORM == "java" end
Returns the latest release version of RubyGems.
# File rubygems.rb, line 878 def self.latest_rubygems_version latest_version_for('rubygems-update') or raise "Can't find 'rubygems-update' in any repo. Check `gem source list`." end
Returns the latest release-version specification for the gem name
.
# File rubygems.rb, line 865 def self.latest_spec_for(name) dependency = Gem::Dependency.new name fetcher = Gem::SpecFetcher.fetcher spec_tuples, = fetcher.spec_for_dependency dependency spec, = spec_tuples.first spec end
Returns the version of the latest release-version of gem name
# File rubygems.rb, line 886 def self.latest_version_for(name) spec = latest_spec_for name spec and spec.version end
Find all 'rubygems_plugin' files in $LOAD_PATH and load them
# File rubygems.rb, line 1072 def self.load_env_plugins load_plugin_files find_files_from_load_path("rubygems_plugin") 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 rubygems.rb, line 589 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
Find rubygems plugin files in the standard location and load them
# File rubygems.rb, line 1065 def self.load_plugins load_plugin_files Gem::Util.glob_files_in_dir("*#{Gem.plugin_suffix_pattern}", plugindir) end
Loads YAML, preferring Psych
# File rubygems.rb, line 622 def self.load_yaml return if @yaml_loaded begin # Try requiring the gem version *or* stdlib version of psych. require 'psych' rescue ::LoadError # If we can't load psych, thats fine, go on. else # If 'yaml' has already been required, then we have to # be sure to switch it over to the newly loaded psych. if defined?(YAML::ENGINE) && YAML::ENGINE.yamler != "psych" YAML::ENGINE.yamler = "psych" end require 'rubygems/psych_additions' require 'rubygems/psych_tree' end require 'yaml' require 'rubygems/safe_yaml' # Now that we're sure some kind of yaml library is loaded, pull # in our hack to deal with Syck's DefaultKey ugliness. require 'rubygems/syck_hack' @yaml_loaded = true end
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 rubygems.rb, line 665 def self.location_of_caller(depth = 1) caller[depth] =~ /(.*?):(\d+).*?$/i file = $1 lineno = $2.to_i [file, lineno] end
The version of the Marshal format for your Ruby.
# File rubygems.rb, line 676 def self.marshal_version "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}" end
# File rubygems.rb, line 228 def self.needs rs = Gem::RequestSet.new yield rs finish_resolve rs 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
# File rubygems/defaults.rb, line 273 def self.operating_system_defaults {} end
How String Gem paths should be split. Overridable for esoteric platforms.
# File rubygems/defaults.rb, line 167 def self.path_separator File::PATH_SEPARATOR end
Retrieve the PathSupport
object that RubyGems uses to lookup files.
# File rubygems.rb, line 379 def self.paths @paths ||= Gem::PathSupport.new(ENV) 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 rubygems.rb, line 389 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
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 rubygems/defaults.rb, line 292 def self.platform_defaults {} end
Array of platforms this RubyGems supports.
# File rubygems.rb, line 690 def self.platforms @platforms ||= [] if @platforms.empty? @platforms = [Gem::Platform::RUBY, Gem::Platform.local] end @platforms end
Set array of platforms this RubyGems supports (primarily for testing).
# File rubygems.rb, line 683 def self.platforms=(platforms) @platforms = platforms end
Glob pattern for require-able plugin suffixes.
# File rubygems.rb, line 961 def self.plugin_suffix_pattern @plugin_suffix_pattern ||= "_plugin#{suffix_pattern}" end
Regexp for require-able plugin suffixes.
# File rubygems.rb, line 968 def self.plugin_suffix_regexp @plugin_suffix_regexp ||= /_plugin#{suffix_regexp}\z/ end
The path were rubygems plugins are to be installed.
# File rubygems.rb, line 327 def self.plugindir(install_dir=Gem.dir) File.join install_dir, 'plugins' 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 rubygems.rb, line 705 def self.post_build(&hook) @post_build_hooks << hook end
Adds a post-install hook that will be passed an Gem::Installer
instance when Gem::Installer#install
is called
# File rubygems.rb, line 713 def self.post_install(&hook) @post_install_hooks << hook end
Adds a hook that will get run after Gem::Specification.reset
is run.
# File rubygems.rb, line 730 def self.post_reset(&hook) @post_reset_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 rubygems.rb, line 739 def self.post_uninstall(&hook) @post_uninstall_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 rubygems.rb, line 748 def self.pre_install(&hook) @pre_install_hooks << hook end
Adds a hook that will get run before Gem::Specification.reset
is run.
# File rubygems.rb, line 756 def self.pre_reset(&hook) @pre_reset_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 rubygems.rb, line 765 def self.pre_uninstall(&hook) @pre_uninstall_hooks << hook 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 rubygems.rb, line 774 def self.prefix prefix = File.dirname RUBYGEMS_DIR if prefix != File.expand_path(RbConfig::CONFIG['sitelibdir']) and prefix != File.expand_path(RbConfig::CONFIG['libdir']) and 'lib' == File.basename(RUBYGEMS_DIR) prefix end end
Safely read a file in binary mode on all platforms.
# File rubygems.rb, line 794 def self.read_binary(path) File.open path, 'rb+' do |f| f.flock(File::LOCK_EX) f.read end rescue *READ_BINARY_ERRORS File.open path, 'rb' do |f| f.read end rescue Errno::ENOLCK # NFS if Thread.main != Thread.current raise else File.open path, 'rb' do |f| f.read end end end
Refresh available gems from disk.
# File rubygems.rb, line 787 def self.refresh Gem::Specification.reset end
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 rubygems.rb, line 1221 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
The path to the running Ruby interpreter.
# File rubygems.rb, line 836 def self.ruby if @ruby.nil? @ruby = RbConfig.ruby @ruby = "\"#{@ruby}\"" if @ruby =~ /\s/ end @ruby end
Allows setting path to Ruby. This method is available when requiring 'rubygems/test_case'
# File rubygems/test_case.rb, line 70 def self.ruby=(ruby) @ruby = ruby end
Returns a String containing the API compatibility version of Ruby
# File rubygems.rb, line 849 def self.ruby_api_version @ruby_api_version ||= RbConfig::CONFIG['ruby_version'].dup end
# File rubygems/defaults.rb, line 207 def self.ruby_engine RUBY_ENGINE end
A Gem::Version
for the currently running Ruby.
# File rubygems.rb, line 894 def self.ruby_version return @ruby_version if defined? @ruby_version version = RUBY_VERSION.dup if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1 version << ".#{RUBY_PATCHLEVEL}" elsif defined?(RUBY_DESCRIPTION) 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
A Gem::Version
for the currently running RubyGems
# File rubygems.rb, line 915 def self.rubygems_version return @rubygems_version if defined? @rubygems_version @rubygems_version = Gem::Version.new Gem::VERSION end
Allows setting the gem path searcher. This method is available when requiring 'rubygems/test_case'
# File rubygems/test_case.rb, line 54 def self.searcher=(searcher) @searcher = searcher end
Returns the value of Gem.source_date_epoch_string
, as a Time object.
This is used throughout RubyGems for enabling reproducible builds.
# File rubygems.rb, line 1184 def self.source_date_epoch Time.at(self.source_date_epoch_string.to_i).utc.freeze end
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 rubygems.rb, line 1165 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
Returns an Array of sources to fetch remote gems from. Uses default_sources
if the sources list is empty.
# File rubygems.rb, line 924 def self.sources source_list = configuration.sources || default_sources @sources ||= Gem::SourceList.from(source_list) end
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 rubygems.rb, line 936 def self.sources=(new_sources) if !new_sources @sources = nil else @sources = Gem::SourceList.from(new_sources) end end
# File rubygems.rb, line 427 def self.spec_cache_dir paths.spec_cache_dir end
Glob pattern for require-able path suffixes.
# File rubygems.rb, line 947 def self.suffix_pattern @suffix_pattern ||= "{#{suffixes.join(',')}}" end
Regexp for require-able path suffixes.
# File rubygems.rb, line 954 def self.suffix_regexp @suffix_regexp ||= /#{Regexp.union(suffixes)}\z/ end
Suffixes for require-able paths.
# File rubygems.rb, line 975 def self.suffixes @suffixes ||= ['', '.rb', *%w[DLEXT DLEXT2].map do |key| val = RbConfig::CONFIG[key] next unless val and not val.empty? ".#{val}" end, ].compact.uniq end
Prints the amount of time the supplied block takes to run using the debug UI output.
# File rubygems.rb, line 990 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 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 rubygems.rb, line 203 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
Lazily loads DefaultUserInteraction
and returns the default UI.
# File rubygems.rb, line 1005 def self.ui require 'rubygems/user_interaction' Gem::DefaultUserInteraction.ui end
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 rubygems.rb, line 1096 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 'rubygems/user_interaction' Gem::DefaultUserInteraction.use_ui(ui) do require "bundler" begin Bundler.ui.silence do @gemdeps = Bundler.setup end ensure Gem::DefaultUserInteraction.ui.close end @gemdeps.requested_specs.map(&:to_spec).sort_by(&:name) end rescue => e case e when Gem::LoadError, Gem::UnsatisfiableDependencyError, (defined?(Bundler::GemNotFound) ? Bundler::GemNotFound : Gem::LoadError) warn e.message warn "You may need to `gem install -g` to install missing gems" warn "" else raise end end
Use the home
and paths
values for Gem.dir
and Gem.path
. Used mainly by the unit tests to provide environment isolation.
# File rubygems.rb, line 1015 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
Path for gems in the user's home directory
# File rubygems/defaults.rb, line 116 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
The home directory for the user.
# File rubygems/defaults.rb, line 109 def self.user_home @user_home ||= find_home.tap(&Gem::UNTAINT) end
Allows toggling Windows behavior. This method is available when requiring 'rubygems/test_case'
# File rubygems/test_case.rb, line 62 def self.win_platform=(val) @@win_platform = val end
Is this a windows platform?
# File rubygems.rb, line 1026 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
Safely write a file in binary mode on all platforms.
# File rubygems.rb, line 815 def self.write_binary(path, data) open(path, 'wb') do |io| begin io.flock(File::LOCK_EX) rescue *WRITE_BINARY_ERRORS end io.write data end rescue Errno::ENOLCK # NFS if Thread.main != Thread.current raise else open(path, 'wb') do |io| io.write data end end end