build-graph 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f97cf5ec9acee56f42a3e032af5e3e6de28329616c5ec14b1e109372e972fdda
-  data.tar.gz: 139321b3283f1a69cc1230a87724ab43e48b289fccc88b120b527289ecbbeaa2
+  metadata.gz: a4e78a7adaa9ae6200d78d04dcad80fb911e55154e49f594070f3784a7ed3510
+  data.tar.gz: fb56d1d8055eb3b9fcaa96470afdb844ff81168cce11d9aa2e3f2cb0ad5f163d
 SHA512:
-  metadata.gz: ca5ce68fd6356a1ba5159b6a52eddd9cbeb79152de4f98f3cf57c934d5c247774c3cda2d47d5d1edd4e17621d8870a2dba162349555529806667d5f85bbb3460
-  data.tar.gz: 2620daa61cb84eade19d3fcde21134f650672da610739bf2036b2be7bcd3ad324b945ed220e744ef52e93722acb8d7da0b5e6a7a35372ced7eba9d3ccf473f68
+  metadata.gz: b9187a0ce3b730a9480e8239ac22873949a98f1d5e2911e80d017b8f6b4f919be6decd0aefa55682864d64b15188bff4d27171b5c45d42044daefad353803971
+  data.tar.gz: ea055341ccb20952b7bd6cce5df7624cdc9273a094006d045d6b321d8048b8eccb75583b910e8fab99cc545bdfd788eac5579a3cb57687b341bbca4d1986e00b

data/.gitignore

@@ -15,3 +15,10 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.bundle
+*.so
+*.o
+*.a
+*.d
+mkmf.log
+.rspec_status

data/lib/build/graph/node.rb

@@ -25,18 +25,14 @@ module Build
 	module Graph
 		# This is essentialy a immutable key:
 		class Node
-			def initialize(inputs, outputs, process)
-				# These are immutable - rather than change them, create a new node:
+			# @param process [Object] Represents an abstract process, e.g. a name or a function.
+			def initialize(inputs, outputs)
 				@inputs = inputs
 				@outputs = outputs
-				
-				# Represents an abstract process, e.g. a name or a function.
-				@process = process
 			end
 			
 			attr :inputs
 			attr :outputs
-			attr :process
 			
 			# Nodes that inherit outputs are special in the sense that outputs are not available until all child nodes have been evaluated.
 			def inherit_outputs?
@@ -78,16 +74,22 @@ module Build
 				return false
 			end
 			
+			def == other
+				self.class == other.class and
+					@inputs == other.inputs and
+					@outputs == other.outputs
+			end
+			
 			def eql?(other)
-				other.kind_of?(self.class) and @inputs.eql?(other.inputs) and @outputs.eql?(other.outputs) and @process.eql?(other.process)
+				self.equal?(other) or self == other
 			end
 			
 			def hash
-				[@inputs, @outputs, @process].hash
+				@inputs.hash ^ @outputs.hash
 			end
 			
 			def inspect
-				"#<#{self.class} #{@inputs.inspect} => #{@outputs.inspect} by #{@process}>"
+				"#<#{self.class} #{@inputs.inspect} => #{@outputs.inspect}>"
 			end
 			
 			def self.top(inputs = Files::Paths::NONE, outputs = :inherit, **options, &block)

data/lib/build/graph/task.rb

@@ -36,7 +36,7 @@ module Build
 		end
 		
 		class Task
-			def initialize(walker, node, dependencies: nil)
+			def initialize(walker, node)
 				@walker = walker
 				
 				@walker.tasks[node] = self
@@ -46,14 +46,10 @@ module Build
 				
 				@error = nil
 				
-				# Tasks that must be complete before processing this task.
-				@dependencies = dependencies
-				
 				# Tasks that must be complete before finishing this task.
 				@children = []
 				
 				@state = nil
-				@annotation = nil
 				
 				@inputs_failed = false
 			end
@@ -61,13 +57,11 @@ module Build
 			attr :inputs
 			attr :outputs
 			
