class Rake::Application + Rake::TaskManager
クラスの継承リスト: Rake::Application < Rake::TaskManager < Object < Kernel < BasicObject
要約
Rake で使用するメインのクラスです。
コマンドラインで rake コマンドを実行した時に作成され、実行されます。
インスタンスメソッド
self[task_name, scopes = nil] -> Rake::Task
-
与えられたタスク名にマッチするタスクを検索します。
- [PARAM] task_name:
- タスク名を指定します。
- [PARAM] scopes:
- スコープを指定します。
add_import(file_name)
-
与えられたファイルをロード予定ファイルのリストに追加します。
- [PARAM] file_name:
- ロード予定のファイル名を指定します。
add_loader(ext, loader)
-
与えられた拡張子で終わるファイル名のファイルをロードするためのローダーを 自身に追加します。
- [PARAM] ext:
- 拡張子を指定します。
- [PARAM] loader:
- ローダーを指定します。
clear
-
全てのタスクとルールをクリアします。
collect_tasks(argv) -> Array
-
コマンドライン引数を解析して実行するタスクのリストを返します。
実行するタスクが指定されていない場合はデフォルトのタスクのみ返します。 また、このとき環境変数の解析も行います。
const_warning(const_name)
-
トップレベルで定数を使用している場合に警告を表示します。
create_rule(*args) { ... }
-
与えられたパラメータに従ってルールを作成します。
- [PARAM] args:
- ルールに与えるパラメータを指定します。
current_scope -> Array
-
現在のスコープを返します。
define_task(task_class, *args) { ... } -> Rake::Task
-
タスクを定義します。
- [PARAM] task_class:
- タスククラスを指定します。
- [PARAM] args:
- タスクに渡すパラメータを指定します。
display_prerequisites
-
タスクとそのタスクに依存しているタスクを表示します。
display_tasks_and_comments
-
タスクとコメントを表示します。
dynamic_width -> Fixnum
-
ターミナルの幅を計算します。
dynamic_width_stty
-
stty(1) を用いてターミナルの幅を計算します。
dynamic_width_tput
-
tput(1) を用いてターミナルの幅を計算します。
enhance_with_matching_rule(task_name, level = 0) -> Rake::Task | nil
-
与えられたタスク名にマッチしたルールが存在する場合は、そのタスクに見つかったルールの 事前タスクとアクションを追加して返します。
- [PARAM] task_name:
- タスクの名前を指定します。
- [PARAM] level:
- 現在のルール解決のネストの深さを指定します。
- [EXCEPTION] RuntimeError:
- ルールの解決時にオーバーフローした場合に発生します。
find_rakefile_location -> Array | nil
-
Rakefile とそのファイルがあったディレクトリのペアを返します。
handle_options
-
コマンドラインオプションを OptionParser に登録します。
have_rakefile -> String | nil
-
Rakefile がカレントディレクトリに存在する場合はそのファイル名を返します。 そうでない場合は nil を返します。
[SEE_ALSO] Rake::Application::DEFAULT_RAKEFILES
in_namespace(name) {|name_space| ... } -> Array
-
与えられた名前の名前空間でブロックを評価します。
- [PARAM] name:
- 名前を指定します。
init(app_name = 'rake')
-
コマンドラインオプションとアプリケーション名を初期化します。
intern(task_class, task_name) -> Rake::Task
-
タスクを検索します。
タスクが見つかれば見つかったタスクを返します。 見つからなければ、与えられた型のタスクを作成して返します。
- [PARAM] task_class:
- タスクのクラスを指定します。
- [PARAM] task_name:
- タスクの名前を指定します。
invoke_task(task_string)
-
与えられた文字列を解析してタスクを実行します。
- [PARAM] task_string:
- タスク名とそれに与えるパラメータをあらわす文字列を指定します。
last_description -> String
last_comment -> String
-
Rakefile 内の最新の詳細説明を追跡するためのメソッドです。
last_description=(description)
-
最新の詳細説明をセットします。
load_imports
-
ロード予定のファイルを全てロードします。
既にロード済みのファイルはロードしません。
load_rakefile
-
Rakefile を探してロードします。
lookup(task_name, initial_scope = nil) -> Rake::Task | nil
-
与えられたタスク名にマッチするタスクを検索します。
このメソッドは、ファイルタスクやルールを合成せずにタスクを探します。 特別なスコープ ('^' など) が存在します。スコープが省略された場合は 現在のスコープを使用します。
- [PARAM] task_name:
- タスク名を指定します。
- [PARAM] initial_scope:
- 検索するスコープを指定します。
name -> String
-
アプリケーションの名前を返します。通常は 'rake' という名前を返します。
options -> OpenStruct
-
コマンドラインで与えられたアプリケーションのオプションを返します。
original_dir -> String
-
rake コマンドを実行したディレクトリを返します。
parse_task_string(string) -> [String, Array]
-
与えられた文字列を解析して、タスク名とそれに与えるパラメータのペアを返します。
- [PARAM] string:
- タスク名とそれに与えるパラメータのペアを返します。
rake_require(file_name, paths = $LOAD_PATH, loaded = $") -> bool
-
Kernel#require に似ていますが、*.rb ファイルではなく *.rake ファイルを探索します。
- [PARAM] file_name:
- ロードするファイル名を指定します。
- [PARAM] paths:
- ロードパスを指定します。
- [PARAM] loaded:
- ロード済みのファイルリストを指定します。
- [EXCEPTION] LoadError:
- 指定されたファイルが見つからなかった場合に発生します。
rakefile -> String
-
実際に使用されている Rakefile の名前を返します。
rakefile_location -> String
-
Rakefile のパスを返します。
raw_load_rakefile
-
Rakefile をロードします。
- [EXCEPTION] RuntimeError:
- Rakefile が見つからなかった場合に発生します。
resolve_args(args) -> Array
-
タスクやルールに与えられたパラメータを解釈します。
- [PARAM] args:
- パラメータを指定します。
- [RETURN]
- [task_name, arg_name_list, prerequisites] を返します。
run
-
Rake アプリケーションを実行します。
このメソッドは以下の 3 ステップを実行します。
- コマンドラインオプションを初期化します。Rake::Application#init
- タスクを定義します。Rake::Application#load_rakefile
- コマンドラインで指定されたタスクを実行します。Rake::Application#top_level
standard_exception_handling { ... }
-
与えられたブロックを評価する際に発生する標準的な例外を補足して アプリケーションを終了させます。
standard_rake_options -> Array
-
Rake コマンドで使用する標準的なコマンドラインオプションのリストを返します。
synthesize_file_task(task_name) -> Rake::FileTask | nil
-
与えられたタスク名をもとにファイルタスクを合成します。
- [PARAM] task_name:
- タスク名を指定します。
- [RETURN]
- 与えられたタスク名と同名のファイルが存在する場合は、ファイルタスクを作成して返します。 そうでない場合は nil を返します。
- [EXCEPTION] RuntimeError:
- タスクを合成できなかった場合に発生します。
system_dir -> String
-
システム全体の Rakefile が格納されているディレクトリを返します。
環境変数 RAKE_SYSTEM で設定することができます。
tasks -> Array
-
全てのタスクリストを返します。
terminal_width -> Fixnum
-
ターミナルの幅を返します。
環境変数 RAKE_COLUMNS で指定することが出来ます。
top_level
-
Rake アプリケーションに与えられたトップレベルのタスク (コマンドラインで指定されたタスク) を実行します。
top_level_tasks -> Array
-
コマンドラインで指定されたタスクのリストを返します。
truncate(string, width) -> String
-
与えられた文字列を与えられた幅で切り詰めます。
truncate_output?
tty_output=(tty_output_state)
-
TTY に対する出力状態を上書きします。
大抵の場合、テストのために使用します。
- [PARAM] tty_output_state:
- 変更後の状態を指定します
tty_output? -> bool
-
TTY に出力している場合は真を返します。そうでない場合は偽を返します。
unix? -> bool
-
現在のプラットフォームが UNIX 系である場合、真を返します。 そうでない場合は偽を返します。
windows? -> bool
-
現在のプラットフォームが Windows 系である場合、真を返します。 そうでない場合は偽を返します。
定数
DEFAULT_RAKEFILES -> Array
-
デフォルトで Rakefile として扱うファイル名の配列を返します。
'rakefile', 'Rakefile', 'rakefile.rb', 'Rakefile.rb' が指定されています。