Class: Rake::Task

Class | Rake::Task
In: | lib/rake.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

[] add_comment clear create_rule define_task enhance execute investigation invoke invoke_prerequisites name needed? new scope_name source sources task_defined? tasks timestamp to_s

### Attributes

application | [RW] | Application owning this task.
comment | [RW] | Comment for this 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

[](task_name)

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()

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

create_rule(args, &block)

Define a rule for synthesizing tasks.

define_task(args, &block)

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.

new(task_name, app)

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

scope_name(scope, task_name)

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.

task_defined?(task_name)

TRUE if the task name is already defined.

tasks()

List of all defined tasks.

### Public Instance methods

add_comment(comment)

Add a comment to the task. If a comment alread exists, separate the new comment with " / ".

enhance(deps=nil, &block)

Enhance a task with prerequisites or actions. Returns self.

execute()

Execute the actions associated with this task.

investigation()

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

invoke()

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

invoke_prerequisites()

Invoke all the prerequisites of a task.

name()

Name of the task, including any namespace qualifiers.

needed?()

Is this task needed?

source()

First source from a rule (nil if no sources)

sources()
timestamp()

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

to_s()

Return task name

[Validate]