build-graph 0.3.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e451eb353fae615423fa48f9f20a2890fcc6157
-  data.tar.gz: 78c36724ea7dc989d38c4b908fc9b9d5a36db7da
+  metadata.gz: 0d8904d4ee2547485c75c63f61acf7e23dfd2415
+  data.tar.gz: 32d6fc93037e6436a9ed00864b1be734dbbf2485
 SHA512:
-  metadata.gz: 80e50b90964b646412353ad187c787a4d40e47e4b11498bfe9f3c2df3e4c4f338b8f1b1b8909dc855204f3e8f26652735e3db9e6d6d8b706852dbeb3fbb7b5d4
-  data.tar.gz: 67c5ce3bdf104256332a94ddd12becb2516d95941a3d697bdf6d753d6b4262d64e33fab17487be0b570ebb8f6d51650ffc967fd2af9b451b46dcb3d105121015
+  metadata.gz: 88acc9b5ad90951fb4b565fb0b0b6b306d4f9727fb4232919fab7f611d33c75215806f3f180adc25c54d6a7738f8481b7f04ae2b170411c865a81c1836dac377
+  data.tar.gz: 63666bd52493dbae90fa0dd302339340ffcc7f24f81075185f8d8c847984b0b538f7c9192a33b604f5927b315a900b37c9205197e29e11b699308d1b4ec89b60

data/Gemfile

@@ -6,4 +6,9 @@ gemspec
 group :test do
 	gem 'simplecov'
 	gem 'coveralls', require: false
+	
+	gem 'rb-fsevent'
+	gem 'rb-inotify'
+	
+	gem 'graphviz'
 end

data/build-graph.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 	spec.required_ruby_version = '>= 2.0'
 	
 	spec.add_dependency "process-group", "~> 0.2.1"
-	spec.add_dependency "build-files", "~> 0.3.3"
+	spec.add_dependency "build-files", "~> 1.0.0"
 	
 	spec.add_dependency "system"
 	spec.add_dependency "rainbow", "~> 2.0.0"

data/lib/build/graph.rb

@@ -18,7 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'graph/controller'
+require_relative 'graph/error'
+require_relative 'graph/node'
+require_relative 'graph/walker'
+require_relative 'graph/edge'
 
 module Build
 	module Graph

data/lib/build/graph/node.rb

@@ -54,15 +54,23 @@ module Build
 			def dirty?
 				if inherit_outputs?
 					return true
+				elsif @inputs.count == 0 or @outputs.count == 0
+					# If there are no inputs or no outputs we are always dirty:
+					return true
+					
+					# I'm not entirely sure this is the correct approach. If input is a glob that matched zero items, but might match items that are older than outputs, what is the correct output from this function?
 				else
 					# Dirty if any outputs don't exist:
 					return true if @outputs.any?{|path| !path.exist?}
 					
 					# Dirty if input modified after any output:
-					input_modified_time = self.modified_time
-					
-					# Outputs should always be more recent than their inputs:
-					return true if @outputs.any?{|output_path| output_path.modified_time < input_modified_time}
+					if input_modified_time = self.modified_time
+						# Outputs should always be more recent than their inputs:
+						return true if @outputs.any?{|output_path| output_path.modified_time < input_modified_time}
+					else
+						# None of the inputs exist:
+						true
+					end
 				end
 				
 				return false
@@ -80,8 +88,8 @@ module Build
 				"<#{self.class.name} #{@inputs.inspect} => #{@outputs.inspect} by #{@process.inspect}>"
 			end
 			
-			def self.top(inputs = Files::Paths::NONE, outputs = :inherit, &block)
-				self.new(inputs, outputs, block)
+			def self.top(inputs = Files::Paths::NONE, outputs = :inherit, **options, &block)
+				self.new(inputs, outputs, block, **options)
 			end
 		end
 	end

data/lib/build/graph/task.rb

@@ -111,11 +111,11 @@ module Build
 			end
 			
 			def changed!
-				@walker.delete(@node)
+				@walker.delete(@node) if (@inputs.update! or @outputs.update!)
 			end
 			
 			def directories
-				@inputs.roots + @outputs.roots
+				(@inputs.roots + @outputs.roots).collect{|path| path.to_s}
 			end
 			
 			def inspect

data/lib/build/graph/version.rb

@@ -20,6 +20,6 @@
 
 module Build
 	module Graph
-		VERSION = "0.3.7"
+		VERSION = "1.0.0"
 	end
 end

data/lib/build/graph/walker.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'set'
+require 'logger'
 
 require_relative 'task'
 require_relative 'node'
@@ -29,7 +30,17 @@ module Build
 	module Graph
 		# A walker walks over a graph and applies a task to each node.
 		class Walker
