bake 0.11.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f99be0a2f861aa6bbfad669012adabb50a63b50284cfbd08184c51aa1ccd833
-  data.tar.gz: d2ed3be69422c1b17e127cc6b3d31097f7203e4ab5fa1260076309659f7a31f8
+  metadata.gz: e5791d094c972d0cec6fa96e65bb0727703a08cde7cf669e82391d5e5783b5dd
+  data.tar.gz: 3f096c089469cb615756a3748f8150e504a39f7910eca170de5d2f39323af796
 SHA512:
-  metadata.gz: 865d204e2390a3ac306c8c9c4e84c779b5070b9356030395ce02b08a0f4a8bb8343912354f47bf7f7f72203be5b8b4a20975e7df549564fc1c3deead1bbcc489
-  data.tar.gz: 7eba460839a07814c3ee432d775789b65a810c876b20e1bb201d2092cdf80c7388a4397613cdd06e608f730ce8613644b99749964fbc7944dbf74d9ed06cd7b6
+  metadata.gz: 8bfa10d9641df00861b68593c4e65731e9e5083550fce23e4e4f3996161ff563fafd9d5de6b19be69a64b33dab986afcd0e89caad07edfe9a3006bfb63a41df8
+  data.tar.gz: e4e3b5fb27bb7bccc0b4f0c2aa3fa4befdedb76a177a2350cf192c77d82b46e192eec9ee62829f01775acfde392ba43bbca6a00d4b01ac83172687595b459a81

data/README.md

@@ -2,9 +2,9 @@
 
 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.
 
