bake 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50c70583a03c13bc968e740c99eb323b533d650d2f4bdf0184cd3545ddbdfb01
-  data.tar.gz: 50c90c5e197996e3e95f4cabd57a19e1bb0708e9acfe0302f8b33cf734acf0b7
+  metadata.gz: a957f57bf8396c2e06cb82745bf11c87ac287097c77b28500dc14a0abd9accf5
+  data.tar.gz: a4292acbdecb68e4d77b926c01347f09564b59db01d88e8705696ad5d2baab92
 SHA512:
-  metadata.gz: 387d065fd0260080f352043f6288a59527944eb7d8b20af09285b39bafa7b6aedf3490ca497aadcdc4835cf0e2e518f1291998a3cc60292d6088b3eeba779b4c
-  data.tar.gz: 99d16f46df97a26509933df503906d1117487e07ab26e9d526c609128e95902219478ec98fedf3cd9b2ef01603d8a5cdbcf8c280fff4bf9c8bbe5e69d73e6ec5
+  metadata.gz: 3f1af90dd73b4f104f09d8594ff3a36a84ddfbe24038c84207a3e714d850cae0b9d719bb6fc6875ede1cf3908f4b26ab02ec1562ae518e3dd2ab7fed1f0a9c2c
+  data.tar.gz: d1639bd8ca01c56450406055f51a22a70d46bffc8b999a04ea35e80180ed672a6ae7ab5bc37046359c563c1989e5a82aa04932521ad1b4f4ca119d8a8ad63883

data/bake.rb

@@ -0,0 +1,4 @@
+
+# A test method.
+def test
+end

data/lib/bake/base.rb

@@ -0,0 +1,76 @@
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'recipe'
+require_relative 'scope'
+
+module Bake
+	class Base < Struct.new(:context)
+		def self.derive(path = [])
+			klass = Class.new(self)
+			
+			klass.const_set(:PATH, path)
+			
+			return klass
+		end
+		
+		def self.to_s
+			if path = self.path
+				path.join(':')
+			else
+				super
+			end
+		end
+		
+		def self.inspect
+			if path = self.path
+				"Bake::Base<#{path.join(':')}>"
+			else
+				super
+			end
+		end
+		
+		def self.path
+			self.const_get(:PATH)
+		rescue
+			nil
+		end
+		
+		def path
+			self.class.path
+		end
+		
+		def call(*arguments)
+			self.context.call(*arguments)
+		end
+		
+		def recipes
+			names = self.public_methods - Base.public_instance_methods
+			
+			names.each do |name|
+				yield recipe_for(name)
+			end
+		end
+		
+		def recipe_for(name)
+			Recipe.new(self, name)
+		end
+	end
+end

data/lib/bake/command/{invoke.rb → call.rb}

@@ -26,12 +26,8 @@ require_relative '../context'
 
 module Bake
 	module Command
-		class Invoke < Samovar::Command
-			self.description = "Invoke one or more commands."
-			
-			options do
-				option "-d/--describe", "Describe what will be done, but don't do it.", default: false
-			end
+		class Call < Samovar::Command
+			self.description = "Execute one or more commands."
 			
 			def bakefile
 				@parent.bakefile
@@ -60,7 +56,7 @@ module Bake
 				
 				self.update_working_directory
 				
-				context.call(*@commands, **@options)
+				context.call(*@commands)
 			end
 		end
 	end

data/lib/bake/command/list.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'samovar'
+require 'set'
 
 module Bake
 	module Command
@@ -49,41 +50,34 @@ module Bake
 				end
 			end
 			
-			def call
-				first = true
-				terminal = @parent.terminal
-				context = @parent.context
+			def print_scope(terminal, scope)
 				format_recipe = self.method(:format_recipe).curry
 				
-				unless context.empty?
-					terminal.print_line(:loader, context)
+				scope.recipes do |recipe|
+					terminal.print_line
+					terminal.print_line("\t", format_recipe[recipe])
 					
-					context.each do |recipe|
-						terminal.print_line
-						terminal.print_line("\t", format_recipe[recipe])
-						if description = recipe.description
-							terminal.print_line("\t\t", :description, description)
-						end
+					recipe.description.each do |line|
+						terminal.print_line("\t\t", :description, line)
 					end
-					
-					terminal.print_line
 				end
 				
+				terminal.print_line
+			end
+			
+			def call
+				first = true
+				terminal = @parent.terminal
+				context = @parent.context
+				
+				print_scope(terminal, context.scope)
+				
 				context.loaders.each do |loader|
