Class: Rake::Task

Inherits:
Object
  • Object
show all
Defined in:
lib/rake/task.rb

Overview

######################################################################### 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.

Direct Known Subclasses

FileTask, MultiTask

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Task) initialize(task_name, app)

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



71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/rake/task.rb', line 71

def initialize(task_name, app)
  @name = task_name.to_s
  @prerequisites = []
  @actions = []
  @already_invoked = false
  @full_comment = nil
  @comment = nil
  @lock = Monitor.new
  @application = app
  @scope = app.current_scope
  @arg_names = nil
  @locations = []
end

Instance Attribute Details

- (Object) actions (readonly)

List of actions attached to a task.



19
20
21
# File 'lib/rake/task.rb', line 19

def actions
  @actions
end

- (Object) application

Application owning this task.



22
23
24
# File 'lib/rake/task.rb', line 22

def application
  @application
end

- (Object) comment

Comment for this task. Restricted to a single line of no more than 50 characters.



26
27
28
# File 'lib/rake/task.rb', line 26

def comment
  @comment
end

- (Object) full_comment (readonly)

Full text of the (possibly multi-line) comment.



29
30
31
# File 'lib/rake/task.rb', line 29

def full_comment
  @full_comment
end

- (Object) locations (readonly)

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



37
38
39
# File 'lib/rake/task.rb', line 37

def locations
  @locations
end

- (Object) prerequisites (readonly)

List of prerequisites for a task.



16
17
18
# File 'lib/rake/task.rb', line 16

def prerequisites
  @prerequisites
end

- (Object) scope (readonly)

Array of nested namespaces names used for task lookup by this task.



32
33
34
# File 'lib/rake/task.rb', line 32

def scope
  @scope
end

- (Object) sources



50
51
52
# File 'lib/rake/task.rb', line 50

def sources
  @sources ||= []
end

Class Method Details

