build 2.6.2 → 2.7.0

data/lib/build/provision_node.rb

@@ -1,29 +1,20 @@
-# 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/graph'
+# Released under the MIT License.
+# Copyright, 2019, by Samuel Williams.
 
-require_relative 'build_node'
+require "build/graph"
+
+require_relative "build_node"
 
 module Build
+	# Represents a build graph node for applying a single provision within a dependency chain.
 	class ProvisionNode < Graph::Node
+		# Initialize the provision node.
+		# @parameter chain [Build::Dependency::Chain] The dependency chain.
+		# @parameter provision [Build::Dependency::Provision] The provision to apply.
+		# @parameter environment [Build::Environment] The root environment.
+		# @parameter arguments [Array] Arguments passed down the build chain.
 		def initialize(chain, provision, environment, arguments)
 			@chain = chain
 			@provision = provision
@@ -39,6 +30,7 @@ module Build
 		attr :environment
 		attr :arguments
 		
+		# @returns [Boolean] Whether this node is equal to another.
 		def == other
 			super and
 				@chain == other.chain and
@@ -47,30 +39,40 @@ module Build
 				@arguments == other.arguments
 		end
 		
+		# @returns [Integer] A hash value for this node.
 		def hash
 			super ^ @chain.hash ^ @provision.hash ^ @environment.hash ^ @arguments.hash
 		end
 		
+		# @returns [Class] The task class to use for this node.
 		def task_class(parent_task)
 			ProvisionTask
 		end
 		
+		# @returns [String] The name of the provision.
 		def name
 			@provision.name
 		end
 		
+		# Build a {DependencyNode} for the given dependency.
+		# @parameter dependency [Build::Dependency] The dependency to wrap.
+		# @returns [Build::DependencyNode] The corresponding dependency node.
 		def dependency_node_for(dependency)
 			DependencyNode.new(@chain, dependency, @environment, @arguments)
 		end
 	end
 	
+	# @namespace
 	module DependenciesFailed
+		# @returns [String] A description of the failure.
 		def self.to_s
 			"Failed to build all dependencies!"
 		end
 	end
 	
+	# Represents a task that builds the dependencies of a provision and applies the provision itself.
 	class ProvisionTask < Task
+		# Initialize the provision task.
 		def initialize(*arguments, **options)
 			super
 			
@@ -87,10 +89,12 @@ module Build
 		
 		attr :build_task
 		
+		# @returns [Build::Dependency::Provision] The provision being built by this task.
 		def provision
 			@node.provision
 		end
 		
+		# Build all dependencies and then apply the provision.
 		def update
 			provision.each_dependency do |dependency|
 				@dependencies << invoke(@node.dependency_node_for(dependency))
@@ -103,16 +107,19 @@ module Build
 			end
 		end
 		
+		# @returns [Build::Environment] The combined local environment for this provision.
 		def local_environment
 			Build::Environment.combine(@node.environment, *@environments)&.evaluate(name: @node.name).freeze
 		end
 		
+		# @returns [Build::Environment | Nil] The output environment produced by the build task, if any.
 		def output_environment
 			if @build_task
 				@build_task.output_environment.dup(parent: nil)
 			end
 		end
 		
+		# @returns [Array(Build::Environment)] All output environments including any public ones.
 		def output_environments
 			environments = @public_environments.dup
 			

data/lib/build/rule.rb

@@ -1,35 +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-2019, by Samuel Williams.
 
 module Build
 	# A rule is a function with a specific set of input and output parameters, which can match against a given set of specific arguments. For example, there might be several rules for compiling, but the specific rules depend on the language being compiled.
 	class Rule
+		# Build a frozen rule from a name and a definition block.
+		# @parameter name [String] The rule name in `"process.type"` format.
+		# @returns [Build::Rule] The constructed and frozen rule.
 		def self.build(name, &block)
-			rule = self.new(*name.split('.', 2))
+			rule = self.new(*name.split(".", 2))
 			
 			rule.instance_eval(&block)
 			
 			return rule.freeze
 		end
 		
+		# Represents a single input, output, or argument parameter of a rule.
 		class Parameter