-			attr :dependencies
 			attr :children
 			
+			# The state of the task, one of nil, :complete or :failed.
 			attr :state
 			
-			attr :annotation
-			
 			# The error, if the execution of the node fails.
 			attr :error
 			
@@ -78,7 +72,7 @@ module Build
 			# A list of any inputs whose relevant tasks failed:
 			attr :inputs_failed
 			
-			# Derived task should override this function to provide appropriate behaviour.
+			# Derived task can override this function to provide appropriate behaviour.
 			def visit
 				update_inputs_and_outputs
 				
@@ -101,7 +95,9 @@ module Build
 						fail!(InputsFailed)
 					end
 					
-					unless wait_for_children?
+					if wait_for_children?
+						update_outputs
+					else
 						fail!(ChildrenFailed)
 					end
 					
@@ -121,12 +117,15 @@ module Build
 				return self
 			end
 			
+			# @return [Task] the child task that was created to update the node.
 			def invoke(node)
 				child_task = @walker.call(node, self)
 				
 				raise ArgumentError.new("Invalid child task") unless child_task
 				
 				@children << child_task
+				
+				return child_task
 			end
 			
 			def failed?
@@ -155,14 +154,28 @@ module Build
 				(@inputs.roots + @outputs.roots).collect{|path| path.to_s}
 			end
 			
-			def inspect
-				"#<#{self.class}:#{'0x%X' % self.object_id} #{@node.inspect} #{@state}>"
+			def to_s
+				"#<#{self.class} #{node_string} #{state_string}>"
 			end
 			
 		protected
 			
+			def state_string
+				if @state
+					@state.to_s
+				elsif @fiber
+					"running"
+				else
+					"new"
+				end
+			end
+			
+			def node_string
+				@node.inspect
+			end
+			
+			# If the node inputs is a glob, this part of the process converts the glob into an actual list of files. If we are not inheriting outputs from children tasks, update our outputs now.
 			def update_inputs_and_outputs
-				# If @node.inputs is a glob, this part of the process converts the glob into an actual list of files.
 				@inputs = Files::State.new(@node.inputs)
 				
 				unless @node.inherit_outputs?
@@ -170,54 +183,44 @@ module Build
 				end
 			end
 			
+			# @return [Build::Files::List] the merged list of all children outputs.
 			def children_outputs
 				@children.collect(&:outputs).inject(Files::Paths::NONE, &:+)
 			end
 			
+			# If the node's outputs were a glob, this checks the filesystem to figure out what files were actually generated. If it inherits the outputs of the child tasks, merge them into our own outputs.
 			def update_outputs
 				if @node.inherit_outputs?
 					@outputs = Files::State.new(self.children_outputs)
 				else
-					@annotation = "update outputs"
 					# After the task has finished, we update the output states:
 					@outputs.update!
 				end
 			end
 			
+			# Fail the task with the given error. Any task which is waiting on this task will also fail (eventually).
 			def fail!(error)
-				@annotation = "failed"
-				
 				@walker.logger&.error(self) {error}
 				
 				@error = error
 				@state = :failed
 			end
 			
-			# Returns false if any input failed.
+			# @return [Boolean] if all inputs succeeded.
 			def wait_for_inputs?
 				# Wait on any inputs, returns whether any inputs failed:
 				if @inputs&.any?
-					@annotation = "wait for inputs"
 					unless @walker.wait_on_paths(self, @inputs)
 						return false
 					end
 				end
 				
-				if @dependencies&.any?
-					@annotation = "wait for dependencies"
-					unless @walker.wait_for_children(self, @dependencies)
-						return false
-					end
-				end
-				
 				return true
 			end
 			
-			# Returns false if any child failed.
+			# @return [Boolean] if all children succeeded.
 			def wait_for_children?
 				if @children&.any?
-					@annotation = "wait for children"
-					
 					unless @walker.wait_for_children(self, @children)
 						return false
 					end

data/lib/build/graph/version.rb

@@ -20,6 +20,6 @@
 
 module Build
 	module Graph
