bake 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5064c2fb5970db1bfd61752e337a35cb1130655d2aa712cac405c4ef9b5ac99
-  data.tar.gz: 34c28cb42f472d9cdb02bcde6576a784d7b9a1beeda8ffde67ddd1a16e7b2cdd
+  metadata.gz: 50c70583a03c13bc968e740c99eb323b533d650d2f4bdf0184cd3545ddbdfb01
+  data.tar.gz: 50c90c5e197996e3e95f4cabd57a19e1bb0708e9acfe0302f8b33cf734acf0b7
 SHA512:
-  metadata.gz: 2aba107faf34db34af932925c0c6ba34fb906a7bd68a10c5ae286f537ba2ad1b085e01a3d7390f88225809fdf0570edb81522e8df98ff7f476b2b22613de5e98
-  data.tar.gz: 5e75149322e7668879aaee32eea149dfdcbb98540f60bb29695fd4e5651a917b04f75d957a4710f77d5067e43e4eeb855d010ff31e85daa27ad3e700073fdacd
+  metadata.gz: 387d065fd0260080f352043f6288a59527944eb7d8b20af09285b39bafa7b6aedf3490ca497aadcdc4835cf0e2e518f1291998a3cc60292d6088b3eeba779b4c
+  data.tar.gz: 99d16f46df97a26509933df503906d1117487e07ab26e9d526c609128e95902219478ec98fedf3cd9b2ef01603d8a5cdbcf8c280fff4bf9c8bbe5e69d73e6ec5

data/.github/workflows/development.yml

@@ -0,0 +1,35 @@
+name: Development
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+        
+        include:
+          - os: 'ubuntu'
+            ruby: '2.6'
+            env: COVERAGE=PartialSummary,Coveralls
+    
+    runs-on: ${{matrix.os}}-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+    - name: Install dependencies
+      run: |
+        command -v bundler || gem install bundler
+        bundle install
+    - name: Run tests
+      run: ${{matrix.env}} bundle exec rspec

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+gems.locked
+
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,6 +1,8 @@
-# Bake
+# Bake ![Development](https://github.com/ioquatix/bake/workflows/Development/badge.svg)
 
-Bake is a task execution tool, inspired by Rake, but codifying many of the typical use cases which are typically implemented in an ad-hoc manner.
+Bake is a task execution tool, inspired by Rake, but codifying many of the use cases which are typically implemented in an ad-hoc manner.
+
+![Example](example.png)
 
 ## Motivation
 
@@ -28,27 +30,30 @@ Bake follows similar patterns to Rake.
 There is a root level `bake.rb` which contains project-specific configuration and recipes, e.g.:
 
 ```ruby
-recipe :deploy do
-	call 'activerecord:migrations:deploy'
-	call 'falcon:server:restart'
+recipe :cake do
+	call 'supermarket:shop', 'flour,sugar,cocoa'
+	call 'mixer:add', 'everything'
 end
 ```
 
-This file is project specific and is the only file which can expose top level tasks (i.e. without a defined namespace).
+This file is project specific and is the only file which can expose top level tasks (i.e. without a defined namespace). When used in a gem, these tasks are not exposed to other gems/projects.
 
 ## Recipes
 
-Alongside the `bake.rb`, there is a `recipes/` directory which contains files like `icons.rb`. These files contain recipes, e.g.:
+Alongside the `bake.rb`, there is a `recipes/` directory which contains files like `supermarket.rb`. These files contain recipes, e.g.:
 
 ```ruby
-recipe :generate do |name|
-	MyProject::Icons::Generate.call(name)
+recipe :shop do |ingredients|
+	supermarket = Supermarket.best
+	supermarket.shop(ingredients.split(","))
 end
 ```
 
+These recipes are automatically scoped according to the file name, e.g. `recipes/supermarket.rb` with `recipe :shop` will define `supermarket:shop`.
+
 ## Gems
 
