Module: Gem

Module | Gem
In: | lib/rubygems/defaults.rb lib/rubygems/gem_openssl.rb lib/rubygems.rb

RubyGems is the Ruby standard for publishing and managing third party libraries.

For user documentation, see:

- `gem help` and `gem help [command]`
- RubyGems User Guide
- Frequently Asked Questions

For gem developer documentation see:

- Creating Gems
- Gem::Specification

Further RubyGems documentation can be found at:

- RubyGems API (also available from `gem server`)
- RubyGems Bookshelf

## RubyGems Plugins

As of RubyGems 1.3.2, RubyGems will load plugins installed in gems or $LOAD_PATH. Plugins must be named ‘rubygems_plugin’ are discovered via Gem::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/#{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 Gem::pre_install, Gem::pre_uninstall, Gem::post_install, Gem::post_uninstall.

## Bugs

You can submit bugs to the RubyGems bug tracker on RubyForge

## 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

(If your name is missing, PLEASE let us know!)

Thanks!

-The RubyGems Team

### Methods

activate all_load_paths available? bin_path binary_mode bindir clear_paths config_file configuration configuration= datadir default_bindir default_dir default_exec_format default_path default_sources default_system_source_cache_dir default_user_source_cache_dir deflate dir ensure_gem_subdirectories ensure_ssl_available find_files gunzip gzip inflate latest_load_paths load_path_insert_index location_of_caller marshal_version path platforms platforms= post_install post_uninstall pre_install pre_uninstall prefix promote_load_path read_binary refresh required_location ruby ruby_engine ruby_version searcher source_index sources sources= ssl_available? suffix_pattern suffixes time ui use_paths user_dir user_home win_platform?

### Classes and Modules

Module Gem::Commands
Module Gem::DefaultUserInteraction
Module Gem::Ext
Module Gem::InstallUpdateOptions
Module Gem::LocalRemoteOptions
Module Gem::Package
Module Gem::RequirePathsBuilder
Module Gem::Security
Module Gem::Text
Module Gem::UserInteraction
Module Gem::VersionOption
Class Gem::Builder
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::DigestAdapter
Class Gem::DocManager
Class Gem::DocumentError
Class Gem::EndOfYAMLException
Class Gem::Exception
Class Gem::FakeFetcher
Class Gem::FileOperations
Class Gem::FilePermissionError
Class Gem::Format
Class Gem::FormatException
Class Gem::GemNotFoundException
Class Gem::GemNotInHomeException
Class Gem::GemPathSearcher
Class Gem::GemRunner
Class Gem::Indexer
Class Gem::InstallError
Class Gem::Installer
Class Gem::InvalidSpecificationException
Class Gem::LoadError
Class Gem::OldFormat
Class Gem::OperationNotSupportedError
Class Gem::PackageTask
Class Gem::Platform
Class Gem::RemoteError
Class Gem::RemoteFetcher
Class Gem::RemoteInstallationCancelled
Class Gem::RemoteInstallationSkipped
Class Gem::RemoteSourceException
Class Gem::Requirement
Class Gem::Server
Class Gem::SilentUI
Class Gem::SourceIndex
Class Gem::SourceInfoCache
Class Gem::SourceInfoCacheEntry
Class Gem::SpecFetcher
Class Gem::Specification
Class Gem::StreamUI
Class Gem::SystemExitException
Class Gem::Uninstaller
Class Gem::Validator
Class Gem::VerificationError
Class Gem::Version

### Constants

RubyGemsVersion | = | VERSION = '1.3.5'
ConfigMap | = | {} unless defined?(ConfigMap) |  | Configuration settings from ::RbConfig
DIRECTORIES | = | %w[cache doc gems specifications] unless defined?(DIRECTORIES) |  | Default directories in a gem repository
WIN_PATTERNS | = | [ /bccwin/i, /cygwin/i, /djgpp/i, /mingw/i, /mswin/i, /wince/i, ] |  | An Array of Regexps that match windows ruby platforms.
MARSHAL_SPEC_DIR | = | "quick/Marshal.#{Gem.marshal_version}/" |  | Location of Marshal quick gemspecs on remote repositories
YAML_SPEC_DIR | = | 'quick/' |  | Location of legacy YAML quick gemspecs on remote repositories

### Attributes

