bake 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7693473d81becf64ea8f5013fe414eb85ecbe82c7924b6aae745c8453eef648
-  data.tar.gz: 9f0df220a0530195b8729b2338860dae28ee3b6d1fbddb004659584d4e7dc603
+  metadata.gz: 9cb4cc20cba975f1a38dc28b9943bdde9316c5c0f39f930666c6f88551852e47
+  data.tar.gz: dd2771c79e248dfac2d1815b6bcbe7b3d23f5c90d7f9fb4da14bdc6feb7e9ca2
 SHA512:
-  metadata.gz: 7b946cde875cd3d8a74fed3d25f9cd5a80ea0ecc7d48868d3f329f1b69ca6184f07f9b0f9df57b529f7b046c96a524321ac9ed02c087bb77c87088d0be620dee
-  data.tar.gz: fd987404064a8fd051c671380dbf3f7c24cf7ef8dc83b0bd9664adc3b32ac89a03ab507960dba2a3bcf291f53680a7e0b58c03426be2496093ef8d536ab0f005
+  metadata.gz: dd9803830df096d57ef548305bdf120899db1a8f85961f14272c50eaa4829d1293ed4adabf084a75a68b291d545d8d7892df8aeeedf5f9ebfe1e6190499d50ec
+  data.tar.gz: 56240dbb1d65c116c6bb48afcb51f6338c34cdc1058c3c1aaeba01b774311182fc51bd6cb1484bcdaaaf422f242e650754613df0a3f193f12f8b27657bb7d86f

data/README.md

@@ -27,12 +27,12 @@ Bake follows similar patterns to Rake.
 
 ## Bakefile
 
-There is a root level `bake.rb` which contains project-specific configuration and recipes, e.g.:
+There is a root level `bake.rb` e.g.:
 
 ```ruby
-recipe :cake do
-	call 'supermarket:shop', 'flour,sugar,cocoa'
-	call 'mixer:add', 'everything'
+def cake
+	ingredients = call 'supermarket:shop', 'flour,sugar,cocoa'
+	lookup('mixer:add').call(ingredients)
 end
 ```
 
@@ -40,23 +40,25 @@ This file is project specific and is the only file which can expose top level ta
 
 ## Recipes
 
-Alongside the `bake.rb`, there is a `recipes/` directory which contains files like `supermarket.rb`. These files contain recipes, e.g.:
+Alongside the `bake.rb`, there is a `bake/` directory which contains files like `supermarket.rb`. These files contain recipes, e.g.:
 
 ```ruby
-recipe :shop do |ingredients|
+# @param ingredients [Array(Any)] the ingredients to purchase.
+def shop(ingredients)
 	supermarket = Supermarket.best
-	supermarket.shop(ingredients.split(","))
+	
+	return supermarket.purchase(ingredients)
 end
 ```
 
-These recipes are automatically scoped according to the file name, e.g. `recipes/supermarket.rb` with `recipe :shop` will define `supermarket:shop`.
+These methods are automatically scoped according to the file name, e.g. `bake/supermarket.rb` will define `supermarket:shop`.
 
 ## Gems
 
-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`:
+Adding a `bake/` 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/bake/mygem.rb`:
 
 ```ruby
-recipe :setup do
+def setup
 	# ...
 end
 ```
@@ -69,13 +71,15 @@ bake mygem:setup
 
 ## Arguments
 
-Both positional and optional parameters are supported, e.g.:
+Arguments work as normal. Documented types are used to parse strings from the command line. Both positional and optional parameters are supported.
 
 ### Positional Parameters
 
 ```ruby
-recipe :add do |x, y|
-	puts Integer(x) + Integer(y)
+# @param x [Integer]
+# @param y [Integer]
+def add(x, y)
+	puts x + y
 end
 ```
 
@@ -84,8 +88,10 @@ Which is invoked by `bake add 1 2`.
 ### Optional Parameters
 
 ```ruby
-recipe :add do |x:, y:|
-	puts Integer(x) + Integer(y)
+# @param x [Integer]
+# @param y [Integer]
+def add(x:, y:)
+	puts x + y
 end
 ```
 
@@ -101,6 +107,8 @@ Which is invoked by `bake add x=1 y=2`.
 
 ## See Also
 
+- [Console](https://github.com/socketry/console) — A logging framework which integrates with bake.
+- [Variant](https://github.com/socketry/variant) — A framework for selecting different environments, including bake tasks.
 - [Utopia](https://github.com/socketry/utopia) — A website framework which uses bake for maintenance tasks.
 
 ## License

data/lib/bake/recipe.rb

@@ -24,8 +24,8 @@ module Bake
 	PARAMETER = /@param\s+(?<name>.*?)\s+\[(?<type>.*?)\]\s+(?<details>.*?)\Z/
 	
 	class Recipe
-		def initialize(scope, name, method = nil)
-			@scope = scope
+		def initialize(instance, name, method = nil)
+			@instance = instance
 			@name = name
 			@command = nil
 			@description = nil
@@ -35,7 +35,7 @@ module Bake
 			@arity = nil
 		end
 		
-		attr :scope
+		attr :instance
 		attr :name
 		
 		def <=> other
@@ -43,7 +43,7 @@ module Bake
 		end
 		
 		def method
-			@method ||= @scope.method(@name)
+			@method ||= @instance.method(@name)
 		end
 		
 		def source_location
@@ -121,10 +121,10 @@ module Bake
 		
 		def call(*arguments, **options)
 			if options?
-				@scope.send(@name, *arguments, **options)
+				@instance.send(@name, *arguments, **options)
 			else
 				# Ignore options...
-				@scope.send(@name, *arguments)
+				@instance.send(@name, *arguments)
 			end
 		end
 		
@@ -147,7 +147,7 @@ module Bake
 		private
 		
 		def compute_command
-			path = @scope.path
+			path = @instance.path
 			
 			if path.empty?
 				@name.to_s

data/lib/bake/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -140,7 +140,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.