Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more
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/#{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 RubyForge
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
(If your name is missing, PLEASE let us know!)
Thanks!
-The RubyGems Team
Configuration settings from ::RbConfig
Default directories in a gem repository
Location of Marshal quick gemspecs on remote repositories
An Array of Regexps that match windows ruby platforms.
Location of legacy YAML quick gemspecs on remote repositories
Activates an installed gem matching gem
. The gem must satisfy
version_requirements
.
Returns true if the gem is activated, false if it is already loaded, or an exception otherwise.
Gem#activate adds the library paths in gem
to $LOAD_PATH.
Before a Gem is activated its required Gems are activated. If the version
information is omitted, the highest version Gem of the supplied name is
loaded. If a Gem is not found that meets the version requirements or a
required Gem is not found, a Gem::LoadError is raised.
More information on version requirements can be found in the Gem::Requirement and Gem::Version documentation.
# File rubygems.rb, line 199 def self.activate(gem, *version_requirements) if version_requirements.last.is_a?(Hash) options = version_requirements.pop else options = {} end sources = options[:sources] || [] if version_requirements.empty? then version_requirements = Gem::Requirement.default end unless gem.respond_to?(:name) and gem.respond_to?(:requirement) then gem = Gem::Dependency.new(gem, version_requirements) end matches = Gem.source_index.find_name(gem.name, gem.requirement) report_activate_error(gem) if matches.empty? if @loaded_specs[gem.name] then # This gem is already loaded. If the currently loaded gem is not in the # list of candidate gems, then we have a version conflict. existing_spec = @loaded_specs[gem.name] unless matches.any? { |spec| spec.version == existing_spec.version } then sources_message = sources.map { |spec| spec.full_name } stack_message = @loaded_stacks[gem.name].map { |spec| spec.full_name } msg = "can't activate #{gem} for #{sources_message.inspect}, " msg << "already activated #{existing_spec.full_name} for " msg << "#{stack_message.inspect}" e = Gem::LoadError.new msg e.name = gem.name e.version_requirement = gem.requirement raise e end return false end # new load spec = matches.last return false if spec.loaded? spec.loaded = true @loaded_specs[spec.name] = spec @loaded_stacks[spec.name] = sources.dup # Load dependent gems first spec.runtime_dependencies.each do |dep_gem| activate dep_gem, :sources => [spec, *sources] end # bin directory must come before library directories spec.require_paths.unshift spec.bindir if spec.bindir require_paths = spec.require_paths.map do |path| File.join spec.full_gem_path, path end # gem directories must come after -I and ENV['RUBYLIB'] insert_index = load_path_insert_index if insert_index then # gem directories must come after -I and ENV['RUBYLIB'] $LOAD_PATH.insert(insert_index, *require_paths) else # we are probably testing in core, -I and RUBYLIB don't apply $LOAD_PATH.unshift(*require_paths) end return true end
An Array of all possible load paths for all versions of all gems in the Gem installation.
# File rubygems.rb, line 281 def self.all_load_paths result = [] Gem.path.each do |gemdir| each_load_path all_partials(gemdir) do |load_path| result << load_path end end result end
See if a given gem is available.
# File rubygems.rb, line 305 def self.available?(gem, *requirements) requirements = Gem::Requirement.default if requirements.empty? unless gem.respond_to?(:name) and gem.respond_to?(:requirement) then gem = Gem::Dependency.new gem, requirements end !Gem.source_index.search(gem).empty? end
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.
version_requirements
allows you to specify specific gem
versions.
# File rubygems.rb, line 322 def self.bin_path(name, exec_name = nil, *version_requirements) version_requirements = Gem::Requirement.default if version_requirements.empty? spec = Gem.source_index.find_name(name, version_requirements).last raise Gem::GemNotFoundException, "can't find gem #{name} (#{version_requirements})" unless spec exec_name ||= spec.default_executable unless exec_name msg = "no default executable for #{spec.full_name}" raise Gem::Exception, msg end unless spec.executables.include? exec_name msg = "can't find executable #{exec_name} for #{spec.full_name}" raise Gem::Exception, msg end File.join(spec.full_gem_path, spec.bindir, exec_name) end
The mode needed to read a file as straight binary.
# File rubygems.rb, line 348 def self.binary_mode 'rb' end
The path where gem executables are to be installed.
# File rubygems.rb, line 355 def self.bindir(install_dir=Gem.dir) return File.join(install_dir, 'bin') unless install_dir.to_s == Gem.default_dir Gem.default_bindir 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 366 def self.clear_paths @gem_home = nil @gem_path = nil @user_home = nil @@source_index = nil MUTEX.synchronize do @searcher = nil end end
The path to standard location of the user's .gemrc file.
# File rubygems.rb, line 381 def self.config_file File.join Gem.user_home, '.gemrc' end
The standard configuration object for gems.
# File rubygems.rb, line 388 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 396 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 404 def self.datadir(gem_name) 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 67 def self.default_bindir if defined? RUBY_FRAMEWORK_VERSION then # mac framework support '/usr/bin' else # generic install ConfigMap[:bindir] end end
Default home directory path to be used if an alternate value is not specified in the environment
# File rubygems/defaults.rb, line 19 def self.default_dir if defined? RUBY_FRAMEWORK_VERSION then File.join File.dirname(ConfigMap[:sitedir]), 'Gems', ConfigMap[:ruby_version] elsif ConfigMap[:rubylibprefix] then File.join(ConfigMap[:rubylibprefix], 'gems', ConfigMap[:ruby_version]) else File.join(ConfigMap[:libdir], ruby_engine, 'gems', ConfigMap[:ruby_version]) end end
Deduce Ruby's –program-prefix and –program-suffix from its install name
# File rubygems/defaults.rb, line 53 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
Default gem load path
# File rubygems/defaults.rb, line 42 def self.default_path if File.exist? Gem.user_home then [user_dir, default_dir] else [default_dir] end end
An Array of the default sources that come with RubyGems
# File rubygems/defaults.rb, line 11 def self.default_sources %w[http://rubygems.org/] end
The default system-wide source info cache directory
# File rubygems/defaults.rb, line 78 def self.default_system_source_cache_dir File.join Gem.dir, 'source_cache' end
The default user-specific source info cache directory
# File rubygems/defaults.rb, line 85 def self.default_user_source_cache_dir File.join Gem.user_home, '.gem', 'source_cache' end
A Zlib::Deflate.deflate wrapper
# File rubygems.rb, line 413 def self.deflate(data) require 'zlib' Zlib::Deflate.deflate data end
The path where gems are to be installed.
# File rubygems.rb, line 421 def self.dir @gem_home ||= nil set_home(ENV['GEM_HOME'] || Gem.configuration.home || default_dir) unless @gem_home @gem_home end
Quietly ensure the named Gem directory contains all the proper subdirectories. If we can't create a directory due to a permission problem, then we will silently continue.
# File rubygems.rb, line 454 def self.ensure_gem_subdirectories(gemdir) require 'fileutils' Gem::DIRECTORIES.each do |filename| fn = File.join gemdir, filename FileUtils.mkdir_p fn rescue nil unless File.exist? fn end end
Ensure that SSL is available. Throw an exception if it is not.
# File rubygems/gem_openssl.rb, line 31 def ensure_ssl_available unless ssl_available? raise Gem::Exception, "SSL is not installed on this system" end end
Returns a list of paths matching file
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
::find_files search $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.
# File rubygems.rb, line 474 def self.find_files(path) load_path_files = $LOAD_PATH.map do |load_path| files = Dir["#{File.expand_path path, load_path}#{Gem.suffix_pattern}"] files.select do |load_path_file| File.file? load_path_file.untaint end end.flatten specs = searcher.find_all path specs_files = specs.map do |spec| searcher.matching_files spec, path end.flatten (load_path_files + specs_files).flatten.uniq end
Zlib::GzipReader wrapper that unzips data
.
# File rubygems.rb, line 510 def self.gunzip(data) require 'stringio' require 'zlib' data = StringIO.new data Zlib::GzipReader.new(data).read end
Zlib::GzipWriter wrapper that zips data
.
# File rubygems.rb, line 521 def self.gzip(data) require 'stringio' require 'zlib' zipped = StringIO.new Zlib::GzipWriter.wrap zipped do |io| io.write data end zipped.string end
A Zlib::Inflate#inflate wrapper
# File rubygems.rb, line 534 def self.inflate(data) require 'zlib' Zlib::Inflate.inflate data end
Return a list of all possible load paths for the latest version for all gems in the Gem installation.
# File rubygems.rb, line 543 def self.latest_load_paths result = [] Gem.path.each do |gemdir| each_load_path(latest_partials(gemdir)) do |load_path| result << load_path end end result 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 582 def self.load_path_insert_index $LOAD_PATH.index { |p| p.instance_variable_defined? :@gem_prelude_index } end
Find all 'rubygems_plugin' files and load them
# File rubygems.rb, line 964 def self.load_plugins plugins = Gem.find_files 'rubygems_plugin' plugins.each do |plugin| # Skip older versions of the GemCutter plugin: Its commands are in # RubyGems proper now. next if plugin =~ /gemcutter-0\.[0-3]/ begin load plugin rescue ::Exception => e details = "#{plugin.inspect}: #{e.message} (#{e.class})" warn "Error loading RubyGems plugin #{details}" end end end
The file name and line number of the caller of the caller of this method.
# File rubygems.rb, line 595 def self.location_of_caller caller[1] =~ /(.*?):(\d+).*?$/i file = $1 lineno = $2.to_i [file, lineno] end
The version of the Marshal format for your Ruby.
# File rubygems.rb, line 606 def self.marshal_version "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}" end
Array of paths to search for Gems.
# File rubygems.rb, line 613 def self.path @gem_path ||= nil unless @gem_path then paths = [ENV['GEM_PATH'] || Gem.configuration.path || default_path] if defined?(APPLE_GEM_HOME) and not ENV['GEM_PATH'] then paths << APPLE_GEM_HOME end set_paths paths.compact.join(File::PATH_SEPARATOR) end @gem_path end
Array of platforms this RubyGems supports.
# File rubygems.rb, line 639 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 632 def self.platforms=(platforms) @platforms = platforms end
Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called
# File rubygems.rb, line 651 def self.post_install(&hook) @post_install_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 660 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
# File rubygems.rb, line 668 def self.pre_install(&hook) @pre_install_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 677 def self.pre_uninstall(&hook) @pre_uninstall_hooks << hook end
The directory prefix this RubyGems was installed at.
# File rubygems.rb, line 684 def self.prefix dir = File.dirname File.expand_path(__FILE__) prefix = File.dirname dir if prefix == File.expand_path(ConfigMap[:sitelibdir]) or prefix == File.expand_path(ConfigMap[:libdir]) or 'lib' != File.basename(dir) then nil else prefix end end
Promotes the load paths of the gem_name
over the load paths of
over_name
. Useful for allowing one gem to override features
in another using find_files.
# File rubygems.rb, line 702 def self.promote_load_path(gem_name, over_name) gem = Gem.loaded_specs[gem_name] over = Gem.loaded_specs[over_name] raise ArgumentError, "gem #{gem_name} is not activated" if gem.nil? raise ArgumentError, "gem #{over_name} is not activated" if over.nil? last_gem_path = File.join gem.full_gem_path, gem.require_paths.last over_paths = over.require_paths.map do |path| File.join over.full_gem_path, path end over_paths.each do |path| $LOAD_PATH.delete path end gem = $LOAD_PATH.index(last_gem_path) + 1 $LOAD_PATH.insert(gem, *over_paths) end
Safely read a file in binary mode on all platforms.
# File rubygems.rb, line 738 def self.read_binary(path) File.open path, binary_mode do |f| f.read end end
Refresh ::source_index from disk and clear searcher.
# File rubygems.rb, line 727 def self.refresh source_index.refresh! MUTEX.synchronize do @searcher = nil end end
# File rubygems.rb, line 586 def self.remove_prelude_paths Gem::QuickLoader::GemLoadPaths.each do |path| $LOAD_PATH.delete(path) end end
Full path to libfile
in gemname
. Searches for
the latest gem unless requirements
is given.
# File rubygems.rb, line 770 def self.required_location(gemname, libfile, *requirements) requirements = Gem::Requirement.default if requirements.empty? matches = Gem.source_index.find_name gemname, requirements return nil if matches.empty? spec = matches.last spec.require_paths.each do |path| result = File.join spec.full_gem_path, path, libfile return result if File.exist? result end nil end
The path to the running Ruby interpreter.
# File rubygems.rb, line 789 def self.ruby if @ruby.nil? then @ruby = File.join(ConfigMap[:bindir], ConfigMap[:ruby_install_name]) @ruby << ConfigMap[:EXEEXT] # escape string in case path to ruby executable contain spaces. @ruby.sub!(/.*\s.*/m, '"\&"') end @ruby end
A wrapper around RUBY_ENGINE const that may not be defined
# File rubygems/defaults.rb, line 92 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 805 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
The GemPathSearcher object used to search for matching installed gems.
# File rubygems.rb, line 821 def self.searcher MUTEX.synchronize do @searcher ||= Gem::GemPathSearcher.new end end
Returns the Gem::SourceIndex of specifications that are in the ::path
# File rubygems.rb, line 864 def self.source_index @@source_index ||= SourceIndex.from_installed_gems end
Returns an Array of sources to fetch remote gems from. If the sources list is empty, attempts to load the “sources” gem, then uses ::default_sources if it is not installed.
# File rubygems.rb, line 873 def self.sources if @sources.empty? then begin gem 'sources', '> 0.0.1' require 'sources' rescue LoadError @sources = default_sources end end @sources end
Need to be able to set the sources without calling ::sources.replace since that would cause an infinite loop.
# File rubygems.rb, line 890 def self.sources=(new_sources) @sources = new_sources end
Is SSL (used by the signing commands) available on this platform?
# File rubygems/gem_openssl.rb, line 19 def ssl_available? @ssl_available end
Glob pattern for require-able path suffixes.
# File rubygems.rb, line 897 def self.suffix_pattern @suffix_pattern ||= "{#{suffixes.join(',')}}" end
Suffixes for require-able paths.
# File rubygems.rb, line 904 def self.suffixes ['', '.rb', '.rbw', '.so', '.bundle', '.dll', '.sl', '.jar'] end
Prints the amount of time the supplied block takes to run using the debug UI output.
# File rubygems.rb, line 912 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
# File rubygems.rb, line 1114 def try_activate(path) spec = Gem.searcher.find(path) return false unless spec Gem.activate(spec.name, "= #{spec.version}") return true end
Lazily loads DefaultUserInteraction and returns the default UI.
# File rubygems.rb, line 927 def self.ui require 'rubygems/user_interaction' Gem::DefaultUserInteraction.ui end
Path for gems in the user's home directory
# File rubygems/defaults.rb, line 35 def self.user_dir File.join Gem.user_home, '.gem', ruby_engine, ConfigMap[:ruby_version] end