Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > rubygems/commandライブラリ > Gem::Commandクラス

class Gem::Command

クラスの継承リスト: Gem::Command < Gem::UserInteraction < Gem::DefaultUserInteraction < Object < Kernel < BasicObject

Abstract

特異メソッド

add_common_option(*args) {|value, options| ... }

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

[PARAM] args:

add_specific_extra_args(cmd, args)

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

[PARAM] cmd:

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

[PARAM] args:

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

common_options -> Array

共通の引数を返します。

extra_args -> Array

追加の引数を返します。

extra_args=(value)

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

[PARAM] value:

配列を指定します。

specific_extra_args(cmd) -> Array

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

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

[PARAM] cmd:

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

specific_extra_args_hash -> Hash

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

インスタンスメソッド

add_extra_args(args) -> Array

???

[PARAM] args:

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

add_option(*opts) {|value, options| ... }

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

[PARAM] opts:

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

[SEE_ALSO] OptionParser#make_switch

arguments -> String

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

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

begins?(long, short) -> bool

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

[PARAM] long:

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

[PARAM] short:

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

command -> String

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

defaults -> Hash

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

defaults=(hash)

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

[PARAM] hash:

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

defaults_str -> String

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

[SEE_ALSO] Gem::Command#arguments

description -> String

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

execute -> ()

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

[EXCEPTION] RuntimeError:

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

get_all_gem_names -> Array

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

[EXCEPTION] Gem::CommandLineError:

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

get_one_gem_name -> String

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

[EXCEPTION] Gem::CommandLineError:

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

get_one_optional_argument -> String

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

[RETURN]

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

handle_options(args)

[PARAM] args:

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

handles?(args) -> bool

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

[PARAM] args:

invoke(*args)

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

[PARAM] args:

merge_options(new_options)

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

options -> Hash

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

program_name -> String

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

program_name=(name)

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

[PARAM] name:

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

remove_option(name)

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

show_help

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

summary -> String

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

summary=(description)

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

[PARAM] description:

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

usage -> String

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

when_invoked

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

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

定数

HELP -> String

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