-[![Actions Status](https://github.com/ioquatix/bake/workflows/Development/badge.svg)](https://github.com/ioquatix/bake/actions?workflow=Development)
+[![Development](https://github.com/ioquatix/bake/workflows/Development/badge.svg)](https://github.com/ioquatix/bake/actions?workflow=Development)
 
-## Motivation
+## Features
 
 Rake is an awesome tool and loved by the community. So, why reinvent it? Bake provides the following features that Rake does not:
 
@@ -15,97 +15,20 @@ Rake is an awesome tool and loved by the community. So, why reinvent it? Bake pr
 
 That being said, Rake and Bake can exist side by side in the same project.
 
-## Installation
-
-Execute the following in your project:
-
-	bundle add bake
-
 ## Usage
 
-Bake follows similar patterns to Rake.
-
-![Example](example.png)
-
-## Bakefile
-
-There is a root level `bake.rb` e.g.:
-
-```ruby
-def cake
-	ingredients = call 'supermarket:shop', 'flour,sugar,cocoa'
-	lookup('mixer:add').call(ingredients)
-end
-```
-
-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 `bake/` directory which contains files like `supermarket.rb`. These files contain recipes, e.g.:
-
-```ruby
-# @param ingredients [Array(Any)] the ingredients to purchase.
-def shop(ingredients)
-	supermarket = Supermarket.best
-	
-	return supermarket.purchase(ingredients)
-end
-```
-
-These methods are automatically scoped according to the file name, e.g. `bake/supermarket.rb` will define `supermarket:shop`.
-
-## Gems
+Please see the [project documentation](https://ioquatix.github.io/bake/).
 
-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
-def setup
-	# ...
-end
-```
-
-Then, in your project `myproject` which depends on `mygem`:
-
-```
-bake mygem:setup
-```
-
-## Arguments
-
-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
-# @param x [Integer]
-# @param y [Integer]
-def add(x, y)
-	puts x + y
-end
-```
-
-Which is invoked by `bake add 1 2`.
-
-### Optional Parameters
-
-```ruby
-# @param x [Integer]
-# @param y [Integer]
-def add(x:, y:)
-	puts x + y
-end
-```
+## Contributing
 
-Which is invoked by `bake add x=1 y=2`.
+We welcome contributions to this project.
 
-## Contributing
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
 
 ## See Also
 

data/bake.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
 	spec.metadata["donation_uri"] = "https://github.com/sponsors/ioquatix"
 	
 	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|test|spec|features)/}) }
 	end
 	
 	spec.bindir = "bin"
@@ -23,10 +23,7 @@ Gem::Specification.new do |spec|
 	
 	spec.add_dependency 'samovar', '~> 2.1'
 	
-	spec.add_development_dependency 'bake-bundler'
-	
 	spec.add_development_dependency 'covered'
 	spec.add_development_dependency 'bundler'
 	spec.add_development_dependency 'rspec'
-	spec.add_development_dependency 'rake'
 end

data/bake.rb

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

data/gems.rb

@@ -3,3 +3,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in bake.gemspec
 gemspec
 
+group :maintenance, optional: true do
+	gem 'bake-modernize'
+	gem 'bake-bundler'
+	
+	gem 'utopia-project'
+end

data/guides/command-line-interface/README.md

@@ -0,0 +1,55 @@
+# Command Line Interface
+
+The `bake` command is broken up into two main functions: `list` and `call`.
+
+<pre>% bake --help
+<b>bake [-h/--help] [-b/--bakefile &lt;path&gt;] &lt;command&gt;</b>
+	<font color="#638FFF">Execute tasks using Ruby.</font>
+
+	[-h/--help]             Show help.                               
+	[-b/--bakefile &lt;path&gt;]  Override the path to the bakefile to use.
+	&lt;command&gt;               One of: call, list.                        (default: call)
+
+	<b>call &lt;commands...&gt;</b>
+		<font color="#638FFF">Execute one or more commands.</font>
+
+		&lt;commands...&gt;  The commands &amp; arguments to invoke.  (default: [&quot;default&quot;])
+
+	<b>list &lt;pattern&gt;</b>
+		&lt;pattern&gt;  The pattern to filter tasks by.
+</pre>
+
+## List
+
+The `bake list` command allows you to list all available recipes. By proving a pattern you will only see recipes that have a matching command name.
+
+<pre>$ bake list console
+<b>Bake::Loader console-1.8.2</b>
+
+	<b>console:info</b>
+		<font color="#638FFF">Increase the verbosity of the logger to info.</font>
+
+	<b>console:debug</b>
+		<font color="#638FFF">Increase the verbosity of the logger to debug.</font>
+</pre>
+
+The listing documents positional and optional arguments. The documentation is generated from the comments in the bakefiles.
+
+## Call
+
+The `bake call` (the default, so `call` can be omitted) allows you to execute one or more recipes. You must provide the name of the command, followed by any arguments.
+
+<pre>$ bake async:http:head https://www.codeotaku.com/index
+<font color="#638FFF"><b>                HEAD</b></font>: https://www.codeotaku.com/index
+<font color="#00AA00"><b>             version</b></font>: h2
+<font color="#00AA00"><b>              status</b></font>: 200
+<font color="#00AA00"><b>                body</b></font>: body with length <b>7879B</b>
+<b>        content-type</b>: &quot;text/html; charset=utf-8&quot;
+<b>       cache-control</b>: &quot;public, max-age=3600&quot;
+<b>             expires</b>: &quot;Mon, 04 May 2020 13:23:47 GMT&quot;
+<b>              server</b>: &quot;falcon/0.36.4&quot;
+<b>                date</b>: &quot;Mon, 04 May 2020 12:23:47 GMT&quot;
+<b>                vary</b>: &quot;accept-encoding&quot;
+</pre>
+
+You can specify multiple commands and they will be executed sequentially.

data/guides/gem-integration/README.md

@@ -0,0 +1,69 @@
+# Gem Integration
+
+This guide explains how to add `bake` to a Ruby gem and export standardised tasks for use by other gems and projects.
+
+## Exporting Tasks
+
+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
+def setup
+	# ...
+end
+~~~
+
+Then, in a different project which depends on `mygem`, you can run tasks from `mygem` by invoking them using `bake`:
+
+~~~ bash
+$ bake mygem:setup
+~~~
+
+## Examples
+
+There are many gems which export tasks in this way. Here are some notable examples:
+
+### Variant
+
+The [variant gem](https://github.com/socketry/variant) exposes bake tasks for setting the environment e.g. `development`, `testing`, or `production`.
+
+<pre class="terminal">$ bake list variant
+<b>Bake::Loader variant-0.1.1</b>
+
+	<b>variant:production</b> <font color="#00AA00">**overrides</font>
+		<font color="#638FFF">Select the production variant.</font>
+		<font color="#00AA00">overrides</font> [Hash] <font color="#638FFF">any specific variant overrides.</font>
+
+	<b>variant:staging</b> <font color="#00AA00">**overrides</font>
+		<font color="#638FFF">Select the staging variant.</font>
+		<font color="#00AA00">overrides</font> [Hash] <font color="#638FFF">any specific variant overrides.</font>
+
+	<b>variant:development</b> <font color="#00AA00">**overrides</font>
+		<font color="#638FFF">Select the development variant.</font>
+		<font color="#00AA00">overrides</font> [Hash] <font color="#638FFF">any specific variant overrides.</font>
+
+	<b>variant:testing</b> <font color="#00AA00">**overrides</font>
+		<font color="#638FFF">Select the testing variant.</font>
+		<font color="#00AA00">overrides</font> [Hash] <font color="#638FFF">any specific variant overrides.</font>
+
+	<b>variant:force</b> <font color="#AA0000">name</font> <font color="#00AA00">**overrides</font>
+		<font color="#638FFF">Force a specific variant.</font>
+		<font color="#00AA00">name</font> [Symbol] <font color="#638FFF">the default variant.</font>
+		<font color="#00AA00">overrides</font> [Hash] <font color="#638FFF">any specific variant overrides.</font>
+
+	<b>variant:show</b>
+		<font color="#638FFF">Show variant-related environment variables.</font>
+</pre>
+
+### Console
+
+The [console gem](https://github.com/socketry/console) exposes bake tasks to change the log level.
+
+<pre class="terminal">$ bake list console
+<b>Bake::Loader console-1.8.2</b>
+
+	<b>console:info</b>
+		<font color="#638FFF">Increase the verbosity of the logger to info.</font>
+
+	<b>console:debug</b>
+		<font color="#638FFF">Increase the verbosity of the logger to debug.</font>
+</pre>

data/guides/getting-started/README.md

@@ -0,0 +1,109 @@
+# Getting Started
+
+This guide gives a general overview of `bake` and how to use it.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add bake
+~~~
+
+## Core Concepts
+
+`bake` has several core concepts:
+
+- A `bake` executable used for invoking one or more tasks.
+- A {ruby Bake::Context} instance which is bound to a project or gem and exposes a hierarchy of runnable tasks.
+- A {ruby Bake::Loaders} instance which is used for on-demand loading of bake files from the current project and all available gems.
+
+## Executing Tasks
+
+The `bake` executable can be used to execute tasks in a `bake.rb` file in the same directory.
+
+``` ruby
+# bake.rb
+
+def add(x, y)
+	puts Integer(x) + Integer(y)
+end
+```
+
+You can execute this task from the command line:
+
+``` shell
+% bake add 10 20
+30
+```
+
+### Using Types
+
+You can annotate your task with a type signature and `bake` will coerce your arguments to these types:
+
+``` ruby
+# bake.rb
+
+# @parameter x [Integer]
+# @parameter y [Integer]
+def add(x, y)
+	puts x + y
+end
+```
+
+You can execute this task from the command line:
+
+``` shell
+% bake add 10 20
+30
+```
+
+The values are automatically coerced to `Integer`.
+
+### Extending With Documentation
+
+You can add documentation to your tasks and parameters (using Markdown formatting).
+
+``` ruby
+# bake.rb
+
+# Add the x and y coordinate together and print the result.
+# @parameter x [Integer] The x offset.
+# @parameter y [Integer] The y offset.
+def add(x, y)
+	puts x + y
+end
+```
+
+You can see this documentation in the task listing:
+
+``` shell
+% bake list add
+Bake::Context getting-started
+
+	add x y
+		Add the x and y coordinate together and print the result.
+		x [Integer] The x offset.
+		y [Integer] The y offset.
+```
+
+### Private Methods
+
+If you want to add helper methods which don't show up as tasks, define them as `protected` or `private`.
+
+``` ruby
+# bake.rb
+
+# Add the x and y coordinate together and print the result.
+# @parameter x [Integer] The x offset.
+# @parameter y [Integer] The y offset.
+def add(x, y)
+	puts x + y
+end
+
+private
+
+def puts(*arguments)
+	$stdout.puts arguments.inspect
+end
+```

data/guides/links.yaml

@@ -0,0 +1,8 @@
+getting-started:
+  order: 1
+command-line-interface:
+  order: 2
+project-integration:
+  order: 3
+gem-integration:
+  order: 4

data/guides/project-integration/README.md

@@ -0,0 +1,64 @@
+# Project Integration
+
+This guide explains how to add `bake` to a Ruby project.
+
+## Bakefile
+
+At the top level of your project, you can create a `bake.rb` file, which contains top level tasks which are private to your project.
+
+~~~ ruby
+def cake
+	ingredients = call 'supermarket:shop', 'flour,sugar,cocoa'
+	lookup('mixer:add').call(ingredients)
+end
+~~~
+
+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 `bake/` directory which contains files like `supermarket.rb`. These files contain recipes, e.g.:
+
+~~~ ruby
+# @param ingredients [Array(Any)] the ingredients to purchase.
+def shop(ingredients)
+	supermarket = Supermarket.best
+	
+	return supermarket.purchase(ingredients)
+end
+~~~
+
+These methods are automatically scoped according to the file name, e.g. `bake/supermarket.rb` will define `supermarket:shop`.
+
+
+## Arguments
+
+Arguments work as normal. Documented types are used to parse strings from the command line. Both positional and optional parameters are supported.
+
+### Positional Parameters
+
+Positional parameters are non-keyword parameters which may have a default value. However, because of the limits of the command line, all positional arguments must be specified.
+
+~~~ ruby
+# @param x [Integer]
+# @param y [Integer]
+def add(x, y)
+	puts x + y
+end
+~~~
+
+Which is invoked by `bake add 1 2`.
+
+### Optional Parameters
+
+Optional parameters are keyword parameters which may have a default value. The parameter is set on the command line using the name of the parameter followed by an equals sign, followed by the value.
+
+~~~ ruby
+# @param x [Integer]
+# @param y [Integer]
+def add(x:, y: 2)
+	puts x + y
+end
+~~~
+
+Which is invoked by `bake add x=1`. Because `y` is not specified, it will default to `2` as per the method definition.