bake 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99b2c03a18fc4aa5cb423eb24baadefa827104d4f85c39d360284e6d086e9e3c
-  data.tar.gz: ce5eb5f377f89d575535fae064465daabb1ce34eab618acf139b9c6c51d9c311
+  metadata.gz: a486a2d684d8417098b550d477c23b52d9ee41e364bdb3eba4abe94a34b7e4bb
+  data.tar.gz: d6ed531b2cb2aa138d3eef54eaef5d082a6b119b5d320bb77cb72c2bc360b802
 SHA512:
-  metadata.gz: d538348c6853c183e713d5e431b7780f3641aa6c6c17a4cbd04a4ae505f8bb143788724b809d5f2745b0c3e9a5cb1a24fc2f56e799da7c8fc64ce02312580792
-  data.tar.gz: 5d2bc47eaea3c6194d6c8ce8f076ea40dc37b6e3a636a37fc305e0a4d1b571925e4d3aa9f195fa8cd02404f9be938e8891b9a4f18416be543e00c0ad371e390c
+  metadata.gz: 77e365e561d39182941954d48fbafb0b85dafd7e7392b5edb5c254052483437729d1d4207355fae156daeac2c10e06c56c9da7dbad8d98eab7d0c32f4b9d5607
+  data.tar.gz: d8a8ffbafbc2797d96026921c77ae99e6b00a719cd66291d36067db1ec72d3c0c9031dc069c20b18ac50fa6841177a07b5303f4367c6aabb01f373babee71783

data/bin/bake

@@ -28,6 +28,6 @@ require_relative '../lib/bake/command'
 begin
 	Bake::Command.call
 rescue => error
-	Console.logger.error(Bake::Command) {error}
+	Console.error(Bake::Command, error)
 	exit 1
 end

data/lib/bake/command/call.rb

@@ -5,8 +5,7 @@
 
 require 'samovar'
 
-require_relative '../loaders'
-require_relative '../loader'
+require_relative '../registry'
 require_relative '../context'
 
 module Bake

data/lib/bake/command/list.rb

@@ -80,21 +80,11 @@ module Bake
 				terminal = @parent.terminal
 				context = @parent.context
 				
-				if scope = context.scope
-					printed = print_scope(terminal, context.scope) do
-						terminal.print_line(:context, context)
-					end
-					
-					if printed
-						terminal.print_line
-					end
-				end
-				
-				context.loaders.each do |loader|
+				context.registry.each do |loader|
 					printed = false
 					
 					loader.each do |path|
-						if scope = loader.scope_for(path)
+						loader.scopes_for(path) do |scope|
 							print_scope(terminal, scope, printed: printed) do
 								terminal.print_line(:loader, loader)
 								printed = true

data/lib/bake/context.rb

@@ -5,6 +5,7 @@
 # Copyright, 2020, by Olle Jonsson.
 
 require_relative 'base'
+require_relative 'registry'
 
 module Bake
 	# The default file name for the top level bakefile.
@@ -45,57 +46,49 @@ module Bake
 		# @path [String] A file-system path.
 		def self.load(path = Dir.pwd)
 			if bakefile_path = self.bakefile_path(path)
-				scope = Scope.load(bakefile_path)
-				
 				working_directory = File.dirname(bakefile_path)
-				loaders = Loaders.default(working_directory)
 			else
-				scope = nil
-				
 				working_directory = path
-				loaders = Loaders.default(working_directory)
 			end
 			
-			return self.new(loaders, scope, working_directory)
+			registry = Registry.default(working_directory, bakefile_path)
+			context = self.new(registry, working_directory)
+			
+			context.bakefile
+			
+			return context
 		end
 		
-		# Initialize the context with the specified loaders.
-		# @parameter loaders [Loaders]
-		def initialize(loaders, scope = nil, root = nil)
-			@loaders = loaders
-			
-			@stack = []
+		# Initialize the context with the specified registry.
+		# @parameter registry [Registry]
+		def initialize(registry, root = nil)
+			@registry = registry
+			@root = root
 			
 			@instances = Hash.new do |hash, key|
 				hash[key] = instance_for(key)
 			end
 			
-			@scope = scope
-			@root = root
-			
-			if @scope
-				base = Base.derive
-				base.prepend(@scope)
-				
-				@instances[[]] = base.new(self)
-			end
-			
 			@recipes = Hash.new do |hash, key|
 				hash[key] = recipe_for(key)
 			end
 		end
 		
-		# The loaders which will be used to resolve recipes in this context.
-		attr :loaders
+		def bakefile
+			@instances[[]]
+		end
 		
-		# The scope for the root {BAKEFILE}.
-		attr :scope
+		# The registry which will be used to resolve recipes in this context.
+		attr :registry
 		
 		# The root path of this context.
 		# @returns [String | Nil]
 		attr :root
 		
 		# Invoke recipes on the context using command line arguments.
