Module: Rake::TaskManager

Included in:
Application
Defined in:
lib/rake/task_manager.rb

Overview

The TaskManager module is a mixin for managing tasks.

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Class Attribute Details

.record_task_metadata ⇒ Object

:nodoc:



318
319
320
 
# File 'lib/rake/task_manager.rb', line 318

def record_task_metadata
  @record_task_metadata
end

Instance Attribute Details

#last_description ⇒ Object

Track the last comment made in the Rakefile.



7
8
9
 
# File 'lib/rake/task_manager.rb', line 7

def last_description
  @last_description
end

Instance Method Details

#[](task_name, scopes = nil) ⇒ Object

Find a matching task for task_name.



54
55
56
57
58
59
60
 
# File 'lib/rake/task_manager.rb', line 54

def [](task_name, scopes=nil)
  task_name = task_name.to_s
  self.lookup(task_name, scopes) or
    enhance_with_matching_rule(task_name) or
    synthesize_file_task(task_name) or
    fail generate_message_for_undefined_task(task_name)
end

#clear ⇒ Object

Clear all tasks in this application.



174
175
176
177
 
# File 'lib/rake/task_manager.rb', line 174

def clear
  @tasks.clear
  @rules.clear
end

#create_rule(*args, &block) ⇒ Object

:nodoc:



17
18
19
20
21
 
# File 'lib/rake/task_manager.rb', line 17

def create_rule(*args, &block) # :nodoc:
  pattern, args, deps = resolve_args(args)
  pattern = Regexp.new(Regexp.quote(pattern) + "$") if String === pattern
  @rules << [pattern, args, deps, block]
end

#current_scope ⇒ Object

Return the list of scope names currently active in the task manager.



214
215
216
 
# File 'lib/rake/task_manager.rb', line 214

def current_scope
  @scope
end

#define_task(task_class, *args, &block) ⇒ Object

:nodoc:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rake/task_manager.rb', line 23

def define_task(task_class, *args, &block) # :nodoc:
  task_name, arg_names, deps = resolve_args(args)

  original_scope = @scope
  if String === task_name and
     not task_class.ancestors.include? Rake::FileTask
    task_name, *definition_scope = *(task_name.split(":").reverse)
    @scope = Scope.make(*(definition_scope + @scope.to_a))
  end

  task_name = task_class.scope_name(@scope, task_name)
  deps = [deps] unless deps.respond_to?(:to_ary)
  deps = deps.map { |d| Rake.from_pathname(d).to_s }
  task = intern(task_class, task_name)
  task.set_arg_names(arg_names) unless arg_names.empty?
  if Rake::TaskManager.record_task_metadata
    add_location(task)
    task.add_description(get_description(task))
  end
  task.enhance(deps, &block)
ensure
  @scope = original_scope
end

#enhance_with_matching_rule(task_name, level = 0) ⇒ Object

If a rule can be found that matches the task name, enhance the task with the prerequisites and actions from the rule. Set the source attribute of the task appropriately for the rule. Return the enhanced task or nil of no rule was found.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rake/task_manager.rb', line 144

def enhance_with_matching_rule(task_name, level=0)
  fail Rake::RuleRecursionOverflowError,
    "Rule Recursion Too Deep" if level >= 16
  @rules.each do |pattern, args, extensions, block|
    if pattern && pattern.match(task_name)
      task = attempt_rule(task_name, pattern, args, extensions, block, level)
      return task if task
    end
  end
  nil
rescue Rake::RuleRecursionOverflowError => ex
  ex.add_target(task_name)
  fail ex
end

#generate_did_you_mean_suggestions(task_name) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rake/task_manager.rb', line 67