-			def initialize(&block)
+			def self.for(task_class, *args, **options)
+				self.new(**options) do |walker, node|
+					task = task_class.new(walker, node, *args)
+					
+					task.visit do
+						task.update
+					end
+				end
+			end
+			
+			def initialize(logger: nil, &block)
 				# Node -> Task mapping.
 				@tasks = {}
 				
@@ -43,7 +54,8 @@ module Build
 				@failed_tasks = []
 				@failed_outputs = Set.new
 				
-				@monitor = Files::Monitor.new
+				@logger = logger || Logger.new(nil)
+				@monitor = Files::Monitor.new(logger: @logger)
 			end
 			
 			attr :tasks # {Node => Task}
@@ -62,13 +74,15 @@ module Build
 			
 			def update(nodes)
 				Array(nodes).each do |node|
-					@update.call(self, node)
+					self.call(node)
 				end
 			end
 			
 			def call(node)
 				# We try to fetch the task if it has already been invoked, otherwise we create a new task.
 				@tasks.fetch(node) do
+					@logger.debug{"Update: #{node}"}
+					
 					@update.call(self, node)
 					
 					# This should now be defined:
@@ -130,7 +144,8 @@ module Build
 			end
 			
 			def enter(task)
-				# puts "--> #{task.node.process}"
+				@logger.debug{"--> #{task.node.process}"}
+				
 				@tasks[task.node] = task
 				
 				# In order to wait on outputs, they must be known before entering the task. This might seem odd, but unless we know outputs are being generated, waiting for them to complete is impossible - unless this was somehow specified ahead of time. The implications of this logic is that all tasks must be sequential in terms of output -> input chaning. This is not a problem in practice.
@@ -142,7 +157,7 @@ module Build
 			end
 			
 			def exit(task)
-				# puts "<-- #{task.node.process}"
+				@logger.debug{"<-- #{task.node.process}"}
 				
 				# Fail outputs if the node failed:
 				if task.failed?
@@ -171,6 +186,8 @@ module Build
 			end
 			
 			def delete(node)
+				@logger.debug{">-< #{node.process}"}
+
 				if task = @tasks.delete(node)
 					@monitor.delete(task)
 				end
@@ -184,6 +201,14 @@ module Build
 				@failed_tasks = []
 				@failed_outputs = Set.new
 			end
+			
+			def run(**options)
+				yield
+				
+				monitor.run(**options) do
+					yield
+				end
+			end
 		end
 	end
 end

data/spec/build/graph/build_test.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
+
+require 'graphviz'
+require_relative 'process_graph'
+
+include ProcessGraph
+
+program_root = Path.join(__dir__, "program")
+code_glob = Glob.new(program_root, "*.cpp")
+program_path = Path.join(program_root, "dictionary-sort")
+
+group = Process::Group.new
+logger = Logger.new($stderr)
+walker = Walker.for(ProcessTask, group)
+
+top = ProcessNode.top code_glob, title: 'top' do
+	process code_glob, program_path, title: 'build' do
+		object_files = inputs.with(extension: ".o") do |input_path, output_path|
+			depfile_path = input_path + ".d"
+			
+			dependencies = Paths.new(input_path)
+			
+			if File.exist? depfile_path
+				depfile = Build::Makefile.load_file(depfile_path)
+				
+				dependencies = depfile[output_path] || dependencies
+			end
+			
+			process dependencies, output_path, title: 'compile' do
+				run("clang++", "-MMD", "-O3",
+					"-o", output_path.shortest_path(input_path.root),
+					"-c", input_path.relative_path, "-std=c++11",
+					chdir: input_path.root
+				)
+			end
+		end
+		
+		process object_files, program_path, title: 'link' do
+			run("clang++", "-O3", "-o", program_path, *object_files.to_a, "-lm", "-pthread")
+		end
+	end
+	
+	process program_path, title: 'run' do
+		run("./" + program_path.relative_path, chdir: program_path.root)
+	end
+end
+
+interrupted = false
+
+trap(:INT) do
+	exit(0)
+end
+
+viz = Graphviz::Graph.new
+viz.attributes[:rankdir] = 'LR'
+
+walker.run do
+	walker.update(top)
+	group.wait
+	
+	walker.tasks.each do |node, task|
+		input_nodes = []
+		output_nodes = []
+		
+		task.inputs.each do |path|
+			input_nodes << viz.add_node(path.basename)
+		end
+		
+		task.outputs.each do |path|
+			output_nodes << viz.add_node(path.basename)
+		end
+		
+		if output_nodes.size == 1
+			input_nodes.each do |input_node|
+				edge = input_node.connect(output_nodes.first)
+				edge.attributes[:label] = node.title
+			end
+		end
+	end
+	
+	File.write('graph.dot', viz.to_dot)
+	`dot -Tpdf graph.dot > graph.pdf && open graph.pdf`
+end

