build-environment 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b0a2e29f0f56710ef70f68f29274237dcdb9fe0a37425280adb8fadf11ded99
-  data.tar.gz: 1c9f18a94aeaca0a1a484b9a3f0ac97068074dd737311634325a5a200e2ace0a
+  metadata.gz: 7d02cb9b10eb8b64658e32892a64fd230b19240b1cba5dd9929f7279b561efde
+  data.tar.gz: 689ed69086ed05c58e918b92ee1a77aa2075cd63edcf0b2d4c1cd6d7b298b95f
 SHA512:
-  metadata.gz: 42ae4a31779fc52ecfc4aaa8616c1948c80c1cd2a9fd6c76a48832ba870f0e2c6e8613bd0c743484c46b7a7be259659b2c638c1e75341cda39ae688130282e01
-  data.tar.gz: 1337f8d7706cc6461c850b801e07ce7a68ac11571ec3af92f137a95d5384a6dbcb36f805e779b0ad8017ca0259442176c86bc513490af6fbf038af376fe055ee
+  metadata.gz: 5cfbe57694c3411f2ea33e5a76c9ff45af79632a4b2eeccf92c458793cdcf6217e46615c467b2045d7b79284a04224d22479224f622da609dfbe6ea2fdf61d90
+  data.tar.gz: 6f12270f025151f6df8723d89cab367af5e4fa95f0d45a19f046551ed672cfc74a4b78a1fbde9225ea10b769ee2d3cf3079852ed0c33edb52da150611c70c49c

data/lib/build/environment/base.rb

@@ -1,26 +1,17 @@
-# 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
 
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
+
+# @namespace
 module Build
-	# This is the basic environment data structure which is essentially a linked list of hashes. It is primarily used for organising build configurations across a wide range of different sub-systems, e.g. platform configuration, target configuration, local project configuration, etc.
+	# Represents a layered build environment, implemented as a linked list of hashes. It is primarily used for organising build configurations across a wide range of different sub-systems, e.g. platform configuration, target configuration, local project configuration, etc.
 	class Environment
+		# Initialize a new environment with an optional parent, initial values, name, and update block.
+		# @parameter parent [Environment | Nil] The parent environment to inherit values from.
+		# @parameter values [Hash | Nil] The initial key-value pairs for this layer.
+		# @parameter name [String | Nil] An optional name for this environment.
+		# @parameter block [Proc] An optional block applied when constructing the environment.
 		def initialize(parent = nil, values = nil, name: nil, &block)
 			@parent = parent
 			@values = (values || {}).to_h
@@ -29,6 +20,9 @@ module Build
 			@name = name
 		end
 		
+		# Compare this environment with another for equality.
+		# @parameter other [Environment] The environment to compare against.
+		# @returns [Boolean] `true` if both environments have the same parent, values, update, and name.
 		def == other
 			self.equal?(other) or
 				self.class == other.class and
@@ -38,10 +32,15 @@ module Build
 				@name == other.name
 		end
 		
+		# Check equality using the `==` operator.
+		# @parameter other [Environment] The environment to compare against.
+		# @returns [Boolean] `true` if the environments are equal.
 		def eql?(other)
 			self == other
 		end
 		
+		# Compute a hash value for this environment based on its parent, values, update, and name.
+		# @returns [Integer] The computed hash value.
 		def hash
 			@parent.hash ^ @values.hash ^ @update.hash ^ @name.hash
 		end
@@ -51,10 +50,18 @@ module Build
 		attr :update
 		attr :name
 		
+		# Create a duplicate of this environment, optionally overriding parent, values, update, or name.
+		# @parameter parent [Environment | Nil] The parent for the duplicate.
+		# @parameter values [Hash] The values for the duplicate.
+		# @parameter update [Proc | Nil] The update block for the duplicate.
+		# @parameter name [String | Nil] The name for the duplicate.
+		# @returns [Environment] A new environment with the given attributes.
 		def dup(parent: @parent, values: @values, update: @update, name: @name)
 			self.class.new(parent, values.dup, name: name, &update)
 		end
 		
+		# Freeze this environment and its entire parent chain, making it immutable.
+		# @returns [Environment] The frozen environment.
 		def freeze
 			return self if frozen?
 			
@@ -65,6 +72,9 @@ module Build
 			super
 		end
 		
+		# Find the environment layer that contains the given key.
+		# @parameter name [Symbol] The key to search for.
+		# @returns [Environment | Nil] The environment layer containing the key, or `nil` if not found.
 		def lookup(name)
 			if @values.include? name
 				self
@@ -73,6 +83,9 @@ module Build
 			end
 		end
 		