-		VERSION = "1.5.1"
+		VERSION = "2.0.0"
 	end
 end

data/lib/build/graph/walker.rb

@@ -160,7 +160,7 @@ module Build
 			end
 			
 			def enter(task)
-				@logger&.debug(self) {"Walker entering: #{task.node.process}"}
+				@logger&.debug(self) {"Walker entering: #{task.node}"}
 				
 				@tasks[task.node] = task
 				
@@ -182,7 +182,7 @@ module Build
 			end
 			
 			def exit(task)
-				@logger&.debug(self) {"Walker exiting: #{task.node.process}, task #{task.failed? ? 'failed' : 'succeeded'}"}
+				@logger&.debug(self) {"Walker exiting: #{task.node}, task #{task.failed? ? 'failed' : 'succeeded'}"}
 				
 				# Fail outputs if the node failed:
 				if task.failed?

data/spec/build/graph/inherit_spec.rb

@@ -28,14 +28,14 @@ RSpec.describe Build::Graph::Walker do
 		test_glob = Build::Files::Glob.new(__dir__, "*.rb")
 		listing_output = Build::Files::Paths.directory(__dir__, ["listing.txt"])
 		
-		node_a = Build::Graph::Node.new(Build::Files::Paths::NONE, :inherit, "a")
-		node_b = Build::Graph::Node.new(test_glob, listing_output, "b")
+		node_a = Build::Graph::Node.new(Build::Files::Paths::NONE, :inherit)
+		node_b = Build::Graph::Node.new(test_glob, listing_output)
 		
 		walker = Build::Graph::Walker.new do |walker, node|
 			task = Build::Graph::Task.new(walker, node)
 			
 			task.visit do
-				if node.process == 'a'
+				if node == node_a
 					task.invoke(node_b)
 				end
 			end

data/spec/build/graph/node_spec.rb

@@ -23,66 +23,58 @@ require 'build/graph/node'
 require 'build/files/glob'
 require 'build/files/system'
 
-module Build::Graph::NodeSpec
+RSpec.describe Build::Graph::Node do
 	include Build::Graph
 	include Build::Files
 	
-	RSpec.describe Build::Graph::Node do
-		it "should be unique" do
-			test_glob = Glob.new(__dir__, "*.rb")
-			listing_output = Paths.directory(__dir__, ["listing.txt"])
-			
-			node_a = Node.new(test_glob, listing_output, "a")
-			node_b = Node.new(listing_output, Paths::NONE, "b")
-			
-			expect(node_a).to be_eql node_a
-			expect(node_a).to_not be_eql node_b
-			
-			node_c = Node.new(test_glob, listing_output, "a")
-			
-			expect(node_a).to be_eql node_c
-		end
+	let(:test_glob) {Build::Files::Glob.new(__dir__, "*.rb")}
+	let(:listing_output) {Build::Files::Paths.directory(__dir__, ["listing.txt"])}
+	
+	it "should be unique" do
+		node_a = Build::Graph::Node.new(test_glob, listing_output)
+		node_b = Build::Graph::Node.new(listing_output, Build::Files::Paths::NONE)
+		
+		expect(node_a).to be_eql node_a
+		expect(node_a).to_not be_eql node_b
+		
+		node_c = Build::Graph::Node.new(test_glob, listing_output)
+		
+		expect(node_a).to be_eql node_c
+	end
+	
+	it "should be dirty" do
+		node_a = Build::Graph::Node.new(test_glob, listing_output)
+		
+		expect(node_a.dirty?).to be true
+	end
+	
+	it "should be clean" do
+		listing_output.first.touch
+		
+		node_a = Build::Graph::Node.new(test_glob, listing_output)
+		
+		expect(node_a.dirty?).to be false
+		
+		listing_output.first.delete
+	end
+	
+	it "should be dirty if input files are missing" do
+		input = Build::Files::Paths.directory(__dir__, ["missing-input.txt"])
+		output = Build::Files::Glob.new(__dir__, "*.rb")
 		