data/spec/build/graph/graph_spec.rb

@@ -19,63 +19,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'build/graph/walker'
-require 'build/makefile'
-
-require 'process/group'
-require 'fileutils'
+require_relative 'process_graph'
 
 module Build::Graph::GraphSpec
-	include Build::Graph
-	include Build::Files
-	
-	class ProcessNode < Node
-		def initialize(inputs, outputs, block)
-			super(inputs, outputs, block.source_location)
-			
-			@block = block
-		end
-		
-		def evaluate(context)
-			context.instance_eval(&@block)
-		end
-	end
-	
-	class ProcessTask < Task
-		def process(inputs, outputs = :inherit, &block)
-			inputs = Build::Files::List.coerce(inputs)
-			outputs = Build::Files::List.coerce(outputs) unless outputs.kind_of? Symbol
-			
-			node = ProcessNode.new(inputs, outputs, block)
-			
-			self.invoke(node)
-		end
-		
-		def wet?
-			@group != nil
-		end
-		
-		def run(*arguments)
-			if wet?
-				puts "\t[run] #{arguments.join(' ')}"
-				status = @group.spawn(*arguments)
-				
-				if status != 0
-					raise CommandError.new(status)
-				end
-			end
-		end
-		
-		# This function is called to finish the invocation of the task within the graph.
-		# There are two possible ways this function can generally proceed.
-		# 1/ The node this task is running for is clean, and thus no actual processing needs to take place, but children should probably be executed.
-		# 2/ The node this task is running for is dirty, and the execution of commands should work as expected.
-		def update(group = nil)
-			@group = group if @node.dirty?
-			
-			@node.evaluate(self)
-		end
-	end
+	include ProcessGraph
 	
 	describe Build::Graph do
 		it "shouldn't update mtime" do
@@ -85,14 +32,7 @@ module Build::Graph::GraphSpec
 			FileUtils.rm_f listing_output.to_a
 			
 			group = Process::Group.new
-			
-			walker = Walker.new do |walker, node|
-				task = ProcessTask.new(walker, node)
-				
-				task.visit do
-					task.update(group)
-				end
-			end
+			walker = Walker.for(ProcessTask, group)
 			
 			top = ProcessNode.top do
 				process test_glob, listing_output do
@@ -134,14 +74,7 @@ module Build::Graph::GraphSpec
 			program_path = Path.join(program_root, "dictionary-sort")
 			
 			group = Process::Group.new
-			
-			walker = Walker.new do |walker, node|
-				task = ProcessTask.new(walker, node)
-				
-				task.visit do
-					task.update(group)
-				end
-			end
+			walker = Walker.for(ProcessTask, group)
 			
 			#FileUtils.touch(code_glob.first)
 			
@@ -183,5 +116,52 @@ module Build::Graph::GraphSpec
 			expect(program_path).to be_exist
 			expect(code_glob.first.modified_time).to be <= program_path.modified_time
 		end
+		
+		it "should copy files incrementally" do
+			program_root = Path.join(__dir__, "program")
+			files = Glob.new(program_root, "*.cpp")
+			destination = Path.new(__dir__) + "tmp"
+			
+			group = Process::Group.new
+			walker = Walker.for(ProcessTask, group)
+			
+			#FileUtils.touch(code_glob.first)
+			
+			top = ProcessNode.top files do
+				fs.mkpath destination
+				
+				inputs.each do |source_path|
+					destination_path = source_path.rebase(destination)
+					
+					process source_path, destination_path do
+						fs.install inputs.first, outputs.first
+					end
+				end
+			end
+			
+			trashed_files = false
+			
+			thread = Thread.new do
+				sleep 0.1
+				
+				destination.glob("*.cpp").each{|path| path.delete}
+				
+				trashed_files = true
+			end
+			
+			walker.run do
+				walker.update(top)
+				group.wait
+				
+				break if trashed_files
+			end
+			
+			thread.join
+			
+			expect(destination).to be_exist
+			expect(destination.glob("*.cpp").count).to be == 2
+			
+			destination.delete
+		end
 	end
 end

data/spec/build/graph/node_spec.rb

@@ -21,7 +21,7 @@
 
 require 'build/graph/node'
 require 'build/files/glob'
-require 'build/files/path/filesystem'
+require 'build/files/system'
 
 module Build::Graph::NodeSpec
 	include Build::Graph

data/spec/build/graph/process_graph.rb

