Class Rake::Task
In: lib/rake/task.rb
Parent: Object

A Task is the basic unit of work in a Rakefile. Tasks have associated actions (possibly more than one) and a list of prerequisites. When invoked, a task will first ensure that all of its prerequisites have an opportunity to run and then it will execute its own actions.

Tasks are not usually created directly using the new method, but rather use the file and task convenience methods.

Methods

External Aliases

prerequisites -> prereqs

Attributes

actions  [R]  List of actions attached to a task.
already_invoked  [R]  Has this task already been invoked? Already invoked tasks will be skipped unless you reenable them.
application  [RW]  Application owning this task.
locations  [R]  File/Line locations of each of the task definitions for this task (only valid if the task was defined with the detect location option set).
order_only_prerequisites  [R]  List of order only prerequisites for a task.
prerequisites  [R]  List of prerequisites for a task.
scope  [R]  Array of nested namespaces names used for task lookup by this task.
sources  [W]  List of sources for task.

Public Class methods

Return a task with the given name. If the task is not currently known, try to synthesize one from the defined rules. If no rules are found, but an existing file matches the task name, assume it is a file task with no dependencies or actions.

Clear the task list. This cause rake to immediately forget all the tasks that have been assigned. (Normally used in the unit tests.)

Define a rule for synthesizing tasks.

Define a task given args and an option block. If a rule with the given name already exists, the prerequisites and actions are added to the existing task. Returns the defined task.

Format dependencies parameter to pass to task.

Create a task named task_name with no actions or prerequisites. Use enhance to add actions and prerequisites.

Apply the scope to the task name according to the rules for this kind of task. Generic tasks will accept the scope as part of the name.

TRUE if the task name is already defined.

List of all defined tasks.

Public Instance methods

Add a description to the task. The description can consist of an option argument list (enclosed brackets) and an optional comment.

List of all unique prerequisite tasks including prerequisite tasks’ prerequisites. Includes self when cyclic dependencies are found.

Name of arguments for this task.

Clear the existing prerequisites, actions, comments, and arguments of a rake task.

Clear the existing actions on a rake task.

Clear the existing arguments on a rake task.

Clear the existing comments on a rake task.

Clear the existing prerequisites of a rake task.

First line (or sentence) of all comments. Multiple comments are separated by a "/".

Enhance a task with prerequisites or actions. Returns self.

Execute the actions associated with this task.

Full collection of comments. Multiple comments are separated by newlines.

Return a string describing the internal state of a task. Useful for debugging.

Invoke the task if it is needed. Prerequisites are invoked first.

Name of the task, including any namespace qualifiers.

Is this task needed?

List of prerequisite tasks

Reenable the task, allowing its tasks to be executed if the task is invoked again.

Set the names of the arguments for this task. args should be an array of symbols, one for each argument name.

First source from a rule (nil if no sources)

Timestamp for this task. Basic tasks return the current time for their time stamp. Other tasks can be more sophisticated.

Return task name

Add order only dependencies.

Protected Instance methods

Same as invoke, but explicitly pass a call chain to detect circular dependencies.

If multiple tasks depend on this one in parallel, they will all fail if the first execution of this task fails.

[Validate]