build-graph 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77b51e210994a3c93e59ddebf8b3aead06b84c07
-  data.tar.gz: 5a9ece86c313dbbf9a0ddd462cd18b10eed49ff5
+  metadata.gz: f429cca0a6fccf4d050a393c0a89e319c6eaadea
+  data.tar.gz: 5c6430d2aca1fcb6ef21cef6b1cad7bfa8514342
 SHA512:
-  metadata.gz: afb78262e92072da8e29dce01898447246e7f718a65b4c5f25a79f049fb9474a0fa21a1685758c11720d0f7cbc1b4c7ee328845da1adaf52a67b860da261c69d
-  data.tar.gz: 4395c36481c93ada46363d602f34e136d9a8759e1022a3f669e97abe05f957ec7b2cab09fe81b06c38f7b796c5baf3a3261b5cb4ebca9e55d9e134f837479e4d
+  metadata.gz: 577cd4e1940d0a819ed599f2ed9950a52db4b7bfcc0031f411cc4f2c40bd9d7624294d33a1ab56f18c6eb73abf1ab59fc6a6ab7c264fcbaecc4c28cb49d77702
+  data.tar.gz: a1aba82f3d79dc93a0fe93720208005ece5f89c0a2b194000a225dd1c42536f2b11d4c65f04c63144d9929b3b0cbf2f9b418568f11d7bc2b2d734ccf2bc230a1

data/.travis.yml

@@ -2,3 +2,10 @@ language: ruby
 rvm:
   - "2.0"
   - "2.1"
+before_install:
+# libstdc++-4.8-dev
+    - sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test
+# clang++-3.2
+    - sudo add-apt-repository --yes ppa:h-rayflood/llvm
+    - sudo apt-get -qq update
+    - sudo apt-get -qq install libstdc++-4.8-dev clang-3.3

data/README.md

@@ -19,10 +19,6 @@ Or install it yourself as:
 
     $ gem install build-graph
 
-### Naming
-
-I'd like to call this gem, simply, `build`, but this name is not available.
-
 ## Usage
 
 TODO: Write usage instructions here

data/Rakefile

@@ -1,9 +1,6 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-	t.libs << 'test'
-end
+RSpec::Core::RakeTask.new(:spec)
 
-desc "Run tests"
-task :default => :test
+task :default => :spec

data/build-graph.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'build/version'
+require 'build/graph/version'
 
 Gem::Specification.new do |spec|
 	spec.name          = "build-graph"
-	spec.version       = Build::VERSION
+	spec.version       = Build::Graph::VERSION
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 	spec.summary       = %q{Build::Graph is a framework for build systems, with specific functionality for dealing with file based processes.}
@@ -20,11 +20,14 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 
-	spec.add_dependency "process-group", "~> 0.1.0"
-
+	spec.add_dependency "process-group", "~> 0.2.1"
+	spec.add_dependency "build-files", "~> 0.1.0"
+	spec.add_dependency "build-makefile", "~> 0.1.0"
+	
 	spec.add_dependency "system"
-	spec.add_dependency "rainbow"
+	spec.add_dependency "rainbow", "~> 2.0.0"
 
 	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.0.0.rc1"
 	spec.add_development_dependency "rake"
 end

data/lib/build/graph.rb

@@ -1,74 +1,26 @@
+# 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 'build/error'
-require 'build/node'
-require 'build/walker'
-require 'build/edge'
+require_relative 'graph/controller'
 
 module Build
-	class Graph < Files::Monitor
-		def initialize
-			super
-			
-			@nodes = {}
-			
-			build_graph!
-		end
-		
-		attr :nodes
-		
-		# You need to override this to traverse the top nodes as required:
-		def traverse!(walker)
-			#Array(top).each do |node|
-			#	node.update!(walker)
-			#end
-		end
-		
-		def walk(&block)
-			Walker.new(self, &block)
-		end
-		
-		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
-		
-		def update_with_log
-			puts Rainbow("*** Graph update traversal ***").green
-			
-			start_time = Time.now
-			
-			walker = update!
-		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
-		
-		def update!
-			walker = walk do |walker, node|
-				yield walker, node
-			end
-			
-			traverse! walker
-			
-			return walker
-		end
+	module Graph
 	end
 end

data/lib/build/graph/controller.rb

@@ -0,0 +1,95 @@
+# 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
+		class Controller < Files::Monitor
+			def initialize
+				super
+			
+				@nodes = {}
+			
+				build_graph!
+			end
+		
+			attr :nodes
+		
+			# You need to override this to traverse the top nodes as required:
+			def traverse!(walker)
+				#Array(top).each do |node|
+				#	node.update!(walker)
+				#end
+			end
+		
+			def walk(&block)
+				Walker.new(self, &block)
+			end
+		
+			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
+		
+			def update_with_log
+				puts Rainbow("*** Graph update traversal ***").green
+			
+				start_time = Time.now
+			
+				walker = update!
+			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
+		
+			def update!
+				walker = walk do |walker, node|
+					yield walker, node
+				end
+			
+				traverse! walker
+			
+				return walker
+			end
+		end
+	end
+end

