teapot 1.0.0.pre.rc7 → 1.0.0.pre.rc9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ec99bb9d6d04670ccda7c53e838c9ac266372e
-  data.tar.gz: b6ee7d9d431b290ec697a19a76674a5a9e82bd98
+  metadata.gz: c85e14574b10f98c7393860c30732ba0ce291322
+  data.tar.gz: 7800be07e0609957751fcdd79bdd3f454b2e9042
 SHA512:
-  metadata.gz: fce6cf29a849f8fc5047dc580b69a46b8153c611a0a89f1374e01407175f30f521e47d4aceb0060a78296586df60ee687f7118869207277b56234a4b64bc20d5
-  data.tar.gz: 5e499452699b8f1ed0f5b92409cbc78e862dbf108971dca638254a00fa4d9779a8f653ac17debc1f89512ea89d4091329fe9b9c22191e6e1e74146a50463ae3e
+  metadata.gz: dc81b95ae0929cc0a7f6c1b387e8b71276b1db78b3f9e8948b7ec72053be173f9279a56c2bb9a6ef6b1f9a6a7de3fa300edd44400e14e64146b828333bcac9a6
+  data.tar.gz: d097232b756dc542314069a3f464da5ed8ad7d456db959a6fe5c6c93b9bb8dc25056b0d0a8b3903ced6e33fcd308e480336735e5f6f898f25c13b0b8e738cad0

data/.travis.yml

@@ -1,8 +1,4 @@
 language: ruby
 rvm:
-  - "1.9"
   - "2.0"
   - "2.1"
-matrix:
-  allow_failures:
-    - rvm: "1.9"

data/README.md

@@ -14,7 +14,7 @@ Teapot is a decentralised build tool for managing complex cross-platform project
 
 Ensure that you already have a working install of Ruby 1.9.3+
 
-    $ gem install teapot
+	$ gem install teapot
 
 ## Usage
 
@@ -58,9 +58,10 @@ For Mac OS X (requires Xcode Command Line Tools):
 
 You need to make sure any basic tools, e.g. compilers, system libraries, are installed correctly before building. Consult the platform and library documentation for any dependencies.
 
-## Dependency Graph
+## Open Issues
 
 - Should packages be built into a shared prefix or should they be built into unique prefixes and joined together either via install or `-L` and `-I`?
+	- Relative include paths might fail to work correctly if headers are not installed into same directory.
 - Should packages expose the tools required to build themselves as dependencies? e.g. should `build-cmake` as required by, say, `OpenCV`, be exposed to all who depend on `OpenCV`? Should there be a mechanism for non-public dependencies, i.e. dependencies which are not exposed to dependants?
 
 ## Contributing

data/lib/teapot/build.rb

@@ -1,15 +1,15 @@
 # Copyright, 2012, 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
@@ -26,6 +26,7 @@ require 'build/makefile'
 
 require 'teapot/name'
 
+require 'graphviz'
 require 'process/group'
 require 'system'
 
@@ -67,6 +68,10 @@ module Teapot
 					scope.instance_exec(@arguments, &@callback)
 				end
 			end
+			
+			def inspect
+				@rule.name.inspect
+			end
 		end
 		
 		class Top < Graph::Node
@@ -87,6 +92,10 @@ module Teapot
 			def requires_update?
 				true
 			end
+			
+			def inspect
+				@task_class.name.inspect
+			end
 		end
 		
 		class Task < Graph::Task
@@ -139,7 +148,9 @@ module Teapot
 			
 			def visit
 				super do
+					@controller.enter(self, @node)
 					@node.apply!(self)
+					@controller.exit(self, @node)
 				end
 			end
 		end
@@ -161,6 +172,8 @@ module Teapot
 			
 			attr :top
 			
+			attr :visualisation
+			
 			# Because we do a depth first traversal, we can capture global state per branch, such as `@task_class`.
 			def traverse!(walker)
 				@top.each do |node|
@@ -186,15 +199,54 @@ module Teapot
 				end
 			end
 			
+			def enter(task, node)
+				return unless @g
+				
+				parent_node = @hierarchy.last
+				
+				task_node = @g.nodes[node] || @g.add_node(node, shape: 'box')
+				
+				if parent_node
+					parent_node.connect(task_node)
+				end
+				
+				node.inputs.map{|path| path.shortest_path(Dir.pwd)}.each do |path|
+					input_node = @g.nodes[path.to_s] || @g.add_node(path.to_s, shape: 'box')
+					input_node.connect(task_node)
+				end
+				
+				@hierarchy << task_node
+			end
+			
+			def exit(task, node)
+				return unless @g
+				
+				@hierarchy.pop
+				
+				task_node = @g.nodes[node] || @g.add_node(node, shape: 'box')
+				
+				node.outputs.map{|path| path.shortest_path(Dir.pwd)}.each do |path|
+					output_node = @g.nodes[path.to_s] || @g.add_node(path.to_s, shape: 'box')
+					output_node.connect(task_node)
+				end
+			end
+			
 			def update!
 				group = Process::Group.new
 				