+ (Object) [](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.



297
298
299
# File 'lib/rake/task.rb', line 297

def [](task_name)
  Rake.application[task_name]
end

+ (Object) clear

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



284
285
286
# File 'lib/rake/task.rb', line 284

def clear
  Rake.application.clear
end

+ (Object) create_rule(*args, &block)

Define a rule for synthesizing tasks.



314
315
316
# File 'lib/rake/task.rb', line 314

def create_rule(*args, &block)
  Rake.application.create_rule(*args, &block)
end

+ (Object) 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.



309
310
311
# File 'lib/rake/task.rb', line 309

def define_task(*args, &block)
  Rake.application.define_task(self, *args, &block)
end

+ (Object) 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.



321
322
323
# File 'lib/rake/task.rb', line 321

def scope_name(scope, task_name)
  (scope + [task_name]).join(':')
end

+ (Boolean) task_defined?(task_name)

TRUE if the task name is already defined.



302
303
304
# File 'lib/rake/task.rb', line 302

def task_defined?(task_name)
  Rake.application.lookup(task_name) != nil
end

+ (Object) tasks

List of all defined tasks.



289
290
291
# File 'lib/rake/task.rb', line 289

def tasks
  Rake.application.tasks
end

Instance Method Details

- (Object) add_description(description)

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



223
224
225
226
227
# File 'lib/rake/task.rb', line 223

def add_description(description)
  return if ! description
  comment = description.strip
  add_comment(comment) if comment && ! comment.empty?
end

- (Object) arg_description

Argument description (nil if none).



107
108
109
# File 'lib/rake/task.rb', line 107

def arg_description # :nodoc:
  @arg_names ? "[#{(arg_names || []).join(',')}]" : nil
end

- (Object) arg_names

Name of arguments for this task.



112
113
114
# File 'lib/rake/task.rb', line 112

def arg_names
  @arg_names || []
end

- (Object) clear

Clear the existing prerequisites and actions of a rake task.



123
124
125
126
127
# File 'lib/rake/task.rb', line 123

def clear
  clear_prerequisites
  clear_actions
  self
end

- (Object) clear_actions

Clear the existing actions on a rake task.



136
137
138
139
# File 'lib/rake/task.rb', line 136

def clear_actions
  actions.clear
  self
end

- (Object) clear_prerequisites

Clear the existing prerequisites of a rake task.



130
131
132
133
# File 'lib/rake/task.rb', line 130

def clear_prerequisites
  prerequisites.clear
  self
end

- (Object) enhance(deps = nil, &block)

Enhance a task with prerequisites or actions. Returns self.



86
87
88
89
90
# File 'lib/rake/task.rb', line 86

def enhance(deps=nil, &block)
  @prerequisites |= deps if deps
  @actions << block if block_given?
  self
end

- (Object) execute(args = nil)

Execute the actions associated with this task.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/rake/task.rb', line 190

def execute(args=nil)
  args ||= EMPTY_TASK_ARGS
  if application.options.dryrun
    $stderr.puts "** Execute (dry run) #{name}"
    return
  end
  if application.options.trace
    $stderr.puts "** Execute #{name}"
  end
  application.enhance_with_matching_rule(name) if @actions.empty?
  @actions.each do |act|
    case act.arity
    when 1
      act.call(self)
    else
      act.call(self, args)
    end
  end
end

- (Object) inspect



44
45
46
# File 'lib/rake/task.rb', line 44

def inspect
  "<#{self.class} #{name} => [#{prerequisites.join(', ')}]>"
end

- (Object) investigation

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/rake/task.rb', line 259

def investigation
  result = "------------------------------\n"
  result << "Investigating #{name}\n"
  result << "class: #{self.class}\n"
  result <<  "task needed: #{needed?}\n"
  result <<  "timestamp: #{timestamp}\n"
  result << "pre-requisites: \n"
  prereqs = prerequisite_tasks
  prereqs.sort! {|a,b| a.timestamp <=> b.timestamp}
  prereqs.each do |p|
    result << "--#{p.name} (#{p.timestamp})\n"
  end
  latest_prereq = prerequisite_tasks.collect { |pre| pre.timestamp }.max
  result <<  "latest-prerequisite time: #{latest_prereq}\n"
  result << "................................\n\n"
  return result
end

- (Object) invoke(*args)

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



142
143
144
145
# File 'lib/rake/task.rb', line 142

def invoke(*args)
  task_args = TaskArguments.new(arg_names, args)
  invoke_with_call_chain(task_args, InvocationChain::EMPTY)
end

- (Object) invoke_prerequisites(task_args, invocation_chain)

Invoke all the prerequisites of a task.



173
174
175
176
177
178
# File 'lib/rake/task.rb', line 173

def invoke_prerequisites(task_args, invocation_chain) # :nodoc:
  prerequisite_tasks.each { |prereq|
    prereq_args = task_args.new_scope(prereq.arg_names)
    prereq.invoke_with_call_chain(prereq_args, invocation_chain)
  }
end

- (Object) name

Name of the task, including any namespace qualifiers.



93
94
95
# File 'lib/rake/task.rb', line 93

def name
  @name.to_s
end

- (Object) name_with_args

Name of task with argument list description.



98
99
100
101
102
103
104
# File 'lib/rake/task.rb', line 98

def name_with_args # :nodoc:
  if arg_description
    "#{name}#{arg_description}"
  else
    name
  end
end

- (Boolean) needed?

Is this task needed?



211
212
213
# File 'lib/rake/task.rb', line 211

def needed?
  true
end

- (Object) prerequisite_tasks

List of prerequisite tasks



55
56
57
# File 'lib/rake/task.rb', line 55

def prerequisite_tasks
  prerequisites.collect { |pre| lookup_prerequisite(pre) }
end

- (Object) reenable

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



118
119
120
# File 'lib/rake/task.rb', line 118

def reenable
  @already_invoked = false
end

- (Object) set_arg_names(args)

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



253
254
255
# File 'lib/rake/task.rb', line 253

def set_arg_names(args)
  @arg_names = args.map { |a| a.to_sym }
end

- (Object) source

First source from a rule (nil if no sources)



65
66
67
# File 'lib/rake/task.rb', line 65

def source
  @sources.first if defined?(@sources)
end

- (Object) timestamp

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



217
218
219
# File 'lib/rake/task.rb', line 217

def timestamp
  prerequisite_tasks.collect { |pre| pre.timestamp }.max || Time.now
end

- (Object) to_s

Return task name



40
41
42
# File 'lib/rake/task.rb', line 40

def to_s
  name
end