-Adding a `recipes/` directory to your gem, will expose those tasks to any project that depends on your gem. In order to prevent collisions, imported commands are prefixed with the name of the gem. If you want to provide top level commands, you may do so by naming a recipe the same as the namespace which encloses it, e.g. in `mygem/recipes/setup.rb`:
+Adding a `recipes/` directory to your gem will allow other gems and projects to consume those recipes. In order to prevent collisions, you *should* prefix your commands with the name of the gem, e.g. in `mygem/recipes/mygem.rb`:
 
 ```ruby
 recipe :setup do
@@ -62,6 +67,30 @@ Then, in your project `myproject` which depends on `mygem`:
 bake mygem:setup
 ```
 
+## Arguments
+
+Both positional and optional parameters are supported, e.g.:
+
+### Positional Parameters
+
+```ruby
+recipe :add do |x, y|
+	puts Integer(x) + Integer(y)
+end
+```
+
+Which is invoked by `bake add 1 2`.
+
+### Optional Parameters
+
+```ruby
+recipe :add do |x:, y:|
+	puts Integer(x) + Integer(y)
+end
+```
+
+Which is invoked by `bake add x=1 y=2`.
+
 ## Contributing
 
 1. Fork it

data/bake.gemspec

@@ -22,4 +22,9 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 	
 	spec.add_dependency 'samovar', '~> 2.1'
+	
+	spec.add_development_dependency 'covered'
+	spec.add_development_dependency 'bundler'
+	spec.add_development_dependency 'rspec'
+	spec.add_development_dependency 'rake'
 end

data/{Gemfile → gems.rb}

@@ -3,5 +3,3 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in bake.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/lib/bake/book.rb

@@ -69,11 +69,5 @@ module Bake
 			
 			@recipes[name] = Recipe.new(self, name, **options, &block)
 		end
-		
-		def attach(name, callable, **options)
-			@recipes[name] = Recipe.new(self, name, **options) do |*arguments, **options|
-				callable.call(*arguments, **options)
-			end
-		end
 	end
 end

data/lib/bake/command/invoke.rb

@@ -53,7 +53,7 @@ module Bake
 				return nil
 			end
 			
-			many :commands, "The commands & arguments to invoke."
+			many :commands, "The commands & arguments to invoke.", default: ["default"]
 			
 			def call
 				context = @parent.context

data/lib/bake/command/list.rb

@@ -26,6 +26,8 @@ module Bake
 			def format_parameters(parameters, terminal)
 				parameters.each do |type, name|
 					case type
+					when :key
+						name = "#{name}="
 					when :keyreq
 						name = "#{name}="
 					when :keyrest
@@ -34,7 +36,8 @@ module Bake
 						name = name.to_s
 					end
 					
-					terminal.print(type, name, " ")
+					terminal.print(:reset, " ")
+					terminal.print(type, name)
 				end
 			end
 			
@@ -42,12 +45,12 @@ module Bake
 				terminal.print(:command, recipe.command)
 				
 				if parameters = recipe.parameters
-					terminal.write(" ")
 					format_parameters(parameters, terminal)
 				end
 			end
 			
 			def call
+				first = true
 				terminal = @parent.terminal
 				context = @parent.context
 				format_recipe = self.method(:format_recipe).curry
@@ -56,19 +59,35 @@ module Bake
 					terminal.print_line(:loader, context)
 					
 					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
 					end
+					
+					terminal.print_line
 				end
 				
 				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
 						end
 					end
+					
+					terminal.print_line
 				end
 			end
 		end

data/lib/bake/command/top.rb

@@ -61,9 +61,10 @@ module Bake
 				terminal = Console::Terminal.for(out)
 				
 				terminal[:loader] = terminal.style(nil, nil, :bold)
-				terminal[:command] = terminal.style(:blue)
+				terminal[:command] = terminal.style(nil, nil, :bold)
+				terminal[:description] = terminal.style(:blue)
 				
-				terminal[:opt] = terminal.style(:green)
+				terminal[:key] = terminal[:opt] = terminal.style(:green)
 				terminal[:req] = terminal.style(:red)
 				terminal[:keyreq] = terminal.style(:red, nil, :bold)
 				terminal[:keyrest] = terminal.style(:green)

