teapot 3.5.3 → 3.6.0

data/lib/teapot/command.rb

@@ -1,41 +1,26 @@
-# Copyright, 2016, 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.
+# frozen_string_literal: true
 
-require 'samovar'
+# Released under the MIT License.
+# Copyright, 2016-2026, by Samuel Williams.
 
-require_relative 'command/build'
-require_relative 'command/clean'
-require_relative 'command/create'
-require_relative 'command/clone'
-require_relative 'command/fetch'
-require_relative 'command/list'
-require_relative 'command/status'
-require_relative 'command/visualize'
+require "samovar"
 
-require_relative 'context'
-require_relative 'configuration'
-require_relative 'version'
+require_relative "command/build"
+require_relative "command/clean"
+require_relative "command/create"
+require_relative "command/clone"
+require_relative "command/fetch"
+require_relative "command/list"
+require_relative "command/status"
+require_relative "command/visualize"
 
-require 'fileutils'
+require_relative "context"
+require_relative "configuration"
+require_relative "version"
 
-require 'console'
+require "fileutils"
+
+require "console"
 
 module Teapot
 	module Command
@@ -43,11 +28,11 @@ module Teapot
 			self.description = "A decentralised package manager and build tool."
 			
 			options do
-				option '-c/--configuration <name>', "Specify a specific build configuration.", default: ENV['TEAPOT_CONFIGURATION']
-				option '--root <path>', "Work in the given root directory."
-				option '--verbose | --quiet', "Verbosity of output for debugging.", key: :logging
-				option '-h/--help', "Print out help information."
-				option '-v/--version', "Print out the application version."
+				option "-c/--configuration <name>", "Specify a specific build configuration.", default: ENV["TEAPOT_CONFIGURATION"]
+				option "--root <path>", "Work in the given root directory."
+				option "--verbose | --quiet", "Verbosity of output for debugging.", key: :logging
+				option "-h/--help", "Print out help information."
+				option "-v/--version", "Print out the application version."
 			end
 			
 			nested :command, {
@@ -59,7 +44,7 @@ module Teapot
 				"build" => Build,
 				"visualize" => Visualize,
 				"clean" => Clean,
-			}, default: 'build'
+			}, default: "build"
 			
 			def root
 				::Build::Files::Path.expand(@options[:root] || Dir.getwd)
@@ -110,19 +95,19 @@ module Teapot
 			rescue ::Build::Dependency::UnresolvedDependencyError => error
 				logger.error(command, error) do |buffer|
 					buffer.puts "Unresolved dependencies:"
-
+					
 					error.chain.unresolved.each do |name, parent|
 						buffer.puts "#{parent} depends on #{name.inspect}"
-					
+						
 						conflicts = error.chain.conflicts[name]
-					
+						
 						if conflicts
 							conflicts.each do |conflict|
 								buffer.puts " - provided by #{conflict.name}"
 							end
 						end
 					end
-
+					
 					buffer.puts "Cannot continue due to unresolved dependencies!"
 				end
 				

data/lib/teapot/configuration.rb

@@ -1,30 +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
-# 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.
+# frozen_string_literal: true
 
-require 'pathname'
-require 'set'
+# Released under the MIT License.
+# Copyright, 2013-2026, by Samuel Williams.
 
-require 'yaml/store'
+require "pathname"
+require "set"
 
-require 'build/dependency/set'
-require_relative 'definition'
+require "yaml/store"
+
+require "build/dependency/set"
+require_relative "definition"
 
 module Teapot
 	# A configuration represents a mapping between package/dependency names and actual source locations. Usually, there is only one configuration, but in some cases it is useful to have more than one, e.g. one for local development using local source code, one for continuous integration, and one for deployment.
@@ -37,18 +22,18 @@ module Teapot
 		
 		def initialize(context, package, name, packages = [], **options)
 			super context, package, name
-
+			
 			@options = DEFAULT_OPTIONS.merge(options)
-
+			
 			@packages = Build::Dependency::Set.new(packages)
 			@imports = Build::Dependency::Set.new
-
+			
 			@visibility = :private
-
+			
 			# A list of named targets for specific purposes:
 			@targets = Hash.new{|hash,key| hash[key] = Array.new}
 		end
-
+		
 		def freeze
 			return self if frozen?
 			
@@ -62,7 +47,7 @@ module Teapot
 			
 			super
 		end
-
+		
 		def environment
 			configuration = self
 			
@@ -71,30 +56,30 @@ module Teapot
 				default platforms_path configuration.build_path
 			end
 		end
-
+		
 		# Controls how the configuration is exposed in the context.
 		attr :visibility
-
+		
 		def public?
 			@visibility == :public
 		end