+				@g = Graphviz::Graph.new('G', rankdir: "LR")
+				@hierarchy = []
+				
 				walker = super do |walker, node|
 					@task_class.new(self, walker, node, group)
 				end
 				
 				group.wait
 				
+				if ENV['BUILD_GRAPH_PDF']
+					Graphviz::output(@g, path: ENV['BUILD_GRAPH_PDF']) rescue nil
+				end
+				
 				return walker
 			end
 		end

data/lib/teapot/context.rb

@@ -1,15 +1,15 @@
 # Copyright, 2012, 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
@@ -35,7 +35,7 @@ module Teapot
 		def self.check(definition, definitions)
 			previous = definitions[definition.name]
 
-			raise new(definition, previous) if previous
+			raise self.new(definition, previous) if previous
 		end
 	end
 

data/lib/teapot/controller/build.rb

@@ -21,6 +21,8 @@
 require 'teapot/controller'
 require 'teapot/build'
 
+$TEAPOT_DEBUG_GRAPH = false
+
 module Teapot
 	class Controller
 		class BuildFailedError < StandardError
@@ -45,24 +47,33 @@ module Teapot
 				end
 			end
 			
-			controller.run do
-				# The graph has been dirtied because files have changed, traverse and update it:
-				walker = controller.update_with_log
-				
-				# Only run once is asked:
-				unless @options[:continuous]
-					if walker.failed?
-						raise BuildFailedError.new("Failed to build all nodes successfully!")
+			walker = nil
+			
+			# We need to catch interrupt here, and exit with the correct exit code:
+			begin
+				controller.run do
+					# The graph has been dirtied because files have changed, traverse and update it:
+					walker = controller.update_with_log
+					
+					if $TEAPOT_DEBUG_GRAPH
+						controller.nodes.each do |key, node|
+							puts "#{node.status} #{node.inspect}" unless node.clean?
+						end
 					end
 					
-					break
-				end
-				
-				if $TEAPOT_DEBUG_GRAPH
-					controller.nodes.each do |key, node|
-						puts "#{node.status} #{node.inspect}"# unless node.clean?
+					# Only run once is asked:
+					unless @options[:continuous]
+						if walker.failed?
+							raise BuildFailedError.new("Failed to build all nodes successfully!")
+						end
+					
+						break
 					end
 				end
+			rescue Interrupt
+				if walker && walker.failed?
+					raise BuildFailedError.new("Failed to build all nodes successfully!")
+				end
 			end
 			
 			return chain, ordered

data/lib/teapot/dependency.rb

@@ -37,6 +37,14 @@ module Teapot
 		Provision = Struct.new(:value)
 		Alias = Struct.new(:dependencies)
 		
+		def priority= value
+			@priority = value
+		end
+		
+		def priority
+			@priority || 0
+		end
+		
 		def provides?(name)
 			provisions.key? name
 		end
@@ -72,7 +80,7 @@ module Teapot
 		end
 		
 		class Chain
-			def initialize(selection, dependencies, providers)
+			def initialize(selection, dependencies, providers, options = {})
 				# Explicitly selected targets which will be used when resolving ambiguity:
 				@selection = Set.new(selection)
 				
@@ -88,6 +96,8 @@ module Teapot
 				@unresolved = []
 				@conflicts = {}
 				
+				@options = options
+				
 				@dependencies.each do |dependency|
 					expand(dependency, "<top>")
 				end
@@ -105,6 +115,25 @@ module Teapot
 			
 			private
 			
+			def ignore_priority?
+				@options[:ignore_priority]
+			end
+			
+			def filter_by_priority(viable_providers)
+				# Sort from highest priority to lowest priority:
+				viable_providers = viable_providers.sort{|a,b| b.priority <=> a.priority}
+				
+				# The first item has the highest priority:
+				highest_priority = viable_providers.first.priority
+				
+				# We compute all providers with the same highest priority (may be zero):
+				return viable_providers.take_while{|provider| provider.priority == highest_priority}
+			end
+			
+			def filter_by_selection(viable_providers)
+				return viable_providers.select{|provider| @selection.include? provider.name}
+			end
+			
 			def find_provider(dependency, parent)
 				# Mostly, only one package will satisfy the dependency...
 				viable_providers = @providers.select{|provider| provider.provides? dependency}
@@ -113,9 +142,17 @@ module Teapot
 
 				if viable_providers.size > 1
 					# ... however in some cases (typically where aliases are being used) an explicit selection must be made for the build to work correctly.
-					explicit_providers = viable_providers.select{|provider| @selection.include? provider.name}
-
+					explicit_providers = filter_by_selection(viable_providers)
+					
 					# puts "** Filtering to #{explicit_providers.collect(&:name).join(', ')} explicit providers.".color(:magenta)
+					
+					if explicit_providers.size != 1 and !ignore_priority?
+						# If we were unable to select a single package, we may use the priority to limit the number of possible options:
+						explicit_providers = viable_providers if explicit_providers.empty?
+						
+						explicit_providers = filter_by_priority(explicit_providers)
+					end
+					
 
 					if explicit_providers.size == 0
 						# No provider was explicitly specified, thus we require explicit conflict resolution:

