class Gem::ConfigFile

要約

設定ファイルに書かれている gem コマンドのオプションをオブジェクトに保存するためのクラスです。

このクラスのインスタンスはハッシュのように振る舞います。

目次

インスタンスメソッド

• []
• []=
• api_keys
• args
• backtrace
• backtrace=
• bulk_threshold
• bulk_threshold=
• cert_expiration_length_days
• cert_expiration_length_days=
• concurrent_downloads
• concurrent_downloads=
• config_file_name
• credentials_path
• disable_default_gem_server
• disable_default_gem_server=
• each
• handle_arguments
• home
• home=
• ipv4_fallback_enabled
• ipv4_fallback_enabled=
• load_file
• path
• path=
• really_verbose
• rubygems_api_key
• rubygems_api_key=
• set_api_key
• sources
• sources=
• ssl_ca_cert
• ssl_ca_cert=
• ssl_client_cert
• ssl_verify_mode
• unset_api_key!
• update_sources
• update_sources=
• verbose
• verbose=
• write

protectedメソッド

• hash

定数

• DEFAULT_BACKTRACE
• DEFAULT_BULK_THRESHOLD
• DEFAULT_CERT_EXPIRATION_LENGTH_DAYS
• DEFAULT_CONCURRENT_DOWNLOADS
• DEFAULT_IPV4_FALLBACK_ENABLED
• DEFAULT_UPDATE_SOURCES
• DEFAULT_VERBOSITY
• OPERATING_SYSTEM_DEFAULTS
• PLATFORM_DEFAULTS
• SYSTEM_WIDE_CONFIG_FILE

インスタンスメソッド

self[key] -> objectRuby 1.9.3 から[permalink][rdoc][edit]

引数で与えられたキーに対応する設定情報を返します。

[PARAM] key:

設定情報を取得するために使用するキーを指定します。

self[key] = valueRuby 1.9.3 から[permalink][rdoc][edit]

引数で与えられたキーに対応する設定情報を自身に保存します。

[PARAM] key:

設定情報をセットするために使用するキーを指定します。

[PARAM] value:

設定情報の値を指定します。

api_keys -> {Symbol => String}Ruby 1.9.3 から[permalink][rdoc][edit]

認証情報ファイルに保存されている API キーのハッシュを返します。

