class Gem::Command

要約

全ての gem コマンドのスーパークラスです。

目次

特異メソッド

• add_common_option
• add_specific_extra_args
• build_args
• build_args=
• common_options
• extra_args
• extra_args=
• specific_extra_args
• specific_extra_args_hash

インスタンスメソッド

• add_extra_args
• add_option
• arguments
• begins?
• command
• defaults
• defaults=
• defaults_str
• description
• execute
• get_all_gem_names
• get_one_gem_name
• get_one_optional_argument
• handle_options
• handles?
• invoke
• merge_options
• options
• program_name
• program_name=
• remove_option
• show_help
• show_lookup_failure
• summary
• summary=
• usage
• when_invoked

定数

• HELP

継承しているメソッド

Gem::UserInteractionから継承しているメソッド

• alert
• alert_error
• alert_warning
• ask
• ask_yes_no
• choose_from_list
• say
• terminate_interaction

Gem::DefaultUserInteractionから継承しているメソッド

• ui
• ui=
• use_ui

特異メソッド

add_common_option(*args) {|value, options| ... }[permalink][rdoc][edit]

全てのコマンドに共通するオプションを登録するためのメソッドです。

[PARAM] args:

追加するオプションの情報を指定します。

add_specific_extra_args(cmd, args)[permalink][rdoc][edit]

与えられたコマンドに対応する追加の引数を追加します。

[PARAM] cmd:

コマンド名を指定します。

[PARAM] args:

追加の引数を配列か、空白で区切った文字列で指定します。

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

Gem をビルドするときに使用するパラメータを返します。

build_args=(value)[permalink][rdoc][edit]

Gem をビルドするときに使用するパラメータをセットします。

[PARAM] value:

Gem をビルドするときに使用するパラメータを指定します。

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

共通の引数を返します。

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

追加の引数を返します。

extra_args=(value)[permalink][rdoc][edit]

追加の引数をセットします。

[PARAM] value:

配列を指定します。

specific_extra_args(cmd) -> Array[permalink][rdoc][edit]

与えられたコマンドに対応する追加の引数を返します。

特別な追加引数はプログラムの開始時に Gem の設定ファイルから読み込まれます。

[PARAM] cmd:

コマンド名を指定します。

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

特別な追加引数へのアクセスを提供します。

インスタンスメソッド

add_extra_args(args) -> Array[permalink][rdoc][edit]

$HOME/.gemrc から読み込んだ引数を追加します。

[PARAM] args:

追加する引数を配列で指定します。

add_option(*opts) {|value, options| ... }[permalink][rdoc][edit]

コマンドに対するコマンドラインオプションとハンドラを追加します。

ブロックには、コマンドライン引数の値とそのオプションが渡されます。オプションはハッシュになっています。

[PARAM] opts:

オプションを指定します。

[SEE_ALSO] OptionParser#make_switch

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

このメソッドはサブクラスで再定義されます。コマンドが取る引数の説明を表示するために使用します。

サブクラスで実装する場合は、一つの引数につき一行で、左揃えの文字列を返すようにしてください。

begins?(long, short) -> bool[permalink][rdoc][edit]

long が short で始まる文字列である場合真を返します。そうでない場合は偽を返します。

[PARAM] long:

長いコマンドラインオプションを指定します。

[PARAM] short:

短いコマンドラインオプションを指定します。

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

コマンドの名前を返します。

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

デフォルトのオプションを返します。

defaults=(hash)[permalink][rdoc][edit]

コマンドで使用するデフォルトのオプションをセットします。

[PARAM] hash:

オプションをハッシュで指定します。

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

このメソッドはサブクラスで再定義されます。コマンドのオプションで使用するデフォルト値を表示するために使用する文字列を返します。

[SEE_ALSO] Gem::Command#arguments

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

このメソッドはサブクラスで再定義されます。コマンドが実行することを説明する文字列を返します。

execute -> ()[permalink][rdoc][edit]

このメソッドはサブクラスで再定義されます。コマンドを実行します。

[EXCEPTION] RuntimeError:

このメソッドがサブクラスで再定義されていない場合に発生します。

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

コマンドラインで与えられた Gem の名前を全て取得して返します。

[EXCEPTION] Gem::CommandLineError:

コマンドライン引数から Gem の名前を取得できない場合に発生します。

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

コマンドラインで与えられた Gem の名前を一つ取得して返します。

[EXCEPTION] Gem::CommandLineError:

コマンドライン引数から Gem の名前を一つだけ取得できない場合に発生します。

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

コマンドラインからオプショナルな引数を取得して返します。

[RETURN]

一つ以上、指定した場合は最初の値を返します。一つも指定していない場合は nil を返します。

handle_options(args)[permalink][rdoc][edit]

与えられた引数のリストをパースして結果を記録します。

[PARAM] args:

引数のリストを指定します。

handles?(args) -> bool[permalink][rdoc][edit]

与えられた引数リストを処理することが出来れば真を返します。処理できない場合は偽を返します。

[PARAM] args:

引数リストを指定子明日。

invoke(*args)[permalink][rdoc][edit]

与えられた引数を使用してコマンドを呼び出します。

[PARAM] args:

引数のリストです。

merge_options(new_options) -> Hash[permalink][rdoc][edit]

与えられたオプションとデフォルトのオプションをマージします。しかし、新しいオプションに同一のキーがあってもデフォルトのオプションは変更されません。

[PARAM] new_options:

新しいコマンドオプションをハッシュで指定します。

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

コマンドで使用するオプションを返します。

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

コマンドラインで実行するときに使用するプログラム名を返します。

program_name=(name)[permalink][rdoc][edit]

コマンドラインで実行するときに使用するプログラム名をセットします。

[PARAM] name:

プログラム名を指定します。

remove_option(name)[permalink][rdoc][edit]

与えられた名前に一致するコマンドラインオプションを削除します。

[PARAM] name:

削除したいコマンドラインオプションの名前を指定します。

show_help -> ()[permalink][rdoc][edit]

コマンドの使用方法を表示します。

show_lookup_failure(gem_name, version, errors = nil) -> ()[permalink][rdoc][edit]

Gem が見つからなかった場合、メッセージを表示するために使用するメソッドです。

[PARAM] gem_name:

Gem の名前を指定します。

[PARAM] version:

Gem のバージョンを指定します。

[PARAM] errors:

Gem が見つからなかった理由を表すオブジェクトを格納した配列を指定します。

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

コマンドの短い説明を返します。

summary=(description)[permalink][rdoc][edit]

コマンドの短い説明をセットします。

[PARAM] description:

コマンドの短い説明を指定します。

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

このメソッドはサブクラスで再定義されます。個々の gem コマンドの使用方法を返します。

when_invoked { ... } -> Proc[permalink][rdoc][edit]

コマンドが実行されたときに評価するブロックを登録します。

通常のコマンド呼び出しは、そのコマンドクラスの execute メソッドを実行するだけです。このメソッドでブロックを登録すると、通常の呼び出しを上書きすることができます。これはテストメソッドで正しくコマンドの呼び出しが実行されたことを確認するのに使用することが出来ます。

定数

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

ヘルプメッセージを表す文字列です。