teapot 0.6.0 → 0.7.0

data/lib/teapot/context.rb

@@ -18,73 +18,52 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'pathname'
-require 'rainbow'
-
-require 'teapot/target'
-require 'teapot/build'
+require 'teapot/loader'
+require 'teapot/package'
 
 module Teapot
-	LOADER_VERSION = "0.6"
-	MINIMUM_LOADER_VERSION = "0.6"
-	
-	class IncompatibleTeapot < StandardError
-	end
-	
-	class Loader
-		# Provides install_directory and install_external methods
-		include Build::Helpers
-		
-		def initialize(context, package)
-			@context = context
-			@package = package
-			
-			@defined = []
-			@version = nil
-		end
-		
-		attr :package
-		attr :defined
-		attr :version
-		
-		def required_version(version)
-			if version >= MINIMUM_LOADER_VERSION && version <= LOADER_VERSION
-				@version = version
-			else
-				raise IncompatibleTeapot.new("Version #{version} isn't compatible with current loader!\n" \
-				"Minimum supported version: #{MINIMUM_LOADER_VERSION}; Current version: #{LOADER_VERSION}.")
-			end
-		end
-
-		def define_target(*args, &block)
-			target = Target.new(@context, @package, *args)
+	TEAPOT_FILE = "teapot.rb"
+	DEFAULT_CONFIGURATION_NAME = 'default'
 
-			yield target
+	class AlreadyDefinedError < StandardError
+		def initialize(definition, previous)
+			super "Definition #{definition.name} in #{definition.path} has already been defined in #{previous.path}!"
+		end
 
-			@context.targets[target.name] = target
+		def self.check(definition, definitions)
+			previous = definitions[definition.name]
 
-			@defined << target
-		end
-		
-		def load(path)
-			self.instance_eval(File.read(path), path)
+			raise new(definition, previous) if previous
 		end
 	end
-	
-	class Context
-		def initialize(config)
-			@config = config
 
-			@selection = nil
+	class Context
+		def initialize(root, options = {})
+			@root = Pathname(root)
+			@options = options
 
-			@targets = {config.name => config}
+			@targets = {}
+			@generators = {}
+			@configurations = {}
 
 			@dependencies = []
 			@selection = Set.new
+
+			@loaded = {}
+
+			# Load the root package:
+			defined = load(root_package)
+
+			# Find the default configuration, if it exists:
+			@default_configuration = defined.default_configuration
 		end
 
-		attr :config
+		attr :root
+		attr :options
+
 		attr :targets
+		attr :generators
+		attr :configurations
 
 		def select(names)
 			names.each do |name|
@@ -95,27 +74,90 @@ module Teapot
 				end
 			end
 		end
-		
+
 		attr :dependencies
 		attr :selection
-		
+
 		def direct_targets(ordered)
 			@dependencies.collect do |dependency|
 				ordered.find{|(package, _)| package.provides? dependency}
 			end.compact
 		end
-		
+
+		def << definition
+			case definition
+			when Target
+				AlreadyDefinedError.check(definition, @targets)
+
+				@targets[definition.name] = definition
+			when Generator
+				AlreadyDefinedError.check(definition, @generators)
+
+				@generators[definition.name] = definition
+			when Configuration
+				if definition.public?
+					# The root package implicitly defines the default configuration.
+					if definition.name == DEFAULT_CONFIGURATION_NAME
+						raise AlreadyDefinedError.new(definition, root_package)
+					end
+
+					AlreadyDefinedError.check(definition, @configurations)
+
+					@configurations[definition.name] = definition
+				end
+			end
+		end
+
 		def load(package)
-			loader = Loader.new(self, package)
+			# In certain cases, a package record might be loaded twice. This typically occurs when multiple configurations are loaded in the same context, or if a package has already been loaded (as is typical with the root package).
+			@loaded.fetch(package) do
+				loader = Loader.new(self, package)
+
+				loader.load(TEAPOT_FILE)
+
+				# Load the definitions into the current context:
+				loader.defined.each do |definition|
+					self << definition
+				end
+
+				# Save the definitions per-package:
+				@loaded[package] = loader.defined
+			end
+		end
+
+		attr :default_configuration
+
+		def configuration_named(name)
+			if name == DEFAULT_CONFIGURATION_NAME
+				configuration = @default_configuration
+			else
+				configuration = @configurations[name]
+			end
 			