data/lib/build/graph/edge.rb

@@ -0,0 +1,70 @@
+# 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_relative 'error'
+
+module Build
+	module Graph
+		# Represents an input to a graph node, with count inputs.
+		class Edge
+			def initialize(count = 0)
+				@fiber = Fiber.current
+				@count = count
+			
+				@failed = []
+			end
+		
+			attr :failed
+		
+			attr :fiber
+			attr :count
+		
+			def wait
+				if @count > 0
+					Fiber.yield
+				end
+			
+				failed?
+			end
+		
+			attr :failed
+		
+			def failed?
+				@failed.size != 0
+			end
+		
+			def traverse(node)
+				@count -= 1
+			
+				if node.failed?
+					@failed << node
+				end
+			
+				if @count == 0
+					@fiber.resume
+				end
+			end
+		
+			def increment!
+				@count += 1
+			end
+		end
+	end
+end

data/lib/build/graph/error.rb

@@ -0,0 +1,36 @@
+# 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.
+
+module Build
+	class TransientError < StandardError
+	end
+	
+	class CommandFailure < TransientError
+		def initialize(command, status)
+			super "Command #{command.inspect} failed with exit status #{status}!"
+		
+			@command = command
+			@status = status
+		end
+	
+		attr :command
+		attr :status
+	end
+end

data/lib/build/graph/node.rb

@@ -0,0 +1,156 @@
+# 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/state'
+
+module Build
+	module Graph
+		class Node
+			def initialize(controller, inputs, outputs)
+				@controller = controller
+			
+				@state = Files::IOState.new(inputs, outputs)
+			
+				@status = :unknown
+				@fiber = nil
+			
+				# These are immutable - rather than change them, create a new node:
+				@inputs = inputs
+				@outputs = outputs
+			
+				@controller.add(self)
+			end
+		
+			def eql?(other)
+				other.kind_of?(self.class) and @inputs.eql?(other.inputs) and @outputs.eql?(other.outputs)
+			end
+		
+			def hash
+				[@inputs, @outputs].hash
+			end
+		
+			def directories
+				@state.files.roots
+			end
+		
+			def remove!
+				@controller.delete(self)
+			end
+		
+			# It is possible this function is called unnecessarily. The state check confirms whether a change occurred or not.
+			def changed!(outputs = [])
+				# Don't do anything if we are already dirty.
+				return if dirty?
+		
+				if @state.intersects?(outputs) || @state.update!
+					# puts "** Dirty: #{@inputs.to_a.inspect} -> #{@outputs.to_a.inspect}"
+			
+					# Could possibly use unknown status here.
+					@status = :dirty
+			
+					# If this node changes, we force all other nodes which depend on this node to be dirty.
+					@controller.update(directories, @outputs)
+				end
+			end
+		
+			attr :inputs
+			attr :outputs
+		
+			attr :state
+			attr :status
+		
+			def unknown?
+				@status == :unknown
+			end
+		
+			def dirty?
+				@status == :dirty
+			end
+		
+			def clean?
+				@status == :clean
+			end
+		
+			def clean!
+				@status = :clean
+			end
+		
+			def fail!
+				@status = :failed
+			end
+		
+			def failed?
+				@status == :failed
+			end
+		
+			def updating?
+				@fiber != nil
+			end
+		
+			# If we are in the initial state, we need to check if the outputs are fresh.
+			def update_status!
+				#puts "Update status: #{@inputs.inspect} -> #{@outputs.inspect} (status=#{@status} @fiber=#{@fiber.inspect}) @status=#{@status} @state.fresh?=#{@state.fresh?}"
+			
+				if @status == :unknown
+					# This could be improved - only stale files should be reported, instead we report all.
+					unless @state.fresh?
+						changed!(self.inputs)
+					else
+						@status = :clean
+					end
+				end
+			end
+		
+			def inspect
+				"<#{dirty? ? '*' : ''}inputs=#{inputs.inspect} outputs=#{outputs.inspect} fiber=#{@fiber.inspect} fresh=#{@state.fresh?}>"
+			end
+		
+			def requires_update?
+				not clean?
+			end
+		
+			# Perform some actions to update this node, returns when completed, and the node is no longer dirty.
+			def update!(walker)
+				#puts "Walking #{@inputs.to_a.inspect} -> #{@outputs.to_a.inspect} (dirty=#{dirty?} @fiber=#{@fiber.inspect})"
+			
+				# If a fiber already exists, this node is in the process of updating.
+				if requires_update? and @fiber == nil
+					# puts "Beginning: #{@inputs.to_a.inspect} -> #{@outputs.to_a.inspect}"
+				
+					@fiber = Fiber.new do
+						task = walker.task(self)
+					
+						task.visit
+					
+						# Commit changes:
+						# puts "** Committing: #{@inputs.to_a.inspect} -> #{@outputs.to_a.inspect}"
+					
+						@state.update!
+						@fiber = nil
+					
+						task.exit
+					end
+			
+					@fiber.resume
+				end
+			end
+		end
+	end
+end