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

class Gem::Command

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

要約

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

特異メソッド

定義 説明
add_common_option(*args) {|value, options| ... }

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

add_specific_extra_args(cmd, args)

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

build_args -> Array

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

build_args=(value)

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

common_options -> Array

共通の引数を返します。

extra_args -> Array

追加の引数を返します。

extra_args=(value)

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

specific_extra_args(cmd) -> Array

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

specific_extra_args_hash -> Hash

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

インスタンスメソッド

定義 説明
add_extra_args(args) -> Array

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

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

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

arguments -> String

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

begins?(long, short) -> bool

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

command -> String

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

defaults -> Hash

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

defaults=(hash)

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

defaults_str -> String

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

description -> String

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

execute -> ()

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

get_all_gem_names -> Array

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

get_one_gem_name -> String

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

get_one_optional_argument -> String

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

handle_options(args)

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

handles?(args) -> bool

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

invoke(*args)

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

merge_options(new_options) -> Hash

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

options -> Hash

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

program_name -> String

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

program_name=(name)

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

remove_option(name)

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

show_help -> ()

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

show_lookup_failure(gem_name, version, errors = nil) -> ()

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

summary -> String

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

summary=(description)

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

usage -> String

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

when_invoked { ... } -> Proc

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

定数

定義 説明
HELP -> String

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

継承したメソッド

! != __id__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined alert alert_error alert_warning ask ask_yes_no choose_from_list say terminate_interaction !~ <=> == === =~ __send__ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .new .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE