business_flow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28c1c9337388a7069d9222ba08a81648fdb252e5
+  data.tar.gz: d041d1b3dc0d6fbc1b5558f575bcbe20d7c76bbd
+SHA512:
+  metadata.gz: fc01941f701b0e526f5d4d57da19fc2156c99ff184fa190ce587dc2103e8e19435629728f7402697e2738897a3372bdf932a90119cfeee4ed22b33b11f2eb083
+  data.tar.gz: 28cd1ece2cfb61a539429ffcae5bc024ab565758a745af3b58925536d2ba7f1ea047915dae3b7c3171a7e48f2da538a1aa74482cfabfa0d5c9ed0759995e16f8

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in business_flow.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    business_flow (0.1.0)
+      activemodel (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.3)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    reek (4.8.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (~> 3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  business_flow!
+  rake (~> 10.0)
+  reek (~> 4.8)
+  rspec (~> 3.0)
+  rubocop (~> 0.53)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alex Scarborough
+
+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,39 @@
+# BusinessFlow
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/business_flow`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'business_flow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install business_flow
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/business_flow.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'business_flow'
+
+# 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(__FILE__)

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/business_flow.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'business_flow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'business_flow'
+  spec.version       = BusinessFlow::VERSION
+  spec.authors       = ['Alex Scarborough']
+  spec.email         = ['alex@teak.io']
+
+  spec.summary       = 'General purpose management of service object flows'
+  spec.homepage      = 'https://teak.io'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 'activemodel', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'reek', '~> 4.8'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+end

data/lib/business_flow.rb

@@ -0,0 +1,8 @@
+require 'active_model'
+require 'business_flow/version'
+require 'business_flow/not_nil_validator'
+require 'business_flow/step'
+require 'business_flow/base'
+
+module BusienssFlow
+end

data/lib/business_flow/base.rb

@@ -0,0 +1,165 @@
+# Magic!
+module BusinessFlow
+  # More magic!
+  # Look at use of class attrs
+  # call! to raise errors
+  # Hooks for cross cutting concerns
+  # Figure out how much we can freeze
+  # Check output slots even if they're not going through our defined setter
+  # Conditional steps?
+  # ActiveSupport notifiers
+  class Base
+    include ActiveModel::Validations
+
+    class << self
+      alias invariant validates
+    end
+
+    class_attribute :step_queue, :requirements
+    attr_reader :parameter_object
+    private :parameter_object
+
+    def self.add_requirement(fields)
+      @requirements ||= []
+      @requirements.concat(fields)
+      fields.each do |field|
+        validates_with NotNilValidator, attributes: [field]
+      end
+    end
+
+    def self.needs(*fields)
+      add_requirement(fields)
+      wants(*fields)
+    end
+
+    def self.wants(*fields)
+      fields.each { |field| add_field(field) }
+    end
+
+    def self.provides(*fields)
+      attr_reader(*fields)
+    end
+
+    def self.expects(field, options = {})
+      validates field, options.merge(on: field)
+    end
+
+    def self.add_field(field)
+      define_method field do
+        if parameter_object.is_a?(Hash) && parameter_object.key?(field)
+          parameter_object[field]
+        else
+          parameter_object.public_send(field)
+        end
+      end
+    end
+
+    def self.steps(*step_queue)
+      self.step_queue = step_queue.map do |step|
+        if !step.is_a?(Step)
+          Step.new(step, {}, {}, self)
+        else
+          step
+        end
+      end
+    end
+
+    def self.step(klass, inputs = {}, outputs = {})
+      create_fields_for_step_outputs(outputs)
+      Step.new(klass, inputs, outputs, self)
+    end
+
+    def self.create_fields_for_step_outputs(outputs)
+      outputs.values.select { |field| field.is_a?(Symbol) }.map do |field|
+        attr_reader field
+        create_setter(field)
+      end
+    end
+
+    def self.create_setter(field)
+      define_method "#{field}=" do |new_value|
+        instance_variable_set("@#{field}", new_value)
+        validate(field)
+        new_value
+      end
+    end
+
+    def self.call(parameter_object)
+      new(parameter_object).tap(&:call)
+    end
+
+    def initialize(parameter_object)
+      @parameter_object = parameter_object
+    end
+
+    def call
+      return if invalid?
+      process_steps
+    end
+
+    def merge_errors_into(other_errors)
+      errors.each do |attribute, message|
+        attribute = "#{self.class.name.underscore}.#{attribute}"
+        (other_errors[attribute] << message).uniq!
+      end
+    end
+
+    private
+
+    def process_steps
+      steps.each do |step_name|
+        process_step(step_name)
+        break if errors.any?
+      end
+    end
+
+    def process_step(step)
+      input_object = marshall_input_object(step.inputs)
+      result = step.dispatch(self, input_object)
+      marshall_outputs(result, step.outputs) if result.present?
+    end
+
+    def marshall_input_object(input_object)
+      return self if input_object.blank?
+      Hash[input_object.map do |input_name, input_value|
+             [
+               input_name,
+               process_input(input_value)
+             ]
+           end
+          ]
+    end
+
+    def marshall_outputs(result, output_object)
+      result.merge_errors_into(errors)
+      return if errors.any? || output_object.blank?
+      output_object.each do |(output_name, output_setter)|
+        output = result.public_send(output_name)
+        process_output(output, output_setter)
+        break if errors.any?
+      end
+    end
+
+    def process_input(input_value)
+      case input_value
+      when Symbol
+        send(input_value)
+      when Proc
+        instance_exec(&input_value)
+      end
+    end
+
+    def process_output(output, output_setter)
+      case output_setter
+      when Symbol
+        send("#{output_setter}=", output)
+      when Proc
+        instance_exec(output, &output_setter)
+      end
+    end
+
+    def steps
+      self.class.step_queue || []
+    end
+  end
+end

data/lib/business_flow/not_nil_validator.rb

@@ -0,0 +1,11 @@
+module BusinessFlow
+  # Validate that a given value is not nil, but allow blank/empty values.
+  class NotNilValidator < ActiveModel::EachValidator
+    # :reek:NilCheck :reek:UtilityFunction
+    # Dear reek -- I didn't decided the ActiveModel Validator API, I just
+    # have to live with it.
+    def validate_each(record, attribute, value)
+      record.errors[attribute] << 'must not be nil' if value.nil?
+    end
+  end
+end

data/lib/business_flow/step.rb

@@ -0,0 +1,43 @@
+module BusinessFlow
+  class Step
+    attr_reader :klass, :inputs, :outputs
+    def initialize(klass, inputs, outputs, flow_klass)
+      @klass = klass
+      @inputs = inputs
+      @outputs = outputs
+      @flow_klass = flow_klass
+    end
+
+    # @klass can be a symbol or class
+    def dispatch(flow, inputs)
+      callable.call(flow, inputs)
+    end
+
+    private
+
+    def callable
+      @callable ||=
+        if @klass.is_a?(Symbol) &&
+           @flow_klass.method_defined?(@klass) ||
+           @flow_klass.private_method_defined?(@klass)
+          proc { |flow, _| flow.send(@klass) && nil }
+        else
+          @klass = lookup_klass ||
+                   raise(NameError, "undefined constant #{@klass}")
+          proc { |_, inputs| @klass.call(inputs) }
+        end
+    end
+
+    def lookup_klass
+      return @klass unless @klass.is_a?(Symbol)
+      constant_name = @klass.to_s.camelcase
+      @flow_klass.parents.each do |parent|
+        begin
+          break parent.const_get(constant_name)
+        rescue NameError
+          next
+        end
+      end
+    end
+  end
+end

data/lib/business_flow/version.rb

@@ -0,0 +1,3 @@
+module BusinessFlow
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: business_flow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Scarborough
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+description: 
+email:
+- alex@teak.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- business_flow.gemspec
+- lib/business_flow.rb
+- lib/business_flow/base.rb
+- lib/business_flow/not_nil_validator.rb
+- lib/business_flow/step.rb
+- lib/business_flow/version.rb
+homepage: https://teak.io
+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.11
+signing_key: 
+specification_version: 4
+summary: General purpose management of service object flows
+test_files: []