def generate_did_you_mean_suggestions(task_name)
  return "" unless defined?(::DidYouMean::SpellChecker)

  suggestions = ::DidYouMean::SpellChecker.new(dictionary: @tasks.keys).correct(task_name.to_s)
  if ::DidYouMean.respond_to?(:formatter)# did_you_mean v1.2.0 or later
    ::DidYouMean.formatter.message_for(suggestions)
  elsif defined?(::DidYouMean::Formatter) # before did_you_mean v1.2.0
    ::DidYouMean::Formatter.new(suggestions).to_s
  else
    ""
  end
end

#generate_message_for_undefined_task(task_name) ⇒ Object 



62
63
64
65
 
# File 'lib/rake/task_manager.rb', line 62

def generate_message_for_undefined_task(task_name)
  message = "Don't know how to build task '#{task_name}' (See the list of available tasks with `rake --tasks`)"
  message + generate_did_you_mean_suggestions(task_name)
end

#in_namespace(name) ⇒ Object

Evaluate the block in a nested namespace named name. Create an anonymous namespace if name is nil.



220
221
222
223
224
225
226
227
228
 
# File 'lib/rake/task_manager.rb', line 220

def in_namespace(name)
  name ||= generate_name
  @scope = Scope.new(name, @scope)
  ns = NameSpace.new(self, @scope)
  yield(ns)
  ns
ensure
  @scope = @scope.tail
end

#initialize ⇒ Object

:nodoc:



9
10
11
12
13
14
15
 
# File 'lib/rake/task_manager.rb', line 9

def initialize # :nodoc:
  super
  @tasks = Hash.new
  @rules = Array.new
  @scope = Scope.make
  @last_description = nil
end

#intern(task_class, task_name) ⇒ Object

Lookup a task. Return an existing task if found, otherwise create a task of the current type.



49
50
51
 
# File 'lib/rake/task_manager.rb', line 49

def intern(task_class, task_name)
  @tasks[task_name.to_s] ||= task_class.new(task_name, self)
end

#lookup(task_name, initial_scope = nil) ⇒ Object

Lookup a task, using scope and the scope hints in the task name. This method performs straight lookups without trying to synthesize file tasks or rules. Special scope names (e.g. ‘^’) are recognized. If no scope argument is supplied, use the current scope. Return nil if the task cannot be found.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/rake/task_manager.rb', line 184

def lookup(task_name, initial_scope=nil)
  initial_scope ||= @scope
  task_name = task_name.to_s
  if task_name =~ /^rake:/
    scopes = Scope.make
    task_name = task_name.sub(/^rake:/, "")
  elsif task_name =~ /^(\^+)/
    scopes = initial_scope.trim($1.size)
    task_name = task_name.sub(/^(\^+)/, "")
  else
    scopes = initial_scope
  end
  lookup_in_scope(task_name, scopes)
end

#resolve_args(args) ⇒ Object

Resolve the arguments for a task/rule. Returns a triplet of [task_name, arg_name_list, prerequisites].



87
88
89
90
91
92
93
94
 
# File 'lib/rake/task_manager.rb', line 87

def resolve_args(args)
  if args.last.is_a?(Hash)
    deps = args.pop
    resolve_args_with_dependencies(args, deps)
  else
    resolve_args_without_dependencies(args)
  end
end

#synthesize_file_task(task_name) ⇒ Object

:nodoc:



80
81
82
83
 
# File 'lib/rake/task_manager.rb', line 80

def synthesize_file_task(task_name) # :nodoc:
  return nil unless File.exist?(task_name)
  define_task(Rake::FileTask, task_name)
end

#tasks ⇒ Object

List of all defined tasks in this application.



160
161
162
 
# File 'lib/rake/task_manager.rb', line 160

def tasks
  @tasks.values.sort_by { |t| t.name }
end

#tasks_in_scope(scope) ⇒ Object

List of all the tasks defined in the given scope (and its sub-scopes).



166
167
168
169
170
171
 
# File 'lib/rake/task_manager.rb', line 166

def tasks_in_scope(scope)
  prefix = scope.path
  tasks.select { |t|
    /^#{prefix}:/ =~ t.name
  }
end