+		#
+		# e.g. `context.call("gem:release:version:increment", "0,0,1")`
+		#
 		# @parameter commands [Array(String)]
 		def call(*commands)
 			last_result = nil
@@ -118,6 +111,8 @@ module Bake
 			@recipes[command]
 		end
 		
+		alias [] lookup
+		
 		def to_s
 			if @root
 				"#{self.class} #{File.basename(@root)}"
@@ -135,9 +130,13 @@ module Bake
 		def recipe_for(command)
 			path = command.split(":")
 			
+			# If the command is in the form `foo:bar`, we check two cases:
+			#
+			# (1) We check for an instance at path `foo:bar` and if it responds to `bar`.
 			if instance = @instances[path] and instance.respond_to?(path.last)
 				return instance.recipe_for(path.last)
 			else
+				# (2) We check for an instance at path `foo` and if it responds to `bar`.
 				*path, name = *path
 				
 				if instance = @instances[path] and instance.respond_to?(name)
@@ -158,12 +157,10 @@ module Bake
 		def base_for(path)
 			base = nil
 			
-			@loaders.each do |loader|
-				if scope = loader.scope_for(path)
-					base ||= Base.derive(path)
-					
-					base.prepend(scope)
-				end
+			# For each loader, we check if it has a scope for the given path. If it does, we prepend it to the base:
+			@registry.scopes_for(path) do |scope|
+				base ||= Base.derive(path)
+				base.prepend(scope)
 			end
 			
 			return base

data/lib/bake/registry/aggregate.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require 'console'
+
+require_relative 'directory_loader'
+require_relative 'bakefile_loader'
+
+module Bake
+	# Structured access to the working directory and loaded gems for loading bakefiles.
+	module Registry
+		class Aggregate
+			include Enumerable
+			
+			# Create a loader using the specified working directory.
+			# @parameter working_directory [String]
+			def self.default(working_directory, bakefile_path = nil)
+				registry = self.new
+				
+				if bakefile_path
+					registry.append_bakefile(bakefile_path)
+				end
+				
+				registry.append_defaults(working_directory)
+				
+				return registry
+			end
+			
+			# Initialize an empty array of registry.
+			def initialize
+				# Used to de-duplicated directories:
+				@roots = {}
+				
+				# The ordered list of loaders:
+				@ordered = Array.new
+			end
+			
+			# Whether any registry are defined.
+			# @returns [Boolean]
+			def empty?
+				@ordered.empty?
+			end
+			
+			# Enumerate the registry in order.
+			def each(&block)
+				@ordered.each(&block)
+			end
+			
+			def scopes_for(path, &block)
+				@ordered.each do |registry|
+					registry.scopes_for(path, &block)
+				end
+			end
+			
+			def append_bakefile(path)
+				@ordered << BakefileLoader.new(path)
+			end
+			
+			# Append a specific project path to the search path for recipes.
+			# The computed path will have `bake` appended to it.
+			# @parameter current [String] The path to add.
+			def append_path(current = Dir.pwd, **options)
+				bake_path = File.join(current, "bake")
+				
+				if File.directory?(bake_path)
+					return insert(bake_path, **options)
+				end
+				
+				return false
+			end
+			
+			# Add registry according to the current working directory and loaded gems.
+			# @parameter working_directory [String]
+			def append_defaults(working_directory)
+				# Load recipes from working directory:
+				self.append_path(working_directory)
+				
+				# Load recipes from loaded gems:
+				self.append_from_gems
+			end
+			
+			# Enumerate all loaded gems and add them.
+			def append_from_gems
+				::Gem.loaded_specs.each do |name, spec|
+					Console.debug(self) {"Checking gem #{name}: #{spec.full_gem_path}..."}
+					
+					if path = spec.full_gem_path and File.directory?(path)
+						append_path(path, name: spec.full_name)
+					end
+				end
+			end
+			
+			protected
+			
+			def insert(directory, **options)
+				unless @roots.key?(directory)
+					Console.debug(self) {"Adding #{directory.inspect}"}
+					
+					loader = DirectoryLoader.new(directory, **options)
+					@roots[directory] = loader
+					@ordered << loader
+					
+					return true
+				end
+				
+				return false
+			end
+		end
+	end
+end

data/lib/bake/registry/bakefile_loader.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require_relative '../scope'
+
+module Bake
+	module Registry
+		class BakefileLoader
+			def initialize(path)
+				@path = path
+			end
+			
+			def to_s
+				"#{self.class} #{@path}"
+			end
+			
+			attr :path
+			
+			def each(&block)
+				yield []
+			end
+			
+			def scopes_for(path)
+				if path == []
+					yield Scope.load(@path, [])
+				end
+			end
+		end
+	end
+end

