faith 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f08e57362c103d57c01b70e1e8adc9130a10d3da8368d1dc75c6a875640be7f8
+  data.tar.gz: aea9712d13039785bbb16ed4e89e38744e88fc40da7fee5d00883ec2f2065a3c
+SHA512:
+  metadata.gz: 18be11a99c1e621aaeeb857cbc14a325f781e22c7ac5fed1c0a723806251b242dab2a104557cd9e1daf5b5c800728fe92f1113af41c178215c12086948fc8edd
+  data.tar.gz: b4e1fc73f66274267aba6642999248324eceec81f71fef1e8d9c96f2ce23a31bde947c8241fb662887e3b82f37501e28e3c5d109f43a286cdc5612d992056846

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+sorbet/rbi/hidden-definitions

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.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    faith (0.1.0)
+      docile
+      rainbow
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    rainbow (3.0.0)
+    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.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      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.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faith!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aaron Christiansen
+
+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/README.md

@@ -0,0 +1,77 @@
+# Faith
+
+**This is a work in progress. Tasks can't be run from a CLI yet, and many
+features are unimplemented.**
+
+Faith is an **powerful and extremely versatile task runner**. Using a lovely
+Ruby DSL, you can:
+
+- Define named tasks
+    - Can be invoked with arguments and options*
+- Assign dependencies between tasks
+- Group tasks together into sensible and organised namespaces
+- Build sequences of tasks which run in order
+    - Can either exit or continue if one task fails*
+- Create parallel groups of tasks*
+- Add mixins, which wrap tasks to enhance their environment by running _before_
+  and _after_ tasks
+
+\* - Not yet implemented
+
+## DSL Example
+
+```ruby
+# A very simple, not-real-world example
+
+# Create two mixins, which can provide `number` to a task
+mixin 'a' do
+    before do
+        provide number: 5
+    end
+end
+
+mixin 'b' do
+    before do
+        provide number: 4
+    end
+end
+
+# Now, create an executable task which uses those provided values
+task 'example', mixins: ['a', 'b'] do
+    puts mixins['a'].number * mixins['b'].number # => 20
+end
+```
+
+## Use Case
+
+Faith should make a great starting point for building your own bespoke testing
+framework, or if you feel like you're outgrowing Rake.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faith'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install faith
+
+## Name
+
+Named after [Faith Connors](https://en.wikipedia.org/wiki/Faith_Connors), a
+**runner** from the _Mirror's Edge_ video games.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AaronC81/faith.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/faith.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/faith/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faith"
+  spec.version       = Faith::VERSION
+  spec.authors       = ["Aaron Christiansen"]
+  spec.email         = ["aaronc20000@gmail.com"]
+
+  spec.summary       = "A versatile task runner"
+  spec.description   = "A versatile task runner"
+  spec.homepage      = "https://github.com/AaronC81/faith"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "docile"
+  spec.add_dependency "rainbow"
+end

data/lib/faith.rb

@@ -0,0 +1,13 @@
+require 'faith/version'
+
+require 'faith/named'
+require 'faith/context'
+require 'faith/mixin'
+require 'faith/mixin_instance'
+require 'faith/task'
+require 'faith/namespace'
+require 'faith/group'
+require 'faith/sequence'
+
+require 'faith/dsl'
+require 'faith/output'

data/lib/faith/context.rb

@@ -0,0 +1,19 @@
+module Faith
+  class Context
+    def initialize
+      @mixin_instances = []
+      @tasks_executed = []
+      @output = Output.new
+    end
+
+    attr_accessor :mixin_instances, :tasks_executed, :output
+
+    def ran?(task)
+      tasks_executed.include?(task)
+    end
+
+    def mixins
+      mixin_instances.to_h { |x| [x.mixin.name, x] }
+    end
+  end
+end

data/lib/faith/dsl.rb

@@ -0,0 +1,71 @@
+require 'docile'
+
+module Faith
+  module DSL
+    def self.to_root(&block)
+      root = Faith::Group.new('root', nil, [])
+      Docile.dsl_eval(ChildBuilder.new(root), &block)
+      root.resolve_self!
+      root
+    end
+
+    def self.validate_name!(name)
+      raise ArgumentError, 'names cannot include :' if name.include?(':')
+      raise ArgumentError, '\'root\' is a reserved name' if name == 'root'
+    end
+
+    class ChildBuilder
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def task(name, mixins: [], dependencies: [], &action)
+        DSL.validate_name!(name)
+        
+        @parent.children << Task.new(name, @parent, mixins: mixins, dependencies: dependencies, &action)
+      end
+
+      def mixin(name, &block)
+        DSL.validate_name!(name)
+
+        @parent.children << Docile.dsl_eval(MixinBuilder.new(name, @parent), &block).result
+      end
+
+      def group(name, &block)
+        DSL.validate_name!(name)
+
+        group = Group.new(name, @parent, [])
+        @parent.children << group
+
+        Docile.dsl_eval(ChildBuilder.new(group), &block)
+      end
+
+      def sequence(name, &block)
+        DSL.validate_name!(name)
+
+        seq = Sequence.new(name, @parent, [])
+        @parent.children << seq
+
+        Docile.dsl_eval(ChildBuilder.new(seq), &block)
+      end
+    end
+
+    class MixinBuilder
+      def initialize(name, parent)
+        @mixin = Mixin.new(name, parent)
+      end
+
+      def before(&block)
+        @mixin.before = block
+      end
+
+      def after(&block)
+        @mixin.after = block
+      end
+
+      def result
+        @mixin
+      end
+    end
+  end
+end

data/lib/faith/group.rb

@@ -0,0 +1,9 @@
+module Faith
+  class Group < Namespace
+    def initialize(name, parent, children, mixins: [], dependencies: [])
+      super(name, parent, children, mixins: mixins, dependencies: dependencies) do
+        raise 'cannot run a group'
+      end
+    end
+  end
+end

data/lib/faith/mixin.rb

@@ -0,0 +1,20 @@
+module Faith
+  class Mixin
+    def initialize(name, parent, before: nil, after: nil)
+      @name = name
+      @parent = parent
+      @before = before
+      @after = after
+    end
+
+    attr_accessor :name, :parent, :before, :after
+
+    include Named
+
+    def instantiate(context)
+      MixinInstance.new(self)
+    end
+
+    def resolve_self!; end
+  end
+end

data/lib/faith/mixin_instance.rb

@@ -0,0 +1,19 @@
+module Faith
+  class MixinInstance
+    def initialize(mixin, provided: {})
+      @mixin = mixin
+      @provided = provided
+    end
+
+    attr_accessor :mixin, :provided
+
+    def method_missing(name, *args, &block)
+      return provided[name] if provided.has_key?(name) && args.length.zero? && block.nil?
+      super
+    end
+
+    def provide(**items)
+      provided.merge! items
+    end
+  end
+end

data/lib/faith/named.rb

@@ -0,0 +1,11 @@
+module Faith
+  module Named
+    def root?
+      name == 'root'
+    end
+
+    def full_name
+      (parent && !parent.root?) ? "#{parent.full_name}:#{name}" : name
+    end
+  end
+end

data/lib/faith/namespace.rb

@@ -0,0 +1,15 @@
+module Faith
+  class Namespace < Task
+    def initialize(name, parent, children, mixins: [], dependencies: [], &action)
+      super(name, parent, mixins: mixins, dependencies: dependencies, &action)
+      @children = children
+    end
+
+    attr_accessor :children
+
+    def resolve_self!
+      super
+      children.each(&:resolve_self!)
+    end
+  end
+end

data/lib/faith/output.rb

@@ -0,0 +1,36 @@
+require 'rainbow'
+
+module Faith
+  class Output
+    def initialize
+      @indent_level = 0
+    end
+
+    def indent; @indent_level += 1; end
+    def dedent; @indent_level -= 1; end
+
+    def indented(x)
+      "#{'  ' * @indent_level}#{x}"
+    end
+
+    def run(task)
+      puts indented(Rainbow(task.full_name).bold)
+    end
+
+    def dependencies(task)
+      puts indented("#{Rainbow("Dependencies of #{task.full_name} -").purple.bold}")
+    end
+
+    def mixin(mixin)
+      puts indented("#{Rainbow("Mixin #{mixin.full_name} -").blue.bold}")
+    end
+
+    def sequence(task)
+      puts indented("#{Rainbow("Sequence #{task.full_name} -").blue.bold}")
+    end
+
+    def mixin_action(action)
+      puts indented("#{Rainbow(action).dark.bold}")
+    end
+  end
+end

data/lib/faith/sequence.rb

@@ -0,0 +1,13 @@
+module Faith
+  class Sequence < Namespace
+    def initialize(name, parent, children, mixins: [], dependencies: [])
+      s = self
+      super(name, parent, children, mixins: mixins, dependencies: dependencies) do |ctx|
+        ctx.output.sequence(s)
+        ctx.output.indent
+        children.each { |child| child.run(ctx) }
+        ctx.output.dedent
+      end
+    end
+  end
+end

data/lib/faith/task.rb

@@ -0,0 +1,105 @@
+module Faith
+  class Task
+    def initialize(name, parent, mixins: [], dependencies: [], &action)
+      @name = name
+      @parent = parent
+      @mixins = mixins
+      @dependencies = dependencies
+      @action = action
+    end
+    
+    attr_accessor :name, :parent, :mixins, :dependencies, :action
+
+    include Named
+
+    def run(context)
+      context.tasks_executed << self
+      
+      # Run dependencies, if not run before
+      any_dependencies = dependencies.reject { |dep| context.ran?(dep) }.any?
+      if any_dependencies
+        context.output.dependencies(self)
+        context.output.indent
+      end
+      dependencies.each do |dep|
+        unless context.ran?(dep)
+          dep.run(context) 
+        end
+      end
+      context.output.dedent if any_dependencies
+
+      # Instantiate mixins
+      new_mixin_instances = mixins.map { |m| m.instantiate(context) }
+      new_mixin_instances.each do |m|
+        context.output.mixin(m.mixin)
+        context.output.indent
+        context.output.mixin_action("before")
+        m.instance_exec(context, &m.mixin.before) unless m.mixin.before.nil?
+        context.mixin_instances << m
+      end
+
+      # Run this task
+      context.instance_exec(context, &action)
+      context.output.run(self) unless is_a?(Sequence)
+
+      # Tear down mixins
+      new_mixin_instances.each do |m|
+        context.output.mixin_action("after")
+        m.instance_exec(context, &m.mixin.after) unless m.mixin.after.nil?
+        context.output.dedent
+        context.mixin_instances.delete(m)
+      end
+    end
+
+    def resolve_self!
+      @mixins = ensure_all_resolved(@mixins)
+      @dependencies = ensure_all_resolved(@dependencies)
+    end
+
+    def ensure_all_resolved(objs)
+      objs.map { |obj| ensure_resolved(obj) }
+    end
+
+    def ensure_resolved(obj)
+      if obj.is_a?(String)
+        resolve(obj)
+      elsif obj.is_a?(Task) || obj.is_a?(Mixin)
+        obj
+      else
+        raise "cannot resolve using #{obj} (of type #{obj.class})"
+      end
+    end 
+
+    def resolve(name_to_resolve)
+      parts = name_to_resolve.split(':')
+      raise 'empty name' if parts.length.zero?
+
+      current = self
+      until parts.empty?
+        current_child = current.child(parts.shift)
+        
+        # If nil, give up finding here
+        if current_child.nil?
+          if parent.nil?
+            raise "could not resolve #{name_to_resolve}"
+          else
+            return parent.resolve(name_to_resolve)
+          end
+        end
+
+        current = current_child
+      end
+
+      # If we actually managed to get parts to be empty, then we found what we were looking for
+      current
+    end
+
+    def child(name_to_resolve)
+      if is_a?(Namespace)
+        children.find { |child| child.name == name_to_resolve }
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/faith/version.rb

@@ -0,0 +1,4 @@
+# typed: strict
+module Faith
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: faith
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Christiansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A versatile task runner
+email:
+- aaronc20000@gmail.com
+executables:
+- faith.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/faith.rb
+- faith.gemspec
+- lib/faith.rb
+- lib/faith/context.rb
+- lib/faith/dsl.rb
+- lib/faith/group.rb
+- lib/faith/mixin.rb
+- lib/faith/mixin_instance.rb
+- lib/faith/named.rb
+- lib/faith/namespace.rb
+- lib/faith/output.rb
+- lib/faith/sequence.rb
+- lib/faith/task.rb
+- lib/faith/version.rb
+homepage: https://github.com/AaronC81/faith
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AaronC81/faith
+  source_code_uri: https://github.com/AaronC81/faith
+  changelog_uri: https://github.com/AaronC81/faith/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A versatile task runner
+test_files: []