+			# Initialize the parameter.
+			# @parameter direction [Symbol] One of `:input`, `:output`, or `:argument`.
+			# @parameter name [Symbol] The parameter name.
+			# @parameter options [Hash] Options such as `:default`, `:optional`, `:implicit`, `:pattern`.
 			def initialize(direction, name, options = {}, &block)
 				@direction = direction
 				@name = name
@@ -45,14 +38,17 @@ module Build
 			attr :options
 			attr :dynamic
 			
+			# @returns [Boolean] Whether this is an input parameter.
 			def input?
 				@direction == :input
 			end
 			
+			# @returns [Boolean] Whether this is an output parameter.
 			def output?
 				@direction == :output
 			end
 			
+			# @returns [Boolean] Whether this parameter has a dynamic computation block.
 			def dynamic?
 				@dynamic != nil
 			end
@@ -62,6 +58,7 @@ module Build
 				@options.key?(:default)
 			end
 			
+			# @returns [Boolean] Whether this parameter is implicitly computed and can be overridden.
 			def implicit?
 				dynamic? and @options[:implicit]
 			end
@@ -71,6 +68,9 @@ module Build
 				@options[:optional] || implicit? || default?
 			end
 			
+			# Check whether the given arguments satisfy this parameter.
+			# @parameter arguments [Hash] The arguments to check.
+			# @returns [Boolean] Whether this parameter is satisfied.
 			def applicable? arguments
 				value = arguments.fetch(@name) do
 					# Value couldn't be found, if it wasn't optional, this parameter didn't apply:
@@ -79,12 +79,16 @@ module Build
 				
 				# If a pattern is provided, we must match it.
 				if pattern = @options[:pattern]
-					return Array(value).all? {|item| pattern.match(item)}
+					return Array(value).all?{|item| pattern.match(item)}
 				end
 				
 				return true
 			end
 			
+			# Compute the value for this parameter given the arguments and scope.
+			# @parameter arguments [Hash] The current argument set.
+			# @parameter scope [Object] The task scope used for dynamic evaluation.
+			# @returns [Object] The computed parameter value.
 			def compute(arguments, scope)
 				if implicit?
 					# Can be replaced if supplied:
@@ -99,6 +103,7 @@ module Build
 				end
 			end
 			
+			# @returns [Integer] A hash value for this parameter.
 			def hash
 				[self.class, @direction, @name, @options].hash
 			end
@@ -108,16 +113,20 @@ module Build
 				other.kind_of?(self.class) and @direction.eql?(other.direction) and @name.eql?(other.name) and @options.eql?(other.options) # and @dynamic == other.dynamic
 			end
 			
+			# @returns [String] A human-readable representation of the parameter.
 			def inspect
 				"#{direction}:#{@name} (#{options.inspect})"
 			end
 		end
 		
+		# Initialize a rule with a process name and type.
+		# @parameter process_name [String] The process name, e.g. `"compile"`.
+		# @parameter type [String] The file type, e.g. `"cpp"`.
 		def initialize(process_name, type)
 			@name = process_name + "." + type
-			@full_name = @name.gsub(/[^\w]/, '_')
+			@full_name = @name.gsub(/[^\w]/, "_")
 			
-			@process_name = process_name.gsub('-', '_').to_sym
+			@process_name = process_name.gsub("-", "_").to_sym
 			@type = type
 			
 			@apply = nil
@@ -139,6 +148,8 @@ module Build
 		
 		attr :primary_output
 		
+		# Freeze the rule and all its components.
+		# @returns [Build::Rule] The frozen rule.
 		def freeze
 			return self if frozen?
 			
@@ -154,18 +165,29 @@ module Build
 			super
 		end
 		
+		# Add an input parameter to the rule.
+		# @parameter name [Symbol] The parameter name.
+		# @parameter options [Hash] Parameter options.
 		def input(name, options = {}, &block)
 			self << Parameter.new(:input, name, options, &block)
 		end
 		
+		# Add a generic argument parameter to the rule.
+		# @parameter name [Symbol] The parameter name.
+		# @parameter options [Hash] Parameter options.
 		def parameter(name, options = {}, &block)
 			self << Parameter.new(:argument, name, options, &block)
 		end
 		