data/lib/bake/registry/directory_loader.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require_relative '../scope'
+
+module Bake
+	module Registry
+		# Represents a directory which contains bakefiles.
+		class DirectoryLoader
+			# Initialize the loader with the specified root path.
+			# @parameter root [String] A file-system path.
+			def initialize(root, name: nil)
+				@root = root
+				@name = name
+			end
+			
+			def to_s
+				"#{self.class} #{@name || @root}"
+			end
+			
+			# The root path for this loader.
+			attr :root
+			
+			# Enumerate all bakefiles within the loaders root directory.
+			#
+			# You can pass the yielded path to {scope_for} to load the corresponding {Scope}.
+			#
+			# @yields {|path| ...}
+			# 	@parameter path [String] The (relative) scope path.
+			def each
+				return to_enum unless block_given?
+				
+				Dir.glob("**/*.rb", base: @root) do |file_path|
+					yield file_path.sub(/\.rb$/, '').split(File::SEPARATOR)
+				end
+			end
+			
+			# Load the {Scope} for the specified relative path within this loader, if it exists.
+			# @parameter path [Array(String)] A relative path.
+			def scopes_for(path)
+				*directory, file = *path
+				
+				file_path = File.join(@root, directory, "#{file}.rb")
+				
+				if File.exist?(file_path)
+					yield Scope.load(file_path, path)
+				end
+			end
+		end
+		
+		class FileLoader
+			def initialize(paths)
+				@paths = paths
+			end
+			
+			def to_s
+				"#{self.class} #{@paths}"
+			end
+			
+			attr :paths
+			
+			def each(&block)
+				@paths.each_key(&block)
+			end
+			
+			def scope_for(path)
+				if file_path = @paths[path]
+					if File.exist?(file_path)
+						return Scope.load(file_path, path)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/bake/registry.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require_relative 'registry/aggregate'
+
+module Bake
+	# Structured access to the working directory and loaded gems for loading bakefiles.
+	module Registry
+		def self.default(...)
+			Aggregate.default(...)
+		end
+	end
+end

data/lib/bake/scope.rb

@@ -11,20 +11,23 @@ module Bake
 		# Load the specified file into a unique scope module, which can then be included into a {Base} instance.
 		def self.load(file_path, path = [])
 			scope = Module.new
+			
+			if scope.respond_to?(:set_temporary_name)
+				scope.set_temporary_name("#{self.name}[#{file_path}]")
+			end
+			
 			scope.extend(self)
 			
 			scope.const_set(:FILE_PATH, file_path)
 			scope.const_set(:PATH, path)
 			
+			# yield scope if block_given?
+			
 			scope.module_eval(File.read(file_path), file_path)
 			
 			return scope
 		end
 		
-		def self.inspect
-			"Bake::Scope<#{self.const_get(:FILE_PATH)}>"
-		end
-		
 		# Recipes defined in this scope.
 		#
 		# @yields {|recipe| ...}
@@ -41,6 +44,12 @@ module Bake
 		end
 		
 		# The path of the file that was used to {load} this scope.
+		def file_path
+			pp file_path_self: self
+			self.const_get(:FILE_PATH)
+		end
+		
+		# The path of the scope, relative to the root of the context.
 		def path
 			self.const_get(:PATH)
 		end

data/lib/bake/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2020-2024, by Samuel Williams.
 
 module Bake
-	VERSION = "0.19.0"
+	VERSION = "0.21.0"
 end

data/lib/bake.rb

@@ -4,6 +4,5 @@
 # Copyright, 2020-2024, by Samuel Williams.
 
 require_relative 'bake/version'
-require_relative 'bake/loaders'
-require_relative 'bake/loader'
+require_relative 'bake/registry'
 require_relative 'bake/context'

data/readme.md

@@ -17,7 +17,17 @@ That being said, Rake and Bake can exist side by side in the same project.
 
 ## Usage
 