-		it "should be dirty" do
-			test_glob = Glob.new(__dir__, "*.rb")
-			listing_output = Paths.directory(__dir__, ["listing.txt"])
-			
-			node_a = Node.new(test_glob, listing_output, "a")
-			
-			expect(node_a.dirty?).to be true
-		end
+		node = Build::Graph::Node.new(input, output)
 		
-		it "should be clean" do
-			test_glob = Glob.new(__dir__, "*.rb")
-			listing_output = Paths.directory(__dir__, ["listing.txt"])
-			
-			listing_output.first.touch
-			
-			node_a = Node.new(test_glob, listing_output, "a")
-			
-			expect(node_a.dirty?).to be false
-			
-			listing_output.first.delete
-		end
+		expect(node.missing?).to be true
+		expect(node.dirty?).to be true
+	end
+	
+	it "should be dirty if output files are missing" do
+		input = Build::Files::Glob.new(__dir__, "*.rb")
+		output = Build::Files::Paths.directory(__dir__, ["missing-output.txt"])
 		
-		it "should be dirty if input files are missing" do
-			input = Paths.directory(__dir__, ["missing-input.txt"])
-			output = Glob.new(__dir__, "*.rb")
-			
-			node = Node.new(input, output, "a")
-			
-			expect(node.missing?).to be true
-			expect(node.dirty?).to be true
-		end
+		node = Build::Graph::Node.new(input, output)
 		
-		it "should be dirty if output files are missing" do
-			input = Glob.new(__dir__, "*.rb")
-			output = Paths.directory(__dir__, ["missing-output.txt"])
-			
-			node = Node.new(input, output, "a")
-			
-			expect(node.missing?).to be true
-			expect(node.dirty?).to be true
-		end
+		expect(node.missing?).to be true
+		expect(node.dirty?).to be true
 	end
 end

data/spec/build/graph/process_graph.rb

@@ -7,17 +7,27 @@ require 'console/event/spawn'
 
 class ProcessNode < Build::Graph::Node
 	def initialize(inputs, outputs, block, title: nil)
-		super(inputs, outputs, block.source_location)
+		super(inputs, outputs)
 		
 		if title
 			@title = title
 		else
-			@title = self.process
+			@title = block.source_location
 		end
 		
 		@block = block
 	end
 	
+	def == other
+		super and
+			@title == other.title and
+			@block == other.block
+	end
+	
+	def hash
+		super ^ @title.hash ^ @block.hash
+	end
+	
 	def evaluate(context)
 		context.instance_eval(&@block)
 	end

data/spec/build/graph/task_spec.rb

@@ -24,10 +24,12 @@ require 'build/graph/walker'
 require 'build/graph/task'
 require 'build/files/glob'
 
+require_relative 'process_graph'
+
 RSpec.describe Build::Graph::Task do
 	it "should wait for children" do
-		node_a = Build::Graph::Node.new(Build::Files::Paths::NONE, Build::Files::Paths::NONE, "a")
-		node_b = Build::Graph::Node.new(Build::Files::Paths::NONE, Build::Files::Paths::NONE, "b")
+		node_a = Build::Graph::Node.new(Build::Files::Paths::NONE, Build::Files::Paths::NONE)
+		node_b = Build::Graph::Node.new(Build::Files::Paths::NONE, :inherit)
 		
 		nodes = Set.new([node_a])
 		
@@ -38,15 +40,15 @@ RSpec.describe Build::Graph::Task do
 			task = Build::Graph::Task.new(walker, node)
 			
 			task.visit do
-				sequence << node.process.upcase
+				sequence << [:entered, node]
 				
-				if node.process == 'a'
+				if node == node_a
 					# This will invoke node_b concurrently, but as it is a child, task.visit won't finish until node_b is done.
 					task.invoke(node_b)
 				end
 			end
 			
-			sequence << node.process
+			sequence << [:exited, node]
 		end
 		
 		walker.update(nodes)