+		# Add an output parameter to the rule.
+		# @parameter name [Symbol] The parameter name.
+		# @parameter options [Hash] Parameter options.
 		def output(name, options = {}, &block)
 			self << Parameter.new(:output, name, options, &block)
 		end
 		
+		# Append a parameter to the rule.
+		# @parameter parameter [Build::Rule::Parameter] The parameter to add.
 		def << parameter
 			@parameters << parameter
 			
@@ -194,6 +216,9 @@ module Build
 			]
 		end
 		
+		# Derive the input and output file lists from the given arguments.
+		# @parameter arguments [Hash] The argument set.
+		# @returns [Array(Build::Files::Composite, Build::Files::Composite)] Input and output file composites.
 		def files(arguments)
 			input_files = []
 			output_files = []
@@ -215,34 +240,46 @@ module Build
 			return Build::Files::Composite.new(input_files), Build::Files::Composite.new(output_files)
 		end
 		
+		# Set the apply block that is executed when the rule is invoked.
 		def apply(&block)
 			@apply = Proc.new(&block)
 		end
 		
+		# Apply the rule in the given scope with the provided arguments.
+		# @parameter scope [Object] The task scope.
+		# @parameter arguments [Hash] The normalised arguments.
 		def apply!(scope, arguments)
 			scope.instance_exec(arguments, &@apply) if @apply
 		end
 		
+		# @returns [Object | Nil] The primary output value from the given arguments, if any.
 		def result(arguments)
 			if @primary_output
 				arguments[@primary_output.name]
 			end
 		end
 		
+		# @returns [Integer] A hash value for this rule.
 		def hash
 			[self.class, @name, @parameters].hash
 		end
 		
+		# @returns [Boolean] Whether this rule is equal to another by name and parameters.
 		def eql?(other)
 			other.kind_of?(self.class) and @name.eql?(other.name) and @parameters.eql?(other.parameters)
 		end
 		
+		# @returns [String] A human-readable representation of the rule.
 		def to_s
 			"#<#{self.class} #{@name.dump}>"
 		end
 	end
 	
+	# Raised when no applicable rule can be found for a given process name and arguments.
 	class NoApplicableRule < StandardError
+		# Initialize with the process name and arguments that had no matching rule.
+		# @parameter name [String] The process name that was looked up.
+		# @parameter arguments [Hash] The arguments that could not be matched.
 		def initialize(name, arguments)
 			super "No applicable rule with name #{name}.* for parameters: #{arguments.inspect}"
 			

data/lib/build/rule_node.rb

@@ -1,27 +1,16 @@
-# 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/graph'
+# Released under the MIT License.
+# Copyright, 2016-2019, by Samuel Williams.
+
+require "build/graph"
 
 module Build
+	# Represents a build graph node that applies a specific rule with given arguments.
 	class RuleNode < Graph::Node
+		# Initialize the rule node.
+		# @parameter rule [Build::Rule] The rule to apply.
+		# @parameter arguments [Hash] The normalised arguments for the rule.
 		def initialize(rule, arguments, &block)
 			@arguments = arguments
 			@rule = rule
@@ -37,6 +26,7 @@ module Build
 		attr :rule
 		attr :callback
 		
+		# @returns [Boolean] Whether this node is equal to another.
 		def == other
 			super and
 				@arguments == other.arguments and
@@ -44,18 +34,23 @@ module Build
 				@callback == other.callback
 		end
 		
+		# @returns [Integer] A hash value for this node.
 		def hash
 			super ^ @arguments.hash ^ @rule.hash ^ @callback.hash
 		end
 		
+		# @returns [Class] The task class inherited from the parent task.
 		def task_class(parent_task)
 			parent_task.class
 		end
 		
+		# @returns [String] The name of the rule.
 		def name
 			@rule.name
 		end
 		
+		# Apply the rule in the given scope, then invoke the callback if present.
+		# @parameter scope [Object] The task scope.
 		def apply!(scope)
 			@rule.apply!(scope, @arguments)
 			
@@ -64,6 +59,7 @@ module Build
 			end
 		end
 		
