Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > rakeライブラリ > Rake::Applicationクラス

class Rake::Application

クラスの継承リスト: Rake::Application < Rake::TaskManager < Object < Kernel < BasicObject

要約

Rake で使用するメインのクラスです。

コマンドラインで rake コマンドを実行した時に作成され、実行されます。

インスタンスメソッド: add_import add_loader collect_command_line_tasks display_prerequisites display_tasks_and_comments dynamic_width dynamic_width_stty dynamic_width_tput find_rakefile_location handle_options have_rakefile init invoke_task load_imports load_rakefile name options original_dir parse_task_string rake_require rakefile rakefile_location raw_load_rakefile run standard_exception_handling standard_rake_options system_dir terminal_width top_level top_level_tasks truncate truncate_output? tty_output= tty_output? unix? windows?
定数: DEFAULT_RAKEFILES

インスタンスメソッド

add_import(file_name)[permalink][rdoc]

与えられたファイルをロード予定ファイルのリストに追加します。

[PARAM] file_name:: ロード予定のファイル名を指定します。

add_loader(ext, loader)[permalink][rdoc]

与えられた拡張子で終わるファイル名のファイルをロードするためのローダーを自身に追加します。

[PARAM] ext:: 拡張子を指定します。
[PARAM] loader:: ローダーを指定します。

collect_command_line_tasks(argv) -> Array[permalink][rdoc]

コマンドライン引数を解析して実行するタスクのリストを返します。

実行するタスクが指定されていない場合はデフォルトのタスクのみ返します。また、このとき環境変数の解析も行います。

display_prerequisites[permalink][rdoc]

タスクとそのタスクに依存しているタスクを表示します。

display_tasks_and_comments[permalink][rdoc]

タスクとコメントを表示します。

dynamic_width -> Integer[permalink][rdoc]

ターミナルの幅を計算します。

dynamic_width_stty[permalink][rdoc]

stty(1) を用いてターミナルの幅を計算します。

dynamic_width_tput[permalink][rdoc]

tput(1) を用いてターミナルの幅を計算します。

find_rakefile_location -> Array | nil[permalink][rdoc]

Rakefile とそのファイルがあったディレクトリのペアを返します。

handle_options[permalink][rdoc]

コマンドラインオプションを OptionParser に登録します。

have_rakefile -> String | nil[permalink][rdoc]

Rakefile がカレントディレクトリに存在する場合はそのファイル名を返します。そうでない場合は nil を返します。

[SEE_ALSO] Rake::Application::DEFAULT_RAKEFILES

init(app_name = 'rake')[permalink][rdoc]

コマンドラインオプションとアプリケーション名を初期化します。

invoke_task(task_string)[permalink][rdoc]

与えられた文字列を解析してタスクを実行します。

[PARAM] task_string:: タスク名とそれに与えるパラメータをあらわす文字列を指定します。

load_imports[permalink][rdoc]

ロード予定のファイルを全てロードします。

既にロード済みのファイルはロードしません。

load_rakefile[permalink][rdoc]

Rakefile を探してロードします。

name -> String[permalink][rdoc]

アプリケーションの名前を返します。通常は 'rake' という名前を返します。


# Rakefile での記載例とする

task default: :test_rake_app
task :test_rake_app do
  Rake.application.name # => "rake"
end

options -> OpenStruct[permalink][rdoc]

コマンドラインで与えられたアプリケーションのオプションを返します。


# Rakefile での記載例とする

task default: :test_rake_app
task :test_rake_app do
  Rake.application.options  # => #<OpenStruct always_multitask=false, backtrace=false, build_all=false, dryrun=false, ignore_deprecate=false, ignore_system=false, job_stats=false, load_system=false, nosearch=false, rakelib=["rakelib"], show_all_tasks=false, show_prereqs=false, show_task_pattern=nil, show_tasks=nil, silent=false, suppress_backtrace_pattern=nil, thread_pool_size=8, trace=false, trace_output=#<IO:<STDERR>>, trace_rules=false>