-			path = (package.path + package.loader_path).to_s
-			loader.load(path)
+			if configuration
+				configuration.materialize
+			end
+		end
+
+		def unresolved(packages)
+			failed_to_load = Set.new
 			
-			if loader.version == nil
-				raise IncompatibleTeapot.new("No version specified in #{path}!")
+			packages.collect do |package|
+				begin
+					definitions = load(package)
+				rescue NonexistantTeapotError
+					failed_to_load << package
+				end
 			end
 			
-			loader.defined
+			return failed_to_load
+		end
+
+		private
+
+		# The root package is a special package which is used to load definitions from a given root path.
+		def root_package
+			@root_package ||= Package.new(@root, "root")
 		end
 	end
 end

data/lib/teapot/controller.rb

@@ -0,0 +1,56 @@
+# 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
+# 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 'teapot/configuration'
+require 'teapot/version'
+
+require 'uri'
+require 'rainbow'
+require 'fileutils'
+
+module Teapot
+	class Controller
+		MAXIMUM_FETCH_DEPTH = 20
+		
+		def initialize(root, options)
+			@root = Pathname(root)
+			@options = options
+			
+			@log_output = @options.fetch(:log, $stdout)
+			
+			@options[:maximum_fetch_depth] ||= MAXIMUM_FETCH_DEPTH
+		end
+		
+		def log(*args)
+			@log_output.puts *args
+		end
+		
+		private
+	
+		def load_teapot
+			configuration_name = @options[:configuration] || DEFAULT_CONFIGURATION_NAME
+		
+			context = Context.new(@root)
+			configuration = context.configuration_named(configuration_name)
+		
+			return context, configuration
+		end
+	end
+end

data/lib/teapot/controller/build.rb

@@ -0,0 +1,71 @@
+# 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
+# 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 'teapot/controller'
+
+module Teapot
+	class Controller
+		def build(package_names)
+			context, configuration = load_teapot
+		
+			configuration.load_all
+		
+			context.select(package_names)
+		
+			chain = Dependency::chain(context.selection, context.dependencies, context.targets.values)
+		
+			if chain.unresolved.size > 0
+				log "Unresolved dependencies:"
+		
+				chain.unresolved.each do |(name, parent)|
+					log "#{parent} depends on #{name.inspect}".color(:red)
+				
+					conflicts = chain.conflicts[name]
+				
+					if conflicts
+						conflicts.each do |conflict|
+							log " - provided by #{conflict.inspect}".color(:red)
+						end
+					end
+				end
+			
+				abort "Cannot continue build due to unresolved dependencies!".color(:red)
+			end
+	
+			log "Resolved: #{chain.resolved.inspect}".color(:magenta)
+	
+			ordered = chain.ordered
+		
+			if @options[:only]
+				ordered = context.direct_targets(ordered)
+			end
+		
+			ordered.each do |(target, dependency)|
+				log "Building #{target.name} for dependency #{dependency}...".color(:cyan)
+		
+				if target.respond_to?(:build!) and !@options[:dry]
+					target.build!(configuration)
+				end
+			end
+	
+			log "Completed build successfully.".color(:green)
+		end
+	end
+end

data/lib/teapot/controller/clean.rb

@@ -0,0 +1,35 @@
+# 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
+# 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 'teapot/controller'
+
+module Teapot
+	class Controller
+		def clean
+			context, configuration = load_teapot
+
+			log "Removing #{configuration.platforms_path}...".color(:cyan)
+			FileUtils.rm_rf configuration.platforms_path
+		
+			log "Removing #{configuration.packages_path}...".color(:cyan)
+			FileUtils.rm_rf configuration.packages_path
+		end
+	end
+end

data/lib/teapot/controller/create.rb

@@ -0,0 +1,52 @@
+# 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
+# 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 'teapot/controller'
+require 'teapot/controller/fetch'
+
+require 'teapot/name'
+
+module Teapot
+	class Controller
+		def create(project_name, source, packages)
+			name = Name.new(project_name)
+			
+			log "Creating project named #{project_name} at path #{@root}...".color(:cyan)
+			
+			File.open(@root + TEAPOT_FILE, "w") do |output|
+				output.puts "\# Teapot configuration generated at #{Time.now.to_s}", ''
+			
+				output.puts "required_version #{VERSION.dump}", ''
+			
+				output.puts "define_configuration #{name.target.dump} do |configuration|"
+			
+				output.puts "\tconfiguration[:source] = #{source.dump}", ''
+			
+				packages.each do |name|
+					output.puts "\tconfiguration.import! #{name.dump}"
+				end
+			
+				output.puts "end"
+			end
+
+			fetch
+		end
+	end
+end