@@ -0,0 +1,77 @@
+
+require 'process/group'
+require 'build/files'
+require 'build/graph'
+
+module ProcessGraph
+	include Build::Graph
+	include Build::Files
+
+	class ProcessNode < Node
+		def initialize(inputs, outputs, block, title: nil)
+			super(inputs, outputs, block.source_location)
+			
+			if title
+				@title = title
+			else
+				@title = self.process
+			end
+			
+			@block = block
+		end
+		
+		def evaluate(context)
+			context.instance_eval(&@block)
+		end
+		
+		attr :title
+	end
+
+	class ProcessTask < Task
+		def initialize(walker, node, group)
+			super(walker, node)
+			
+			@group = group
+		end
+		
+		def process(inputs, outputs = :inherit, **options, &block)
+			inputs = Build::Files::List.coerce(inputs)
+			outputs = Build::Files::List.coerce(outputs) unless outputs.kind_of? Symbol
+			
+			node = ProcessNode.new(inputs, outputs, block, **options)
+			
+			self.invoke(node)
+		end
+		
+		def wet?
+			@node.dirty?
+		end
+		
+		def run(*arguments)
+			if wet?
+				puts "\t[run] #{arguments.join(' ')}"
+				status = @group.spawn(*arguments)
+				
+				if status != 0
+					raise CommandError.new(status)
+				end
+			end
+		end
+		
+		def fs
+			if wet?
+				FileUtils::Verbose
+			else
+				FileUtils::Verbose::Dry
+			end
+		end
+		
+		# This function is called to finish the invocation of the task within the graph.
+		# There are two possible ways this function can generally proceed.
+		# 1/ The node this task is running for is clean, and thus no actual processing needs to take place, but children should probably be executed.
+		# 2/ The node this task is running for is dirty, and the execution of commands should work as expected.
+		def update
+			@node.evaluate(self)
+		end
+	end
+end

data/spec/build/graph/program/main.cpp

@@ -118,8 +118,6 @@ static void test_dictionary ()
     
 	std::cerr << "Checksum: " << checksum << " ? " << (checksum == 479465310674138860) << std::endl;
 	std::cerr << "Total Time: " << elapsed_time << std::endl;
-
-	std::cerr << "Finished." << std::endl;
 }
 
 int main (int argc, const char * argv[])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: build-graph
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-06-28 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.3.3
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: system
   requirement: !ruby/object:Gem::Requirement
@@ -139,16 +139,18 @@ files:
 - Rakefile
 - build-graph.gemspec
 - lib/build/graph.rb
-- lib/build/graph/controller.rb
 - lib/build/graph/edge.rb
 - lib/build/graph/error.rb
 - lib/build/graph/node.rb
 - lib/build/graph/task.rb
 - lib/build/graph/version.rb
 - lib/build/graph/walker.rb
+- spec/build/graph/build_test.rb
+- spec/build/graph/graph.pdf
 - spec/build/graph/graph_spec.rb
 - spec/build/graph/inherit_spec.rb
 - spec/build/graph/node_spec.rb
+- spec/build/graph/process_graph.rb
 - spec/build/graph/program/Benchmark.cpp
 - spec/build/graph/program/Benchmark.h
 - spec/build/graph/program/DictionarySort.h
@@ -182,9 +184,12 @@ specification_version: 4
 summary: Build::Graph is a framework for build systems, with specific functionality
   for dealing with file based processes.
 test_files:
+- spec/build/graph/build_test.rb
+- spec/build/graph/graph.pdf
 - spec/build/graph/graph_spec.rb
 - spec/build/graph/inherit_spec.rb
 - spec/build/graph/node_spec.rb
+- spec/build/graph/process_graph.rb
 - spec/build/graph/program/Benchmark.cpp
 - spec/build/graph/program/Benchmark.h
 - spec/build/graph/program/DictionarySort.h
@@ -192,3 +197,4 @@ test_files:
 - spec/build/graph/program/main.cpp
 - spec/build/graph/task_spec.rb
 - spec/build/graph/walker_spec.rb
+has_rdoc: 

data/lib/build/graph/controller.rb

@@ -1,107 +0,0 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'build/files/monitor'
-
-require_relative 'error'
-require_relative 'node'
-require_relative 'walker'
-require_relative 'edge'
-
-module Build
-	module Graph
-		# The top level graph controller is responsible for managing build graph state.
-		class Controller
-			def initialize
-				super
-				
-				@nodes = {}
-				
-				build_graph!
-			end
-			
-			attr :nodes
-			
-			# 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!
-				
-				return walker
-			ensure
-				end_time = Time.now
-				elapsed_time = end_time - start_time
-			
-				$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
-			
-			# What to do when a task has a trasient failure:
-			def task_failure(error, task)
-				$stderr.puts Rainbow("Error: #{error.inspect}").red
-			end
-		end
-	end
-end