loaded_specs | [R] | Hash of loaded Gem::Specification keyed by name
post_install_hooks | [R] | The list of hooks to be run before Gem::Install#install does any work
post_uninstall_hooks | [R] | The list of hooks to be run before Gem::Uninstall#uninstall does any work
pre_install_hooks | [R] | The list of hooks to be run after Gem::Install#install is finished
pre_uninstall_hooks | [R] | The list of hooks to be run after Gem::Uninstall#uninstall is finished
ssl_available | [W] | Is SSL available?

### Public Class methods

activate(gem, *version_requirements)

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.

all_load_paths()

An Array of all possible load paths for all versions of all gems in the Gem installation.

available?(gem, *requirements)

See if a given gem is available.

bin_path(name, exec_name = nil, *version_requirements)

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 specifed executable‘s path is returned. `version_requirements` allows you to specify specific gem versions.

binary_mode()

The mode needed to read a file as straight binary.

bindir(install_dir=Gem.dir)

The path where gem executables are to be installed.

clear_paths()

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.

config_file()

The path to standard location of the user‘s .gemrc file.

configuration()

The standard configuration object for gems.

configuration=(config)

Use the given configuration object (which implements the ConfigFile protocol) as the standard configuration object.

datadir(gem_name)

The path the the data directory specified by the gem name. If the package is not available as a gem, return nil.

default_bindir()

The default directory for binaries

default_dir()

Default home directory path to be used if an alternate value is not specified in the environment

default_exec_format()

Deduce Ruby‘s —program-prefix and —program-suffix from its install name

default_path()

Default gem load path

default_sources()

An Array of the default sources that come with RubyGems

default_system_source_cache_dir()

The default system-wide source info cache directory

default_user_source_cache_dir()

The default user-specific source info cache directory

deflate(data)

A Zlib::Deflate.deflate wrapper

dir()

The path where gems are to be installed.

ensure_gem_subdirectories(gemdir)

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.

ensure_ssl_available()

Ensure that SSL is available. Throw an exception if it is not.

find_files(path)

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.

gunzip(data)

Zlib::GzipReader wrapper that unzips `data`.

gzip(data)

Zlib::GzipWriter wrapper that zips `data`.

inflate(data)

A Zlib::Inflate#inflate wrapper

latest_load_paths()

Return a list of all possible load paths for the latest version for all gems in the Gem installation.

load_path_insert_index()

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.

location_of_caller()

The file name and line number of the caller of the caller of this method.

marshal_version()

The version of the Marshal format for your Ruby.

path()

Array of paths to search for Gems.

platforms()

Array of platforms this RubyGems supports.

platforms=(platforms)

Set array of platforms this RubyGems supports (primarily for testing).

post_install(&hook)

Adds a post-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called

post_uninstall(&hook)

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

pre_install(&hook)

Adds a pre-install hook that will be passed an Gem::Installer instance when Gem::Installer#install is called

pre_uninstall(&hook)

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

prefix()

The directory prefix this RubyGems was installed at.

promote_load_path(gem_name, over_name)

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.

read_binary(path)

Safely read a file in binary mode on all platforms.

refresh()

Refresh source_index from disk and clear searcher.

required_location(gemname, libfile, *requirements)

Full path to `libfile` in `gemname`. Searches for the latest gem unless `requirements` is given.

ruby()

The path to the running Ruby interpreter.

ruby_engine()

A wrapper around RUBY_ENGINE const that may not be defined

ruby_version()

A Gem::Version for the currently running ruby.

searcher()

The GemPathSearcher object used to search for matching installed gems.

source_index()

Returns the Gem::SourceIndex of specifications that are in the Gem.path

sources()

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.

sources=(new_sources)

Need to be able to set the sources without calling Gem.sources.replace since that would cause an infinite loop.

ssl_available?()

Is SSL (used by the signing commands) available on this platform?

suffix_pattern()

Glob pattern for require-able path suffixes.

suffixes()

Suffixes for require-able paths.

time(msg, width = 0, display = Gem.configuration.verbose) {|| ...}

Prints the amount of time the supplied block takes to run using the debug UI output.

ui()

Lazily loads DefaultUserInteraction and returns the default UI.

use_paths(home, paths=[])

Use the `home` and `paths` values for Gem.dir and Gem.path. Used mainly by the unit tests to provide environment isolation.

user_dir()

Path for gems in the user‘s home directory

user_home()

The home directory for the user.

win_platform?()

Is this a windows platform?

[Validate]