+		# Check whether the key exists in this environment or any parent layer.
+		# @parameter key [Symbol] The key to check.
+		# @returns [Boolean | Nil] `true` if the key exists, `nil` otherwise.
 		def include?(key)
 			if @values.include?(key)
 				true
@@ -81,10 +94,19 @@ module Build
 			end
 		end
 		
+		alias :key? :include?
+		
+		# Count the total number of key-value pairs across all layers.
+		# @returns [Integer] The total size.
 		def size
 			@values.size + (@parent ? @parent.size : 0)
 		end
 		
+		# Retrieve the value for a key, with support for a default value or block.
+		# @parameter key [Symbol] The key to look up.
+		# @parameter default [Array] An optional default value.
+		# @raises [KeyError] If the key is not found and no default or block is given.
+		# @returns [Object] The value associated with the key, or the default.
 		def fetch(key, *default, &block)
 			if environment = lookup(key)
 				return environment.values[key]
@@ -97,28 +119,36 @@ module Build
 			end
 		end
 		
+		# Retrieve the value for a key, returning `nil` if not found.
+		# @parameter key [Symbol] The key to look up.
+		# @returns [Object | Nil] The value, or `nil` if the key does not exist.
 		def [](key)
 			environment = lookup(key)
 			
 			environment ? environment.values[key] : nil
 		end
 		
+		# Set the value for a key in the current environment layer.
+		# @parameter key [Symbol] The key to set.
+		# @parameter value [Object] The value to assign.
 		def []=(key, value)
 			@values[key] = value
 		end
 		
+		# Return a human-readable string representation of this environment.
+		# @returns [String] A string showing the class, name, update source location, and values.
 		def to_s
 			buffer = String.new("\#<#{self.class} ")
 			
 			if @name
-				buffer << @name.inspect << ' '
+				buffer << @name.inspect << " "
 			end
 			
 			if @update
-				buffer << @update.source_location.join(':') << ' '
+				buffer << @update.source_location.join(":") << " "
 			end
 			
-			buffer << @values.to_s << '>'
+			buffer << @values.to_s << ">"
 			
 			return buffer
 		end

data/lib/build/environment/constructor.rb

@@ -1,40 +1,33 @@
-# 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 'ostruct'
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
 
 module Build
 	class Environment
 		Default = Struct.new(:value)
 		Replace = Struct.new(:value)
 		
+		# Represents a deferred class instantiation, binding a class and a configuration block to an environment key.
 		class Define < Struct.new(:klass, :block)
+			# Initialize a define with a class and an optional configuration block.
+			# @parameter klass [Class] The class to instantiate.
+			# @parameter block [Proc] An optional block used to configure the instance.
 			def initialize(klass, &block)
 				super klass, block
 			end
 			
+			# Return a string representation of this define.
+			# @returns [String] A string showing the class and block source location.
 			def to_s
 				"#<#{klass} #{block ? block.source_location.join(':') : 'unknown'}>"
 			end
 		end
 		
+		# Apply a block to this environment using a {Constructor} proxy, then return the environment.
+		# @parameter proxy [Object | Nil] An optional proxy object to delegate unknown method calls to.
+		# @parameter arguments [Array] Arguments forwarded to the block.
+		# @returns [Environment] The updated environment.
 		def construct!(proxy, *arguments, &block)
 			constructor = Constructor.new(self, proxy)
 			
@@ -45,16 +38,29 @@ module Build
 			return self
 		end
 		
+		# Represents a DSL proxy used to populate an environment using a block-based interface.
 		class Constructor
+			# Initialize the constructor with an environment and an optional proxy object.
+			# @parameter environment [Environment] The environment to populate.
+			# @parameter proxy [Object | Nil] An optional proxy for delegating unknown method calls.
 			def initialize(environment, proxy = nil)
 				@environment = environment
 				@proxy = proxy
 			end
 			
+			# Check whether the constructor responds to the given method name.
+			# @parameter name [Symbol] The method name to check.
+			# @parameter include_private [Boolean] Whether to include private methods.
+			# @returns [Boolean] `true` if the environment includes the key or the proxy responds to the method.
 			def respond_to?(name, include_private = false)
 				@environment.include?(name) || @proxy&.respond_to?(name, include_private) || super
 			end
 			
+			# Dynamically set environment keys or delegate to the proxy object.
+			# @parameter name [Symbol] The key name or proxy method name.
+			# @parameter args [Array] Positional arguments: a single value, multiple values, or none (with a block).
+			# @parameter options [Hash] Keyword arguments forwarded to the proxy.
+			# @parameter block [Proc] A block used as the value when no positional arguments are given.
 			def method_missing(name, *args, **options, &block)
 				if options.empty?
 					if args.empty? and block_given?