+		# @returns [String] A human-readable representation of the rule node.
 		def inspect
 			@rule.name.inspect
 		end

data/lib/build/rulebook.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_relative 'rule'
+# Released under the MIT License.
+# Copyright, 2015-2019, by Samuel Williams.
+
+require_relative "rule"
 
 module Build
+	# Represents a collection of rules, organized by process name for fast lookup.
 	class Rulebook
+		# Initialize the rulebook.
+		# @parameter name [String | Nil] An optional name for this rulebook.
 		def initialize(name = nil)
 			@name = name
 			@rules = {}
@@ -30,18 +18,27 @@ module Build
 		
 		attr :rules
 		
+		# Add a rule to this rulebook.
+		# @parameter rule [Build::Rule] The rule to add.
 		def << rule
 			@rules[rule.name] = rule
-		
+			
 			# A cache for fast process/file-type lookup:
 			processes = @processes[rule.process_name] ||= []
 			processes << rule
 		end
 		
+		# Look up a rule by its full name.
+		# @parameter name [String] The rule name, e.g. `"compile.cpp"`.
+		# @returns [Build::Rule | Nil] The matching rule, or `nil`.
 		def [] name
 			@rules[name]
 		end
 		
+		# Generate a task subclass with methods for all rules in this rulebook.
+		# @parameter superclass [Class] The base task class to inherit from.
+		# @parameter state [Hash] Additional state methods to define on the subclass.
+		# @returns [Class] The generated task subclass.
 		def with(superclass, **state)
 			task_class = Class.new(superclass)
 			
@@ -54,7 +51,7 @@ module Build
 			@processes.each do |key, rules|
 				# Define general rules, which use rule applicability for disambiguation:
 				task_class.send(:define_method, key) do |arguments, &block|
-					rule = rules.find{|rule| rule.applicable? arguments }
+					rule = rules.find{|rule| rule.applicable? arguments}
 					
 					if rule
 						invoke_rule(rule, arguments, &block)
@@ -81,6 +78,9 @@ module Build
 			return task_class
 		end
 		
+		# Build a rulebook from all rule definitions in the given environment.
+		# @parameter environment [Build::Environment] The environment to extract rules from.
+		# @returns [Build::Rulebook] The populated rulebook.
 		def self.for(environment)
 			rulebook = self.new(environment.name)
 			

data/lib/build/task.rb

@@ -1,53 +1,44 @@
-# 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 'fileutils'
-require 'build/graph'
+# Released under the MIT License.
+# Copyright, 2016-2019, by Samuel Williams.
 
-require 'console/event/spawn'
+require "fileutils"
+require "build/graph"
+
+require "console/event/spawn"
 
 module Build
 	# This task class serves as the base class for the environment specific task classes genearted when adding targets.
 	class Task < Graph::Task
-		def initialize(walker, node, group, logger: nil)
+		# Initialize the task.
+		# @parameter walker [Build::Graph::Walker] The graph walker.
+		# @parameter node [Build::Graph::Node] The node being processed.
+		# @parameter group [Process::Group] The process group for spawning commands.
+		def initialize(walker, node, group)
 			super(walker, node)
 			
 			@group = group
-			@logger = logger
 		end
 		
+		# @returns [Class] The class of this task.
 		def task_class
 			self.class
 		end
 		
 		attr :group
-		attr :logger
 		
+		# Apply the node to this task, executing any build logic.
 		def update
 			@node.apply!(self)
 		end
 		
+		# @returns [String] A string representation of the task.
 		def name
 			self.to_s
 		end
 		
+		# @returns [String] The name of the underlying node.
 		def node_string
 			@node.name
 		end

data/lib/build/version.rb

@@ -1,23 +1,9 @@
-# Copyright, 2015, 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-2024, by Samuel Williams.
+
+# @namespace
 module Build
-	VERSION = "2.6.2"
+	VERSION = "2.7.0"
 end

data/lib/build.rb

@@ -1,21 +1,6 @@
-# Copyright, 2015, 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 'build/version'
+# Released under the MIT License.
+# Copyright, 2015, by Samuel Williams.
+
+require_relative "build/version"

data/license.md

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