-					terminal.print_line unless first
-					first = false
-					
 					terminal.print_line(:loader, loader)
+					
 					loader.each do |path|
-						if book = loader.lookup(path)
-							# terminal.print_line("\t", book)
-							book.each do |recipe|
-								terminal.print_line
-								terminal.print_line("\t", format_recipe[recipe])
-								if description = recipe.description
-									terminal.print_line("\t\t", :description, description)
-								end
-							end
+						if scope = loader.scope_for(path)
+							print_scope(terminal, scope)
 						end
 					end
 					

data/lib/bake/command/top.rb

@@ -21,7 +21,7 @@
 require 'samovar'
 require 'console/terminal'
 
-require_relative 'invoke'
+require_relative 'call'
 require_relative 'list'
 
 module Bake
@@ -53,9 +53,9 @@ module Bake
 			end
 			
 			nested :command, {
-				'invoke' => Invoke,
+				'call' => Call,
 				'list' => List,
-			}, default: 'invoke'
+			}, default: 'call'
 			
 			def terminal(out = $stdout)
 				terminal = Console::Terminal.for(out)
@@ -85,16 +85,10 @@ module Bake
 			end
 			
 			def context
-				loaders = Loaders.new
-				
 				if bakefile = self.bakefile
-					context = Context.load(self.bakefile, loaders)
+					return Context.load(self.bakefile)
 				else
-					context = Context.new(loaders)
-				end
-				
-				if loaders.empty?
-					loaders.append_defaults(working_directory)
+					raise "Cannot find `bake.rb` file."
 				end
 				
 				return context

data/lib/bake/context.rb

@@ -18,86 +18,108 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'base'
+
 module Bake
-	class Context < Book
-		def initialize(loaders, **options)
-			@loaders = loaders
+	class Context
+		def self.load(file_path, loaders = nil)
+			scope = Scope.load(file_path)
 			
-			@scope = []
+			unless loaders
+				if scope.respond_to?(:loaders)
+					loaders = scope.loaders
+				else
+					working_directory = File.dirname(file_path)
+					loaders = Loaders.default(working_directory)
+				end
+			end
 			
-			super(**options)
+			self.new(scope, loaders)
 		end
 		
-		def to_s
-			self.class.name
+		def initialize(scope, loaders, **options)
+			base = Base.derive
+			base.prepend(scope)
+			
+			@loaders = loaders
+			
+			@stack = []
+			
+			@scopes = Hash.new do |hash, key|
+				hash[key] = scope_for(key)
+			end
+			
+			@scope = base.new(self)
+			@scopes[[]] = @scope
+			
+			@recipes = Hash.new do |hash, key|
+				hash[key] = recipe_for(key)
+			end
 		end
 		
+		attr :scope
 		attr :loaders
 		
 		def call(*commands)
 			while command = commands.shift
-				if recipes = recipes_for(command)
-					arguments, options = recipes.first.prepare(commands)
-					
-					recipes.each do |recipe|
-						with(recipe) do
-							yield recipe, arguments, options if block_given?
-							recipe.call(self, *arguments, **options)
-						end
-					end
+				if recipe = @recipes[command]
+					arguments, options = recipe.prepare(commands)
+					recipe.call(*arguments, **options)
 				else
 					raise ArgumentError, "Could not find recipe for #{command}!"
 				end
 			end
 		end
 		
+		def lookup(command)
+			@recipes[command]
+		end
+		
 		private
 		
-		def with(recipe)
-			@scope << recipe.book
+		def recipe_for(command)
+			path = command.split(":")
 			
-			yield
-		ensure
-			@scope.pop
-		end
-		
-		def recipes_for(command)
-			if command.is_a?(Symbol)
-				recipes_for_relative_reference(command)
+			if scope = @scopes[path]
+				return scope.recipe_for(path.last)
 			else
-				recipes_for_absolute_reference(command)
+				*path, name = *path
+				
+				if scope = @scopes[path]
+					return scope.recipe_for(name)
+				end
 			end
+			
+			return nil
 		end
 		
-		def recipes_for_relative_reference(command)
-			if scope = @scope.last
-				if recipe = scope.lookup(command)
-					return [recipe]
-				end
+		def scope_for(path)
+			if base = base_for(path)
+				return base.new(self)
 			end
 		end
 		
-		def recipes_for_absolute_reference(command)
-			path = command.split(":")
-			
-			recipes = []
-			
-			# Get the root level recipes:
-			if recipe = self.recipe_for(path)
-				recipes << recipe
-			end
+		# @param scope [Array<String>] the path for the scope.
+		def base_for(path)
+			base = nil
 			
 			@loaders.each do |loader|