-
+		
 		def public!
 			@visibility = :public
 		end
-
+		
 		# A table of named targets for specific purposes.
 		attr :targets
-
+		
 		# Options used to bind packages to this configuration.
 		attr :options
-
+		
 		# A list of packages which are required by this configuration.
 		attr :packages
-
+		
 		# A list of other configurations to include when materialising the list of packages.
 		attr :imports
-
+		
 		# Specifies that this configuration depends on an external package of some sort.
 		def require(name, **options)
 			options = @options.merge(options)
@@ -107,12 +92,12 @@ module Teapot
 				import(options[:import])
 			end
 		end
-
+		
 		# Specifies that this package will import additional configuration records from another definition.
 		def import(name, explicit = true)
 			@imports << Import.new(name, explicit, @options.dup)
 		end
-
+		
 		# Create a group for configuration options which will be only be active within the group block.
 		def group
 			options = @options.dup
@@ -121,41 +106,41 @@ module Teapot
 			
 			@options = options
 		end
-
+		
 		# Set a configuration option.
 		def []= key, value
 			@options[key] = value
 		end
-
+		
 		# Get a configuration option.
 		def [] key
 			@options[key]
 		end
-
+		
 		# The path where packages will be located when fetched.
 		def packages_path
 			context.root + "teapot/packages/#{name}"
 		end
-
+		
 		# The path where built products will be placed.
 		def build_path
 			context.root + "teapot/build/#{name}"
 		end
-
+		
 		alias platforms_path build_path
-
+		
 		def lock_path
 			context.root + "#{@name}-lock.yml"
 		end
-
+		
 		def lock_store
-			YAML::Store.new(lock_path.to_s)
+			::YAML::Store.new(lock_path.to_s)
 		end
-
+		
 		def to_s
 			"#<#{self.class} #{@name.dump} visibility=#{@visibility}>"
 		end
-
+		
 		# Process all import directives and return a new configuration based on the current configuration. Import directives bring packages and other import directives from the specififed configuration definition.
 		def traverse(configurations, imported = Build::Dependency::Set.new, &block)
 			yield self # Whatever happens here, should ensure that...

data/lib/teapot/context.rb

@@ -1,24 +1,9 @@
-# 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.
+# frozen_string_literal: true
 
-require_relative 'select'
+# Released under the MIT License.
+# Copyright, 2012-2026, by Samuel Williams.
+
+require_relative "select"
 
 module Teapot
 	# A context represents a specific root package instance with a given configuration and all related definitions. A context is stateful in the sense that package selection is specialized based on #select and #dependency_chain. These parameters are usually set up initially as part of the context setup.
@@ -26,24 +11,24 @@ module Teapot
 		def initialize(root, **options)
 			@root = Path[root]
 			@options = options
-
+			
 			@configuration = nil
 			@project = nil
-
+			
 			@loaded = {}
-
+			
 			load_root_package(**options)
 		end
-
+		
 		attr :root
 		attr :options
-
+		
 		# The primary configuration.
 		attr :configuration
-
+		
 		# The primary project.
 		attr :project
-
+		
 		def repository
 			@repository ||= Rugged::Repository.discover(@root.to_s)
 		end
@@ -51,41 +36,41 @@ module Teapot
 		def select(names = nil, configuration = @configuration)
 			Select.new(self, configuration, names || [])
 		end
-
+		
 		def substitutions
 			substitutions = Build::Text::Substitutions.new
 			
-			substitutions['TEAPOT_VERSION'] = Teapot::VERSION
+			substitutions["TEAPOT_VERSION"] = Teapot::VERSION
 			
 			if @project
 				name = @project.name
 				
 				# e.g. Foo Bar, typically used as a title, directory, etc.
-				substitutions['PROJECT_NAME'] = name.text
+				substitutions["PROJECT_NAME"] = name.text
 				
 				# e.g. FooBar, typically used as a namespace
-				substitutions['PROJECT_IDENTIFIER'] = name.identifier
+				substitutions["PROJECT_IDENTIFIER"] = name.identifier
 				
 				# e.g. foo-bar, typically used for targets, executables
-				substitutions['PROJECT_TARGET_NAME'] = name.target
+				substitutions["PROJECT_TARGET_NAME"] = name.target
 				
 				# e.g. foo_bar, typically used for variables.
-				substitutions['PROJECT_VARIABLE_NAME'] = name.key
+				substitutions["PROJECT_VARIABLE_NAME"] = name.key
 				
-				substitutions['LICENSE'] = @project.license
+				substitutions["LICENSE"] = @project.license
 			end
 			
 			# The user's current name:
-			substitutions['AUTHOR_NAME'] = repository.config['user.name']
-			substitutions['AUTHOR_EMAIL'] = repository.config['user.email']
+			substitutions["AUTHOR_NAME"] = repository.config["user.name"]
+			substitutions["AUTHOR_EMAIL"] = repository.config["user.email"]
 			
 			current_date = Time.new
-			substitutions['DATE'] = current_date.strftime("%-d/%-m/%Y")
-			substitutions['YEAR'] = current_date.strftime("%Y")
+			substitutions["DATE"] = current_date.strftime("%-d/%-m/%Y")
+			substitutions["YEAR"] = current_date.strftime("%Y")
 			
 			return substitutions
 		end
-
+		
 		def load(package)
 			if loader = @loaded[package]
 				return loader.script unless loader.changed?

data/lib/teapot/definition.rb

@@ -1,22 +1,7 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2013-2026, by Samuel Williams.
 
 module Teapot
 	class Definition
@@ -35,11 +20,11 @@ module Teapot
 			
 			super
 		end
-
+		
 		def inspect
 			"\#<#{self.class.name} #{@name}>"
 		end
-
+		
 		# The context in which the definition was loaded:
 		attr :context
 		
@@ -54,7 +39,7 @@ module Teapot
 		
 		def description=(text)
 			if text =~ /^(\t+)/
-				text = text.gsub(/#{$1}/, '')
+				text = text.gsub(/#{$1}/, "")
 			end
 			
 			@description = text

data/lib/teapot/loader.rb

@@ -1,30 +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
-# 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.
+# frozen_string_literal: true
 
-require_relative 'project'
-require_relative 'target'
-require_relative 'configuration'
+# Released under the MIT License.
+# Copyright, 2013-2026, by Samuel Williams.
 
-require 'build/rule'
-require 'build/name'
-require 'build/files'
+require_relative "project"
+require_relative "target"
+require_relative "configuration"
+
+require "build/rule"
+require "build/name"
+require "build/files"
 
 module Teapot
 	# Cannot load packages newer than this.
@@ -37,7 +22,7 @@ module Teapot
 	MINIMUM_LOADER_VERSION = "1.0"
 	
 	# The package relative path to the file to load:
-	TEAPOT_FILE = 'teapot.rb'.freeze
+	TEAPOT_FILE = "teapot.rb".freeze
 	
 	class IncompatibleTeapotError < StandardError
 		def initialize(package, version)
@@ -118,9 +103,9 @@ module Teapot
 		
 		def define_configuration(*arguments, **options)
 			configuration = Configuration.new(@context, @package, *arguments, **options)
-
+			
 			yield configuration
-
+			
 			@default_configuration ||= configuration
 			@defined << configuration
 			@configurations << configuration

data/lib/teapot/package.rb

@@ -1,27 +1,12 @@
-# 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.
+# frozen_string_literal: true
 
-require 'build/files'
-require 'build/uri'
+# Released under the MIT License.
+# Copyright, 2012-2026, by Samuel Williams.
 
-require_relative 'definition'
+require "build/files"
+require "build/uri"
+
+require_relative "definition"
 
 module Teapot
 	Path = Build::Files::Path
@@ -30,12 +15,12 @@ module Teapot
 		def initialize(path, name, options = {})
 			# The path where the package is (or will be) located:
 			@path = Path[path]
-
+			
 			# Get the name of the package from the options, if provided:
 			if options[:name]
 				@name = options[:name]
 			end
-
+			
 			if Symbol === name
 				# If the name argument was symbolic, we convert it into a string, and use it for both the uri and the name itself:
 				@uri = name.to_s
@@ -58,34 +43,34 @@ module Teapot
 			
 			super
 		end
-
+		
 		attr :name
 		attr :path
-
+		
 		attr :uri
 		attr_accessor :options
-
+		
 		def local
 			@options[:local].to_s
 		end
-
+		
 		def local?
 			@options.include?(:local)
 		end
-
+		
 		def external?
 			@options.include?(:source)
 		end
-
+		
 		# The source uri from which this package would be cloned. Might be relative, in which case it's relative to the root of the context.
 		def source_uri
 			Build::URI[@options[:source]]
 		end
-
+		
 		def external_url(root_path = nil)
 			Build::URI[root_path] + source_uri + Build::URI[@uri]
 		end
-
+		
 		def to_s
 			if self.local?
 				"links #{@name} from #{self.local}"

data/lib/teapot/project.rb

@@ -1,24 +1,9 @@
-# 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.
+# frozen_string_literal: true
 
-require_relative 'definition'
+# Released under the MIT License.
+# Copyright, 2013-2026, by Samuel Williams.
+
+require_relative "definition"
 
 module Teapot
 	class Project < Definition