bake 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5064c2fb5970db1bfd61752e337a35cb1130655d2aa712cac405c4ef9b5ac99
+  data.tar.gz: 34c28cb42f472d9cdb02bcde6576a784d7b9a1beeda8ffde67ddd1a16e7b2cdd
+SHA512:
+  metadata.gz: 2aba107faf34db34af932925c0c6ba34fb906a7bd68a10c5ae286f537ba2ad1b085e01a3d7390f88225809fdf0570edb81522e8df98ff7f476b2b22613de5e98
+  data.tar.gz: 5e75149322e7668879aaee32eea149dfdcbb98540f60bb29695fd4e5651a917b04f75d957a4710f77d5067e43e4eeb855d010ff31e85daa27ad3e700073fdacd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+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

data/README.md

@@ -0,0 +1,99 @@
+# Bake
+
+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.
+
+## Motivation
+
+Rake is an awesome tool and loved by the community. So, why reinvent it? Bake provides the following features that Rake does not:
+
+- On demand loading of files following a standard convention. This avoid loading all your rake tasks just to execute a single command.
+- Better argument handling including support for positional and optional arguments.
+- Focused on task execution not dependency resolution. Implementation is simpler and a bit more predictable.
+- Canonical structure for integration with gems.
+
+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.
+
+## Bakefile
+
+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'
+end
+```
+
+This file is project specific and is the only file which can expose top level tasks (i.e. without a defined namespace).
+
+## Recipes
+
+Alongside the `bake.rb`, there is a `recipes/` directory which contains files like `icons.rb`. These files contain recipes, e.g.:
+
+```ruby
+recipe :generate do |name|
+	MyProject::Icons::Generate.call(name)
+end
+```
+
+## 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`:
+
+```ruby
+recipe :setup do
+	# ...
+end
+```
+
+Then, in your project `myproject` which depends on `mygem`:
+
+```
+bake mygem:setup
+```
+
+## 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
+
+## See Also
+
+- [Utopia](https://github.com/socketry/utopia) — A website framework which uses bake for maintenance tasks.
+
+## License
+
+Released under the MIT license.
+
+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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bake.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/bake/version'
+
+Gem::Specification.new do |spec|
+	spec.name = "bake"
+	spec.version = Bake::VERSION
+	spec.authors = ["Samuel Williams"]
+	spec.email = ["samuel.williams@oriontransfer.co.nz"]
+	
+	spec.summary = "A replacement for rake with a simpler syntax."
+	spec.homepage = "https://github.com/ioquatix/bake"
+	spec.license = "MIT"
+	spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+	
+	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)/}) }
+	end
+	
+	spec.bindir = "bin"
+	spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency 'samovar', '~> 2.1'
+end

data/bin/bake

@@ -1,10 +1,25 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'rubygems'
-rescue LoadError
-  # no rubygems to load, so we fail silently
-end
-
-require 'bake'
-
+#!/usr/bin/env ruby
+
+# 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 '../lib/bake/command'
+
+Bake::Command.call

data/lib/bake.rb