-Please see the [project documentation](https://ioquatix.github.io/bake/).
+Please see the [project documentation](https://ioquatix.github.io/bake/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/bake/guides/getting-started/index) - This guide gives a general overview of `bake` and how to use it.
+
+  - [Command Line Interface](https://ioquatix.github.io/bake/guides/command-line-interface/index) - The `bake` command is broken up into two main functions: `list` and `call`.
+
+  - [Project Integration](https://ioquatix.github.io/bake/guides/project-integration/index) - This guide explains how to add `bake` to a Ruby project.
+
+  - [Gem Integration](https://ioquatix.github.io/bake/guides/gem-integration/index) - This guide explains how to add `bake` to a Ruby gem and export standardised tasks for use by other gems and projects.
+
+  - [Input and Output](https://ioquatix.github.io/bake/guides/input-and-output/index) - `bake` has built in tasks for reading input and writing output in different formats. While this can be useful for general processing, there are some limitations, notably that rich object representations like `json` and `yaml` often don't support stream processing.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -87,9 +87,11 @@ files:
 - lib/bake/command/top.rb
 - lib/bake/context.rb
 - lib/bake/documentation.rb
-- lib/bake/loader.rb
-- lib/bake/loaders.rb
 - lib/bake/recipe.rb
+- lib/bake/registry.rb
+- lib/bake/registry/aggregate.rb
+- lib/bake/registry/bakefile_loader.rb
+- lib/bake/registry/directory_loader.rb
 - lib/bake/scope.rb
 - lib/bake/types.rb
 - lib/bake/types/any.rb
@@ -112,7 +114,9 @@ homepage: https://github.com/ioquatix/bake
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://ioquatix.github.io/bake/
   funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/ioquatix/bake.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -121,14 +125,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A replacement for rake with a simpler syntax.

data/lib/bake/loader.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
-
-require_relative 'scope'
-
-module Bake
-	# Represents a directory which contains bakefiles.
-	class Loader
-		# Initialize the loader with the specified root path.
-		# @parameter root [String] A file-system path.
-		def initialize(root, name: nil)
-			@root = root
-			@name = name
-		end
-		
-		def to_s
-			"#{self.class} #{@name || @root}"
-		end
-		
-		# The root path for this loader.
-		attr :root
-		
-		# Enumerate all bakefiles within the loaders root directory.
-		# @yields {|path| ...}
-		# 	@parameter path [String] The Ruby source file path.
-		def each
-			return to_enum unless block_given?
-			
-			Dir.glob("**/*.rb", base: @root) do |file_path|
-				yield file_path.sub(/\.rb$/, '').split(File::SEPARATOR)
-			end
-		end
-		
-		# Load the {Scope} for the specified relative path within this loader, if it exists.
-		# @parameter path [Array(String)] A relative path.
-		def scope_for(path)
-			*directory, file = *path
-			
-			file_path = File.join(@root, directory, "#{file}.rb")
-			
-			if File.exist?(file_path)
-				return Scope.load(file_path, path)
-			end
-		end
-	end
-end

data/lib/bake/loaders.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
-
-require 'console'
-
-require_relative 'loader'
-
-module Bake
-	# Structured access to the working directory and loaded gems for loading bakefiles.
-	class Loaders
-		include Enumerable
-		
-		# Create a loader using the specified working directory.
-		# @parameter working_directory [String]
-		def self.default(working_directory)
-			loaders = self.new
-			
-			loaders.append_defaults(working_directory)
-			
-			return loaders
-		end
-		
-		# Initialize an empty array of loaders.
-		def initialize
-			@roots = {}
-			@ordered = Array.new
-		end
-		
-		# Whether any loaders are defined.
-		# @returns [Boolean]
-		def empty?
-			@ordered.empty?
-		end
-		
-		# Add loaders according to the current working directory and loaded gems.
-		# @parameter working_directory [String]
-		def append_defaults(working_directory)
-			# Load recipes from working directory:
-			self.append_path(working_directory)
-			
-			# Load recipes from loaded gems:
-			self.append_from_gems
-		end
-		
-		# Enumerate the loaders in order.
-		def each(&block)
-			@ordered.each(&block)
-		end
-		
-		# Append a specific project path to the search path for recipes.
-		# The computed path will have `bake` appended to it.
-		# @parameter current [String] The path to add.
-		def append_path(current = Dir.pwd, **options)
-			bake_path = File.join(current, "bake")
-			
-			if File.directory?(bake_path)
-				return insert(bake_path, **options)
-			end
-			
-			return false
-		end
-		
-		# Search from the current working directory until a suitable bakefile is found and add it.
-		# @parameter current [String] The path to start searching from.
-		def append_from_root(current = Dir.pwd, **options)
-			while current
-				Console.logger.debug(self) {"Checking current #{current}..."}
-				
-				append_path(current, **options)
-				
-				parent = File.dirname(current)
-				
-				if current == parent
-					break
-				else
-					current = parent
-				end
-			end
-		end
-		
-		# Enumerate all loaded gems and add them.
-		def append_from_gems
-			::Gem.loaded_specs.each do |name, spec|
-				Console.logger.debug(self) {"Checking gem #{name}: #{spec.full_gem_path}..."}
-				
-				if path = spec.full_gem_path and File.directory?(path)
-					append_path(path, name: spec.full_name)
-				end
-			end
-		end
-		
-		protected
-		
-		def insert(directory, **options)
-			unless @roots.key?(directory)
-				Console.logger.debug(self) {"Adding #{directory.inspect}"}
-				
-				loader = Loader.new(directory, **options)
-				@roots[directory] = loader
-				@ordered << loader
-				
-				return true
-			end
-			
-			return false
-		end
-	end
-end