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.
- []
- add_description
- arg_names
- clear
- clear
- clear_actions
- clear_prerequisites
- comment=
- create_rule
- define_task
- enhance
- execute
- inspect
- investigation
- invoke
- name
- needed?
- new
- reenable
- scope_name
- set_arg_names
- source
- sources
- task_defined?
- tasks
- timestamp
- to_s
[R] | actions | List of actions attached to a task. |
[RW] | application | Application owning this task. |
[R] | comment | Comment for this task. Restricted to a single line of no more than 50 characters. |
[R] | full_comment | Full text of the (possibly multi-line) comment. |
[R] | prerequisites | List of prerequisites for a task. |
[R] | scope | Array of nested namespaces names used for task lookup by this task. |
[W] | sources | List of sources for task. |
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.
[ show source ]
# File lib/rake.rb, line 728 728: def [](task_name) 729: Rake.application[task_name] 730: end
Clear the task list. This cause rake to immediately forget all the tasks that have been assigned. (Normally used in the unit tests.)
[ show source ]
# File lib/rake.rb, line 715 715: def clear 716: Rake.application.clear 717: end
Define a rule for synthesizing tasks.
[ show source ]
# File lib/rake.rb, line 745 745: def create_rule(*args, &block) 746: Rake.application.create_rule(*args, &block) 747: end
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.
[ show source ]
# File lib/rake.rb, line 740 740: def define_task(*args, &block) 741: Rake.application.define_task(self, *args, &block) 742: end
Create a task named task_name with no actions or prerequisites. Use enhance to add actions and prerequisites.
[ show source ]
# File lib/rake.rb, line 511 511: def initialize(task_name, app) 512: @name = task_name.to_s 513: @prerequisites = [] 514: @actions = [] 515: @already_invoked = false 516: @full_comment = nil 517: @comment = nil 518: @lock = Monitor.new 519: @application = app 520: @scope = app.current_scope 521: @arg_names = nil 522: end
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.
[ show source ]
# File lib/rake.rb, line 752 752: def scope_name(scope, task_name) 753: (scope + [task_name]).join(':') 754: end
TRUE if the task name is already defined.
[ show source ]
# File lib/rake.rb, line 733 733: def task_defined?(task_name) 734: Rake.application.lookup(task_name) != nil 735: end
List of all defined tasks.
[ show source ]
# File lib/rake.rb, line 720 720: def tasks 721: Rake.application.tasks 722: end
Add a description to the task. The description can consist of an option argument list (enclosed brackets) and an optional comment.
[ show source ]
# File lib/rake.rb, line 654 654: def add_description(description) 655: return if ! description 656: comment = description.strip 657: add_comment(comment) if comment && ! comment.empty? 658: end
Name of arguments for this task.
[ show source ]
# File lib/rake.rb, line 551 551: def arg_names 552: @arg_names || [] 553: end
Clear the existing prerequisites and actions of a rake task.
[ show source ]
# File lib/rake.rb, line 562 562: def clear 563: clear_prerequisites 564: clear_actions 565: self 566: end
Clear the existing actions on a rake task.
[ show source ]
# File lib/rake.rb, line 575 575: def clear_actions 576: actions.clear 577: self 578: end
Clear the existing prerequisites of a rake task.
[ show source ]
# File lib/rake.rb, line 569 569: def clear_prerequisites 570: prerequisites.clear 571: self 572: end
Writing to the comment attribute is the same as adding a description.
[ show source ]
# File lib/rake.rb, line 661 661: def comment=(description) 662: add_description(description) 663: end
Enhance a task with prerequisites or actions. Returns self.
[ show source ]
# File lib/rake.rb, line 525 525: def enhance(deps=nil, &block) 526: @prerequisites |= deps if deps 527: @actions << block if block_given? 528: self 529: end
Execute the actions associated with this task.
[ show source ]
# File lib/rake.rb, line 621 621: def execute(args=nil) 622: args ||= EMPTY_TASK_ARGS 623: if application.options.dryrun 624: puts "** Execute (dry run) #{name}" 625: return 626: end 627: if application.options.trace 628: puts "** Execute #{name}" 629: end 630: application.enhance_with_matching_rule(name) if @actions.empty? 631: @actions.each do |act| 632: case act.arity 633: when 1 634: act.call(self) 635: else 636: act.call(self, args) 637: end 638: end 639: end
[ show source ]
# File lib/rake.rb, line 494 494: def inspect 495: "<#{self.class} #{name} => [#{prerequisites.join(', ')}]>" 496: end
Return a string describing the internal state of a task. Useful for debugging.
[ show source ]
# File lib/rake.rb, line 690 690: def investigation 691: result = "------------------------------\n" 692: result << "Investigating #{name}\n" 693: result << "class: #{self.class}\n" 694: result << "task needed: #{needed?}\n" 695: result << "timestamp: #{timestamp}\n" 696: result << "pre-requisites: \n" 697: prereqs = @prerequisites.collect {|name| application[name]} 698: prereqs.sort! {|a,b| a.timestamp <=> b.timestamp} 699: prereqs.each do |p| 700: result << "--#{p.name} (#{p.timestamp})\n" 701: end 702: latest_prereq = @prerequisites.collect{|n| application[n].timestamp}.max 703: result << "latest-prerequisite time: #{latest_prereq}\n" 704: result << "................................\n\n" 705: return result 706: end
Invoke the task if it is needed. Prerequites are invoked first.
[ show source ]
# File lib/rake.rb, line 581 581: def invoke(*args) 582: task_args = TaskArguments.new(arg_names, args) 583: invoke_with_call_chain(task_args, InvocationChain::EMPTY) 584: end
Name of the task, including any namespace qualifiers.
[ show source ]
# File lib/rake.rb, line 532 532: def name 533: @name.to_s 534: end
Is this task needed?
[ show source ]
# File lib/rake.rb, line 642 642: def needed? 643: true 644: end
Reenable the task, allowing its tasks to be executed if the task is invoked again.
[ show source ]
# File lib/rake.rb, line 557 557: def reenable 558: @already_invoked = false 559: end
Set the names of the arguments for this task. args should be an array of symbols, one for each argument name.
[ show source ]
# File lib/rake.rb, line 684 684: def set_arg_names(args) 685: @arg_names = args.map { |a| a.to_sym } 686: end
[ show source ]
# File lib/rake.rb, line 505 505: def source 506: @sources.first if defined?(@sources) 507: end
[ show source ]
# File lib/rake.rb, line 500 500: def sources 501: @sources ||= [] 502: end
Timestamp for this task. Basic tasks return the current time for their time stamp. Other tasks can be more sophisticated.
[ show source ]
# File lib/rake.rb, line 648 648: def timestamp 649: @prerequisites.collect { |p| application[p].timestamp }.max || Time.now 650: end
Return task name
[ show source ]
# File lib/rake.rb, line 490 490: def to_s 491: name 492: end