module Gem (Ruby 3.1 リファレンスマニュアル)

このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。最新版のマニュアルへ

要約

モジュール関数

bin_path(name, exec_name = nil, *requirements) -> StringRuby 1.9.2 から[permalink][rdoc][edit]

Gem name に含まれる実行可能ファイル exec_name のフルパスを返します。

exec_name を省略した場合は例外が発生します。requirements で特定のバージョンを指定できます。Gem を有効化(activate)する副作用はありません。

[PARAM] name:: 実行可能ファイルを含む Gem の名前です。
[PARAM] exec_name:: 実行可能ファイルの名前です。省略すると例外が発生します。
[PARAM] requirements:: 使用する Gem のバージョンを指定します。Gem::Requirement が解釈できる形式で複数指定できます。
[RETURN]: 実行可能ファイルのフルパスです。
[EXCEPTION] ArgumentError:: exec_name を指定しなかった場合に発生します。
[EXCEPTION] Gem::GemNotFoundException:: 条件に一致する Gem や実行可能ファイルが見つからなかった場合に発生します。

bindir(install_dir = Gem.dir) -> StringRuby 1.9.2 から[permalink][rdoc][edit]

Gem の実行可能ファイルをインストールするディレクトリのパスを返します。

install_dir にデフォルトのインストール先(Gem.#dir)を指定した場合は Gem.default_bindir を返します。それ以外の場合は install_dir の下の bin ディレクトリを返します。

[PARAM] install_dir:: Gem をインストールするディレクトリです。省略した場合は Gem.#dir になります。
[RETURN]: 実行可能ファイルをインストールするディレクトリのパスです。

[SEE_ALSO] Gem.#plugindir

clear_paths -> nilRuby 1.9.3 から[permalink][rdoc][edit]

Gem.#dir, Gem.#path の値をリセットします。

次に Gem.#dir, Gem.#path が呼ばれた時は、値を最初から計算します。このメソッドは主にユニットテストの独立性を提供するために使用します。

configuration -> Gem::ConfigFileRuby 1.9.2 から[permalink][rdoc][edit]

configuration=(config)

Gem の標準の設定オブジェクトを返します。

configuration= で明示的に設定していない場合は、Gem::ConfigFile の新しいインスタンスを生成して使用します。

[PARAM] config:: 標準の設定オブジェクトとして使うオブジェクトを指定します。Gem::ConfigFile と同じプロトコルを実装している必要があります。
[RETURN]: 標準の設定オブジェクトです。

[SEE_ALSO] Gem::ConfigFile

datadir(gem_name) -> String | nilRuby 1.9.2 から Ruby 3.3 で削除[permalink][rdoc][edit]

Gem gem_name のデータディレクトリのパスを返します。

gem_name が Gem として読み込まれていない場合は nil を返します。

[PARAM] gem_name:: データディレクトリを調べたい Gem の名前です。
[RETURN]: データディレクトリのパスです。gem_name が Gem として利用できない場合は nil です。

dir -> StringRuby 1.9.3 から[permalink][rdoc][edit]

Gem のインストールされているディレクトリを返します。

done_installing {|installer, specs| ... } -> [Proc]Ruby 2.0.0 から[permalink][rdoc][edit]

Gem::DependencyInstaller によるインストールが完了した後に呼び出すフックを登録します。

ブロックには、インストールを行った Gem::DependencyInstaller のインスタンスと、インストールされた Gem::Specification の配列が渡されます。

[PARAM] installer:: インストールを行った Gem::DependencyInstaller のインスタンスです。
[PARAM] specs:: インストールされた Gem::Specification の配列です。
[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem::DependencyInstaller#install, Gem.#done_installing_hooks

done_installing_hooks -> [Proc]Ruby 2.0.0 から[permalink][rdoc][edit]

Gem.#done_installing で登録された、インストール完了後に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#done_installing

ensure_gem_subdirectoriesRuby 1.9.3 から[permalink][rdoc][edit]

Gem をインストールするために必要なサブディレクトリを適切に作成します。

ディレクトリを作成する権限が無い場合もこのメソッドからは例外は発生しません。

find_files(glob, check_load_path = true) -> [String]Ruby 1.9.2 から[permalink][rdoc][edit]

glob にマッチするパスの一覧を、Gem や $LOAD_PATH から探して返します。

他の Gem が提供する機能を取り込むために使います。異なるバージョンの同じ Gem のファイルであってもすべて返します。最新バージョンの Gem のファイルだけがほしい場合は Gem.#find_latest_files を使ってください。

[PARAM] glob:: 検索するファイルパスのパターンです。
[PARAM] check_load_path:: 真の場合、$LOAD_PATH からも検索します。省略した場合は真になります。
[RETURN]: 見つかったファイルパスの配列です。

例

Gem.find_files("rdoc/discover").each {|path| load path }

[SEE_ALSO] Gem.#find_latest_files

find_latest_files(glob, check_load_path = true) -> [String]Ruby 2.1.0 から[permalink][rdoc][edit]

glob にマッチするパスを、最新バージョンの Gem や $LOAD_PATH から探して返します。

Gem.#find_files と異なり、同じ Gem については最新バージョンのファイルだけを返します。

[PARAM] glob:: 検索するファイルパスのパターンです。
[PARAM] check_load_path:: 真の場合、$LOAD_PATH からも検索します。省略した場合は真になります。
[RETURN]: 見つかったファイルパスの配列です。

[SEE_ALSO] Gem.#find_files

host -> StringRuby 1.9.3 から[permalink][rdoc][edit]

host=(host)

デフォルトの RubyGems API のホストを返します。通常は https://rubygems.org です。

[PARAM] host:: デフォルトの RubyGems API のホストとして設定する URL です。
[RETURN]: デフォルトの RubyGems API のホストです。

例

p Gem.host # => "https://rubygems.org"

install(name, version = Gem::Requirement.default, *options) -> [Gem::Specification]Ruby 2.0.0 から[permalink][rdoc][edit]

Gem name をインストールします。

irb などから対話的に Gem をインストールするためのヘルパーメソッドです。内部で Gem::DependencyInstaller のインスタンスを生成し、Gem::DependencyInstaller#install を呼び出します。

[PARAM] name:: インストールする Gem の名前です。
[PARAM] version:: インストールする Gem のバージョンの要求です。省略した場合は Gem::Requirement.default になります。
[PARAM] options:: Gem::DependencyInstaller.new に渡すオプションのハッシュです。
[RETURN]: インストールされた Gem::Specification の配列です。

[SEE_ALSO] Gem::DependencyInstaller.new, Gem::DependencyInstaller#install

java_platform? -> boolRuby 2.7.0 から[permalink][rdoc][edit]

実行中の Ruby 処理系が Java プラットフォーム(JRuby)であれば真を返します。そうでなければ偽を返します。

[SEE_ALSO] Object::RUBY_PLATFORM

latest_spec_for(name) -> Gem::Specification | nilRuby 1.9.3 から[permalink][rdoc][edit]

Gem name の、最新のリリースバージョンの Gem::Specification を返します。

[PARAM] name:: 調べたい Gem の名前です。
[RETURN]: Gem name の最新のリリースバージョンの Gem::Specification です。見つからない場合は nil です。

[SEE_ALSO] Gem.#latest_version_for

latest_version_for(name) -> Gem::Version | nilRuby 1.9.3 から[permalink][rdoc][edit]

Gem name の、最新のリリースバージョンを返します。

[PARAM] name:: 調べたい Gem の名前です。
[RETURN]: Gem name の最新のリリースバージョンです。見つからない場合は nil です。

[SEE_ALSO] Gem.#latest_spec_for

loaded_specs -> {String => Gem::Specification}Ruby 1.9.2 から[permalink][rdoc][edit]

読み込み済みの Gem::Specification を、Gem 名をキーにしたハッシュで返します。

[RETURN]: Gem 名をキー、読み込み済みの Gem::Specification を値とするハッシュです。

marshal_version -> StringRuby 1.9.3 から[permalink][rdoc][edit]

Marshal のバージョンを表す文字列を返します。

needs {|request_set| ... } -> ()Ruby 2.0.0 から[permalink][rdoc][edit]

ブロックに渡した Gem::RequestSet で宣言した Gem を解決し、有効化(activate)します。

ブロック引数として新しい Gem::RequestSet のインスタンスを受け取ります。ブロックの中で RequestSet#gem を呼び出して必要な Gem とバージョンを宣言すると、このメソッドがそれらを解決して有効化します。

[PARAM] request_set:: 必要な Gem を宣言するための Gem::RequestSet のインスタンスです。

例

Gem.needs do |req|
  req.gem "rake"
end

path -> ArrayRuby 1.9.3 から[permalink][rdoc][edit]

Gem を検索するパスの配列を返します。

paths -> Gem::PathSupportRuby 1.9.3 から[permalink][rdoc][edit]

paths=(env)

RubyGems がファイルを検索するために使う Gem::PathSupport のインスタンスを返します。

paths= に env を渡すと、それをもとに Gem の検索パスを再設定します。

[PARAM] env:: GEM_HOME・GEM_PATH・GEM_SPEC_CACHE を問い合わせるハッシュ相当のオブジェクトです(通常は ENV)。キーは文字列、値は文字列または nil を指定します。
[RETURN]: RubyGems がファイルを検索するために使う Gem::PathSupport のインスタンスです。

platforms -> [Gem::Platform]Ruby 1.9.2 から[permalink][rdoc][edit]

platforms=(platforms)

この RubyGems がサポートするプラットフォームの配列を返します。

明示的に設定していない場合は [Gem::Platform::RUBY, Gem::Platform.local] になります。platforms= は主にテストのために、この配列を明示的に設定するために使います。

[PARAM] platforms:: 設定する Gem::Platform の配列です。
[RETURN]: この RubyGems がサポートするプラットフォームの配列です。

[SEE_ALSO] Gem::Platform.local, Gem::Platform

plugindir(install_dir = Gem.dir) -> StringRuby 3.0 から[permalink][rdoc][edit]

RubyGems のプラグインをインストールするディレクトリのパスを返します。

[PARAM] install_dir:: Gem をインストールするディレクトリです。省略した場合は Gem.#dir になります。
[RETURN]: install_dir の下の plugins ディレクトリのパスです。

[SEE_ALSO] Gem.#bindir

post_build {|installer| ... } -> [Proc]Ruby 1.9.3 から[permalink][rdoc][edit]

Gem::Installer#install でファイルの展開と拡張ライブラリのビルドが終わった後、実行可能ファイルや gemspec を書き込む前に呼び出すフックを登録します。

ブロックが偽を返した場合、インストールされたファイルは削除され、インストールは中止されます。

[PARAM] installer:: インストールを行っている Gem::Installer のインスタンスです。
[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem::Installer#install, Gem.#post_build_hooks

post_build_hooks -> [Proc]Ruby 1.9.3 から[permalink][rdoc][edit]

Gem.#post_build で登録された、インストール中に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#post_build

post_install {|installer| ... } -> [Proc]Ruby 1.9.1 から[permalink][rdoc][edit]

Gem::Installer#install が完了した後に呼び出すフックを登録します。

[PARAM] installer:: インストールを行った Gem::Installer のインスタンスです。
[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem::Installer#install, Gem.#post_install_hooks

post_install_hooks -> [Proc]Ruby 1.9.2 から[permalink][rdoc][edit]

Gem.#post_install で登録された、インストール完了後に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#post_install

post_reset { ... } -> [Proc]Ruby 1.9.3 から[permalink][rdoc][edit]

Gem::Specification.reset の実行後に呼び出すフックを登録します。

ブロックに引数は渡されません。

[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem.#post_reset_hooks, Gem.#pre_reset

post_reset_hooks -> [Proc]Ruby 1.9.3 から[permalink][rdoc][edit]

Gem.#post_reset で登録された、Gem::Specification.reset の実行後に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#post_reset

post_uninstall {|uninstaller| ... } -> [Proc]Ruby 1.9.1 から[permalink][rdoc][edit]

Gem::Uninstaller#uninstall が完了した後に呼び出すフックを登録します。

ブロックには Gem::Uninstaller のインスタンスが渡されます。アンインストールされた Gem::Specification は、そのインスタンスの spec から取得できます。

[PARAM] uninstaller:: アンインストールを行った Gem::Uninstaller のインスタンスです。
[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem::Uninstaller#uninstall, Gem.#post_uninstall_hooks

post_uninstall_hooks -> [Proc]Ruby 1.9.2 から[permalink][rdoc][edit]

Gem.#post_uninstall で登録された、アンインストール完了後に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#post_uninstall

pre_install {|installer| ... } -> [Proc]Ruby 1.9.1 から[permalink][rdoc][edit]

Gem::Installer#install が処理を始める前に呼び出すフックを登録します。

ブロックが偽を返した場合、インストールは中止されます。

[PARAM] installer:: インストールを行おうとしている Gem::Installer のインスタンスです。
[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem::Installer#install, Gem.#pre_install_hooks

pre_install_hooks -> [Proc]Ruby 1.9.2 から[permalink][rdoc][edit]

Gem.#pre_install で登録された、インストールを始める前に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#pre_install

pre_reset { ... } -> [Proc]Ruby 1.9.3 から[permalink][rdoc][edit]

Gem::Specification.reset の実行前に呼び出すフックを登録します。

ブロックに引数は渡されません。

[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem.#pre_reset_hooks, Gem.#post_reset

pre_reset_hooks -> [Proc]Ruby 1.9.3 から[permalink][rdoc][edit]

Gem.#pre_reset で登録された、Gem::Specification.reset の実行前に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#pre_reset

pre_uninstall {|uninstaller| ... } -> [Proc]Ruby 1.9.1 から[permalink][rdoc][edit]

Gem::Uninstaller#uninstall が処理を始める前に呼び出すフックを登録します。

ブロックには Gem::Uninstaller のインスタンスが渡されます。アンインストールされる予定の Gem::Specification は、そのインスタンスの spec から取得できます。

[PARAM] uninstaller:: アンインストールを行おうとしている Gem::Uninstaller のインスタンスです。
[RETURN]: 登録済みのフック(Proc)の配列です。

[SEE_ALSO] Gem::Uninstaller#uninstall, Gem.#pre_uninstall_hooks

pre_uninstall_hooks -> [Proc]Ruby 1.9.2 から[permalink][rdoc][edit]

Gem.#pre_uninstall で登録された、アンインストールを始める前に呼び出されるフックの配列を返します。

[SEE_ALSO] Gem.#pre_uninstall

prefix -> StringRuby 1.9.3 から[permalink][rdoc][edit]

このライブラリがインストールされているディレクトリの親ディレクトリを返します。

refresh -> ()Ruby 1.9.2 から[permalink][rdoc][edit]

ディスク上の Gem の一覧をもとに、読み込み済みの Gem の情報を最新の状態に更新します。

内部で Gem::Specification.reset を呼び出します。これに伴い、Gem.#pre_reset と Gem.#post_reset で登録したフックも実行されます。

[SEE_ALSO] Gem.#pre_reset, Gem.#post_reset

ruby -> StringRuby 2.7.0 から[permalink][rdoc][edit]

実行中のRubyインタプリタのパスを返します。

ruby_api_version -> StringRuby 2.1.0 から[permalink][rdoc][edit]

実行中の Ruby の API 互換性を表すバージョン文字列を返します。

[RETURN]: Ruby の API 互換性を表すバージョン文字列です。

ruby_version -> Gem::VersionRuby 1.9.2 から[permalink][rdoc][edit]

実行中の Ruby のバージョンを表す Gem::Version を返します。

[RETURN]: 実行中の Ruby のバージョンを表す Gem::Version です。

rubygems_version -> Gem::VersionRuby 2.0.0 から[permalink][rdoc][edit]

実行中の RubyGems のバージョンを表す Gem::Version を返します。

[RETURN]: 実行中の RubyGems のバージョンを表す Gem::Version です。

solaris_platform? -> boolRuby 3.1 から[permalink][rdoc][edit]

実行中のプラットフォームが Solaris であれば真を返します。そうでなければ偽を返します。

[SEE_ALSO] Object::RUBY_PLATFORM, Gem.#java_platform?

source_date_epoch -> TimeRuby 2.7.0 から[permalink][rdoc][edit]

ビルドを再現可能にするための基準時刻を返します。

環境変数 SOURCE_DATE_EPOCH が設定されていればその値を、設定されていなければ 1980-01-02 00:00:00 UTC を返します。

[RETURN]: ビルドを再現可能にするための基準時刻です。

例(環境変数 SOURCE_DATE_EPOCH が未設定の場合)

p Gem.source_date_epoch # => 1980-01-02 00:00:00 UTC

sources -> Gem::SourceListRuby 1.9.2 から[permalink][rdoc][edit]

sources=(new_sources)

リモートから Gem を取得する際のソースの一覧を返します。

sources= で明示的に設定していない場合は、設定ファイルに指定されたソース、それも無ければ Gem.default_sources を使います。sources= に偽を渡すと設定がリセットされ、次に Gem.#sources を呼んだときに再計算されます。

[PARAM] new_sources:: 設定するソースの一覧です。偽を渡すとリセットされます。
[RETURN]: リモートから Gem を取得する際のソースの一覧です。

[SEE_ALSO] Gem::ConfigFile, Gem.default_sources

spec_cache_dir -> StringRuby 2.1.0 から[permalink][rdoc][edit]

Gem の仕様(spec)のキャッシュを保存するディレクトリのパスを返します。

[RETURN]: Gem の仕様のキャッシュを保存するディレクトリのパスです。

suffixes -> [String]Ruby 1.9.2 から[permalink][rdoc][edit]

require 可能なパスの末尾に付きうるサフィックスの配列を返します。

空文字列・".rb"・実行環境の共有ライブラリの拡張子が含まれます。

[RETURN]: require 可能なパスのサフィックスの配列です。

ui -> Gem::ConsoleUIRuby 1.9.2 から[permalink][rdoc][edit]

RubyGems が既定で使う UI(ユーザーとの対話)オブジェクトを返します。

遅延読み込みされる Gem::DefaultUserInteraction 経由で取得します。既定では Gem::ConsoleUI のインスタンスですが、Gem::DefaultUserInteraction.use_ui で別の UI オブジェクトに切り替えられている場合はそちらを返します。

[RETURN]: RubyGems が既定で使う UI オブジェクトです。

[SEE_ALSO] Gem::ConsoleUI

use_gemdeps(path = nil) -> ()Ruby 2.1.0 から[permalink][rdoc][edit]

path で指定した Gem の依存関係ファイルを探し、見つかった場合はそこに書かれている Gem を有効化します。

path を省略した場合は環境変数 RUBYGEMS_GEMDEPS の値を使います。それも無い場合は何もしません。path に "-" を指定すると、カレントディレクトリから親ディレクトリの方向に gem.deps.rb・Gemfile・Isolate を探し、最初に見つかったファイルの内容を有効化します。

複数ユーザーが使うシステムでこの自動探索を有効にすると、権限の及ばないディレクトリにある依存関係ファイルの内容が実行されてしまう可能性があるため注意してください。

[PARAM] path:: Gem の依存関係ファイルのパスです。省略した場合は環境変数 RUBYGEMS_GEMDEPS を使います。
[EXCEPTION] ArgumentError:: path を明示的に指定したにもかかわらず、そのファイルが見つからなかった場合に発生します。

win_platform? -> boolRuby 1.9.3 から[permalink][rdoc][edit]

Windows プラットフォームであれば真を返します。そうでなければ偽を返します。

[SEE_ALSO] Object::RUBY_PLATFORM

追加されるメソッド

cache_home -> StringRuby 3.0 から[permalink][rdoc][edit] [added by rubygems/defaults]

ユーザーのキャッシュディレクトリの標準的な場所を返します。

環境変数 XDG_CACHE_HOME が設定されていればその値を、設定されていなければ Gem.user_home の下の .cache を返します。

[RETURN]: ユーザーのキャッシュディレクトリの標準的な場所です。

config_file -> StringRuby 1.9.2 から[permalink][rdoc][edit] [added by rubygems/defaults]

ユーザーの .gemrc ファイルの標準的な場所を返します。

Gem.user_home の直下に .gemrc があればそのパスを、無ければ Gem.config_home の下の gem/gemrc を返します。

[RETURN]: ユーザーの .gemrc ファイルの標準的な場所です。

config_home -> StringRuby 3.0 から[permalink][rdoc][edit] [added by rubygems/defaults]

ユーザーの設定ディレクトリの標準的な場所を返します。

環境変数 XDG_CONFIG_HOME が設定されていればその値を、設定されていなければ Gem.user_home の下の .config を返します。

[RETURN]: ユーザーの設定ディレクトリの標準的な場所です。

data_home -> StringRuby 3.0 から[permalink][rdoc][edit] [added by rubygems/defaults]

ユーザーのデータディレクトリの標準的な場所を返します。

環境変数 XDG_DATA_HOME が設定されていればその値を、設定されていなければ Gem.user_home の下の .local/share を返します。

[RETURN]: ユーザーのデータディレクトリの標準的な場所です。

default_bindir -> StringRuby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

実行ファイルのデフォルトのパスを返します。

default_dir -> StringRuby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

デフォルトの Gem パッケージをインストールするディレクトリを返します。

default_exec_format -> StringRuby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

デフォルトのインストールするコマンド名を決めるためのフォーマット文字列を返します。

default_path -> [String]Ruby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

デフォルトの Gem パッケージをロードするディレクトリのリストを返します。

default_sources -> [String]Ruby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

デフォルトのパッケージ情報取得先のリストを返します。

default_specifications_dir -> StringRuby 2.7.0 から[permalink][rdoc][edit] [added by rubygems/defaults]

default gem(Ruby にあらかじめ組み込まれている Gem)の gemspec ファイルが置かれるディレクトリを返します。

Gem.default_dir の下の specifications/default です。

[RETURN]: default gem の gemspec ファイルが置かれるディレクトリです。

ruby_engine -> StringRuby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

Ruby処理系実装の種類を表す文字列を返します。

user_dir -> StringRuby 1.9.3 から[permalink][rdoc][edit] [added by rubygems/defaults]

ユーザのホームディレクトリの中の Gem のパスを返します。

user_home -> StringRuby 1.9.2 から[permalink][rdoc][edit] [added by rubygems/defaults]

ユーザーのホームディレクトリを返します。

内部で Dir.home を使って求めます。何らかの理由で求められなかった場合、Windows であれば HOMEDRIVE(または SystemDrive)が指すドライブのルートを、それ以外であれば / を返します。

[RETURN]: ユーザーのホームディレクトリです。

定数

ConfigMap -> HashRuby 1.9.3 から Ruby 4.0 で削除[permalink][rdoc][edit]: RbConfig::CONFIG の中からこのライブラリで使用するものを抽出して定義したハッシュ。
RubyGemsVersion -> StringRuby 1.9.3 から Ruby 4.0 で削除[permalink][rdoc][edit]: このライブラリのバージョンを表す文字列。
WIN_PATTERNS -> ArrayRuby 1.9.3 から[permalink][rdoc][edit]: Windows 上で動いている Ruby を識別するための正規表現の配列。

要約

目次

モジュール関数

追加されるメソッド

定数