-				if recipe = loader.recipe_for(path)
-					recipes << recipe
+				if scope = loader.scope_for(path)
+					base ||= Base.derive(path)
+					
+					base.prepend(scope)
 				end
 			end
 			
-			if recipes.empty?
-				return nil
-			else
-				return recipes
-			end
+			return base
+		end
+		
+		def with!(scope)
+			@stack << scope
+			
+			yield
+		ensure
+			@scope.pop
 		end
 	end
 end

data/lib/bake/loader.rb

@@ -18,14 +18,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'book'
+require_relative 'scope'
 
 module Bake
 	class Loader
 		def initialize(root, name: nil)
 			@root = root
 			@name = name
-			@cache = {}
 		end
 		
 		def to_s
@@ -54,22 +53,14 @@ module Bake
 			end
 		end
 		
-		def lookup(path)
+		def scope_for(path)
 			*directory, file = *path
 			
 			file_path = File.join(@root, directory, "#{file}.rb")
 			
-			unless @cache.key?(path)
-				if File.exist?(file_path)
-					book = Book.load(file_path, path)
-					
-					@cache[path] = book
-				else
-					@cache[path] = nil
-				end
+			if File.exist?(file_path)
+				return Scope.load(file_path, path)
 			end
-			
-			return @cache[path]
 		end
 	end
 end

data/lib/bake/loaders.rb

@@ -20,11 +20,19 @@
 
 require 'console'
 
+require_relative 'loader'
+
 module Bake
 	class Loaders
 		include Enumerable
 		
-		RECIPES_PATH = "recipes"
+		def self.default(working_directory)
+			loaders = self.new
+			
+			loaders.append_defaults(working_directory)
+			
+			return loaders
+		end
 		
 		def initialize
 			@roots = {}
@@ -49,12 +57,24 @@ module Bake
 			@ordered.each(&block)
 		end
 		
-		def append_path(current = Dir.pwd, recipes_path: RECIPES_PATH, **options)
-			recipes_path = File.join(current, recipes_path)
+		def append_path(current = Dir.pwd, **options)
+			recipes_path = File.join(current, "recipes")
+			bake_path = File.join(current, "bake")
+			
+			if File.directory?(bake_path)
+				return insert(bake_path, **options)
+			end
 			
 			if File.directory?(recipes_path)
-				insert(recipes_path, **options)
+				Console.logger.warn(self) do |buffer|
+					buffer.puts "Recipes path: #{recipes_path.inspect} is deprecated."
+					buffer.puts "Please use #{bake_path.inspect} instead."
+				end
+				
+				return insert(recipes_path, **options)
 			end
+			
+			return false
 		end
 		
 		def append_from_root(current = Dir.pwd, **options)
@@ -91,13 +111,7 @@ module Bake
 		
 		def insert(directory, **options)
 			unless @roots.key?(directory)
-				Console.logger.debug(self) do
-					if path
-						"Adding #{directory.inspect} for #{path.inspect}."
-					else
-						"Adding #{directory.inspect}"
-					end
-				end
+				Console.logger.debug(self) {"Adding #{directory.inspect}"}
 				
 				loader = Loader.new(directory, **options)
 				@roots[directory] = loader

data/lib/bake/recipe.rb

@@ -20,50 +20,55 @@
 
 module Bake
 	class Recipe
-		def initialize(book, name, description: nil, &block)
-			@book = book
+		def initialize(scope, name, method = nil)
+			@scope = scope
 			@name = name
-			@description = description
-			@block = block
-		end
-		
-		attr :book
-		attr :description
-		
-		def options?
-			type, name = @block.parameters.last
+			@description = nil
 			
-			return type == :keyrest || type == :keyreq || type == :key
+			@method = method
 		end
 		
-		def command
-			if @book.path.empty?
-				@name.to_s
-			elsif @book.path.last.to_sym == @name
-				@book.to_s
-			else
-				"#{@book}:#{@name}"
-			end
+		attr :scope
+		attr :name
+		
+		def method
+			@method ||= @scope.method(@name)
 		end
 		
 		def parameters
-			parameters = @block.parameters
+			parameters = method.parameters
 			
 			unless parameters.empty?
 				return parameters
 			end
 		end
 		
