build-graph 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 099abe451e05dd43b268f1d85551a88b01ad1a9b
-  data.tar.gz: 09d54433b10c28b942bb4e195896023bf3067190
+  metadata.gz: 0ac0622352764d8a850dc19bd98394fad151e1fe
+  data.tar.gz: 67f61c902d33f69b7ea262532dd135bd5b58fa95
 SHA512:
-  metadata.gz: b7f79b01e9dfe117f74d3a2a9e566dc55795ac47ce791a5ac8a341bc5a46d1cad3b7c3b5f6c8575d201b0b5b2b3684783830327de0a2627ab05d274d2893f443
-  data.tar.gz: d47a65ba2f7168fa8bb6646d45f309495f135512149ec5b08cc719c1337da12726c29b5fd8cbec45b821bf8b30692183f215c9a86d535861db909a4c3dbfaefd
+  metadata.gz: acaf99a70edf2f1540e5814b70f9e879d48494a8509462a87c262d7cd1000172445bfec444bd2d6eff1bef620f5ebd6eef86470e34be9929edba4cc9a5c9fb76
+  data.tar.gz: e3abaa8571aac1584b6578fa42f58f1cd3fdc2f51033b080cc3e0a581e3f8327d5acf83bc34669641ca0d0dda4dbb79866400744bde03826052e8c1198e944f2

data/build-graph.gemspec

@@ -19,13 +19,15 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
-
+	
+	spec.required_ruby_version = '>= 2.0'
+	
 	spec.add_dependency "process-group", "~> 0.2.1"
-	spec.add_dependency "build-files", "~> 0.2.0"
+	spec.add_dependency "build-files", "~> 0.2.6"
 	
 	spec.add_dependency "system"
 	spec.add_dependency "rainbow", "~> 2.0.0"
-
+	
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "rspec", "~> 3.0.0"
 	spec.add_development_dependency "build-makefile", "~> 0.2.0"

data/lib/build/graph/controller.rb

@@ -27,6 +27,7 @@ require_relative 'edge'
 
 module Build
 	module Graph
+		# The top level graph controller is responsible for managing build graph state.
 		class Controller < Files::Monitor
 			def initialize
 				super
@@ -35,43 +36,46 @@ module Build
 			
 				build_graph!
 			end
-		
+			
 			attr :nodes
-		
-			# You need to override this to traverse the top nodes as required:
+			
+			# Override this to traverse the top nodes as required.
 			def traverse!(walker)
 				#Array(top).each do |node|
 				#	node.update!(walker)
 				#end
 			end
-		
+			
+			# Walk the graph with the given callback.
 			def walk(&block)
 				Walker.new(self, &block)
 			end
-		
+			
+			# Build the initial graph structure.
 			def build_graph!
 				# We build the graph without doing any actual execution:
 				nodes = []
-			
+				
 				walker = walk do |walker, node|
 					nodes << node
 				
 					yield walker, node
 				end
-			
+				
 				traverse! walker
-			
+				
 				# We should update the status of all nodes in the graph once we've traversed the graph.
 				nodes.each do |node|
 					node.update_status!
 				end
 			end
-		
+			
+			# Update the graph and print out timing information.
 			def update_with_log
 				puts Rainbow("*** Graph update traversal ***").green
-			
+				
 				start_time = Time.now
-			
+				
 				walker = update!
 			ensure
 				end_time = Time.now
@@ -80,14 +84,15 @@ module Build
 				$stdout.flush
 				$stderr.puts Rainbow("Graph Update Time: %0.3fs" % elapsed_time).magenta
 			end
-		
+			
+			# Update the graph.
 			def update!
 				walker = walk do |walker, node|
 					yield walker, node
 				end
-			
+				
 				traverse! walker
-			
+				
 				return walker
 			end
 		end

data/lib/build/graph/edge.rb

@@ -24,12 +24,14 @@ require 'fiber'
 
 module Build
 	module Graph
-		# Represents an input to a graph node, with count inputs.
+		# Represents a set of inputs to a graph node.
 		class Edge
 			def initialize(count = 0)
 				@fiber = Fiber.current
+				
+				# The number of inputs we are waiting for:
 				@count = count
-			
+				
 				@failed = []
 			end
 		
@@ -37,7 +39,8 @@ module Build
 		
 			attr :fiber
 			attr :count
-		
+			
+			# Wait until all inputs to the edge have been traversed.
 			def wait
 				if @count > 0
 					Fiber.yield
@@ -51,7 +54,8 @@ module Build
 			def failed?
 				@failed.size != 0
 			end
-		
+			
+			# Traverse the edge, mark the edge as failed if the source was also failed.
 			def traverse(node)
 				@count -= 1
 			
@@ -63,7 +67,8 @@ module Build
 					@fiber.resume
 				end
 			end
-		
+			
+			# Increase the number of traversals we are waiting for.
 			def increment!
 				@count += 1
 			end

data/lib/build/graph/error.rb

@@ -19,18 +19,20 @@
 # THE SOFTWARE.
 
 module Build
-	class TransientError < StandardError
-	end
+	module Graph
+		class TransientError < StandardError
+		end
 	
-	class CommandFailure < TransientError
-		def initialize(command, status)
-			super "Command #{command.inspect} failed with exit status #{status}!"
+		class CommandFailure < TransientError
+			def initialize(command, status)
+				super "Command #{command.inspect} failed with exit status #{status}!"
 		
-			@command = command
-			@status = status
-		end
+				@command = command
+				@status = status
+			end
 	
-		attr :command
-		attr :status
+			attr :command
+			attr :status
+		end
 	end
 end

data/lib/build/graph/version.rb

@@ -20,6 +20,6 @@
 
 module Build
 	module Graph
-		VERSION = "0.3.2"
+		VERSION = "0.3.3"
 	end
 end

data/lib/build/graph/walker.rb

@@ -29,9 +29,10 @@ module Build
 			def initialize(controller, &task)
 				@controller = controller
 				@task = task
-			
+				
+				# The number of nodes we have touched:
 				@count = 0
-			
+				
 				@outputs = {}
 				@dirty = Set.new
 			
@@ -40,9 +41,9 @@ module Build
 					# For a given child, a list of any parents waiting on it.
 					if node.dirty?
 						@dirty << node
-					
+						
 						@outputs[node] = []
-					
+						
 						node.outputs.each do |output|
 							@outputs[output] = []
 						end
@@ -54,19 +55,21 @@ module Build
 				# Failed output paths:
 				@failed = Set.new
 			end
-		
+			
 			attr :controller
-			attr :output
-		
+			attr :task
+			
+			attr :outputs
+			
 			attr_accessor :count
-		
 			attr :dirty
+			
 			attr :parents
-		
+			
 			def task(*arguments)
 				@task.call(self, *arguments)
 			end
-		
+			
 			def wait_on_paths(paths)
 				edge = Edge.new
 				failed = false
@@ -155,7 +158,6 @@ module Build
 				# If all inputs were good, we can update the node.
 				unless any_inputs_failed?
 					begin
-						#self.instance_eval(&update)e
 						yield
 					rescue TransientError => error
 						$stderr.puts Rainbow("Error: #{error.inspect}").red
@@ -172,9 +174,9 @@ module Build
 				elsif wet?
 					@node.clean!
 				end
-			
+				
 				@walker.exit(@node)
-			
+				
 				@walker.count += 1
 			end
 		

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: build-graph
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-07 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: process-group
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
   name: system
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="