end

original_dir -> String[permalink][rdoc]

rake コマンドを実行したディレクトリを返します。


# Rakefile での記載例とする

task default: :test_rake_app
task :test_rake_app do
  Rake.application.original_dir # => "/path/to/dir"
end

parse_task_string(string) -> [String, Array][permalink][rdoc]

与えられた文字列を解析して、タスク名とそれに与えるパラメータのペアを返します。

[PARAM] string:: タスク名とそれに与えるパラメータのペアを返します。

rake_require(file_name, paths = $LOAD_PATH, loaded = $") -> bool[permalink][rdoc]

Kernel#require に似ていますが、*.rb ファイルではなく *.rake ファイルを探索します。

[PARAM] file_name:: ロードするファイル名を指定します。
[PARAM] paths:: ロードパスを指定します。
[PARAM] loaded:: ロード済みのファイルリストを指定します。
[EXCEPTION] LoadError:: 指定されたファイルが見つからなかった場合に発生します。

rakefile -> String[permalink][rdoc]

実際に使用されている Rakefile の名前を返します。


# Rakefile での記載例とする

task default: :test_rake_app
task :test_rake_app do
  Rake.application.rakefile # => "Rakefile"
end

rakefile_location -> String[permalink][rdoc]

Rakefile のパスを返します。

raw_load_rakefile[permalink][rdoc]

Rakefile をロードします。

[EXCEPTION] RuntimeError:: Rakefile が見つからなかった場合に発生します。

run[permalink][rdoc]

Rake アプリケーションを実行します。

このメソッドは以下の 3 ステップを実行します。

コマンドラインオプションを初期化します。Rake::Application#init
タスクを定義します。Rake::Application#load_rakefile
コマンドラインで指定されたタスクを実行します。Rake::Application#top_level

standard_exception_handling { ... }[permalink][rdoc]

与えられたブロックを評価する際に発生する標準的な例外を捕捉してアプリケーションを終了させます。

standard_rake_options -> Array[permalink][rdoc]

Rake コマンドで使用する標準的なコマンドラインオプションのリストを返します。

system_dir -> String[permalink][rdoc]

システム全体の Rakefile が格納されているディレクトリを返します。

環境変数 RAKE_SYSTEM で設定することができます。

terminal_width -> Integer[permalink][rdoc]

ターミナルの幅を返します。

環境変数 RAKE_COLUMNS で指定することが出来ます。

top_level[permalink][rdoc]

Rake アプリケーションに与えられたトップレベルのタスク (コマンドラインで指定されたタスク) を実行します。

top_level_tasks -> Array[permalink][rdoc]

コマンドラインで指定されたタスクのリストを返します。

truncate(string, width) -> String[permalink][rdoc]

与えられた文字列を与えられた幅で切り詰めます。

truncate_output?[permalink][rdoc]

tty_output=(tty_output_state)[permalink][rdoc]

TTY に対する出力状態を上書きします。

大抵の場合、テストのために使用します。

[PARAM] tty_output_state:: 変更後の状態を指定します

tty_output? -> bool[permalink][rdoc]

TTY に出力している場合は真を返します。そうでない場合は偽を返します。

unix? -> bool[permalink][rdoc]

現在のプラットフォームが UNIX 系である場合、真を返します。そうでない場合は偽を返します。

windows? -> bool[permalink][rdoc]

現在のプラットフォームが Windows 系である場合、真を返します。そうでない場合は偽を返します。

定数

DEFAULT_RAKEFILES -> Array[permalink][rdoc]

デフォルトで Rakefile として扱うファイル名の配列を返します。

'rakefile', 'Rakefile', 'rakefile.rb', 'Rakefile.rb' が指定されています。

class Rake::Application

要約

目次

インスタンスメソッド

定数