Class: Build::Graph::Task

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(walker, node) ⇒ Task

Returns a new instance of Task.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/build/graph/task.rb', line 39

def initialize(walker, node)
  @walker = walker
  
  @walker.tasks[node] = self
  
  @node = node
  @fiber = nil
  
  @error = nil
  
  @children = []
  
  @state = nil
  @annotation = nil
  
  @inputs_failed = false
end

Instance Attribute Details

#annotation ⇒ Object (readonly)

Returns the value of attribute annotation.



63
64
65
 
# File 'lib/build/graph/task.rb', line 63

def annotation
  @annotation
end

#children ⇒ Object (readonly)

Returns the value of attribute children.



60
61
62
 
# File 'lib/build/graph/task.rb', line 60

def children
  @children
end

#error ⇒ Object (readonly)

The error, if the execution of the node fails.



66
67
68
 
# File 'lib/build/graph/task.rb', line 66

def error
  @error
end

#inputs ⇒ Object (readonly)

Returns the value of attribute inputs.



57
58
59
 
# File 'lib/build/graph/task.rb', line 57

def inputs
  @inputs
end

#inputs_failed ⇒ Object (readonly)

A list of any inputs whose relevant tasks failed:



73
74
75
 
# File 'lib/build/graph/task.rb', line 73

def inputs_failed
  @inputs_failed
end

#node ⇒ Object (readonly)

Returns the value of attribute node.



70
71
72
 
# File 'lib/build/graph/task.rb', line 70

def node
  @node
end

#outputs ⇒ Object (readonly)

Returns the value of attribute outputs.



58
59
60
 
# File 'lib/build/graph/task.rb', line 58

def outputs
  @outputs
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



61
62
63
 
# File 'lib/build/graph/task.rb', line 61

def state
  @state
end

#walker ⇒ Object (readonly)

Returns the value of attribute walker.



68
69
70
 
# File 'lib/build/graph/task.rb', line 68

def walker
  @walker
end

Instance Method Details

#changed! ⇒ Object 



144
145
146
 
# File 'lib/build/graph/task.rb', line 144

def changed!
  @walker.delete(@node) if (@inputs.update! or @outputs.update!)
end

#complete? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/build/graph/task.rb', line 130

def complete?
  @state == :complete
end

#directories ⇒ Object 



148
149
150
 
# File 'lib/build/graph/task.rb', line 148

def directories
  (@inputs.roots + @outputs.roots).collect{|path| path.to_s}
end

#dirty? ⇒ Boolean

Returns true if the outputs of the task are out of date w.r.t. the inputs. Currently, does not take into account if the input is a glob and files have been added.

Returns:

  • (Boolean) 


136
137
138
139
140
141
142
 
# File 'lib/build/graph/task.rb', line 136

def dirty?
  if @outputs
    @outputs.dirty?(@inputs)
  else
    true
  end
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/build/graph/task.rb', line 126

def failed?
  @state == :failed
end

#inspect ⇒ Object 



152
153
154
 
# File 'lib/build/graph/task.rb', line 152

def inspect
  "#<#{self.class}:#{'0x%X' % self.object_id} #{@node.inspect} #{@state}>"
end

#invoke(node) ⇒ Object

Raises:

  • (ArgumentError) 


118
119
120
121
122
123
124
 
# File 'lib/build/graph/task.rb', line 118

def invoke(node)
  child_task = @walker.call(node, self)
  
  raise ArgumentError.new("Invalid child task") unless child_task
  
  @children << child_task
end

#visit ⇒ Object

Derived task should override this function to provide appropriate behaviour.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/build/graph/task.rb', line 76

def visit
  update_inputs_and_outputs
  
  # Inforn the walker a new task is being generated for this node:
  @walker.enter(self)
  
  if @fiber
    raise RuntimeError, "Task is already running!"
  end
  
  @fiber = Fiber.new do
    # If all inputs were good, we can update the node.
    if wait_for_inputs?
      begin
        yield
      rescue TransientError => error
        fail!(error)
      end
    else
      fail!(InputsFailed)
    end
    
    unless wait_for_children?
      fail!(ChildrenFailed)
    end
    
    update_outputs
    
    @state ||= :complete
    
    @walker.exit(self)
    
    @fiber = nil
  end
  
  # Schedule the work, hopefully synchronously:
  @fiber.resume
  
  # This allows the child task to be passed back to the parent when it is first invoked.
  return self
end