data/lib/bake/context.rb

@@ -34,18 +34,15 @@ module Bake
 		
 		attr :loaders
 		
-		def call(*commands, describe: false)
+		def call(*commands)
 			while command = commands.shift
 				if recipes = recipes_for(command)
 					arguments, options = recipes.first.prepare(commands)
 					
 					recipes.each do |recipe|
-						if describe
-							recipe.explain(self, *arguments, **options)
-						else
-							with(recipe) do
-								recipe.call(self, *arguments, **options)
-							end
+						with(recipe) do
+							yield recipe, arguments, options if block_given?
+							recipe.call(self, *arguments, **options)
 						end
 					end
 				else

data/lib/bake/loader.rb

@@ -22,9 +22,8 @@ require_relative 'book'
 
 module Bake
 	class Loader
-		def initialize(root, path = nil, name: nil)
+		def initialize(root, name: nil)
 			@root = root
-			@path = path
 			@name = name
 			@cache = {}
 		end
@@ -39,13 +38,7 @@ module Bake
 			return to_enum unless block_given?
 			
 			Dir.glob("**/*.rb", base: @root) do |file_path|
-				path = file_path.sub(/\.rb$/, '').split(File::SEPARATOR)
-				
-				if @path
-					yield(@path + path)
-				else
-					yield(path)
-				end
+				yield file_path.sub(/\.rb$/, '').split(File::SEPARATOR)
 			end
 		end
 		
@@ -64,7 +57,7 @@ module Bake
 		def lookup(path)
 			*directory, file = *path
 			
-			file_path = File.join(@root, @path || [], directory, "#{file}.rb")
+			file_path = File.join(@root, directory, "#{file}.rb")
 			
 			unless @cache.key?(path)
 				if File.exist?(file_path)

data/lib/bake/loaders.rb

@@ -49,11 +49,11 @@ module Bake
 			@ordered.each(&block)
 		end
 		
-		def append_path(current = Dir.pwd, recipes_path: RECIPES_PATH, path: nil, **options)
+		def append_path(current = Dir.pwd, recipes_path: RECIPES_PATH, **options)
 			recipes_path = File.join(current, recipes_path)
 			
 			if File.directory?(recipes_path)
-				insert(recipes_path, path, **options)
+				insert(recipes_path, **options)
 			end
 		end
 		
@@ -73,8 +73,10 @@ module Bake
 		
 		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, path: name, name: spec.full_name)
+					append_path(path, name: spec.full_name)
 				end
 			end
 		end
@@ -87,7 +89,7 @@ module Bake
 		
 		protected
 		
-		def insert(directory, path, **options)
+		def insert(directory, **options)
 			unless @roots.key?(directory)
 				Console.logger.debug(self) do
 					if path
@@ -97,7 +99,7 @@ module Bake
 					end
 				end
 				
-				loader = Loader.new(directory, path, **options)
+				loader = Loader.new(directory, **options)
 				@roots[directory] = loader
 				@ordered << loader
 				

data/lib/bake/recipe.rb

@@ -28,11 +28,12 @@ module Bake
 		end
 		
 		attr :book
+		attr :description
 		
 		def options?
 			type, name = @block.parameters.last
 			
-			return type == :keyrest
+			return type == :keyrest || type == :keyreq || type == :key
 		end
 		
 		def command

data/lib/bake/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - samuel.williams@oriontransfer.co.nz
@@ -32,15 +88,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/development.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bake.gemspec
 - bin/bake
+- example.png
+- gems.rb
 - lib/bake.rb
 - lib/bake/book.rb
 - lib/bake/command.rb
@@ -72,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A replacement for rake with a simpler syntax.

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.2

data/Gemfile.lock

@@ -1,40 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bake (0.2.0)
-      samovar (~> 2.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    console (1.8.0)
-    diff-lcs (1.3)
-    mapping (1.1.1)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    samovar (2.1.4)
-      console (~> 1.0)
-      mapping (~> 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bake!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.2