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

#initialize(task_name, app) ⇒ Task

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



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/rake/task.rb', line 54

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
end

Instance Attribute Details

#actions ⇒ Object (readonly)

List of actions attached to a task.



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

def actions
  @actions
end

#application ⇒ Object

Application owning this task.



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

def application
  @application
end

#comment ⇒ Object

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



24
25
26
 
# File 'lib/rake/task.rb', line 24

def comment
  @comment
end

#full_comment ⇒ Object (readonly)

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



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

def full_comment
  @full_comment
end

#prerequisites ⇒ Object (readonly)

List of prerequisites for a task.



14
15
16
 
# File 'lib/rake/task.rb', line 14

def prerequisites
  @prerequisites
end

#scope ⇒ Object (readonly)

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



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

def scope
  @scope
end

#sources ⇒ Object 



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

def sources
  @sources ||= []
end

Class Method Details

.[](task_name) ⇒ Object

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.



271
272
273
 
# File 'lib/rake/task.rb', line 271

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

.clear ⇒ Object

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



258
259
260
 
# File 'lib/rake/task.rb', line 258

def clear
  Rake.application.clear
end

.create_rule(*args, &block) ⇒ Object

Define a rule for synthesizing tasks.



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

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

.define_task(*args, &block) ⇒ Object

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.



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

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

.scope_name(scope, task_name) ⇒ Object

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.



295
296
297
 
# File 'lib/rake/task.rb', line 295

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

.task_defined?(task_name) ⇒ Boolean

TRUE if the task name is already defined.

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/rake/task.rb', line 276

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

.tasks ⇒ Object

List of all defined tasks.



263
264
265
 
# File 'lib/rake/task.rb', line 263

def tasks
  Rake.application.tasks
end

Instance Method Details

#add_description(description) ⇒ Object

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



197
198
199
200
201
 
# File 'lib/rake/task.rb', line 197

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

#arg_description ⇒ Object

Argument description (nil if none).



89
90
91
 
# File 'lib/rake/task.rb', line 89

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

#arg_names ⇒ Object

Name of arguments for this task.



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

def arg_names
  @arg_names || []
end

#clear ⇒ Object

Clear the existing prerequisites and actions of a rake task.



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

def clear
  clear_prerequisites
  clear_actions
  self
end

#clear_actions ⇒ Object

Clear the existing actions on a rake task.



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

def clear_actions
  actions.clear
  self
end

#clear_prerequisites ⇒ Object

Clear the existing prerequisites of a rake task.



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

def clear_prerequisites
  prerequisites.clear
  self
end

#enhance(deps = nil, &block) ⇒ Object

Enhance a task with prerequisites or actions. Returns self.



68
69
70
71
72
 
# File 'lib/rake/task.rb', line 68

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

#execute(args = nil) ⇒ Object

Execute the actions associated with this task.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/rake/task.rb', line 164

def execute(args=nil)
  args ||= EMPTY_TASK_ARGS
  if application.options.dryrun
    puts "** Execute (dry run) #{name}"
    return
  end
  if application.options.trace
    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

#inspect ⇒ Object 



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

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

#investigation ⇒ Object

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/rake/task.rb', line 233

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 = @prerequisites.collect {|name| application[name]}
  prereqs.sort! {|a,b| a.timestamp <=> b.timestamp}
  prereqs.each do |p|
    result << "--#{p.name} (#{p.timestamp})\n"
  end
  latest_prereq = @prerequisites.collect{|n| application[n].timestamp}.max
  result <<  "latest-prerequisite time: #{latest_prereq}\n"
  result << "................................\n\n"
  return result
end

#invoke(*args) ⇒ Object

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



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

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

#invoke_prerequisites(task_args, invocation_chain) ⇒ Object

Invoke all the prerequisites of a task.



146
147
148
149
150
151
152
 
# File 'lib/rake/task.rb', line 146

def invoke_prerequisites(task_args, invocation_chain) # :nodoc:
  @prerequisites.each { |n|
    prereq = application[n, @scope]
    prereq_args = task_args.new_scope(prereq.arg_names)
    prereq.invoke_with_call_chain(prereq_args, invocation_chain)
  }
end

#name ⇒ Object

Name of the task, including any namespace qualifiers.



75
76
77
 
# File 'lib/rake/task.rb', line 75

def name
  @name.to_s
end

#name_with_args ⇒ Object

Name of task with argument list description.



80
81
82
83
84
85
86
 
# File 'lib/rake/task.rb', line 80

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

#needed? ⇒ Boolean

Is this task needed?

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/rake/task.rb', line 185

def needed?
  true
end

#reenable ⇒ Object

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



100
101
102
 
# File 'lib/rake/task.rb', line 100

def reenable
  @already_invoked = false
end

#set_arg_names(args) ⇒ Object

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



227
228
229
 
# File 'lib/rake/task.rb', line 227

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

#source ⇒ Object

First source from a rule (nil if no sources)



48
49
50
 
# File 'lib/rake/task.rb', line 48

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

#timestamp ⇒ Object

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



191
192
193
 
# File 'lib/rake/task.rb', line 191

def timestamp
  @prerequisites.collect { |p| application[p].timestamp }.max || Time.now
end

#to_s ⇒ Object

Return task name



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

def to_s
  name
end