-		def to_s
-			if @description
-				"#{self.command} #{@description}"
+		def options?
+			if parameters = self.parameters
+				type, name = self.parameters.last
+				
+				return type == :keyrest || type == :keyreq || type == :key
+			end
+		end
+		
+		def command
+			path = @scope.path
+			
+			if path.empty?
+				@name.to_s
+			elsif path.last.to_sym == @name
+				path.join(':')
 			else
-				self.command
+				(path + [@name]).join(':')
 			end
 		end
 		
+		def to_s
+			self.command
+		end
+		
 		def arity
-			@block.arity
+			method.arity
 		end
 		
 		def prepare(arguments)
@@ -90,12 +95,12 @@ module Bake
 			return ordered, options
 		end
 		
-		def call(context, *arguments, **options)
+		def call(*arguments, **options)
 			if options?
-				context.instance_exec(*arguments, **options, &@block)
+				@scope.send(@name, *arguments, **options)
 			else
 				# Ignore options...
-				context.instance_exec(*arguments, &@block)
+				@scope.send(@name, *arguments)
 			end
 		end
 		
@@ -106,5 +111,39 @@ module Bake
 				puts "#{self}(#{arguments.join(", ")})"
 			end
 		end
+		
+		def description
+			@description ||= read_description
+		end
+		
+		private
+		
+		def read_description
+			file, line_number = self.method.source_location
+			
+			lines = File.readlines(file)
+			line_index = line_number - 1
+			
+			# Legacy "recipe" syntax:
+			if match = lines[line_index].match(/description: "(.*?)"/)
+				return [match[1]]
+			end
+			
+			description = []
+			line_index -= 1
+			
+			# Extract comment preceeding method:
+			while line = lines[line_index]
+				if match = line.match(/^\s*\#\s?(.*?)$/)
+					description.unshift(match[1])
+				else
+					break
+				end
+				
+				line_index -= 1
+			end
+			
+			return description
+		end
 	end
 end

data/lib/bake/{book.rb → scope.rb}

@@ -21,53 +21,41 @@
 require_relative 'recipe'
 
 module Bake
-	class Book
-		def self.load(file_path, *arguments, **options)
-			instance = self.new(*arguments, **options)
+	module Scope
+		def self.load(file_path, path = [])
+			scope = Module.new
+			scope.extend(self)
 			
-			instance.freeze
+			scope.const_set(:FILE_PATH, file_path)
+			scope.const_set(:PATH, path)
 			
-			instance.instance_eval(File.read(file_path), file_path)
+			scope.module_eval(File.read(file_path), file_path)
 			
-			return instance
+			return scope
 		end
 		
-		def initialize(path = [], **options)
-			@path = path
-			@recipes = {}
+		def self.inspect
+			"Bake::Scope<#{self.const_get(:FILE_PATH)}>"
 		end
 		
-		def empty?
-			@recipes.empty?
-		end
-		
-		def each(&block)
-			@recipes.each_value(&block)
-		end
-		
-		attr :path
-		attr :recipes
-		
-		def to_s
-			@path.join(':')
+		def recipe(name, **options, &block)
+			define_method(name, &block)
 		end
 		
-		def lookup(name)
-			@recipes[name.to_sym]
+		def recipes
+			names = self.instance_methods
+			
+			names.each do |name|
+				yield recipe_for(name)
+			end
 		end
 		
-		def recipe_for(path)
-			if path.size == 1
-				lookup(path.first)
-			end
+		def path
+			self.const_get(:PATH)
 		end
 		
-		def recipe(name, **options, &block)
-			unless block_given?
-				block = self.method(name)
-			end
-			
-			@recipes[name] = Recipe.new(self, name, **options, &block)
+		def recipe_for(name)
+			Recipe.new(self, name, self.instance_method(name))
 		end
 	end
 end

data/lib/bake/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Bake
-	VERSION = "0.2.1"
+	VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bake
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: samovar
@@ -94,19 +94,21 @@ files:
 - README.md
 - Rakefile
 - bake.gemspec
+- bake.rb
 - bin/bake
 - example.png
 - gems.rb
 - lib/bake.rb
-- lib/bake/book.rb
+- lib/bake/base.rb
 - lib/bake/command.rb
-- lib/bake/command/invoke.rb
+- lib/bake/command/call.rb
 - lib/bake/command/list.rb
 - lib/bake/command/top.rb
 - lib/bake/context.rb
 - lib/bake/loader.rb
 - lib/bake/loaders.rb
 - lib/bake/recipe.rb
+- lib/bake/scope.rb
 - lib/bake/version.rb
 homepage: https://github.com/ioquatix/bake
 licenses:
@@ -128,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A replacement for rake with a simpler syntax.