data/lib/teapot/environment/system.rb

@@ -1,15 +1,15 @@
 # Copyright, 2012, 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
@@ -18,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rexec/environment'
-
 require 'rainbow'
 require 'rainbow/ext/string'
 

data/lib/teapot/rule.rb

@@ -44,26 +44,15 @@ module Teapot
 				dynamic? and @options[:implicit]
 			end
 			
-			def typed?
-				@options[:typed]
+			# Optional parameters are those that are either defined as optional or implicit.
+			def optional?
+				@options[:optional] || implicit?
 			end
 			
 			def applicable? arguments
-				# The parameter is either optional, or is included in the argument list, otherwise we fail.
-				unless @options[:optional] or arguments.include?(@name)
-					return false
-				end
-				
-				value = arguments[@name]
-				
-				# If the parameter is optional, and wasn't provided, we are okay.
-				if @options[:optional]
-					return true if value == nil
-				end
-				
-				# If the parameter is typed, and we don't match the expected type, we fail.
-				if type = @options[:typed]
-					return false unless type === value
+				value = arguments.fetch(@name) do
+					# Value couldn't be found, if it wasn't optional, this parameter didn't apply:
+					return optional?
 				end
 				
 				# If a pattern is provided, we must match it.
@@ -76,8 +65,10 @@ module Teapot
 			
 			def compute(arguments, scope)
 				if implicit?
-					scope.instance_exec(arguments, &@dynamic)
+					# Can be replaced if supplied:
+					arguments[@name] || scope.instance_exec(arguments, &@dynamic)
 				elsif dynamic?
+					# Argument is optional:
 					scope.instance_exec(arguments[@name], arguments, &@dynamic)
 				else
 					arguments[@name]

data/lib/teapot/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Teapot
-	VERSION = "1.0.0-rc7"
+	VERSION = "1.0.0-rc9"
 end

data/spec/teapot/dependency_spec.rb

@@ -29,6 +29,10 @@ module Teapot::DependencySpec
 		end
 		
 		attr :name
+		
+		def inspect
+			"<BasicDependency:#{@name}>"
+		end
 	end
 	
 	describe Teapot::Dependency do
@@ -109,5 +113,51 @@ module Teapot::DependencySpec
 			expect(chain.conflicts).to be == {}
 			expect(chain.ordered).to be == [[apple, "apple"], [salad, "salad"]]
 		end
+		
+		it "should select dependencies with high priority" do
+			bad_apple = BasicDependency.new('bad_apple')
+			bad_apple.provides 'apple'
+			bad_apple.priority = 20
+			
+			good_apple = BasicDependency.new('good_apple')
+			good_apple.provides 'apple'
+			good_apple.priority = 40
+			
+			chain = Teapot::Dependency::chain([], ['apple'], [bad_apple, good_apple])
+			
+			expect(chain.unresolved).to be == []
+			expect(chain.conflicts).to be == {}
+			
+			# Should select higher priority package by default:
+			expect(chain.ordered).to be == [[good_apple, 'apple']]
+		end
+		
+		it "should expose direct dependencies" do
+			system = BasicDependency.new('linux')
+			system.provides 'linux'
+			system.provides 'clang'
+			system.provides system: 'linux'
+			system.provides compiler: 'clang'
+			
+			library = BasicDependency.new('library')
+			library.provides 'library'
+			library.depends :system
+			library.depends :compiler
+			
+			application = BasicDependency.new('application')
+			application.provides 'application'
+			application.depends :compiler
+			application.depends 'library'
+			
+			chain = Teapot::Dependency::chain([], ['application'], [system, library, application])
+			
+			expect(chain.unresolved).to be == []
+			expect(chain.conflicts).to be == {}
+			expect(chain.ordered).to be == [
+				[system, 'clang'],
+				[library, 'library'],
+				[application, 'application']
+			]
+		end
 	end
 end

data/teapot.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 	
+	spec.has_rdoc = 'yard'
+	
 	spec.required_ruby_version = '>= 2.0'
 	
 	spec.add_dependency "rainbow", "~> 2.0.0"
@@ -31,9 +33,9 @@ Gem::Specification.new do |spec|
 	
 	spec.add_dependency "system", "~> 0.1.3"
 	
-	spec.add_dependency "graphviz", "~> 0.0.2"
+	spec.add_dependency "graphviz", "~> 0.1.0"
 	
-	spec.add_dependency "build-files", "~> 0.2.8"
+	spec.add_dependency "build-files", "~> 0.2.9"
 	spec.add_dependency "build-graph", "~> 0.3.5"
 	spec.add_dependency "build-makefile", "~> 0.2.0"
 	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teapot
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc7
+  version: 1.0.0.pre.rc9
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: build-files
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.8
+        version: 0.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.8
+        version: 0.2.9
 - !ruby/object:Gem::Dependency
   name: build-graph
   requirement: !ruby/object:Gem::Requirement