@@ -1,140 +1,21 @@
-require 'bake/extensions'
-require 'bake/context'
-require 'bake/project_loader'
-require 'bake/plugin'
-require 'bake/system_utils'
-require 'bake_version'
-require 'optparse'
-
-module Bake
-    class CommandLineParseError < RuntimeError
-    end
-
-    class ProgramInfoRequested < RuntimeError
-    end
-
-    class App
-        @@instance = nil
-
-        def self.instance
-            return @@instance
-        end
-
-        def initialize
-            raise "App instance already created" if @@instance
-            @@instance = self
-        end
-
-        def run(*args)
-            options, args = parse_command_line(*args)
-            props, targets = process_excess_args(*args)
-            props[:platform] = determine_platform
-
-            sys = SystemUtils.new(:verbose => options[:verbose],
-                :dry_run => options[:dry_run])
-            @context = Context.new(sys)
-            # must execute this in context so that plugins are loaded properly
-            @context.context_eval(nil, 'import System, Macro')
-            @project_loader = ProjectLoader.new(@context, Dir.pwd, props)
-            targets = targets.collect do |name|
-                target = @project_loader.invok_project.resolve(name)
-                if !target
-                    raise CommandLineParseError,
-                        "could not find target '#{name}'"
-                end
-                target
-            end
-
-            method = options[:clean] ? :clean_r : :build_r
-            if targets.empty?
-                @project_loader.invok_project.send(method)
-            else
-                targets.each { |target| target.send(method) }
-            end
-        end
-
-    private
-        def determine_platform
-            if RUBY_PLATFORM =~ /darwin/i
-                return 'osx'
-            elsif RUBY_PLATFORM =~ /linux/i
-                return 'linux'
-            elsif RUBY_PLATFORM =~ /mswin/i
-                return 'win32'
-            end
-            return 'other'
-        end
-
-        def parse_command_line(*args)
-            options = {}
-            opts = OptionParser.new do |opts|
-                opts.banner = "Usage:  bake [options] [target ...]"
-                opts.on('--clean', 'Clean the given targets') do |clean|
-                    options[:clean] = clean
-                end
-                opts.on('-n', '--dry-run', 'Do not update targets') do |dr|
-                    options[:dry_run] = dr
-                end
-                opts.on('--verbose', 'Verbose output') do |verbose|
-                    options[:verbose] = verbose
-                end
-                opts.on_tail('-h', '--help', 'Display usage message') do
-                    raise ProgramInfoRequested, opts
-                end
-                opts.on_tail('--version', 'Show version information') do
-                    raise ProgramInfoRequested, 'bake ' + VERSION_STRING
-                end
-            end
-
-            begin
-                opts.parse!(args)
-            rescue ProgramInfoRequested
-                raise
-            rescue Exception => e
-                raise CommandLineParseError,
-                    "#{e.message} (use --help for usage information)"
-            end
-            return options, args
-        end
-
-        def process_excess_args(*args)
-            props = {}
-            targets = []
-            args.each do |name|
-                if name.count('=') == 1
-                    key, val = name.split('=')
-                    props[key.to_sym] = val
-                else
-                    targets << name
-                end
-            end
-            return props, targets
-        end
-    end
-end
-
-def parse_backtrace(backtrace)
-    if backtrace.find { |entry| entry =~ /^.*?(config|root|sub)\.bake:\d+/ }
-        return $&
-    end
-    return backtrace.join("\n")
-end
-
-exit_code = 1
-begin
-    app = Bake::App.new
-    app.run(*ARGV)
-    puts 'build successful'
-    exit_code = 0
-rescue Bake::ProgramInfoRequested => e
-    puts e.message
-    exit_code = 0
-rescue Bake::CommandLineParseError => e
-    puts e.message
-rescue Exception => e
-    puts parse_backtrace(e.backtrace) + ': ' + e.message
-    puts 'build failed'
-end
-
-exit(exit_code)
-
+# 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 "bake/version"

data/lib/bake/book.rb

@@ -0,0 +1,79 @@
+# 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'
+
+module Bake
+	class Book
+		def self.load(file_path, *arguments, **options)
+			instance = self.new(*arguments, **options)
+			
+			instance.freeze
+			
+			instance.instance_eval(File.read(file_path), file_path)
+			
+			return instance
+		end
+		
+		def initialize(path = [], **options)
+			@path = path
+			@recipes = {}
+		end
+		
+		def empty?
+			@recipes.empty?
+		end
+		
+		def each(&block)
+			@recipes.each_value(&block)
+		end
+		
+		attr :path
+		attr :recipes
+		
+		def to_s
+			@path.join(':')
+		end
+		
+		def lookup(name)
+			@recipes[name.to_sym]
+		end
+		
+		def recipe_for(path)
+			if path.size == 1
+				lookup(path.first)
+			end
+		end
+		
+		def recipe(name, **options, &block)
+			unless block_given?
+				block = self.method(name)
+			end
+			
+			@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