@@ -84,40 +90,64 @@ module Build
 				end
 			end
 			
+			# Delegate `respond_to` to the proxy if available.
+			# @returns [Boolean] `true` if the constructor or proxy responds to the given arguments.
 			def respond_to(*args)
 				super or @proxy&.respond_to(*args)
 			end
 			
+			# Retrieve the value of a key from the underlying environment.
+			# @parameter key [Symbol] The key to look up.
+			# @returns [Object | Nil] The value associated with the key.
 			def [] key
 				@environment[key]
 			end
 			
+			# Return the parent of the underlying environment.
+			# @returns [Environment | Nil] The parent environment.
 			def parent
 				@environment.parent
 			end
 			
+			# Create an `OpenStruct` from the given keyword options.
+			# @parameter options [Hash] The key-value pairs for the struct.
+			# @returns [OpenStruct] A new struct with the given options.
 			def hash(**options)
 				OpenStruct.new(options)
 			end
 			
+			# Mark the current value of a key as the default, wrapping it in a `Default` struct.
+			# @parameter name [Symbol] The key whose value should be treated as a default.
+			# @returns [Symbol] The key name.
 			def default(name)
 				@environment[name] = Default.new(@environment[name])
 				
 				return name
 			end
 			
+			# Mark the current value of a key for replacement, wrapping it in a `Replace` struct.
+			# @parameter name [Symbol] The key whose value should be replaced.
+			# @returns [Symbol] The key name.
 			def replace(name)
 				@environment[name] = Replace.new(@environment[name])
 				
 				return name
 			end
 			
+			# Convert the current value of a key to an array to allow appending.
+			# @parameter name [Symbol] The key whose value should be converted to an array.
+			# @returns [Symbol] The key name.
 			def append(name)
 				@environment[name] = Array(@environment[name])
 				
 				return name
 			end
 			
+			# Associate a class and configuration block with a key as a `Define` struct.
+			# @parameter klass [Class] The class to associate with the key.
+			# @parameter name [Symbol] The key to define.
+			# @parameter block [Proc] A block used to configure the class instance.
+			# @returns [Symbol] The key name.
 			def define(klass, name, &block)
 				@environment[name] = Define.new(klass, &block)
 				
@@ -138,6 +168,10 @@ module Build
 			end
 		end
 		
+		# Create a new child environment inheriting from this one, with optional keyword options and block.
+		# @parameter options [Hash] Options forwarded to the new environment's constructor.
+		# @parameter block [Proc] An optional update block for the new environment.
+		# @returns [Environment] A new environment with `self` as the parent.
 		def merge(**options, &block)
 			self.class.new(self, **options, &block)
 		end
@@ -151,6 +185,8 @@ module Build
 			return flat
 		end
 		
+		# Recursively collect this environment and its ancestors into an array, parent first.
+		# @parameter array [Array] The array to append environments into.
 		def flatten_to_array(array)
 			if @parent
 				@parent.flatten_to_array(array)

data/lib/build/environment/evaluator.rb

@@ -1,31 +1,21 @@
-# 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
+
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
 
 module Build
 	class Environment
+		# Represents a lazy evaluator that resolves and caches environment values on demand.
 		class Evaluator
+			# Initialize the evaluator with an environment.
+			# @parameter environment [Environment] The environment whose values will be evaluated.
 			def initialize(environment)
 				@environment = environment
 				@cache = {}
 			end
 			
+			# Copy the environment reference and cache when duplicating.
+			# @parameter other [Evaluator] The evaluator being duplicated.
 			def initialize_dup(other)
 				@environment = other.instance_variable_get(:@environment)
 				@cache = other.instance_variable_get(:@cache).dup
@@ -33,10 +23,17 @@ module Build
 				super
 			end
 			
+			# Check whether the evaluator responds to a given method name.
+			# @parameter name [Symbol] The method name to check.
+			# @parameter include_private [Boolean] Whether to include private methods.
+			# @returns [Boolean] `true` if the environment contains the key or the evaluator responds via `super`.
 			def respond_to?(name, include_private = false)
 				@environment.include?(name) || super
 			end
 			
+			# Evaluate and cache the value for the named key.
+			# @parameter name [Symbol] The key to resolve from the environment.
+			# @returns [Object] The resolved and cached value.
 			def method_missing(name)
 				@cache[name] ||= object_value(@environment[name])
 			end

data/lib/build/environment/flatten.rb

