chaintown 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d79eff11d87d85d01edc1641eb7f1960f2916e0e4b576a0b86328c8891545df
+  data.tar.gz: 4564635fa0a80fc6d000204bde45e5ea0a52e23015793f32ad7867ba9326fbdd
+SHA512:
+  metadata.gz: 96260cf8ed3df258dbb589bee05dc306f8df879eed7fc276022852917c33b2eb7776ac4ca8f60ab3dd53c4715c526e5a3d6f12a647d9c6b9a350e71a81077b33
+  data.tar.gz: 598ad9bb05c59fb80e7fd54a0d85e9f9adf849115ec7ffd095f55ee8a80f53c984e40311d5817983bd659dfd1272718e4cca017ad0daa229ad7b75919a6d793f

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ziolmar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 chaintown.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    chaintown (0.1.3)
+      activesupport (~> 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    i18n (1.2.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  chaintown!
+  pry (~> 0.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcin Ziolkowski
+
+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,132 @@
+# Chaintown
+
+This gem provides very simple implementation of pipeline or chain of commands design pattern. If you ever had service class which had to handle complex process and you would like to make the process more explicit and easier to maintain this gem can help you with it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chaintown'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chaintown
+
+## Usage
+
+To use the gem first we need to include `Chaintown::Chain` module inside our service.
+
+```ruby
+class AnyService
+  include Chaintown::Chain
+end
+
+```
+
+The module define constructor which require two arguments. State and params. State is a class which should inherit from `Chaintown::State` and is used to share data between steps in the process. Params is a any object which provide initialization parameters. Param are frozen to be immutable. This prevents from changing it and force to use state object to share data.
+
+```ruby
+AnyService.new(Chaintown::State.new, params1: 'value')
+```
+
+The Chain module also provide DSL for defining steps. Every step is a method inside the class Inside every method you have access to state and params.
+
+```ruby
+  step :step1
+  step :step2
+
+  def step1
+    puts 'Step 1'
+  end
+
+  def step2
+    puts 'Step 2'
+  end
+```
+
+You can simply nest the steps by using `yield` inside your step.
+
+```ruby
+  step :step1 do
+    step :step2
+    step :step3
+  end
+
+  def step1
+    if state.run_nested_process? # method defined in your own class
+      yield
+    end
+  end
+```
+
+There is also a way to run step based on some condition by using `if` argument. In the if block there is an access to all instance variables, state, params and current_step.
+
+```ruby
+  step :step1, if: proc { params[:run_step_1] }
+```
+
+If in any step you set the state `valid` param to false the process will be terminated and no other steps will be called instead the process will be moved to alternative flow defined by failed steps.
+
+```ruby
+  step :step1
+  step :step2
+  failed_step :step3
+
+  def step1
+    state.valid = false
+  end
+
+  def step2
+    puts 'will not be called'
+  end
+
+  def step3
+    puts 'handle invalid state'
+  end
+```
+In case you would like to add callbacks to the steps, for example to log some data to logs or send process to monitoring service you can define before, after and around actions.
+
+```ruby
+  before_step_action :before_action_1, :before_action_2
+  after_step_action :after_action_1
+  around_step_action :around_action_1
+
+  def before_action_1
+    logger("Start #{current_step_name}")
+  end
+
+  def after_action_1
+    logger(state.inspect)
+  end
+
+  def around_step_action_1
+    statsd = Datadog::Statsd.new('localhost', 8125)
+    statsd.batch do
+      yield
+    end
+  end
+```
+
+## 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/ziolmar/chaintown. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Chaintown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ziolmar/chaintown/blob/master/CODE_OF_CONDUCT.md).

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 "chaintown"
+
+# 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/chaintown.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chaintown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chaintown"
+  spec.version       = Chaintown::VERSION
+  spec.authors       = ["Marcin Ziolkowski"]
+  spec.email         = ["ziolmar@gmail.com"]
+
+  spec.summary       = 'Simple implementation of the pipeline or chain of command design pattern.'
+  spec.description   = 'Simple implementation of the pipeline or chain of command design pattern.'
+  spec.homepage      = 'https://github.com/ziolmar/chaintown'
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.1"
+
+  spec.add_dependency "activesupport", "~> 5"
+end

data/lib/chaintown/callbacks.rb

@@ -0,0 +1,54 @@
+module Chaintown
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :before_step_actions, default: []
+      class_attribute :after_step_actions, default: []
+      class_attribute :around_step_actions, default: []
+
+      delegate :before_step_actions, :after_step_actions, :around_step_actions, to: :class
+    end
+
+    class_methods do
+      def before_step_action(*callbacks)
+        before_step_actions.concat(callbacks)
+      end
+
+      def after_step_action(*callbacks)
+        after_step_actions.concat(callbacks)
+      end
+
+      def around_step_action(*callbacks)
+        around_step_actions.concat(callbacks)
+      end
+    end
+
+    def run_before_actions
+      before_step_actions.each { |callback| send(callback) }
+    end
+
+    def run_after_actions
+      after_step_actions.each { |callback| send(callback) }
+    end
+
+    def with_around_actions
+      if around_step_actions.present?
+        callbacks = around_step_actions.dup
+        around_callback(callbacks.delete_at(0), callbacks) { yield }
+      else
+        yield
+      end
+    end
+
+    def around_callback(callback, nested_callbacks, &block)
+      send(callback) do
+        if nested_callbacks.present?
+          around_callback(nested_callbacks.delete_at(0), nested_callbacks, &block)
+        else
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/chaintown/chain.rb

@@ -0,0 +1,83 @@
+# This module add ability to define chain of steps
+# which will be called in order.
+# Every step is a method in the class which include this module.
+# Every class receive state and immutable params.
+#
+# State is used to keep information which will be shared between
+# steps. State should inherit from Chaintown::State.
+# Steps are calls only when state is valid in other case invocation
+# is stopped and moved to run steps defined as failed.
+#
+# We can add conditions to step by using *if* parameter.
+# We can also nest steps.
+#
+# Example:
+#
+#   step :step1
+#   step :step2, if: proc { |state, params| params[:run_step_2] }
+#   step :step3 do
+#     step :step4
+#   end
+#   failed_step :step5
+#
+module Chaintown
+  module Chain
+    extend ActiveSupport::Concern
+
+    included do
+      self.extend Chaintown::Steps
+      self.include Chaintown::Callbacks
+
+      attr_reader :state, :params
+      attr_accessor :current_step
+      delegate :steps, :failed_steps, to: :class
+    end
+
+    def initialize(state, params = {})
+      @state, @params = state, params.freeze
+    end
+
+    def perform
+      perform_steps(steps, failed_steps)
+      state
+    end
+
+  protected
+
+    def current_step_name
+      current_step&.step_handler.to_s
+    end
+
+  private
+
+    def perform_steps(steps, failed_steps)
+      steps.each do |step|
+        break unless state.valid?
+        next unless step.if_condition.blank? || self.instance_exec(&step.if_condition)
+        perform_step(step)
+      end
+      unless state.valid?
+        failed_steps.each do |step|
+          next unless step.if_condition.blank? || self.instance_exec(&step.if_condition)
+          perform_step(step)
+        end
+      end
+    end
+
+    def perform_step(step)
+      self.current_step = step # set step to use in callbacks
+      run_before_actions
+      with_around_actions do
+        if step.steps.present?
+          method(step.step_handler).call do
+            perform_steps(step.steps, step.failed_steps)
+            self.current_step = step # set proper step to use in callbacks after processing nested steps
+          end
+        else
+          method(step.step_handler).call
+        end
+      end
+      run_after_actions
+    end
+  end
+end

data/lib/chaintown/state.rb

@@ -0,0 +1,16 @@
+module Chaintown
+  class State
+    attr_accessor :result, :valid, :enroll_type, :enroll_count, :schedule
+    alias_method :valid?, :valid
+
+    def initialize
+      @valid = true
+      @enroll_count = 0
+    end
+
+    def failed(result)
+      @valid = false
+      @result = result
+    end
+  end
+end

data/lib/chaintown/step.rb

@@ -0,0 +1,12 @@
+module Chaintown
+  class Step
+    include Chaintown::Steps
+
+    attr_reader :step_handler
+    attr_accessor :if_condition
+
+    def initialize(step_handler)
+      @step_handler = step_handler
+    end
+  end
+end

data/lib/chaintown/steps.rb

@@ -0,0 +1,66 @@
+# This module add DLS for defininig steps or failed_steps.
+# All steps are of type Chaintown::Step.
+module Chaintown
+  module Steps
+
+    # When module is included we want to make steps and failed_steps
+    # instance variables
+    def self.included(base)
+      base.class_eval do
+        attr_writer :steps, :failed_steps
+
+        define_method(:steps) do
+          instance_variable_get(:@steps) || instance_variable_set(:@steps, [])
+        end
+
+        define_method(:failed_steps) do
+          instance_variable_get(:@failed_steps) || instance_variable_set(:@failed_steps, [])
+        end
+      end
+    end
+
+    # When module is extended we want to make steps and failed steps
+    # variabled of specific class type, so every class will have its own
+    # list of steps
+    def self.extended(base)
+      base.class_eval do
+        attr_writer :steps, :failed_steps
+
+        define_singleton_method(:steps) do
+          instance_variable_get(:@steps) || instance_variable_set(:@steps, [])
+        end
+
+        define_singleton_method(:failed_steps) do
+          instance_variable_get(:@failed_steps) || instance_variable_set(:@failed_steps, [])
+        end
+      end
+    end
+
+    # DLS method to add new step to the list
+    def step(step_handler, **params, &block)
+      steps << init_step(step_handler, params, &block)
+    end
+
+    # DSL method to add new step called when process will fail
+    def failed_step(step_handler, **params, &block)
+      failed_steps << init_step(step_handler, params, &block)
+    end
+
+    # Callback, assure that we add steps from parent class
+    def inherited(subclass)
+      [:steps, :failed_steps].each do |inheritable_attribute|
+        instance_var = "@#{inheritable_attribute}"
+        subclass.instance_variable_set(instance_var, instance_variable_get(instance_var).dup || [])
+      end
+    end
+
+  private
+
+    def init_step(step_handler, params = {}, &block)
+      Chaintown::Step.new(step_handler).tap do |new_step|
+        new_step.if_condition = params[:if] if params.present?
+        new_step.instance_eval(&block) if block_given?
+      end
+    end
+  end
+end

data/lib/chaintown/version.rb

@@ -0,0 +1,3 @@
+module Chaintown
+  VERSION = "0.1.3"
+end

data/lib/chaintown.rb

@@ -0,0 +1,10 @@
+require 'active_support/all'
+require 'chaintown/version'
+require 'chaintown/callbacks'
+require 'chaintown/steps'
+require 'chaintown/step'
+require 'chaintown/state'
+require 'chaintown/chain'
+
+module Chaintown
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: chaintown
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Marcin Ziolkowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-15 00:00:00.000000000 Z
+dependencies:
+- !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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Simple implementation of the pipeline or chain of command design pattern.
+email:
+- ziolmar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chaintown.gemspec
+- lib/chaintown.rb
+- lib/chaintown/callbacks.rb
+- lib/chaintown/chain.rb
+- lib/chaintown/state.rb
+- lib/chaintown/step.rb
+- lib/chaintown/steps.rb
+- lib/chaintown/version.rb
+homepage: https://github.com/ziolmar/chaintown
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Simple implementation of the pipeline or chain of command design pattern.
+test_files: []