class Gem::ConfigFile

要約

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

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

目次

インスタンスメソッド

• []
• []=
• args
• backtrace
• backtrace=
• benchmark
• benchmark=
• bulk_threshold
• bulk_threshold=
• config_file_name
• each
• handle_arguments
• load_file
• path
• path=
• really_verbose
• update_sources
• update_sources=
• verbose
• verbose=
• write

protectedメソッド

• hash

定数

• DEFAULT_BACKTRACE
• DEFAULT_BENCHMARK
• DEFAULT_BULK_THRESHOLD
• DEFAULT_UPDATE_SOURCES
• DEFAULT_VERBOSITY
• OPERATING_SYSTEM_DEFAULTS
• PLATFORM_DEFAULTS
• SYSTEM_WIDE_CONFIG_FILE

インスタンスメソッド

self[key] -> object[permalink][rdoc][edit]

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

[PARAM] key:

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

self[key] = value[permalink][rdoc][edit]

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

[PARAM] key:

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

[PARAM] value:

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

args -> Array[permalink][rdoc][edit]

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

backtrace -> bool[permalink][rdoc][edit]

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

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

backtrace=(backtrace)[permalink][rdoc][edit]

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

[PARAM] backtrace:

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

benchmark -> bool[permalink][rdoc][edit]

真の場合はベンチマークを実行します。そうでない場合は、ベンチマークを実行しません。

benchmark=(benchmark)[permalink][rdoc][edit]

ベンチマークを実行するかどうか設定します。

[PARAM] benchmark:

真を指定するとベンチマークを実行するようになります。

bulk_threshold -> Integer[permalink][rdoc][edit]

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

bulk_threshold=(bulk_threshold)[permalink][rdoc][edit]

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

[PARAM] bulk_threshold:

数値を指定します。

config_file_name -> String[permalink][rdoc][edit]

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

each {|key, value| ... } -> Hash[permalink][rdoc][edit]

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

handle_arguments(arg_list)[permalink][rdoc][edit]

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

[PARAM] arg_list:

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

load_file(file_name) -> object[permalink][rdoc][edit]

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

[PARAM] file_name:

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

path -> String[permalink][rdoc][edit]

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

path=(path)[permalink][rdoc][edit]

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

really_verbose -> bool[permalink][rdoc][edit]

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

update_sources -> bool[permalink][rdoc][edit]

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

update_sources=(update_sources)[permalink][rdoc][edit]

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

[PARAM] update_sources:

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

verbose -> bool | Symbol[permalink][rdoc][edit]

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

[SEE_ALSO] Gem::ConfigFile#verbose=

verbose=(verbose_level)[permalink][rdoc][edit]

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

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

false

何も出力しません。

true

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

:loud

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

[PARAM] verbose_level:

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

write[permalink][rdoc][edit]

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

protectedメソッド

hash -> Hash[permalink][rdoc][edit]

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

定数

DEFAULT_BACKTRACE -> false[permalink][rdoc][edit]

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

DEFAULT_BENCHMARK -> false[permalink][rdoc][edit]

ベンチマークを実行するかどうかのデフォルト値です。

DEFAULT_BULK_THRESHOLD -> 1000[permalink][rdoc][edit]

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

DEFAULT_UPDATE_SOURCES -> true[permalink][rdoc][edit]

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

DEFAULT_VERBOSITY -> true[permalink][rdoc][edit]

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

OPERATING_SYSTEM_DEFAULTS -> {}[permalink][rdoc][edit]

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

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

PLATFORM_DEFAULTS -> {}[permalink][rdoc][edit]

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

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

SYSTEM_WIDE_CONFIG_FILE -> String[permalink][rdoc][edit]

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