class SC::Buildfile::Task

Buildfile tasks are rake tasks with a few extras added to support unique buildfile constraints. Much of this source code is borrowed from Rake 0.8.3

Attributes

actions[R]

List of actions attached to a task.

application[RW]

Application owning this task.

comment[R]

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

execute_count[R]

The number of times the task was actually executed. This may differ from the invoke_count if the task was invoked but was not needed.

full_comment[R]

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

invoke_count[R]

The number of times this task has been invoked. Use to ensure that the task was invoked during some call chain…

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.

task_options[R]

Various options you can set on the task to control log level, etc.

Public Class Methods

indent_logs() click to toggle source
# File lib/sproutcore/buildfile/task.rb, line 147
def self.indent_logs
  @task_indent = (@task_indent || '') + '  '
end
log_indent() click to toggle source
# File lib/sproutcore/buildfile/task.rb, line 143
def self.log_indent
  @task_indent ||= ''
end
new(task_name, app) click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 73
def initialize(task_name, app)
  @name = task_name.to_s
  @prerequisites = []
  @actions = []
  @full_comment = nil
  @comment = nil
  @application = app
  @scope = app.current_scope
  @arg_names = nil
  @invoke_count = @execute_count = 0
  @task_options = {}
end
outdent_logs() click to toggle source
# File lib/sproutcore/buildfile/task.rb, line 151
def self.outdent_logs
  @task_indent = (@task_indent || '')[0..-3]
end
scope_name(scope, task_name) click to toggle source

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.

# File lib/sproutcore/buildfile/task.rb, line 315
def scope_name(scope, task_name)
  (scope + [task_name]).join(':')
end

Public Instance Methods

add_description(description) click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 250
def add_description(description)
  return if ! description
  comment = description.strip
  add_comment(comment) if comment && ! comment.empty?
end
add_options(task_options) click to toggle source

Add task options.

# File lib/sproutcore/buildfile/task.rb, line 257
def add_options(task_options)
  return if !task_options
  @task_options = task_options
end
arg_names() click to toggle source

Name of arguments for this task.

# File lib/sproutcore/buildfile/task.rb, line 113
def arg_names
  @arg_names || []
end
clear() click to toggle source

Clear the existing prerequisites and actions of a rake task.

# File lib/sproutcore/buildfile/task.rb, line 118
def clear
  clear_prerequisites
  clear_actions
  self
end
clear_actions() click to toggle source

Clear the existing actions on a rake task.

# File lib/sproutcore/buildfile/task.rb, line 131
def clear_actions
  actions.clear
  self
end
clear_prerequisites() click to toggle source

Clear the existing prerequisites of a rake task.

# File lib/sproutcore/buildfile/task.rb, line 125
def clear_prerequisites
  prerequisites.clear
  self
end
comment=(description) click to toggle source

Writing to the comment attribute is the same as adding a description.

# File lib/sproutcore/buildfile/task.rb, line 263
def comment=(description)
  add_description(description)
end
dup(app=application) click to toggle source
Calls superclass method
# File lib/sproutcore/buildfile/task.rb, line 65
def dup(app=application)
  ret = super()
  ret.application = app
  return ret
end
enhance(deps=nil, &block) click to toggle source

Enhance a task with prerequisites or actions. Returns self.

# File lib/sproutcore/buildfile/task.rb, line 87
def enhance(deps=nil, &block)
  @prerequisites |= deps if deps
  @actions << block if block_given?
  self
end
execute(args=nil) click to toggle source

Execute the actions associated with this task.

# File lib/sproutcore/buildfile/task.rb, line 221
def execute(args=nil)
  @execute_count += 1
  args ||= EMPTY_TASK_ARGS
  return if SC.env[:dryrun]

  @actions.each do |act|
    case act.arity
    when 1
      act.call(self)
    else
      act.call(self, args)
    end
  end

end
inspect() click to toggle source
# File lib/sproutcore/buildfile/task.rb, line 50
def inspect
  "<#{self.class} #{name} => [#{prerequisites.join(', ')}]>"
end
investigation() click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 292
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(hash) click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 137
def invoke(hash)
  task_args = hash
  task_args = TaskArguments.with_hash(hash) #TaskArguments.new(arg_names, args)
  invoke_with_call_chain(task_args, InvocationChain::EMPTY)
end
name() click to toggle source

Name of the task, including any namespace qualifiers.

# File lib/sproutcore/buildfile/task.rb, line 94
def name
  @name.to_s
end
needed?() click to toggle source

Is this task needed?

# File lib/sproutcore/buildfile/task.rb, line 238
def needed?
  true
end
set_arg_names(args) click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 286
def set_arg_names(args)
  @arg_names = args.map { |a| a.to_sym }
end
source() click to toggle source

First source from a rule (nil if no sources)

# File lib/sproutcore/buildfile/task.rb, line 61
def source
  @sources.first if defined?(@sources)
end
sources() click to toggle source
# File lib/sproutcore/buildfile/task.rb, line 56
def sources
  @sources ||= []
end
timestamp() click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 244
def timestamp
  @prerequisites.collect { |p| application[p].timestamp }.max || Time.now
end
to_s() click to toggle source

Return task name

# File lib/sproutcore/buildfile/task.rb, line 46
def to_s
  name
end

Private Instance Methods

add_comment(comment) click to toggle source

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

# File lib/sproutcore/buildfile/task.rb, line 269
def add_comment(comment)
  if @full_comment
    @full_comment << " / "
  else
    @full_comment = ''
  end
  @full_comment << comment
  if @full_comment =~ /\A([^.]+?\.)( |$)/
    @comment = $1
  else
    @comment = @full_comment
  end
end
format_trace_flags() click to toggle source

Format the trace flags for display.

# File lib/sproutcore/buildfile/task.rb, line 212
def format_trace_flags
  flags = []
  flags << "first_time" unless @already_invoked
  flags << "not_needed" unless needed?
  flags.empty? ? "" : "(" + flags.join(", ") + ")"
end