@@ -56,6 +58,12 @@ RSpec.describe Build::Graph::Task do
 		
 		task_b = walker.tasks[node_b]
 		expect(walker.tasks[node_a].children).to be == [task_b]
-		expect(sequence).to be == ['A', 'B', 'b', 'a']
+		
+		expect(sequence).to be == [
+			[:entered, node_a],
+			[:entered, node_b],
+			[:exited, node_b],
+			[:exited, node_a]
+		]
 	end
 end

data/spec/build/graph/walker_spec.rb

@@ -29,8 +29,8 @@ RSpec.describe Build::Graph::Walker do
 		test_glob = Build::Files::Glob.new(__dir__, "*.rb")
 		listing_output = Build::Files::Paths.directory(__dir__, ["listing.txt"])
 		
-		node_a = Build::Graph::Node.new(test_glob, listing_output, "a")
-		node_b = Build::Graph::Node.new(Build::Files::Paths::NONE, listing_output, "b")
+		node_a = Build::Graph::Node.new(test_glob, listing_output)
+		node_b = Build::Graph::Node.new(Build::Files::Paths::NONE, listing_output)
 		
 		sequence = []
 		
@@ -39,14 +39,15 @@ RSpec.describe Build::Graph::Walker do
 			task = Build::Graph::Task.new(walker, node)
 			
 			task.visit do
-				if node.process == "a"
+				if node == node_a
 					task.invoke(node_b)
 				end
 				
 				node.outputs.each do |output|
 					output.touch
 				end
-				sequence << node.process
+				
+				sequence << node
 			end
 		end
 		
@@ -58,15 +59,15 @@ RSpec.describe Build::Graph::Walker do
 		
 		expect(walker.tasks.count).to be == 2
 		expect(walker.failed_tasks.count).to be == 0
-		expect(sequence).to be == ['b', 'a']
+		expect(sequence).to be == [node_b, node_a]
 	end
 	
 	it "should be unique" do
 		test_glob = Build::Files::Glob.new(__dir__, "*.rb")
 		listing_output = Build::Files::Paths.directory(__dir__, ["listing.txt"])
 		
-		node_a = Build::Graph::Node.new(test_glob, listing_output, "a")
-		node_b = Build::Graph::Node.new(listing_output, Build::Files::Paths::NONE, "b")
+		node_a = Build::Graph::Node.new(test_glob, listing_output)
+		node_b = Build::Graph::Node.new(listing_output, Build::Files::Paths::NONE)
 		
 		sequence = []
 		
@@ -78,7 +79,8 @@ RSpec.describe Build::Graph::Walker do
 				node.outputs.each do |output|
 					output.touch
 				end
-				sequence << node.process
+				
+				sequence << node
 			end
 		end
 		
@@ -86,7 +88,7 @@ RSpec.describe Build::Graph::Walker do
 		
 		expect(walker.tasks.count).to be == 2
 		expect(walker.failed_tasks.count).to be == 0
-		expect(sequence).to be == ['a', 'b']
+		expect(sequence).to be == [node_a, node_b]
 	end
 	
 	it "should cascade failure" do
@@ -94,15 +96,15 @@ RSpec.describe Build::Graph::Walker do
 		listing_output = Build::Files::Paths.directory(__dir__, ["listing.txt"])
 		summary_output = Build::Files::Paths.directory(__dir__, ["summary.txt"])
 		
-		node_a = Build::Graph::Node.new(test_glob, listing_output, "a")
-		node_b = Build::Graph::Node.new(listing_output, summary_output, "b")
+		node_a = Build::Graph::Node.new(test_glob, listing_output)
+		node_b = Build::Graph::Node.new(listing_output, summary_output)
 		
 		# A walker runs repeatedly, updating tasks which have been marked as dirty.
 		walker = Build::Graph::Walker.new do |walker, node|
 			task = Build::Graph::Task.new(walker, node)
 			
 			task.visit do
-				if node.process == 'a'
+				if node == node_a
 					raise Build::Graph::TransientError.new('Test Failure')
 				end
 			end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: build-graph
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: process-group