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

class Rake::Task

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

要約

タスクは Rakefile における基本単位です。

タスクは一つ以上の関連するアクションと事前タスクを持ちます。 タスクを実行すると、まず始めに全ての事前タスクを一度だけ実行してから 自身のアクションを実行します。

タスクは通常 Kernel#task, Kernel#file という便利なメソッドを使用して定義します。

目次

特異メソッド
[] clear create_rule define_task new scope_name task_defined? tasks
インスタンスメソッド
actions add_description application application= arg_description arg_names clear clear_actions clear_prerequisites comment comment= enhance execute full_comment inspect investigation invoke name needed? prerequisites reenable scope set_arg_names source sources sources= timestamp to_s

特異メソッド

self[task_name] -> Rake::Task[permalink][rdoc]

与えられた名前のタスクを返します。

与えられた名前のタスクが存在しない場合は、ルールからタスク名を合成しようとします。 ルールからタスク名を合成出来なかったが、与えられたタスク名にマッチするファイルが存在する 場合は、ファイルタスクがアクションや事前タスク無しで存在していると仮定します。

[PARAM] task_name:
タスクの名前を指定します。
clear[permalink][rdoc]

タスクリストをクリアします。

このメソッドはユニットテスト用です。

create_rule(*args) { ... } -> Rake::Task[permalink][rdoc]

タスクを合成するためのルールを作成します。

define_task(*args) { ... } -> Rake::Task[permalink][rdoc]

与えられたパラメータと省略可能なブロックを用いてタスクを定義します。

同名のタスクが存在する場合は、事前タスクとアクションを既に存在するタスクに追加します。

[PARAM] args:
パラメータを指定します。
new(task_name, app)[permalink][rdoc]

与えられたタスク名とアプリケーションで自身を初期化します。

このメソッドで作成したタスクは、アクションや事前タスクを持っていません。 それらを追加する場合は Rake::Task#enhance を使用してください。

[SEE_ALSO] Rake::Task#enhance

scope_name(scope, task_name) -> String[permalink][rdoc]

与えられたスコープとタスク名をコロンで連結して返します。

task_defined?(task_name) -> bool[permalink][rdoc]

与えられたタスク名が既に定義されている場合は真を返します。 そうでない場合は偽を返します。

[PARAM] task_name:
タスク名を指定します。
tasks -> Array[permalink][rdoc]

定義されているタスクのリストを返します。

インスタンスメソッド

actions -> Array[permalink][rdoc]

自身に関連するアクションのリストを返します。

add_description(description)[permalink][rdoc]

自身に詳細説明を追加します。

application -> Rake::Application[permalink][rdoc]

自身を所有している Rake::Application のインスタンスを返します。

application=(app)[permalink][rdoc]

自身を所有している Rake::Application のインスタンスをセットします。

[PARAM] app:
自身を所有しているアプリケーションを指定します。
arg_description[permalink][rdoc]
arg_names -> Array[permalink][rdoc]

自身のパラメータ名のリストを返します。

clear -> self[permalink][rdoc]

自身に登録されているアクションと事前タスクをクリアします。

clear_actions -> self[permalink][rdoc]

自身に登録されているアクションをクリアします。

clear_prerequisites -> self[permalink][rdoc]

自身に登録されている事前タスクをクリアします。

comment -> String[permalink][rdoc]

自身の短いコメントを返します。

comment=(comment)[permalink][rdoc]

自身のコメントをセットします。

与えられた文字列が 50 文字を越える場合や複数行である場合は文字列を切り詰めます。

[PARAM] comment:
コメントをあらわす文字列を指定します。
enhance(deps = nil) { ... } -> self[permalink][rdoc]

自身に事前タスクとアクションを追加します。

execute(args = nil)[permalink][rdoc]

自身に関連付けられているアクションを実行します。

full_comment -> String[permalink][rdoc]

自身のコメントを全て返します。

inspect -> String[permalink][rdoc]

自身の情報を人間に読める形式で返します。

investigation -> String[permalink][rdoc]

自身の詳しい内部状態を文字列化して返します。

このメソッドはデバッグに便利です。

invoke(*args)[permalink][rdoc]

必要であれば自身を実行します。最初に事前タスクを実行します。

name -> String[permalink][rdoc]

ネームスペースを含むタスクの名前を返します。

needed? -> true[permalink][rdoc]

このタスクが必要ならば真を返します。

prerequisites -> Array[permalink][rdoc]

事前タスクのリストを返します。

reenable -> false[permalink][rdoc]

自身をもう一度実行出来るようにします。

scope[permalink][rdoc]
set_arg_names(args)[permalink][rdoc]

自身のパラメータの名前のリストをセットします。

[PARAM] args:
シンボルのリストを指定します。
source -> String[permalink][rdoc]

Rake::Task#sources の最初の要素を返します。

sources -> Array[permalink][rdoc]

自身が依存するファイルのリストを返します。

sources=(sources)[permalink][rdoc]

自身が依存するファイルのリストをセットします。

[PARAM] sources:
自身が依存するファイルのリストを指定します。
timestamp -> Time[permalink][rdoc]

自身のタイムスタンプを返します。

基本的なタスクは現在時刻を返しますが、高度なタスクはタイムスタンプを 計算して返します。

to_s -> String[permalink][rdoc]

自身の名前を返します。