teapot 0.6.0 → 0.7.0

data/lib/teapot/controller/generate.rb

@@ -0,0 +1,40 @@
+# 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 generate(name, arguments)
+			context, configuration = load_teapot
+
+			configuration.load_all
+
+			generator = context.generators[name]
+
+			unless generator
+				abort "Could not find generator with name #{name.inspect}".color(:red)
+			end
+
+			log "Generating #{name.inspect} with arguments #{arguments.inspect}".color(:cyan)
+			generator.generate!(*arguments)
+		end
+	end
+end

data/lib/teapot/controller/list.rb

@@ -0,0 +1,79 @@
+# 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 list
+			context, configuration = load_teapot
+		
+			# Should this somehow consider context.root_package?
+			configuration.packages.each do |package|
+				log "Package #{package.name} (from #{package.path}):".bright
+			
+				begin
+					definitions = context.load(package)
+				
+					definitions.each do |definition|
+						log "\t#{definition}"
+				
+						definition.description.each_line do |line|
+							log "\t\t#{line.chomp}".color(:cyan)
+						end if definition.description
+				
+						case definition
+						when Target
+							definition.dependencies.each do |name|
+								log "\t\t- depends on #{name.inspect}".color(:red)
+							end
+			
+							definition.provisions.each do |(name, provision)|
+								if Dependency::Alias === provision
+									log "\t\t- provides #{name.inspect} => #{provision.dependencies.inspect}".color(:green)
+								else
+									log "\t\t- provides #{name.inspect}".color(:green)
+								end
+							end
+						when Configuration
+							definition = definition.materialize
+						
+							definition.packages.each do |package|
+								if package.local?
+									log "\t\t- links #{package.name} from #{package.options[:local]}".color(:green)
+								elsif package.external?
+									log "\t\t- clones #{package.name} from #{package.external_url(context.root)}".color(:green)
+								else
+									log "\t\t- references #{package.name} from #{package.path}".color(:green)
+								end
+							end
+						
+							definition.imports.each do |import|
+								log "\t\t- unmaterialised import #{import.name}".color(:red)
+							end
+						end
+					end
+				rescue NonexistantTeapotError => error
+					log "\t#{error.message}".color(:red)
+				end
+			end
+		end
+	end
+end

data/lib/teapot/definition.rb

