RubyGems is the Ruby standard for publishing and managing third party libraries.
For user documentation, see:
-
gem help
andgem 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 Plugins
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, Packaging
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.
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 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
- MODULE Gem::Commands
- MODULE Gem::DefaultUserInteraction
- MODULE Gem::Deprecate
- MODULE Gem::Ext
- MODULE Gem::GemcutterUtilities
- MODULE Gem::InstallUpdateOptions
- MODULE Gem::LocalRemoteOptions
- MODULE Gem::Security
- MODULE Gem::Text
- MODULE Gem::UserInteraction
- MODULE Gem::VersionOption
- CLASS Gem::AvailableSet
- CLASS Gem::Command
- CLASS Gem::CommandLineError
- CLASS Gem::CommandManager
- CLASS Gem::ConfigFile
- CLASS Gem::ConsoleUI
- CLASS Gem::Dependency
- CLASS Gem::DependencyError
- CLASS Gem::DependencyInstaller
- CLASS Gem::DependencyList
- CLASS Gem::DependencyRemovalException
- CLASS Gem::DependencyResolutionError
- CLASS Gem::DependencyResolver
- CLASS Gem::Doctor
- CLASS Gem::DocumentError
- CLASS Gem::EndOfYAMLException
- CLASS Gem::ErrorReason
- CLASS Gem::Exception
- CLASS Gem::FilePermissionError
- CLASS Gem::FormatException
- CLASS Gem::GemNotFoundException
- CLASS Gem::GemNotInHomeException
- CLASS Gem::GemRunner
- CLASS Gem::ImpossibleDependenciesError
- CLASS Gem::Indexer
- CLASS Gem::InstallError
- CLASS Gem::Installer
- CLASS Gem::InvalidSpecificationException
- CLASS Gem::LoadError
- CLASS Gem::MockGemUi
- CLASS Gem::NameTuple
- CLASS Gem::NoAliasYAMLTree
- CLASS Gem::OperationNotSupportedError
- CLASS Gem::Package
- CLASS Gem::PackageTask
- CLASS Gem::PathSupport
- CLASS Gem::Platform
- CLASS Gem::PlatformMismatch
- CLASS Gem::RemoteError
- CLASS Gem::RemoteFetcher
- CLASS Gem::RemoteInstallationCancelled
- CLASS Gem::RemoteInstallationSkipped
- CLASS Gem::RemoteSourceException
- CLASS Gem::RequestSet
- CLASS Gem::Requirement
- CLASS Gem::Server
- CLASS Gem::SilentUI
- CLASS Gem::Source
- CLASS Gem::SourceFetchProblem
- CLASS Gem::SourceList
- CLASS Gem::SpecFetcher
- CLASS Gem::SpecificGemNotFoundException
- CLASS Gem::Specification
- CLASS Gem::StreamUI
- CLASS Gem::SystemExitException
- CLASS Gem::Uninstaller
- CLASS Gem::UnsatisfiableDepedencyError
- CLASS Gem::Validator
- CLASS Gem::VerificationError
- CLASS Gem::Version
- CLASS RDoc::RubygemsHook
- CLASS YAML::Syck::SyckDefaultKey
- B
- C
- D
- E
- F
- G
- H
- I
- L
- M
- N
- P
- R
- S
- T
- U
- W
VERSION | = | '2.0.14' |
RUBYGEMS_DIR | = | File.dirname File.expand_path(__FILE__) |
WIN_PATTERNS | = | [ /bccwin/i, /cygwin/i, /djgpp/i, /mingw/i, /mswin/i, /wince/i, ] |
An Array of Regexps that match windows ruby platforms. |
||
GEM_DEP_FILES | = | %w[ gem.deps.rb Gemfile Isolate ] |
REPOSITORY_SUBDIRECTORIES | = | %w[ build_info cache doc gems specifications ] |
Subdirectories in a gem repository |
||
MARSHAL_SPEC_DIR | = | "quick/Marshal.#{Gem.marshal_version}/" |
Location of Marshal quick gemspecs on remote repositories |
||
DEFAULT_HOST | = | "https://rubygems.org" |
RDoc | = | RDoc::RubygemsHook |
Gem::RDoc provides methods to generate RDoc and ri data for installed gems upon gem installation. This file is automatically required by RubyGems 1.9 and newer. |
[R] | done_installing_hooks | The list of hooks to be run after Gem::DependencyInstaller installs a set of gems |
[R] | loaded_specs | Hash of loaded Gem::Specification keyed by name |
[R] | post_build_hooks | The list of hooks to be run after Gem::Installer#install extracts files and builds extensions |
[R] | post_install_hooks | The list of hooks to be run after Gem::Installer#install completes installation |
[R] | post_reset_hooks | The list of hooks to be run after Gem::Specification.reset is run. |
[R] | post_uninstall_hooks | The list of hooks to be run after Gem::Uninstaller#uninstall completes installation |
[R] | pre_install_hooks | The list of hooks to be run before Gem::Installer#install does any work |
[R] | pre_reset_hooks | The list of hooks to be run before Gem::Specification.reset is run. |
[R] | pre_uninstall_hooks | The list of hooks to be run before Gem::Uninstaller#uninstall does any work |
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 lib/rubygems.rb, line 257 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.
The path where gem executables are to be installed.
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.
The path to standard location of the user's .gemrc file.
The standard configuration object for gems.
Use the given configuration object (which implements the ConfigFile protocol) as the standard configuration object.
The path the the data directory specified by the gem name. If the package is not available as a gem, return nil.
# File lib/rubygems.rb, line 338 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
The default signing certificate chain path
Default home directory path to be used if an alternate value is not specified in the environment
# File lib/rubygems/defaults.rb, line 21 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 lib/rubygems/defaults.rb, line 83 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
Default gem load path
Paths where RubyGems' .rb files and bin files are installed
An Array of the default sources that come with RubyGems
A Zlib::Deflate.deflate wrapper
# File lib/rubygems.rb, line 207 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.
Adds a post-installs hook that will be passed a Gem::DependencyInstaller and a list of installed specifications when Gem::DependencyInstaller#install is complete
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 lib/rubygems.rb, line 390 def self.ensure_gem_subdirectories dir = Gem.dir, mode = nil old_umask = File.umask File.umask old_umask | 002 require 'fileutils' options = {} options[:mode] = mode if mode REPOSITORY_SUBDIRECTORIES.each do |name| subdir = File.join dir, name next if File.exist? subdir FileUtils.mkdir_p subdir, options rescue nil end ensure File.umask old_umask 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.
# File lib/rubygems.rb, line 421 def self.find_files(glob, check_load_path=true) files = [] if check_load_path files = $LOAD_PATH.map { |load_path| Dir["#{File.expand_path glob, load_path}#{Gem.suffix_pattern}"] }.flatten.select { |file| File.file? file.untaint } end 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
Zlib::GzipReader wrapper that unzips
data
.
Zlib::GzipWriter wrapper that zips
data
.
# File lib/rubygems.rb, line 498 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
.
A Zlib::Inflate#inflate wrapper
Top level install helper method. Allows you to install gems interactively:
% irb
>> Gem.install "minitest"
Fetching: minitest-3.0.1.gem (100%)
=> [#<Gem::Specification:0x1013b4528 @name="minitest", ...>]
Returns the latest release version of RubyGems.
Returns the latest release-version specification for the gem
name
.
Returns the version of the latest release-version of gem name
Find all 'rubygems_plugin' files in $LOAD_PATH and load them
# File lib/rubygems.rb, line 947 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.
Load plugins
as ruby files
# File lib/rubygems.rb, line 920 def self.load_plugin_files(plugins) 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
Loads YAML, preferring Psych
# File lib/rubygems.rb, line 568 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.
How String Gem paths should be split. Overridable for esoteric platforms.
DOC: needs doc'd or :nodoc'd
DOC: needs doc'd or :nodoc'd
Array of platforms this RubyGems supports.
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.
Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called
Adds a hook that will get run after Gem::Specification.reset is run.
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
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.
Adds a hook that will get run before Gem::Specification.reset is run.
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
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.
Safely read a file in binary mode on all platforms.
Refresh available gems from disk.
The path to the running Ruby interpreter.
A wrapper around RUBY_ENGINE const that may not be defined
A Gem::Version for the currently running ruby.
# File lib/rubygems.rb, line 797 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
Returns an Array of sources to fetch remote gems from. Uses ::default_sources if the sources list is empty.
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.
Glob pattern for require-able path suffixes.
Suffixes for require-able paths.
Prints the amount of time the supplied block takes to run using the debug UI output.
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 lib/rubygems.rb, line 167 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.
Path for gems in the user's home directory
The home directory for the user.
Is this a windows platform?
Clear default gem related varibles. It is for test
Find a Gem::Specification of default gem from
path
Register a Gem::Specification for default gem
Remove needless Gem::Specification of default gem from unresolved default gem list