carry_out 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23c83d41577d5ded2aed464a837500e437cdcc4a
+  data.tar.gz: 7dcc7d36ad98c067350a57be5b4138031cf96bb8
+SHA512:
+  metadata.gz: a594a27b2a0c569ce1a4cce37f3467b64df623b78e06545cf638883b94fac55382bf1ed6491fce49c31f65de833b9f18d64a7fbd1ef6f2321ab8768e2055a2d4
+  data.tar.gz: e080d44e2802c491bf9cb03117b4f01b9ddbfc2a89656e7daadfa8909fec6ee7a73120b339d443efc542a65be49c65a6ad94772363aca9df8804a7b72ca91a8a

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ryan.fields@twoleftbeats.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carry_out.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryan Fields
+
+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,129 @@
+# CarryOut
+
+CarryOut facilitates connecting single-purpose units of logic into larger workflows via a small DSL.  Each unit can further extend the DSL with parameter methods.  Artifacts and errors are collected as the workflow executes and are returned in a result bundle upon completion.
+
+[![Build Status](https://travis-ci.org/ryanfields/carry_out.svg?branch=master)](https://travis-ci.org/ryanfields/carry_out) [![Coverage Status](https://coveralls.io/repos/github/ryanfields/carry_out/badge.svg?branch=master)](https://coveralls.io/github/ryanfields/carry_out?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carry_out'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carry_out
+
+## Usage
+
+Execution units extend CarryOut::Unit and should implement ```CarryOut::Unit#execute(result)```.
+```ruby
+class SayHello < CarryOut::Unit
+    def execute(result)
+        puts "Hello, World!"
+    end
+end
+```
+
+CarryOut can then be used to create an execution plan using the unit.
+```ruby
+plan = CarryOut.will(SayHello)
+```
+
+Run the plan using:
+```
+result = plan.execute
+```
+
+### Parameters
+Execution units can be passed parameters statically during plan creation, or dynamically via a block.
+
+Redefine the example above to greet someone by name:
+```ruby
+class SayHello < CarryOut::Unit
+    parameter :to, :name
+    
+    def execute(result)
+        puts "Hello, #{@name}!"
+    end
+end
+```
+
+Define the plan as:
+```ruby
+plan = CarryOut
+    .will(SayHello)
+    .to("Ryan")
+    
+# or
+
+plan = CarryOut
+    .will(SayHello)
+    .to { "Ryan" }
+```
+
+And execute the same way as above.
+
+### Artifacts and References
+Execution units can publish artifacts to the plan's result.  Parameter blocks can be used to pass these artifacts on to subsequent execution units in the plan.
+
+```ruby
+class AddToCart < CarryOut::Unit
+    parameter :items
+    
+    def execute(result)
+        result.add :contents, @items
+    end
+end
+
+class CalculateSubtotal < CarryOut::Unit
+    parameters :items
+    
+    def execut(result)
+        subtotal = items.inject { |sum, item| sum + item.price }
+        result.add :subtotal, subtotal
+    end
+end
+```
+```ruby
+plan = CarryOut
+    .will(AddToCart, as: :cart)
+    .items([ item1, item2, item3])
+    .then(CalculateSubtotal, as: :invoice)
+    .items { |refs| refs[:cart][:contents] }
+    
+plan.execute do |result|
+    puts "Subtotal: #{result.artifacts[:invoice][:subtotal]}"
+end
+```
+
+## Motivation
+
+I've been trying to keep my Rails controllers clean, but I prefer to avoid shoving inter-model business logic inside database models.  The recommendation I most frequently run into is to move that kind of logic into something akin to service objects.  I like that idea, but I want to keep my services small and composable, and I want to separate the "what" from the "how" of my logic.
+
+CarryOut is designed to be a consistent layer of glue between single-purpose or "simple-purpose" units of business logic.  CarryOut describes what needs to be done and what inputs are to be used.  The units themselves worry about how to perform the actual work.  These units tend to have names that describe their intent.  They remain small and easier to test.  What ends up in my controllers is a process description that that can be comprehended at a glance and remains fairly agnostic to the underlying details of my chosen ORM, job queue, message queue, etc.
+
+I'm building up CarryOut alongside a new Rails application, but my intent is for CarryOut to remain just as useful outside of Rails.  At present, it isn't bound in any way to things like ActiveRecord.  If those sorts of bindings emerge, I'll provide an add-on gem or an alternate require.
+
+CarryOut's workflows don't support asynchronous execution units yet.  The workflows can't branch or loop.  These are features I hope to provide in the future.  Feature requests are welcome.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanfields/carry_out. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carry_out"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/carry_out.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carry_out/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carry_out"
+  spec.version       = CarryOut::VERSION
+  spec.authors       = ["Ryan Fields"]
+  spec.email         = ["ryan.fields@twoleftbeats.com"]
+
+  spec.summary       = %q{Compose units of logic into an executable workflow.}
+  spec.description   = <<-EOF
+    CarryOut connects units of logic into workflows.  Each unit can extend
+    the DSL with parameter methods.  Artifacts and errors are collected as
+    the workflow executes and are returned in a result bundle upon completion.
+  EOF
+
+  spec.homepage      = "https://github.com/ryanfields/carry_out"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "coveralls"
+end

data/lib/carry_out/error.rb

@@ -0,0 +1,11 @@
+module CarryOut
+  class Error
+    attr_reader :details
+    attr_reader :message
+
+    def initialize(message, details = nil)
+      @message = message
+      @details = details
+    end
+  end
+end

data/lib/carry_out/plan.rb

@@ -0,0 +1,80 @@
+module CarryOut
+  class Plan
+    
+    def initialize(unit = nil, options = {})
+      @nodes = {}
+      @previously_added_node = nil
+      @initial_node_key = add_node(PlanNode.new)
+
+      unless unit.nil?
+        self.then(unit, options)
+      end
+    end
+
+    def execute(&block)
+      node = @nodes[@initial_node_key]
+      label = node.next unless node.nil?
+
+      Result.new.tap do |result|
+        while node = @nodes[label] do
+          begin
+            node.execute(ResultManipulator.new(result, label), result.artifacts)
+          rescue UnitError => error
+            result.add(label, CarryOut::Error.new(error.error.message, error.error))
+            break
+          end
+
+          label = node.next
+        end
+
+        unless block.nil?
+          block.call(result)
+        end
+      end
+    end
+
+    def then(unit, options = {})
+      add_node(PlanNode.new(unit), options[:as])
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      if @previously_added_node
+        @previously_added_node.send(method, *args, &block)
+        self
+      else
+        super
+      end
+    end
+
+    def respond_to?(method)
+      (@previously_added_node && @previously_added_node.respond_to?(method)) || super
+    end
+
+    private
+      def add_node(node, as = nil)
+        label = (as || generate_node_name)
+
+        if as.nil?
+          until @nodes[label].nil?
+            label = generate_node_name
+          end
+        end
+
+        unless @previously_added_node.nil?
+          @previously_added_node.next = label
+        end
+
+        @nodes[label] = node
+        @previously_added_node = node
+
+        label
+      end
+
+      def generate_node_name
+        id = @next_node_id ||= 1
+        @next_node_id += 1
+        "node_#{id}".to_sym
+      end
+  end
+end

data/lib/carry_out/plan_node.rb

@@ -0,0 +1,49 @@
+module CarryOut
+  class PlanNode
+    attr_reader :next
+
+    def initialize(klass = nil)
+      @unitClass = klass
+      @messages = []
+    end
+
+    def method_missing(method, *args, &block)
+      if args.length == 1 || (args.length == 0 && !block.nil?)
+        if @unitClass.instance_methods.include?(method)
+          @messages << { method: method, argument: args.first, block: block }
+        else
+          raise NoMethodError.new("#{@unitClass} instances do not respond to `#{method}'", method, *args)
+        end
+      else
+        super
+      end
+    end
+
+    def raises?(klass)
+      @unitClass.raises?(klass)
+    end
+
+    def respond_to?(method)
+      @unitClass.instance_methods.include?(method) || super
+    end
+
+    def execute(result, artifacts)
+      unit = @unitClass.new
+
+      @messages.each do |message|
+        arg = message[:block] ? message[:block].call(artifacts) : message[:argument]
+        unit.send(message[:method], arg)
+      end
+
+      begin
+        unit.execute(result)
+      rescue StandardError => error
+        raise UnitError.new(error)
+      end
+    end
+
+    def next=(value)
+      @next = value.to_sym
+    end
+  end
+end

data/lib/carry_out/result.rb

@@ -0,0 +1,27 @@
+module CarryOut
+  class Result
+
+    def add(group, label, object = nil)
+      if label.kind_of?(CarryOut::Error)
+        add_error(group, label)
+      else
+        group = artifacts[group] ||= {}
+        group[label] = object
+      end
+    end
+
+    def artifacts
+      @artifacts ||= {}
+    end
+
+    def errors
+      @errors ||= {}
+    end
+
+    private
+      def add_error(group, error)
+        group = errors[group] ||= []
+        group << error
+      end
+  end
+end

data/lib/carry_out/result_manipulator.rb

@@ -0,0 +1,13 @@
+module CarryOut
+  class ResultManipulator
+    
+    def initialize(result, group)
+      @result = result
+      @group = group
+    end
+
+    def add(label, object)
+      @result.add(@group, label, object) unless @group.nil?
+    end
+  end
+end

data/lib/carry_out/unit.rb

@@ -0,0 +1,36 @@
+module CarryOut
+  class Unit
+    
+    def execute(result)
+    end
+
+    def self.parameter(method_name, var = nil)
+      unless var.nil?
+        define_method(method_name.to_sym) do |value|
+          instance_variable_set("@#{var.to_s}", value)
+          self
+        end
+      end
+
+      var = (var || method_name).to_s
+      instance_var = "@#{var}"
+  
+      unless self.respond_to?(var)
+        define_method(var) do |*args|
+          if args.length > 0
+            instance_variable_set(instance_var, args.first)
+            return self
+          end
+
+          instance_variable_get(instance_var)
+        end
+      end
+
+      unless self.respond_to?("#{var}=")
+        define_method("#{var}=") do |value|
+          instance_variable_set(instance_var, value)
+        end
+      end
+    end
+  end
+end

data/lib/carry_out/unit_error.rb

@@ -0,0 +1,9 @@
+module CarryOut
+  class UnitError < StandardError
+    attr_reader :error
+
+    def initialize(error)
+      @error = error
+    end
+  end
+end

data/lib/carry_out/version.rb

@@ -0,0 +1,3 @@
+module CarryOut
+  VERSION = "0.1.0"
+end

data/lib/carry_out.rb

@@ -0,0 +1,15 @@
+require "carry_out/version"
+
+require "carry_out/error"
+require "carry_out/plan"
+require "carry_out/plan_node"
+require "carry_out/result"
+require "carry_out/result_manipulator"
+require "carry_out/unit"
+require "carry_out/unit_error"
+
+module CarryOut
+  def self.will(*args)
+    Plan.new(*args)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: carry_out
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Fields
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: |2
+      CarryOut connects units of logic into workflows.  Each unit can extend
+      the DSL with parameter methods.  Artifacts and errors are collected as
+      the workflow executes and are returned in a result bundle upon completion.
+email:
+- ryan.fields@twoleftbeats.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carry_out.gemspec
+- lib/carry_out.rb
+- lib/carry_out/error.rb
+- lib/carry_out/plan.rb
+- lib/carry_out/plan_node.rb
+- lib/carry_out/result.rb
+- lib/carry_out/result_manipulator.rb
+- lib/carry_out/unit.rb
+- lib/carry_out/unit_error.rb
+- lib/carry_out/version.rb
+homepage: https://github.com/ryanfields/carry_out
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Compose units of logic into an executable workflow.
+test_files: []