@@ -1,27 +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 'digest/md5'
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
+
+require "digest/md5"
+require "ostruct"
 
 module Build
 	class Environment
+		# Evaluate all environment layers into a single flat hash with all values resolved.
+		# @returns [Hash] A hash mapping all keys to their fully evaluated values.
 		def to_h
 			hash = {}
 			
@@ -35,14 +23,22 @@ module Build
 			Hash[hash.map{|key, value| [key, evaluator.object_value(value)]}]
 		end
 		
+		# Create a new {Evaluator} for this environment.
+		# @returns [Evaluator] An evaluator backed by this environment.
 		def evaluator
 			Evaluator.new(self)
 		end
 		
+		# Flatten and evaluate all values, returning a new single-layer environment.
+		# @parameter options [Hash] Options forwarded to the new environment's constructor.
+		# @returns [Environment] A new environment with all values fully evaluated.
 		def evaluate(**options)
 			self.class.new(nil, self.to_h, **options)
 		end
 		
+		# Merge all environment layers into a single-level environment without evaluating values.
+		# @parameter options [Hash] Options forwarded to the new environment's constructor.
+		# @returns [Environment] A flat environment containing the merged but unevaluated values.
 		def flatten(**options)
 			hash = {}
 			
@@ -53,10 +49,15 @@ module Build
 			return self.class.new(nil, hash, **options)
 		end
 		
+		# Return all key-value pairs in the current layer whose values are `Define` instances.
+		# @returns [Hash] A hash of keys mapped to their `Define` values.
 		def defined
 			@values.select{|name,value| Define === value}
 		end
 		
+		# Compute a hex digest checksum of the environment's content.
+		# @parameter digester [Digest] The digest algorithm to use.
+		# @returns [String] The hexadecimal digest string.
 		def checksum(digester: Digest::SHA1.new)
 			checksum_recursively(digester)
 			

data/lib/build/environment/system.rb

@@ -1,36 +1,28 @@
-# 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
+
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
 
 module Build
 	class Environment
+		# Provides utilities for converting environment values to shell-compatible strings.
 		module System
+			# Escape a value for safe use in a shell command string.
+			# @parameter value [String | Array] The value to escape.
+			# @returns [String] The shell-escaped string.
 			def self.shell_escape(value)
 				case value
 				when Array
-					value.flatten.collect{|argument| shell_escape(argument)}.join(' ')
+					value.flatten.collect{|argument| shell_escape(argument)}.join(" ")
 				else
 					# Ensure that any whitespace has been escaped:
 					value.to_s.gsub(/ /, '\ ')
 				end
 			end
 			
+			# Check whether a value is suitable for export to a shell environment.
+			# @parameter value [Object] The value to check.
+			# @returns [Boolean] `true` if the value can be exported, `false` otherwise.
 			def self.valid_for_export(value)
 				case value
 				when Array
@@ -50,6 +42,9 @@ module Build
 				end
 			end
 			
+			# Convert an environment to a shell-compatible hash with uppercase string keys and escaped string values.
+			# @parameter environment [Environment] The environment to convert.
+			# @returns [Hash] A hash of uppercase string keys mapped to shell-escaped string values.
 			def self.convert_to_shell(environment)
 				values = environment.values.select{|key, value| valid_for_export(value)}
 				

data/lib/build/environment/version.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
+
 module Build
 	class Environment
-		VERSION = "1.13.0"
+		VERSION = "1.13.1"
 	end
 end

data/lib/build/environment.rb

@@ -1,25 +1,10 @@
-# 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 'environment/base'
-require_relative 'environment/constructor'
-require_relative 'environment/evaluator'
-require_relative 'environment/flatten'
-require_relative 'environment/system'
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
+
+require_relative "environment/base"
+require_relative "environment/constructor"
+require_relative "environment/evaluator"
+require_relative "environment/flatten"
+require_relative "environment/system"

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2015-2026, by Samuel Williams.  
+
+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.

data/readme.md

@@ -0,0 +1,35 @@
+# Build::Environment
+
+Build::Environment provides a nested hash data structure which can contain lambdas for evaluating environments for generating appropriate build environments.
+
+[![Development Status](https://github.com/ioquatix/build-environment/workflows/Test/badge.svg)](https://github.com/ioquatix/build-environment/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://ioquatix.github.io/build-environment) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/build-environmentguides/getting-started/index) - This guide explains how to get started with `build-environment`, a nested key-value data structure for organising build configurations.
+
+## Releases
+
+Please see the [project releases](https://ioquatix.github.io/build-environmentreleases/index) for all releases.
+
+### v1.13.1
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,3 @@
+# Releases
+
+## v1.13.1