hopscotch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11e34e73cb8b90c514f46582abec823f62c9e117
+  data.tar.gz: 553d488f944437ba0372bd26a252a7500490df60
+SHA512:
+  metadata.gz: 1ed0160c9985a117ba55c9ebaf2ec4e50f41482705c7cf78649a931e3dcc8aec3073b75c3f99b723055a523e0a48235e3d168a22464cb296bc0b855565ce7ddd
+  data.tar.gz: 98f4c2dd2437e25b59acd31b380aff30784a4de0b8939c0d13145e9386ee7e719cc637a609e7379cbffa39a44ca1191e835c1d2e3c9510396671089369a413c6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Garrett Heinlen
+
+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,330 @@
+# Hopscotch
+
+Hopscotch allows us to chain together complex logic and ensure if any specific part of the chain fails, everything is rolled back to its original state.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hopscotch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hopscotch
+
+## Usage
+
+The Hopscotch gem is made up out of 2 essential parts. Runners and Steps.
+
+Some simple usage examples. Detailed explanations below.
+
+```ruby
+# - simple lambdas steps
+# - compose steps into 1 function
+# - runner call function with success/failure callbacks
+success_step = -> { Hopscotch::Step.success! }
+fail_step = -> { Hopscotch::Step.failure!("bad") }
+
+reduced_fn = Hopscotch::StepComposer.compose_with_error_handling(success_step, success_step, success_step)
+Hopscotch::Runner.call(reduced_fn, success: -> { "success" }, failure: -> (x) { "failure: #{x}" })
+# => "success"
+
+error_reduced_fn = Hopscotch::StepComposer.compose_with_error_handling(success_step, fail_step, success_step)
+Hopscotch::Runner.call(error_reduced_fn, success: -> { "success" }, failure: -> (x) { "failure: #{x}" })
+# => "failure: bad"
+
+
+# - simple lambdas steps
+# - runner call function + compose steps inline with success/failure callbacks
+success_step_1 = -> { Hopscotch::Step.success! }
+success_step_2 = -> { Hopscotch::Step.success! }
+
+Hopscotch::Runner.call(
+  Hopscotch::StepComposer.call_each(success_step_1, success_step_2),
+  success: -> { "success" },
+  failure: -> (x) { "failure: #{x}" },
+)
+# => "success"
+
+
+# Module method to compose multiple steps into 1 step
+# - runner call composed function with success/failure callbacks
+module ChainSteps
+  extend self
+  def call
+    Hopscotch::StepComposer.call_each(
+      -> { Hopscotch::Step.success! },
+      -> do
+        if 2.even?
+          Hopscotch::Step.success!
+        else
+          Hopscotch::Step.failure!
+        end
+      end
+    )
+  end
+end
+
+Hopscotch::Runner.call_each(
+  ChainSteps,
+  success: -> { "success" },
+  failure: -> (x) { "failure: #{x}" },
+)
+# => "success"
+```
+
+### Top level architecture
+
+![hopscotch](https://cloud.githubusercontent.com/assets/873687/9781348/8c23c872-57d6-11e5-8903-991838f4b3c6.png)
+
+### Runners
+A runner is a pipeline to run steps and handle the success or failure of the group of them.
+
+Runners are not meant to be the point of reuse or shared behavior. They are simply a way to run steps.
+
+Runners can call an array of steps and compose them under the hood.
+
+```ruby
+Hopscotch::Runner.call_each(
+  -> { Hopscotch::Step.success! },
+  -> { Hopscotch::Step.success! },
+  success: -> { success.call("The step was successful!", Time.now.to_i) },
+  failure: failure
+)
+```
+
+You can optionally compose the steps manually (great for reuse) and just make use of the `Runner#call` method.
+
+```ruby
+success_step_1 = -> { Hopscotch::Step.success! }
+success_step_2 = -> { Hopscotch::Step.success! }
+
+Hopscotch::Runner.call(
+  Hopscotch::StepComposer.call_each(success_step_1, success_step_2),
+  success: -> { success.call("The step was successful!", Time.now.to_i) },
+  failure: failure
+)
+```
+
+### Steps
+
+A step is a function type. It can be plugged into any module/class as long as it conforms to returning `Hopscotch::Step.success!` or `Hopscotch::Step.failure!`
+
+These two functions wrap the return value to let the runner know if the step was successful or not.
+
+```ruby
+module Service
+  module AddItemToCart
+    extend self
+
+    def call(item, cart)
+      if cart.add(item)
+        Hopscotch::Step.success!
+      else
+        Hopscotch::Step.failure!
+      end
+    end
+  end
+end
+```
+
+**note** You can optionally pass in values to `success!` and `failure!` to be used outside of the step. ie: `failure!(cart.errors)`
+
+### A typical use-case
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    success = -> (response, time) { redirect_to root_path, notice: "#{response} - at: #{time}" }
+    failure = -> { render :new }
+    Workflow::CreateUser.call(params[:name], success: success, failure: failure)
+  end
+end
+
+module Workflow
+  module CreateUser
+    extend self
+
+    def call(name, success:, failure:)
+      Hopscotch::Runner.call_each(
+        -> { Service::CreateUser.call(name) },
+        success: -> { success.call("Workflow::CreateUser worked!", Time.now.to_i) },
+        failure: failure
+      )
+    end
+  end
+end
+
+module Service
+  module CreateUser
+    extend self
+
+    def call(name)
+      if User.create(name: name)
+        Hopscotch::Steps.success!
+      else
+        Hopscotch::Steps.failure!
+      end
+    end
+  end
+end
+```
+
+### Reusing steps
+
+A common problem you might run into when dealing with multiple runners and steps is the need to copy 90% of a previous runner but just change 1 or 2 step calls. Let's make it happen.
+
+Let's take an example of `Signup` runner which creates a student, and sends them an email.
+
+```ruby
+module Workflow
+  module Signup
+    def call(student_params, success:, failure:)
+      # We make heavy use of form objects, so this is a common pattern for us
+      # but you can really do what ever you want in here..
+      form = Form::NewStudent.new(student_params)
+
+      Hopscotch::Runner.call_each(
+        -> { Service::CreateStudent.call(form) }, # these return `Hopscotch::Step.success!` or `Hopscotch::Step.failure!`
+        -> { Service::NotifyStudent.call(form) }
+        success: success,
+        failure: failure
+      )
+    end
+  end
+end
+```
+
+Here's a brief example of what the services might look like.
+
+```ruby
+module Service
+  module CreateStudent
+    extend self
+
+    def call(student_form)
+      if student_form.valid? && student_form.save
+        Hopscotch::Steps.success!
+      else
+        Hopscotch::Steps.failure!(student_form.errors)
+      end
+    end
+  end
+end
+
+module Service
+  module NotifyStudent
+    extend self
+
+    def call(student_form)
+      if Notify::SendMail.new(student_form).deliver
+        Hopscotch::Steps.success!
+      else
+        Hopscotch::Steps.failure!
+      end
+    end
+  end
+end
+```
+
+Here we just ensure the student is valid and persisted and then send a mailer.
+
+All is well in love and steps. Let's assume that something in the system has to change (as it rarely does..), and we need to add a new step to the process to the runner, but only for a segmented part of our user base. Phew..
+
+The new feature request comes in and we want to give free points to a student when they signup if they are home schooled. While we could chunk some lovely if statements into our runner or steps to do this, I prefer to create a new runner only for this particular interaction in the system. Let's start.
+
+```ruby
+module Workflow
+  module SignupWithFreePoints
+    def call(student_params, success:, failure:)
+      form = Form::NewStudent.new(student_params)
+
+      Hopscotch::Runner.call_each(
+        -> { Service::CreateStudent.call(form) }, # this is duplication.. :(
+        -> { Service::NotifyStudent.call(form) }, # this is duplication.. :(
+        -> { Service::GiveFreePointsToStudent.call(form) }, # this sucker is the new one
+        success: success,
+        failure: failure
+      )
+    end
+  end
+end
+```
+
+While this example _could_ work, we're already duplicating code and things could easily get out of sync with the previous Signup runner. Let's say steps get removed or changed and we forget to update in both places.. bug reports will soon roll in. Let's fix this.
+
+Here is where Steps shine. Steps can be composed to nest other steps. Let's see how we can clean up our code with a new Step that utilizes this.
+
+```ruby
+module Service
+  module CreateStudentAndNotify
+    extend self
+
+    def call(student_form)
+      # This will bubble up the success or failure of both of these nested steps
+      # and return a success! or failure! depending on the collected results.
+      Hopscotch::StepComposer.call_each(
+        -> { Service::CreateStudent.call(student_form) },
+        -> { Service::NotifyStudent.call(student_form) }
+      )
+    end
+  end
+end
+```
+
+What does this mean for our runner? They get simpler and allow for quick reuse! Let's see.
+
+```ruby
+module Workflow
+  module Signup
+    def call(student_params, success:, failure:)
+      form = Form::NewStudent.new(student_params)
+
+      Hopscotch::Runner.call_each(
+        -> { Service::CreateStudentAndNotify.call(form) },
+        success: success,
+        failure: failure
+      )
+    end
+  end
+end
+
+module Workflow
+  module SignupWithFreePoints
+    def call(student_params, success:, failure:)
+      form = Form::NewStudent.new(student_params)
+
+      Hopscotch::Runner.call_each(
+        -> { Service::CreateStudentAndNotify.call(form) }, # re-use steps
+        -> { Service::GiveFreePointsToStudent.call(form) }, # the new step
+        success: success,
+        failure: failure
+      )
+    end
+  end
+end
+```
+
+2 runners, different behavior - no duplication. It's a beauty.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/blake-education/hopscotch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hopscotch"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hopscotch.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hopscotch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hopscotch"
+  spec.version       = Hopscotch::VERSION
+  spec.authors       = ["Garrett Heinlen"]
+  spec.email         = ["heinleng@gmail.com"]
+
+  spec.summary       = %q{simplify complex business logic.}
+  spec.description   = %q{Hopscotch allows us to chain together complex logic and ensure if any specific part of the chain fails, everything is rolled back to its original state.}
+  spec.homepage      = "https://github.com/blake-education/hopscotch"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+end

data/lib/hopscotch.rb

@@ -0,0 +1,32 @@
+require "hopscotch/version"
+
+require "hopscotch/error"
+require "hopscotch/step"
+require "hopscotch/step_composers/default"
+require "hopscotch/runners/default"
+
+module Hopscotch
+  module Runner
+    extend self
+
+    def call(fn, failure:, success:)
+      Hopscotch::Runners::Default.call(fn, failure: failure, success: success)
+    end
+
+    def call_each(*fns, failure:, success:)
+      Hopscotch::Runners::Default.call_each(*fns, failure: failure, success: success)
+    end
+  end
+
+  module StepComposer
+    extend self
+
+    def call_each(*fns)
+      Hopscotch::StepComposers::Default.call_each(fns)
+    end
+
+    def compose_with_error_handling(*fns)
+      Hopscotch::StepComposers::Default.compose_with_error_handling(fns)
+    end
+  end
+end

data/lib/hopscotch/error.rb

@@ -0,0 +1,39 @@
+module Hopscotch
+  # `ErrorValue` denotes an error.
+  #
+  # ```
+  # data ReturnValue = ErrorValue value | value
+  # ```
+  #
+  # In the context of Ruby and `Workflows` this means:
+  # - a value represents an error iff it is an `ErrorValue`
+  # - otherwise the value represents success
+  #
+  class ErrorValue < Struct.new(:value)
+  end
+
+  # `Error` provides helper functions for working with ErrorValue (and thus ReturnValue)
+  module Error
+    extend self
+
+    # Returns `true` if `e` is an error
+    def error?(e)
+      ErrorValue === e
+    end
+
+    # Returns `false` if `e` is an error
+    def success?(e)
+      ! error?(e)
+    end
+
+    # Convert `e` into a value representing an error, if required.
+    def to_error(e)
+      case e
+      when ErrorValue
+        e
+      else
+        ErrorValue.new(e)
+      end
+    end
+  end
+end

data/lib/hopscotch/runners/default.rb

@@ -0,0 +1,53 @@
+module Hopscotch
+  module Runners
+    module Default
+      extend self
+
+      # Execute `fn` within an `ActiveRecord` transaction.
+      #
+      # Rough types:
+      # ```
+      # fn :: void -> ReturnValue
+      # failure :: value -> NilClass
+      #
+      # success :: value -> NilClass
+      # # or
+      # success :: void -> NilClass
+      # ```
+      #
+      # If `fn` returns an `ErrorValue`, roll back the transaction and call `failure` with the unwrapped error `value`.
+      # Otherwise commit the transaction and call success.
+      def call(fn, failure:, success:)
+        error = nil
+        result = nil
+
+        ActiveRecord::Base.transaction do
+          result = fn.call
+
+          if Hopscotch::Error.error?(result)
+            error = result
+            raise ActiveRecord::Rollback
+          end
+        end
+
+        if error
+          failure.call(error.value)
+        else
+          success.arity == 1 ? success.call(result) : success.call
+        end
+      end
+
+      # `call_each` composes a list of functions into a single function
+      # which it then passes along to a `call` to perform the workflow logic.
+      #
+      # Each fn should have the rough type:
+      # ```
+      # fn :: void -> ReturnValue
+      # ```
+      #
+      def call_each(*fns, failure:, success:)
+        call ::Hopscotch::StepComposers::Default.compose_with_error_handling(*fns), failure: failure, success: success
+      end
+    end
+  end
+end

data/lib/hopscotch/step.rb

@@ -0,0 +1,13 @@
+module Hopscotch
+  module Step
+    extend self
+
+    def success!(value = true)
+      value
+    end
+
+    def failure!(value = false)
+      Hopscotch::Error.to_error(value)
+    end
+  end
+end

data/lib/hopscotch/step_composers/default.rb

@@ -0,0 +1,46 @@
+module Hopscotch
+  module StepComposers
+    module Default
+      extend self
+
+      # `call_each` composes a list of functions into a single function
+      # which it thens calls, returning the result of the composition
+      #
+      # Each fn should have the rough type:
+      # ```
+      # fn :: void -> ReturnValue
+      # ```
+      #
+      def call_each(*fns)
+        compose_with_error_handling(fns).call
+      end
+
+      # Composes a list of functions into a single function.
+      #
+      # *Note* that this isn't a general purpose composition.
+      # *Note* a function here is anything that responds to `call` i.e. lambda or a singleton module.
+      #
+      # The composed function and each constituent function have the same signature, roughly:
+      # ```
+      # fn :: void -> ReturnValue
+      # ```
+      #
+      # *Note* that `void` is used here to mean "takes no arguments".
+      # This is a dead giveaway that functions of this type signature will have side effects.
+      #
+      def compose_with_error_handling(*fns)
+        redcued_fn = fns.flatten.compact.inject do |composed, fn|
+          -> do
+            last_return = composed.call
+            if Hopscotch::Error.error?(last_return)
+              last_return
+            else
+              fn.call
+            end
+          end
+        end
+        redcued_fn || -> { Hopscotch::Step.success! }
+      end
+    end
+  end
+end

data/lib/hopscotch/version.rb

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: hopscotch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garrett Heinlen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Hopscotch allows us to chain together complex logic and ensure if any
+  specific part of the chain fails, everything is rolled back to its original state.
+email:
+- heinleng@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hopscotch.gemspec
+- lib/hopscotch.rb
+- lib/hopscotch/error.rb
+- lib/hopscotch/runners/default.rb
+- lib/hopscotch/step.rb
+- lib/hopscotch/step_composers/default.rb
+- lib/hopscotch/version.rb
+homepage: https://github.com/blake-education/hopscotch
+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.4.7
+signing_key: 
+specification_version: 4
+summary: simplify complex business logic.
+test_files: []