@@ -0,0 +1,61 @@
+# Copyright, 2013, 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 Teapot
+	class Definition
+		def initialize(context, package, name)
+			@context = context
+			@package = package
+			
+			@name = name
+			
+			@description = nil
+		end
+
+		# The context in which the definition was loaded:
+		attr :context
+		
+		# The package in which the definition was specified:
+		attr :package
+		
+		# The name of the definition:
+		attr :name
+
+		# A textual description of the definition, possibly in markdown format:
+		attr :description, true
+		
+		def description=(text)
+			if text =~ /^(\t+)/
+				text = text.gsub(/#{$1}/, '')
+			end
+			
+			@description = text
+		end
+		
+		# The path that the definition is relative to:
+		def path
+			@package.path
+		end
+		
+		def to_s
+			"<#{self.class.name} #{@name.dump}>"
+		end
+	end
+end

data/lib/teapot/dependency.rb

@@ -43,7 +43,7 @@ module Teapot
 			else
 				aliases = name_or_aliases
 				
-				aliases.each do |(name, dependencies)|
+				aliases.each do |name, dependencies|
 					provisions[name] = Alias.new(Array dependencies)
 				end
 			end

data/lib/teapot/generator.rb

@@ -0,0 +1,109 @@
+# Copyright, 2013, 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/definition'
+require 'tempfile'
+
+module Teapot
+	class Generator < Definition
+		def initialize(context, package, name)
+			super context, package, name
+			
+			@generate = nil
+		end
+
+		def generate(&block)
+			@generate = Proc.new(&block)
+		end
+
+		def generate!(*args)
+			@generate[*args]
+		end
+		
+		def substitute(text, substitutions)
+			return text unless substitutions
+			
+			# Use positive look behind so that the pattern is just the substitution key:
+			pattern = Regexp.new(substitutions.keys.map{|x| Regexp.escape(x)}.join('|'))
+			
+			text.gsub(pattern) {|key| substitutions[key]}
+		end
+		
+		def write(source, destination, substitutions = nil, mode = "a")
+			source_path = Pathname(path) + source
+			destination_path = Pathname(context.root) + destination
+			
+			destination_path.dirname.mkpath
+			
+			File.open(destination_path, mode) do |file|
+				text = File.read(source_path)
+				
+				file.write substitute(text, substitutions)
+			end
+		end
+		
+		def append(source, destination, substitutions = nil)
+			write(source, destination, substitutions, "a")
+		end
+		
+		def merge(source, destination, substitutions = nil)
+			source_path = Pathname(path) + source
+			destination_path = Pathname(context.root) + destination
+			
+			if destination_path.exist?
+				temporary_file = Tempfile.new(destination_path.basename.to_s)
+				
+				# This functionality works, but needs improvements.
+				begin
+					# Need to ask user what to do?
+					write(source_path, temporary_file.path, substitutions, "w")
+					
+					if temporary_file.read != destination_path.read
+						if `which opendiff`.chomp != ''
+							system("opendiff", "-merge", destination_path.to_s, destination_path.to_s, temporary_file.path)
+						elsif `which sdiff`.chomp != ''
+							system("sdiff", "-o", destination_path.to_s, destination_path.to_s, temporary_file.path)
+						else
+							abort "Can't find diff/merge tools. Please install sdiff!"
+						end
+					end
+				ensure
+					temporary_file.unlink
+				end
+			else
+				write(source_path, destination_path, substitutions, "w")
+			end
+		end
+		
+		def copy(source, destination, substitutions = nil)
+			source_path = Pathname(path) + source
+			
+			if source_path.directory?
+				destination_path = Pathname(context.root) + destination
+				
+				source_path.children(false).each do |child_path|
+					copy(source_path + child_path, destination_path + substitute(child_path.to_s, substitutions), substitutions)
+				end
+			else
+				merge(source_path, destination, substitutions)
+			end
+		end
+	end
+end

data/lib/teapot/loader.rb

@@ -0,0 +1,135 @@
+# 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/target'
+require 'teapot/generator'
+require 'teapot/configuration'
+
+require 'teapot/name'
+require 'teapot/build'
+
+module Teapot
+	LOADER_VERSION = "0.7"
+	MINIMUM_LOADER_VERSION = "0.7"
+	
+	class IncompatibleTeapotError < StandardError
+		def initialize(version)
+			super "Version #{version} isn't compatible with current loader! Minimum supported version: #{MINIMUM_LOADER_VERSION}; Current version: #{LOADER_VERSION}."
+		end
+		
+		attr :version
+	end
+	
+	class NonexistantTeapotError < StandardError
+		def initialize(path)
+			super "Could not load #{path}!"
+		end
+		
+		attr :path
+	end
+	
+	class Loader
+		class Definitions < Array
+			def default_configuration
+				find{|definition| Configuration === definition}
+			end
+		end
+		
+		# Provides build_directory and build_external methods
+		include Build::Helpers
+		
+		def initialize(context, package)
+			@context = context
+			@package = package
+
+			@defined = Definitions.new
+			@version = nil
+		end
+
+		attr :context
+		attr :package
+		attr :defined
+		attr :version
+
+		def teapot_version(version)
+			version = version[0..2]
+			
+			if version >= MINIMUM_LOADER_VERSION && version <= LOADER_VERSION
+				@version = version
+			else
+				raise IncompatibleTeapotError.new(version)
+			end
+		end
+
+		alias required_version teapot_version
+
+		def define_target(*args)
+			target = Target.new(@context, @package, *args)
+
+			yield target
+
+			@defined << target
+		end
+
+		def define_generator(*args)
+			generator = Generator.new(@context, @package, *args)
+
+			yield generator
+
+			@defined << generator
+		end
+
+		def define_configuration(*args)
+			configuration = Configuration.new(@context, @package, *args)
+
+			yield configuration
+
+			configuration.top!
+
+			@defined << configuration
+		end
+
+		# Checks the host patterns and executes the block if they match.
+		def host(*args, &block)
+			name = @context.options[:host_platform] || RUBY_PLATFORM
+			
+			if block_given?
+				if args.find{|arg| arg === name}
+					yield
+				end
+			else
+				name
+			end
+		end
+
+		# Load a teapot.rb file relative to the root of the @package.
+		def load(path)
+			absolute_path = @package.path + path
+
+			raise NonexistantTeapotError.new(absolute_path) unless File.exist?(absolute_path)
+
+			self.instance_eval(absolute_path.read, absolute_path.to_s)
+			
+			if @version == nil
+				raise IncompatibleTeapotError.new("<unspecified>")
+			end
+		end
+	end
+end

data/lib/teapot/name.rb

@@ -0,0 +1,37 @@
+# Copyright, 2013, 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 Teapot
+	class Name
+		def initialize(text)
+			@text = text
+		end
+		
+		attr :text
+		
+		def identifier
+			@identifier ||= @text.gsub(/\s+/, '')
+		end
+		
+		def target
+			@target ||= @text.gsub(/\s+/, '-').downcase
+		end
+	end
+end