キーは rubygems.org の場合は :rubygems、それ以外の場合はホスト名のシンボルで、値は API キーです。認証情報ファイル(Gem::ConfigFile#credentials_path)が無いときは、設定ファイルから読み込んだハッシュをそのまま返します。

[SEE_ALSO] Gem::ConfigFile#credentials_path, Gem::ConfigFile#set_api_key

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

設定ファイルオブジェクトに与えられたコマンドライン引数のリストを返します。

backtrace -> boolRuby 1.9.3 から[permalink][rdoc][edit]

エラー発生時にバックトレースを出力するかどうかを返します。

真の場合はバックトレースを出力します。そうでない場合はバックトレースを出力しません。

backtrace=(backtrace)Ruby 1.9.3 から[permalink][rdoc][edit]

エラー発生時にバックトレースを出力するかどうか設定します。

[PARAM] backtrace:

真を指定するとエラー発生時にバックトレースを出力するようになります。

bulk_threshold -> IntegerRuby 1.9.3 から[permalink][rdoc][edit]

一括ダウンロードの閾値を返します。インストールしていない Gem がこの数値を越えるとき一括ダウンロードを行います。

bulk_threshold=(bulk_threshold)Ruby 1.9.3 から[permalink][rdoc][edit]

一括ダウンロードの閾値を設定します。

[PARAM] bulk_threshold:

数値を指定します。

cert_expiration_length_days -> IntegerRuby 2.6.0 から[permalink][rdoc][edit]

gem cert で証明書を作るときの有効期間(日数)を返します。

デフォルトは 365 日(Gem::ConfigFile::DEFAULT_CERT_EXPIRATION_LENGTH_DAYS)です。

例

Gem.configuration.cert_expiration_length_days # => 365

[SEE_ALSO] Gem::ConfigFile#cert_expiration_length_days=

cert_expiration_length_days=(days)Ruby 2.6.0 から[permalink][rdoc][edit]

gem cert で証明書を作るときの有効期間(日数)を設定します。

[PARAM] days:

日数を整数で指定します。

[SEE_ALSO] Gem::ConfigFile#cert_expiration_length_days

concurrent_downloads -> IntegerRuby 2.6.0 から[permalink][rdoc][edit]

同時にダウンロードする gem の数を返します。

デフォルトは 8(Gem::ConfigFile::DEFAULT_CONCURRENT_DOWNLOADS)です。

例

Gem.configuration.concurrent_downloads # => 8

[SEE_ALSO] Gem::ConfigFile#concurrent_downloads=

concurrent_downloads=(count)Ruby 2.6.0 から[permalink][rdoc][edit]

同時にダウンロードする gem の数を設定します。

[PARAM] count:

gem の数を整数で指定します。

[SEE_ALSO] Gem::ConfigFile#concurrent_downloads

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

設定ファイルの名前を返します。

credentials_path -> StringRuby 1.9.2 から[permalink][rdoc][edit]

API キーを保存する認証情報ファイルのパスを返します。

Gem.user_home の下の .gem/credentials があればそのパスを、無ければ Gem.data_home の下の gem/credentials を返します。

[SEE_ALSO] Gem::ConfigFile#api_keys

disable_default_gem_server -> bool | nilRuby 2.0.0 から[permalink][rdoc][edit]

gem push でホストの明示を必須にするかどうかを返します。

真の場合は、gem push でホストを明示する必要があります。設定ファイルの disable_default_gem_server キーの値で、設定が無い場合は nil を返します。

[SEE_ALSO] Gem::ConfigFile#disable_default_gem_server=

disable_default_gem_server=(flag)Ruby 2.0.0 から[permalink][rdoc][edit]

gem push でホストの明示を必須にするかどうかを設定します。

[PARAM] flag:

真を指定すると、gem push でホストを明示する必要があります。

[SEE_ALSO] Gem::ConfigFile#disable_default_gem_server

each {|key, value| ... } -> HashRuby 1.9.3 から[permalink][rdoc][edit]

設定ファイルの各項目のキーと値をブロック引数として与えられたブロックを評価します。

handle_arguments(arg_list)Ruby 1.9.3 から[permalink][rdoc][edit]

コマンドに渡された引数を処理します。

[PARAM] arg_list:

コマンドに渡された引数の配列を指定します。

home -> String | nilRuby 1.9.1 から[permalink][rdoc][edit]

gem をインストールするディレクトリを返します。

設定ファイルの gemhome キーの値で、設定が無い場合は nil を返します。非推奨です。

[SEE_ALSO] Gem::ConfigFile#home=

home=(dir)Ruby 1.9.1 から[permalink][rdoc][edit]

gem をインストールするディレクトリを設定します。非推奨です。

[PARAM] dir:

ディレクトリのパスを指定します。

[SEE_ALSO] Gem::ConfigFile#home

ipv4_fallback_enabled -> boolRuby 3.1 から[permalink][rdoc][edit]

IPv6 で接続できない場合や接続が遅い場合に、IPv4 にフォールバックするかどうかを返します。実験的な機能です。

デフォルトは偽(Gem::ConfigFile::DEFAULT_IPV4_FALLBACK_ENABLED)ですが、環境変数 IPV4_FALLBACK_ENABLED が true の場合は真になります。

[SEE_ALSO] Gem::ConfigFile#ipv4_fallback_enabled=

ipv4_fallback_enabled=(flag)Ruby 3.1 から[permalink][rdoc][edit]

IPv6 で接続できない場合や接続が遅い場合に、IPv4 にフォールバックするかどうかを設定します。

[PARAM] flag:

真を指定すると IPv4 にフォールバックします。

[SEE_ALSO] Gem::ConfigFile#ipv4_fallback_enabled

load_file(file_name) -> objectRuby 1.9.3 から[permalink][rdoc][edit]

与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。

[PARAM] file_name:

YAML 形式で記述された設定ファイル名を指定します。

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

Gem を探索するパスを返します。

path=(path)Ruby 1.9.3 から[permalink][rdoc][edit]

Gem を探索するパスをセットします。

really_verbose -> boolRuby 1.9.3 から[permalink][rdoc][edit]

このメソッドの返り値が真の場合は verbose モードよりも多くの情報を表示します。

rubygems_api_key -> String | nilRuby 1.9.2 から[permalink][rdoc][edit]

rubygems.org の API キーを返します。

未設定の場合は nil を返します。

[SEE_ALSO] Gem::ConfigFile#rubygems_api_key=

rubygems_api_key=(api_key)Ruby 1.9.2 から[permalink][rdoc][edit]

rubygems.org の API キーを設定し、認証情報ファイルに書き込みます。

[PARAM] api_key:

API キーを文字列で指定します。

[SEE_ALSO] Gem::ConfigFile#rubygems_api_key, Gem::ConfigFile#set_api_key

set_api_key(host, api_key) -> ()Ruby 2.4.0 から[permalink][rdoc][edit]

host の API キーを認証情報ファイルに書き込みます。

認証情報ファイルは、パーミッション 0600 で作られます。

[PARAM] host:

ホスト名をシンボルまたは文字列で指定します。

[PARAM] api_key:

API キーを文字列で指定します。

[SEE_ALSO] Gem::ConfigFile#api_keys, Gem::ConfigFile#credentials_path

sources -> [String] | nilRuby 2.4.0 から[permalink][rdoc][edit]

gem を探すソースの URL の配列を返します。

設定ファイルの sources キーの値で、設定が無い場合は nil を返します。

[SEE_ALSO] Gem.#sources, Gem::ConfigFile#sources=

sources=(sources)Ruby 2.4.0 から[permalink][rdoc][edit]

gem を探すソースの URL の配列を設定します。

[PARAM] sources:

URL の文字列の配列を指定します。

[SEE_ALSO] Gem::ConfigFile#sources

ssl_ca_cert -> String | nilRuby 2.0.0 から[permalink][rdoc][edit]

HTTPS 接続に使う CA 証明書のファイルまたはディレクトリのパスを返します。

設定ファイルの ssl_ca_cert キーの値で、設定が無い場合は nil を返します。

[SEE_ALSO] Gem::ConfigFile#ssl_ca_cert=

ssl_ca_cert=(path)Ruby 2.2.0 から[permalink][rdoc][edit]

HTTPS 接続に使う CA 証明書のファイルまたはディレクトリのパスを設定します。

[PARAM] path:

ファイルまたはディレクトリのパスを指定します。

[SEE_ALSO] Gem::ConfigFile#ssl_ca_cert

ssl_client_cert -> String | nilRuby 2.1.0 から[permalink][rdoc][edit]

クライアント認証付きの HTTPS 接続に使うクライアント証明書のファイルまたはディレクトリのパスを返します。

設定ファイルの ssl_client_cert キーの値で、設定が無い場合は nil を返します。

ssl_verify_mode -> Integer | nilRuby 2.0.0 から[permalink][rdoc][edit]

HTTPS 接続で使う OpenSSL の検証モードを返します。

設定ファイルの ssl_verify_mode キーの値(OpenSSL::SSL::VERIFY_PEER などの整数)で、設定が無い場合は nil を返します。

unset_api_key! -> Integer | falseRuby 2.5.0 から[permalink][rdoc][edit]

認証情報ファイルを削除して、すべての API キーを消します。

[RETURN]

認証情報ファイルが無ければ偽を返します。あれば削除して、削除したファイルの数(1)を返します。

[SEE_ALSO] Gem::ConfigFile#credentials_path

update_sources -> boolRuby 1.9.3 から[permalink][rdoc][edit]

真の場合は Gem::SourceInfoCache を毎回更新します。そうでない場合は、キャッシュがあればキャッシュの情報を使用します。

update_sources=(update_sources)Ruby 1.9.3 から[permalink][rdoc][edit]

Gem::SourceInfoCache を毎回更新するかどうか設定します。

[PARAM] update_sources:

真を指定すると毎回 Gem::SourceInfoCache を更新します。

verbose -> bool | SymbolRuby 1.9.3 から[permalink][rdoc][edit]

ログの出力レベルを返します。

[SEE_ALSO] Gem::ConfigFile#verbose=

verbose=(verbose_level)Ruby 1.9.3 から[permalink][rdoc][edit]

ログの出力レベルをセットします。

以下の出力レベルを設定できます。

false

何も出力しません。

true

通常のログを出力します。

:loud

より多くのログを出力します。

[PARAM] verbose_level:

真偽値またはシンボルを指定します。

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

自身を読み込んだ設定ファイルを書き換えます。

protectedメソッド

hash -> HashRuby 1.9.3 から[permalink][rdoc][edit]

設定ファイルの各項目のキーと値を要素として持つハッシュです。

定数

DEFAULT_BACKTRACE -> trueRuby 1.9.3 から[permalink][rdoc][edit]

バックトレースが表示されるかどうかのデフォルト値です。

DEFAULT_BULK_THRESHOLD -> 1000Ruby 1.9.3 から[permalink][rdoc][edit]

一括ダウンロードをするかどうかのデフォルト値です。

DEFAULT_CERT_EXPIRATION_LENGTH_DAYS -> 365Ruby 2.6.0 から[permalink][rdoc][edit]

Gem::ConfigFile#cert_expiration_length_days のデフォルト値です。

DEFAULT_CONCURRENT_DOWNLOADS -> 8Ruby 2.6.0 から[permalink][rdoc][edit]

Gem::ConfigFile#concurrent_downloads のデフォルト値です。

DEFAULT_IPV4_FALLBACK_ENABLED -> falseRuby 3.1 から[permalink][rdoc][edit]

Gem::ConfigFile#ipv4_fallback_enabled のデフォルト値です。

DEFAULT_UPDATE_SOURCES -> trueRuby 1.9.3 から[permalink][rdoc][edit]

毎回 Gem::SourceInfoCache を更新するかどうかのデフォルト値です。

DEFAULT_VERBOSITY -> trueRuby 1.9.3 から[permalink][rdoc][edit]

ログレベルのデフォルト値です。

OPERATING_SYSTEM_DEFAULTS -> {}Ruby 1.9.3 から[permalink][rdoc][edit]

Ruby をパッケージングしている人がデフォルトの設定値をセットするために使用します。

使用するファイルは rubygems/defaults/operating_system.rb です。

PLATFORM_DEFAULTS -> {}Ruby 1.9.3 から[permalink][rdoc][edit]

Ruby の実装者がデフォルトの設定値をセットするために使用します。

使用するファイルは rubygems/defaults/#{RUBY_ENGINE}.rb です。

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

システム全体の設定ファイルのパスです。