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)
As of RubyGems 1.3.2, RubyGems will load plugins installed in gems or $LOAD_PATH. Plugins must be named ‘rubygems_plugin’ (.rb, .so, etc) and placed at the root of your gem’s require_path. Plugins are discovered via ::find_files then loaded. Take care when implementing a plugin as your plugin file may be loaded multiple times if multiple versions of your gem are installed.
For an example plugin, see the graph gem which adds a `gem graph` command.
RubyGems defaults are stored in rubygems/defaults.rb. If you’re packaging RubyGems or implementing Ruby you can change RubyGems’ defaults.
For RubyGems packagers, provide lib/rubygems/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 and post install and uninstall hooks. See ::pre_install, ::pre_uninstall, ::post_install, ::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 Weirch – 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
Location of Marshal quick gemspecs on remote repositories
Subdirectories in a gem repository for default gems
Subdirectories in a gem repository
An Array of Regexps that match windows Ruby platforms.
The list of hooks to be run after Gem::DependencyInstaller installs a set of gems
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
Find the full path to the executable for gem name. If the
exec_name is not given, the gem’s default_executable is
chosen, otherwise the specified executable’s path is returned.
requirements allows you to specify specific gem versions.
# File rubygems.rb, line 265
def self.bin_path(name, exec_name = nil, *requirements)
# TODO: fails test_self_bin_path_bin_file_gone_in_latest
# Gem::Specification.find_by_name(name, *requirements).bin_file exec_name
raise ArgumentError, "you must supply exec_name" unless exec_name
requirements = Gem::Requirement.default if
requirements.empty?
specs = Gem::Dependency.new(name, requirements).matching_specs(true)
raise Gem::GemNotFoundException,
"can't find gem #{name} (#{requirements})" if specs.empty?
specs = specs.find_all { |spec|
spec.executables.include? exec_name
} if exec_name
unless spec = specs.last
msg = "can't find gem #{name} (#{requirements}) with executable #{exec_name}"
raise Gem::GemNotFoundException, msg
end
spec.bin_file exec_name
end
The mode needed to read a file as straight binary.
# File rubygems.rb, line 294
def self.binary_mode
'rb'
end
The path where gem executables are to be installed.
# File rubygems.rb, line 301
def self.bindir(install_dir=Gem.dir)
# TODO: move to Gem::Dirs
return File.join install_dir, 'bin' unless
install_dir.to_s == Gem.default_dir.to_s
Gem.default_bindir
end
Clear default gem related varibles. It is for test
# File rubygems.rb, line 1093
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 313
def self.clear_paths
@paths = nil
@user_home = nil
Gem::Specification.reset
Gem::Security.reset if const_defined? :Security
end
The path to standard location of the user’s .gemrc file.
# File rubygems.rb, line 323
def self.config_file
@config_file ||= File.join Gem.user_home, '.gemrc'
end
The standard configuration object for gems.
# File rubygems.rb, line 330
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 338
def self.configuration=(config)
@configuration = config
end
The path the the data directory specified by the gem name. If the package is not available as a gem, return nil.
# File rubygems.rb, line 346
def self.datadir(gem_name)
# TODO: deprecate and move to Gem::Specification
# and drop the extra ", gem_name" which is uselessly redundant
spec = @loaded_specs[gem_name]
return nil if spec.nil?
File.join spec.full_gem_path, "data", gem_name
end
The default directory for binaries
# File rubygems/defaults.rb, line 105
def self.default_bindir
if defined? RUBY_FRAMEWORK_VERSION then # mac framework support
'/usr/bin'
else # generic install
ConfigMap[:bindir]
end
end
The default signing certificate chain path
# File rubygems/defaults.rb, line 134
def self.default_cert_path
File.join Gem.user_home, ".gem", "gem-public_cert.pem"
end
Default home directory path to be used if an alternate value is not specified in the environment
# File rubygems/defaults.rb, line 29
def self.default_dir
path = if defined? RUBY_FRAMEWORK_VERSION then
[
File.dirname(ConfigMap[:sitedir]),
'Gems',
ConfigMap[:ruby_version]
]
elsif ConfigMap[:rubylibprefix] then
[
ConfigMap[:rubylibprefix],
'gems',
ConfigMap[:ruby_version]
]
else
[
ConfigMap[:libdir],
ruby_engine,
'gems',
ConfigMap[: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 91
def self.default_exec_format
exec_format = ConfigMap[:ruby_install_name].sub('ruby', '%s') rescue '%s'
unless exec_format =~ /%s/ then
raise Gem::Exception,
"[BUG] invalid exec_format #{exec_format.inspect}, no %s"
end
exec_format
end
The default signing key path
# File rubygems/defaults.rb, line 127
def self.default_key_path
File.join Gem.user_home, ".gem", "gem-private_key.pem"
end
Default gem load path
# File rubygems/defaults.rb, line 80
def self.default_path
if Gem.user_home && File.exist?(Gem.user_home) then
[user_dir, default_dir]
else
[default_dir]
end
end
Paths where RubyGems’ .rb files and bin files are installed
# File rubygems/defaults.rb, line 57
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 13
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 21
def self.default_spec_cache_dir
File.join Gem.user_home, '.gem', 'specs'
end
A Zlib::Deflate.deflate wrapper
# File rubygems.rb, line 357
def self.deflate(data)
require 'zlib'
Zlib::Deflate.deflate data
end
# File rubygems.rb, line 215
def self.detect_gemdeps
if path = ENV['RUBYGEMS_GEMDEPS']
path = path.dup.untaint
if path == "-"
here = Dir.pwd.untaint
start = here
begin
while true
path = GEM_DEP_FILES.find { |f| File.file?(f) }
if path
path = File.join here, path
break
end
Dir.chdir ".."
# If we're at a toplevel, stop.
return if Dir.pwd == here
here = Dir.pwd
end
ensure
Dir.chdir start
end
end
path.untaint
return unless File.file? path
rs = Gem::RequestSet.new
rs.load_gemdeps path
rs.resolve_current.map do |s|
sp = s.full_spec
sp.activate
sp
end
end
end
The path where gems are to be installed.
# File rubygems.rb, line 379
def self.dir
# TODO: raise "no"
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 734
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 415
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 402
def self.ensure_gem_subdirectories dir = Gem.dir, mode = nil
ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES)
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 450
def self.find_files(glob, check_load_path=true)
files = []
files = find_files_from_load_path glob if check_load_path
files.concat Gem::Specification.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 484
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 1072
def find_unresolved_default_spec(path)
Gem.suffixes.each do |suffix|
spec = @path_to_default_spec_map["#{path}#{suffix}"]
return spec if spec
end
nil
end
# File rubygems.rb, line 207
def self.finish_resolve(request_set=Gem::RequestSet.new)
request_set.import Gem::Specification.unresolved_deps.values
request_set.resolve_current.each do |s|
s.full_spec.activate
end
end
Zlib::GzipReader wrapper that unzips data.
# File rubygems.rb, line 543
def self.gunzip(data)
# TODO: move to utils
require 'stringio'
require 'zlib'
data = StringIO.new data
unzipped = Zlib::GzipReader.new(data).read
unzipped.force_encoding Encoding::BINARY if Object.const_defined? :Encoding
unzipped
end
Zlib::GzipWriter wrapper that zips data.
# File rubygems.rb, line 557
def self.gzip(data)
# TODO: move to utils
require 'stringio'
require 'zlib'
zipped = StringIO.new
zipped.set_encoding Encoding::BINARY if Object.const_defined? :Encoding
Zlib::GzipWriter.wrap zipped do |io| io.write data end
zipped.string
end
Get the default RubyGems API host. This is normally
https://rubygems.org.
# File rubygems.rb, line 597
def self.host
# TODO: move to utils
@host ||= Gem::DEFAULT_HOST
end
Set the default RubyGems API host.
# File rubygems.rb, line 604
def self.host= host
# TODO: move to utils
@host = host
end
A Zlib::Inflate#inflate wrapper
# File rubygems.rb, line 572
def self.inflate(data)
# TODO: move to utils
require 'zlib'
Zlib::Inflate.inflate data
end
Top level install helper method. Allows you to install gems interactively:
%Qirb >> Gem.install "minitest" Fetching: minitest-3.0.1.gem (100%) => [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]
# File rubygems.rb, line 586
def self.install name, version = Gem::Requirement.default
require "rubygems/dependency_installer"
inst = Gem::DependencyInstaller.new
inst.install name, version
inst.installed_gems
end
Returns the latest release version of RubyGems.
# File rubygems.rb, line 840
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 827
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 848
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 1012
def self.load_env_plugins
path = "rubygems_plugin"
files = []
$LOAD_PATH.each do |load_path|
globbed = Dir["#{File.expand_path path, load_path}#{Gem.suffix_pattern}"]
globbed.each do |load_path_file|
files << load_path_file if File.file?(load_path_file.untaint)
end
end
load_plugin_files files
end
The index to insert activated gem paths into the $LOAD_PATH.
Defaults to the site lib directory unless gem_prelude.rb has loaded paths, then it inserts the activated gem’s paths before the gem_prelude.rb paths so you can override the gem_prelude.rb default $LOAD_PATH paths.
# File rubygems.rb, line 616
def self.load_path_insert_index
index = $LOAD_PATH.index ConfigMap[:sitelibdir]
index
end
Find the ‘rubygems_plugin’ files in the latest installed gems and load them
# File rubygems.rb, line 1000
def self.load_plugins
# Remove this env var by at least 3.0
if ENV['RUBYGEMS_LOAD_ALL_PLUGINS']
load_plugin_files find_files('rubygems_plugin', false)
else
load_plugin_files find_latest_files('rubygems_plugin', false)
end
end
Loads YAML, preferring Psych
# File rubygems.rb, line 627
def self.load_yaml
return if @yaml_loaded
return unless defined?(gem)
test_syck = ENV['TEST_SYCK']
unless test_syck
begin
gem 'psych', '~> 1.2', '>= 1.2.1'
rescue Gem::LoadError
# It's OK if the user does not have the psych gem installed. We will
# attempt to require the stdlib version
end
begin
# Try requiring the gem version *or* stdlib version of psych.
require 'psych'
rescue ::LoadError
# If we can't load psych, thats fine, go on.
else
# If 'yaml' has already been required, then we have to
# be sure to switch it over to the newly loaded psych.
if defined?(YAML::ENGINE) && YAML::ENGINE.yamler != "psych"
YAML::ENGINE.yamler = "psych"
end
require 'rubygems/psych_additions'
require 'rubygems/psych_tree'
end
end
require 'yaml'
# If we're supposed to be using syck, then we may have to force
# activate it via the YAML::ENGINE API.
if test_syck and defined?(YAML::ENGINE)
YAML::ENGINE.yamler = "syck" unless YAML::ENGINE.syck?
end
# Now that we're sure some kind of yaml library is loaded, pull
# in our hack to deal with Syck's DefaultKey ugliness.
require 'rubygems/syck_hack'
@yaml_loaded = true
end
The file name and line number of the caller of the caller of this method.
# File rubygems.rb, line 676
def self.location_of_caller
caller[1] =~ /(.*?):(\d+).*?$/
file = $1
lineno = $2.to_i
# TODO: it is ALWAYS joined! STUPID!
[file, lineno]
end
The version of the Marshal format for your Ruby.
# File rubygems.rb, line 688
def self.marshal_version
"#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
end
# File rubygems.rb, line 199
def self.needs
rs = Gem::RequestSet.new
yield rs
finish_resolve rs
end
# File rubygems.rb, line 384
def self.path
# TODO: raise "no"
paths.path
end
How String Gem paths should be split. Overridable for esoteric platforms.
# File rubygems/defaults.rb, line 73
def self.path_separator
File::PATH_SEPARATOR
end
DOC: needs doc’d or :nodoc’d
# File rubygems.rb, line 363
def self.paths
@paths ||= Gem::PathSupport.new
end
DOC: needs doc’d or :nodoc’d
# File rubygems.rb, line 368
def self.paths=(env)
clear_paths
@paths = Gem::PathSupport.new env
Gem::Specification.dirs = @paths.path # FIX: home is at end
end
Array of platforms this RubyGems supports.
# File rubygems.rb, line 702
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 695
def self.platforms=(platforms)
@platforms = platforms
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 717
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 725
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 742
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 751
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 760
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 768
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 777
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 786
def self.prefix
prefix = File.dirname RUBYGEMS_DIR
if prefix != File.expand_path(ConfigMap[:sitelibdir]) and
prefix != File.expand_path(ConfigMap[:libdir]) and
'lib' == File.basename(RUBYGEMS_DIR) then
prefix
end
end
Safely read a file in binary mode on all platforms.
# File rubygems.rb, line 806
def self.read_binary(path)
File.open path, binary_mode do |f| f.read end
end
Refresh available gems from disk.
# File rubygems.rb, line 799
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 1049
def register_default_spec(spec)
new_format, prefix_pattern = nil
spec.files.each do |file|
if new_format == nil
new_format = spec.require_paths.any? {|path| file.start_with? path}
prefix_group = spec.require_paths.map {|f| f + "/"}.join("|")
prefix_pattern = /^(#{prefix_group})/
end
if new_format
file = file.sub(prefix_pattern, "")
next unless $~
end
@path_to_default_spec_map[file] = spec
end
end
Remove needless Gem::Specification of default gem from unresolved default gem list
# File rubygems.rb, line 1084
def remove_unresolved_default_spec(spec)
spec.files.each do |file|
@path_to_default_spec_map.delete(file)
end
end
The path to the running Ruby interpreter.
# File rubygems.rb, line 813
def self.ruby
if @ruby.nil? then
@ruby = File.join(ConfigMap[:bindir],
"#{ConfigMap[:ruby_install_name]}#{ConfigMap[:EXEEXT]}")
@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 64
def self.ruby= ruby
@ruby = ruby
end
A wrapper around RUBY_ENGINE const that may not be defined
# File rubygems/defaults.rb, line 116
def self.ruby_engine
if defined? RUBY_ENGINE then
RUBY_ENGINE
else
'ruby'
end
end
A Gem::Version for the currently running Ruby.
# File rubygems.rb, line 856
def self.ruby_version
return @ruby_version if defined? @ruby_version
version = RUBY_VERSION.dup
if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1 then
version << ".#{RUBY_PATCHLEVEL}"
elsif defined?(RUBY_REVISION) then
version << ".dev.#{RUBY_REVISION}"
end
@ruby_version = Gem::Version.new version
end
A Gem::Version for the currently running RubyGems
# File rubygems.rb, line 872
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 48
def self.searcher=(searcher)
@searcher = searcher
end
Returns an Array of sources to fetch remote gems from. Uses ::default_sources if the sources list is empty.
# File rubygems.rb, line 881
def self.sources
@sources ||= Gem::SourceList.from(default_sources)
end
Need to be able to set the sources without calling ::sources.replace since that would cause an infinite loop.
DOC: This comment is not documentation about the method itself, it’s more of a code comment about the implementation.
# File rubygems.rb, line 892
def self.sources= new_sources
if !new_sources
@sources = nil
else
@sources = Gem::SourceList.from(new_sources)
end
end
# File rubygems.rb, line 389
def self.spec_cache_dir
paths.spec_cache_dir
end
Glob pattern for require-able path suffixes.
# File rubygems.rb, line 903
def self.suffix_pattern
@suffix_pattern ||= "{#{suffixes.join(',')}}"
end
Suffixes for require-able paths.
# File rubygems.rb, line 910
def self.suffixes
@suffixes ||= ['',
'.rb',
*%w(DLEXT DLEXT2).map { |key|
val = RbConfig::CONFIG[key]
next unless val and not val.empty?
".#{val}"
}
].compact.uniq
end
Prints the amount of time the supplied block takes to run using the debug UI output.
# File rubygems.rb, line 925
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 175
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 alreaby be activated
# or if it was ambigious (and thus unresolved) the code in our custom
# require will try to activate the more specific version.
spec = Gem::Specification.find_inactive_by_path path
unless spec
spec = Gem::Specification.find_by_path path
return true if spec && spec.activated?
return false
end
begin
spec.activate
rescue Gem::LoadError # this could fail due to gem dep collisions, go lax
Gem::Specification.find_by_name(spec.name).activate
end
return true
end
Lazily loads DefaultUserInteraction and returns the default UI.
# File rubygems.rb, line 940
def self.ui
require 'rubygems/user_interaction'
Gem::DefaultUserInteraction.ui
end
Use the home and paths values for ::dir and ::path. Used mainly by the unit tests to
provide environment isolation.
# File rubygems.rb, line 950
def self.use_paths(home, *paths)
paths = nil if paths == [nil]
paths = paths.first if Array === Array(paths).first
self.paths = { "GEM_HOME" => home, "GEM_PATH" => paths }
# TODO: self.paths = home, paths
end
Path for gems in the user’s home directory
# File rubygems/defaults.rb, line 64
def self.user_dir
parts = [Gem.user_home, '.gem', ruby_engine]
parts << ConfigMap[:ruby_version] unless ConfigMap[:ruby_version].empty?
File.join parts
end
The home directory for the user.
# File rubygems.rb, line 960
def self.user_home
@user_home ||= find_home.untaint
end