data/lib/teapot/controller/fetch.rb

@@ -0,0 +1,167 @@
+# 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
+# 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 'teapot/controller'
+
+module Teapot
+	class Controller
+		def fetch
+			context, configuration = load_teapot
+
+			resolved = Set.new
+			unresolved = context.unresolved(configuration.packages)
+			tries = 0
+
+			while tries < @options[:maximum_fetch_depth]
+				configuration.packages.each do |package|
+					next if resolved.include? package
+				
+					fetch_package(context, configuration, package)
+				
+					# We are done with this package, don't try to process it again:
+					resolved << package
+				end
+			
+				# Resolve any/all imports:
+				configuration = configuration.materialize
+			
+				previously_unresolved = unresolved
+				unresolved = context.unresolved(configuration.packages)
+			
+				# No additional packages were resolved, we have reached a fixed point:
+				if previously_unresolved == unresolved || unresolved.count == 0
+					break
+				end
+			
+				tries += 1
+			end
+		
+			if unresolved.count > 0
+				log "Could not fetch all packages!".color(:red)
+				unresolved.each do |package|
+					log "\t#{package}".color(:red)
+				end
+			else
+				log "Completed fetch successfully.".color(:green)
+			end
+		end
+		
+		private
+
+		def current_commit(package)
+			IO.popen(['git', '--git-dir', (package.path + ".git").to_s, 'rev-parse', '--verify', 'HEAD']) do |io|
+				io.read.chomp!
+			end
+		end
+
+		def fetch_package(context, configuration, package)
+			destination_path = package.path
+			lock_store = configuration.lock_store
+		
+			if package.local?
+				log "Linking local #{package}...".color(:cyan)
+		
+				local_path = context.root + package.options[:local]
+	
+				# Make the top level directory if required:
+				destination_path.dirname.mkpath
+	
+				unless destination_path.exist?
+					destination_path.make_symlink(local_path)
+				end
+			elsif package.external?
+				package_lock = lock_store.transaction(true){|store| store[package.name]}
+
+				log "Fetching #{package}...".color(:cyan)
+
+				base_uri = URI(package.options[:source].to_s)
+
+				if base_uri.scheme == nil || base_uri.scheme == 'file'
+					base_uri = URI "file://" + File.expand_path(base_uri.path, context.root) + "/"
+				end
+
+				branch = package.options.fetch(:version, 'master')
+
+				if package_lock
+					log "Package locked to commit: #{package_lock[:branch]}/#{package_lock[:commit]}"
+
+					branch = package_lock[:branch]
+				end
+
+				unless destination_path.exist?
+					log "Cloning package at path #{destination_path} ...".color(:cyan)
+			
+					begin
+						destination_path.mkpath
+
+						external_url = package.external_url(context.root)
+
+						Commands.run("git", "clone", external_url, destination_path, "--branch", branch)
+
+						# Checkout the specific version if it was given:
+						if package_lock
+							Commands.run("git", "reset", "--hard", package_lock[:commit])
+						end
+
+						Dir.chdir(destination_path) do
+							Commands.run("git", "submodule", "update", "--init", "--recursive")
+						end
+					rescue
+						log "Removing incomplete package at path #{destination_path}...".color(:red)
+				
+						# Clean up if the git checkout process is interrupted:
+						destination_path.rmtree
+				
+						raise
+					end
+				else
+					log "Updating package at path #{destination_path} ...".color(:cyan)
+
+					Dir.chdir(destination_path) do
+						Commands.run("git", "fetch", "origin")
+		
+						Commands.run("git", "checkout", branch)
+		
+						# Pull any changes, if you might get the error from above:
+						# Your branch is behind 'origin/0.1' by 1 commit, and can be fast-forwarded.
+						Commands.run("git", "pull")
+
+						# Checkout the specific version if it was given:
+						if package_lock
+							Commands.run("git", "reset", "--hard", package_lock[:commit])
+						end
+
+						Commands.run("git", "submodule", "update", "--init", "--recursive")
+					end
+				end
+				
+				# Lock the package, unless it was already locked:
+				unless package_lock
+					lock_store.transaction do |store|
+						store[package.name] = {
+							:branch => branch,
+							:commit => current_commit(package)
+						}
+					end
+				end
+			end
+		end
+	end
+end