end_state 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd9f6c8fbf5f8ec9fd075dabbd2011aa51420465
+  data.tar.gz: 12ba88eafad32a520b119756773f723482054536
+SHA512:
+  metadata.gz: 569f287932d9c85bb81ff72bfba03e8c5d78d1ea03d492a2ba8379213f794e5fe12f445ee13eab17036c775789a9a88c4525256b71738ca07601c48850c6ea9d
+  data.tar.gz: 497920437e5eea536f63249ffe9bf84875793ab2e39c276cbf1d56e627953a90a05967500acb503f03802b3ad115d5bc4d680f7e528e51052a89c9eb6cd21681

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.hound.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Include:
+    - Rakefile
+    - config.ru
+  Exclude:
+    - db/**
+    - config/**
+    - spec/*helper.rb
+
+LineLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+AndOr:
+  Enabled: false

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  ./.hound.yml

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 alexpeachey
+
+MIT License
+
+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,202 @@
+# EndState
+
+EndState is an unobtrusive way to add state machines to your application.
+
+An `EndState::StateMachine` acts as a decorator of sorts for your stateful object.
+Your stateful object does not need to know it is being used in a state machine and
+only needs to respond to `state` and `state=`. (This is customizable)
+
+The control flow for guarding against transitions and performing post-transition
+operations is handled by classes you create allowing maximum separation of responsibilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'end_state'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install end_state
+
+## StateMachine
+
+Create a state machine by subclassing `EndState::StateMachine`.
+
+```ruby
+class Machine < EndState::StateMachine
+  transition a: :b
+  transition b: :c
+  transition [:b, :c] => :a
+end
+```
+
+Use it by wrapping a stateful object.
+
+```ruby
+class StatefulObject
+  attr_accessor :state
+
+  def initialize(state)
+    @state = state
+  end
+end
+
+machine = Machine.new(StatefulObject.new(:a))
+
+machine.transition :b       # => true
+machine.state               # => :b
+machine.b?                  # => true
+machine.c!                  # => true
+machine.state               # => :c
+machine.can_transition? :b  # => false
+machine.can_transition? :a  # => true
+machine.b!                  # => false
+machine.a!                  # => true
+machine.state               # => :a
+```
+
+## Guards
+
+Guards can be created by subclassing `EndState::Guard`. Your class will be provided access to:
+
+* `object` - The wrapped object.
+* `state` - The desired state.
+* `params` - A hash of params as set in the transition definition.
+
+Your class should implement the `will_allow?` method which must return true or false.
+
+Optionally you can implement the `passed` and/or `failed` methods which will be called after the guard passes or fails.
+These will only be called during the check performed during the transition and will not be fired when asking `can_transition?`.
+These hooks can be useful for things like logging.
+
+The wrapped object has an array `failure_messages` available for tracking reasons for invalid transitions. You may shovel
+a reason (string) into this if you want to provide information on why your guard failed.
+
+```ruby
+class EasyGuard < EndState::Guard
+  def will_allow?
+    true
+  end
+
+  def failed
+    Rails.logger.error "Failed to transition to state #{state} from #{object.state}."
+  end
+end
+```
+
+A guard can be added to the transition definition:
+
+```ruby
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.guard EasyGuard
+    t.guard SomeOtherGuard, option1: 'Some Option', option2: 'Some Other Option'
+  end
+end
+```
+
+## Finalizers
+
+Finalizers can be created by subclassing `EndState::Finalizer`. Your class will be provided access to:
+
+* `object` - The wrapped object that has been transitioned.
+* `state` - The previous state.
+* `params` - A hash of params as set in the transition definition.
+
+Your class should implement the `call` method which should return true or false as to whether it was successful or not.
+
+If your finalizer returns false, the transition will be "rolled back" and the failing transition, as well as all previous transitions
+will be rolled back. The roll back is performed by calling `rollback` on the finalizer. During the roll back the finalizer will be
+set up a little differently and you have access to:
+
+* `object` - The wrapped object that has been rolled back.
+* `state` - The attempted desired state.
+* `params` - A hash of params as set in the transition definition.
+
+The wrapped object has an array `failure_messages` available for tracking reasons for invalid transitions. You may shovel
+a reason (string) into this if you want to provide information on why your finalizer failed.
+
+```ruby
+class WrapUp < EndState::Finalizer
+  def call
+    # Some important processing
+    true
+  end
+
+  def rollback
+    # Undo stuff that shouldn't have been done.
+  end
+end
+```
+
+A finalizer can be added to the transition definition:
+
+```ruby
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.finalizer WrapUp, option1: 'Some Option', option2: 'Some Other Option'
+  end
+end
+```
+
+Since it is a common use case, a finalizer is included which will call `save` on the wrapped object if it responds to `save`.
+You can use this with a convience method in your transition definition:
+
+```ruby
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.persistence_on
+  end
+end
+```
+
+## Action
+
+By default, a transition from one state to another is handled by `EndState` and only changes the state to the new state.
+This is the recommended default and you should have a good reason to do something more or different.
+If you really want to do something different though you can create a class that subclasses `EndState::Action` and implement
+the `call` method.
+
+You will have access to:
+
+* `object` - The wrapped object.
+* `state` - The desired state.
+
+```ruby
+class MyCustomAction < EndState::Action
+  def call
+    # Do something special
+    super
+  end
+end
+```
+
+```ruby
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.custom_action MyCustomAction
+  end
+end
+```
+
+## Exceptions for failing Transitions
+
+By default `transition` will only raise an exception, `EndState::UnknownState`, if called with a state that doesn't exist.
+All other failures, such as missing transition, guard failure, or finalizer failure will silently just return `false` and not
+transition to the new state.
+
+You also have the option to use `transition!` which will instead raise an error for failures. If your guards and/or finalizers
+add to the `failure_messages` array then they will be included in the error message.
+
+## Contributing
+
+1. Fork it ( https://github.com/Originate/end_state/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/end_state.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'end_state/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'end_state'
+  spec.version       = EndState::VERSION
+  spec.authors       = ['alexpeachey']
+  spec.email         = ['alex.peachey@gmail.com']
+  spec.summary       = 'A State Machine implementation'
+  spec.description   = 'A modular state machine with single responsibilities.'
+  spec.homepage      = 'https://github.com/Originate/end_state'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/examples/example1.rb

@@ -0,0 +1,70 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'end_state'
+
+class Easy < EndState::Guard
+  def will_allow?
+    true
+  end
+end
+
+class NoOp < EndState::Finalizer
+  def call
+    true
+  end
+
+  def rollback
+    true
+  end
+end
+
+class CustomAction < EndState::Action
+  def call
+    super
+  end
+end
+
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.guard Easy, important_param: 'FOO!'
+    t.persistence_on
+  end
+
+  transition b: :c do |t|
+    t.custom_action CustomAction
+    t.persistence_on
+  end
+
+  transition [:b, :c] => :a do |t|
+    t.finalizer NoOp, not_very_important_param: 'Ignore me'
+    t.persistence_on
+  end
+end
+
+class StatefulObject
+  attr_accessor :state
+
+  def initialize(state)
+    @state = state
+  end
+
+  def save
+    puts "Saved with state: #{state}"
+    true
+  end
+end
+
+object = StatefulObject.new(:a)
+machine = Machine.new(object)
+
+puts "The machine's class is: #{machine.class.name}"
+puts "The machine's object class is: #{machine.object.class.name}"
+puts
+
+%i( b c a c).each do |state|
+  puts "Attempting to move to #{state}"
+  machine.transition state
+  puts "State: #{machine.state}"
+  predicate = "#{state}?".to_sym
+  puts "#{state}?: #{machine.send(predicate)}"
+  puts
+end

data/lib/end_state/action.rb

@@ -0,0 +1,19 @@
+module EndState
+  class Action
+    attr_reader :object, :state
+
+    def initialize(object, state)
+      @object = object
+      @state = state
+    end
+
+    def call
+      object.state = state
+      true
+    end
+
+    def rollback
+      call
+    end
+  end
+end

data/lib/end_state/errors.rb

@@ -0,0 +1,7 @@
+module EndState
+  class Error < StandardError; end
+  class UnknownState < Error; end
+  class UnknownTransition < Error; end
+  class GuardFailed < Error; end
+  class FinalizerFailed < Error; end
+end

data/lib/end_state/finalizer.rb

@@ -0,0 +1,19 @@
+module EndState
+  class Finalizer
+    attr_reader :object, :state, :params
+
+    def initialize(object, state, params)
+      @object = object
+      @state = state
+      @params = params
+    end
+
+    def call
+      false
+    end
+
+    def rollback
+      true
+    end
+  end
+end

data/lib/end_state/finalizers/persistence.rb

@@ -0,0 +1,15 @@
+module EndState
+  module Finalizers
+    class Persistence < EndState::Finalizer
+      def call
+        return false unless object.respond_to? :save
+        !!(object.save)
+      end
+
+      def rollback
+        return true unless object.respond_to? :save
+        !!(object.save)
+      end
+    end
+  end
+end

data/lib/end_state/finalizers.rb

@@ -0,0 +1 @@
+require 'end_state/finalizers/persistence'

data/lib/end_state/guard.rb

@@ -0,0 +1,28 @@
+module EndState
+  class Guard
+    attr_reader :object, :state, :params
+
+    def initialize(object, state, params)
+      @object = object
+      @state = state
+      @params = params
+    end
+
+    def allowed?
+      will_allow?.tap do |result|
+        failed unless result
+        passed if result
+      end
+    end
+
+    def will_allow?
+      false
+    end
+
+    def passed
+    end
+
+    def failed
+    end
+  end
+end

data/lib/end_state/state_machine.rb

@@ -0,0 +1,93 @@
+module EndState
+  class StateMachine < SimpleDelegator
+    attr_accessor :failure_messages
+
+    def self.transition(state_map, &block)
+      final_state = state_map.values.first
+      transition = Transition.new(final_state)
+      Array(state_map.keys.first).each do |state|
+        transitions[{ state => final_state }] = transition
+      end
+      yield transition if block
+    end
+
+    def self.transitions
+      @transitions ||= {}
+    end
+
+    def self.state_attribute(attribute)
+      define_method(:state) { send(attribute.to_sym) }
+      define_method(:state=) { |val| send("#{attribute}=".to_sym, val) }
+    end
+
+    def self.states
+      (start_states + end_states).uniq
+    end
+
+    def self.start_states
+      transitions.keys.map { |state_map| state_map.keys.first }.uniq
+    end
+
+    def self.end_states
+      transitions.keys.map { |state_map| state_map.values.first }.uniq
+    end
+
+    def object
+      __getobj__
+    end
+
+    def can_transition?(state)
+      previous_state = self.state
+      transition = self.class.transitions[{ previous_state => state }]
+      return block_transistion(transition, state, :soft) unless transition
+      transition.will_allow? state
+    end
+
+    def transition(state, mode = :soft)
+      @failure_messages = []
+      previous_state = self.state
+      transition = self.class.transitions[{ previous_state => state }]
+      return block_transistion(transition, state, mode) unless transition
+      return guard_failed(state, mode) unless transition.allowed?(self)
+      return false unless transition.action.new(self, state).call
+      return finalize_failed(state, mode) unless transition.finalize(self, previous_state)
+      true
+    end
+
+    def transition!(state)
+      transition state, :hard
+    end
+
+    def method_missing(method, *args, &block)
+      check_state = method.to_s[0..-2].to_sym
+      return super unless self.class.states.include? check_state
+      if method.to_s.end_with?('?')
+        state == check_state
+      elsif method.to_s.end_with?('!')
+        transition check_state
+      else
+        super
+      end
+    end
+
+    private
+
+    def block_transistion(transition, state, mode)
+      if self.class.end_states.include? state
+        fail UnknownTransition, "The transition: #{object.state} => #{state} is unknown." if mode == :hard
+        return false
+      end
+      fail UnknownState, "The state: #{state} is unknown." unless transition
+    end
+
+    def guard_failed(state, mode)
+      return false unless mode == :hard
+      fail GuardFailed, "The transition to #{state} was blocked: #{failure_messages.join(', ')}"
+    end
+
+    def finalize_failed(state, mode)
+      return false unless mode == :hard
+      fail FinalizerFailed, "The transition to #{state} was rolled back: #{failure_messages.join(', ')}"
+    end
+  end
+end

data/lib/end_state/transition.rb

@@ -0,0 +1,57 @@
+module EndState
+  class Transition
+    attr_reader :state
+    attr_accessor :action, :guards, :finalizers
+
+    def initialize(state)
+      @state = state
+      @action = Action
+      @guards = []
+      @finalizers = []
+    end
+
+    def allowed?(object)
+      guards.all? { |guard| guard[:guard].new(object, state, guard[:params]).allowed? }
+    end
+
+    def will_allow?(object)
+      guards.all? { |guard| guard[:guard].new(object, state, guard[:params]).will_allow? }
+    end
+
+    def finalize(object, previous_state)
+      finalizers.each_with_object([]) do |finalizer, finalized|
+        finalized << finalizer
+        return rollback(finalized, object, previous_state) unless run_finalizer(finalizer, object, state)
+      end
+      true
+    end
+
+    def custom_action(action)
+      @action = action
+    end
+
+    def guard(guard, params = {})
+      guards << { guard: guard, params: params }
+    end
+
+    def finalizer(finalizer, params = {})
+      finalizers << { finalizer: finalizer, params: params }
+    end
+
+    def persistence_on
+      finalizer Finalizers::Persistence
+    end
+
+    private
+
+    def rollback(finalized, object, previous_state)
+      action.new(object, previous_state).rollback
+      finalized.reverse.each { |f| f[:finalizer].new(object, state, f[:params]).rollback }
+      false
+    end
+
+    def run_finalizer(finalizer, object, state)
+      finalizer[:finalizer].new(object, state, finalizer[:params]).call
+    end
+  end
+end

data/lib/end_state/version.rb

@@ -0,0 +1,3 @@
+module EndState
+  VERSION = "0.0.1"
+end

data/lib/end_state.rb

@@ -0,0 +1,12 @@
+require 'delegate'
+require 'end_state/version'
+require 'end_state/errors'
+require 'end_state/guard'
+require 'end_state/finalizer'
+require 'end_state/finalizers'
+require 'end_state/transition'
+require 'end_state/action'
+require 'end_state/state_machine'
+
+module EndState
+end

data/spec/end_state/action_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module EndState
+  describe Action do
+    subject(:action) { Action.new(object, state) }
+    let(:object) { OpenStruct.new(state: nil) }
+    let(:state) { :a }
+
+    describe '#call' do
+      it 'changes the state to the new state' do
+        action.call
+        expect(object.state).to eq :a
+      end
+    end
+
+    describe '#rollback' do
+      it 'changes the state to the new state' do
+        action.rollback
+        expect(object.state).to eq :a
+      end
+    end
+  end
+end

data/spec/end_state/finalizers/persistence_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module EndState
+  module Finalizers
+    describe Persistence do
+      subject(:finalizer) { Persistence.new(object, state, params) }
+      let(:object) { double :object, save: nil }
+      let(:state) { :b }
+      let(:params) { {} }
+
+      describe '#call' do
+        it 'calls save on the object' do
+          finalizer.call
+          expect(object).to have_received(:save)
+        end
+
+        context 'when the object does not respond to save' do
+          let(:object) { Object.new }
+
+          it 'returns false' do
+            expect(finalizer.call).to be_false
+          end
+        end
+      end
+
+      describe '#rollback' do
+        it 'calls save on the object' do
+          finalizer.rollback
+          expect(object).to have_received(:save)
+        end
+
+        context 'when the object does not respond to save' do
+          let(:object) { Object.new }
+
+          it 'returns true' do
+            expect(finalizer.rollback).to be_true
+          end
+        end
+      end
+    end
+  end
+end

data/spec/end_state/state_machine_spec.rb

@@ -0,0 +1,327 @@
+require 'spec_helper'
+require 'ostruct'
+
+module EndState
+  describe StateMachine do
+    subject(:machine) { StateMachine.new(object) }
+    let(:object) { OpenStruct.new(state: nil) }
+    before { StateMachine.instance_variable_set '@transitions'.to_sym, nil }
+
+    describe '.transition' do
+      let(:state_map) { { a: :b } }
+      let(:yielded) { OpenStruct.new(transition: nil) }
+      before { StateMachine.transition(state_map) { |transition| yielded.transition = transition } }
+
+      it 'yields a transition for the supplied end state' do
+        expect(yielded.transition.state).to eq :b
+      end
+
+      it 'does not require a block' do
+        expect(StateMachine.transition(b: :c)).not_to raise_error
+      end
+
+      it 'adds the transition to the state machine' do
+        expect(StateMachine.transitions[state_map]).to eq yielded.transition
+      end
+    end
+
+    describe '.state_attribute' do
+      context 'when set to :foobar' do
+        let(:object) { OpenStruct.new(foobar: :a) }
+        before { StateMachine.state_attribute :foobar }
+
+        it 'answers state with foobar' do
+          expect(machine.state).to eq object.foobar
+        end
+
+        it 'answers state= with foobar=' do
+          machine.state = :b
+          expect(object.foobar).to eq :b
+        end
+
+        after do
+          StateMachine.send(:remove_method, :state)
+          StateMachine.send(:remove_method, :state=)
+        end
+      end
+    end
+
+    describe '.states' do
+      before do
+        StateMachine.transition(a: :b)
+        StateMachine.transition(b: :c)
+      end
+
+      specify { expect(StateMachine.states).to eq [:a, :b, :c] }
+    end
+
+    describe '.start_states' do
+      before do
+        StateMachine.transition(a: :b)
+        StateMachine.transition(b: :c)
+      end
+
+      specify { expect(StateMachine.start_states).to eq [:a, :b] }
+    end
+
+    describe '.end_states' do
+      before do
+        StateMachine.transition(a: :b)
+        StateMachine.transition(b: :c)
+      end
+
+      specify { expect(StateMachine.end_states).to eq [:b, :c] }
+    end
+
+    describe '#state' do
+      context 'when the object has state :a' do
+        let(:object) { OpenStruct.new(state: :a) }
+
+        specify { expect(machine.state).to eq :a }
+      end
+
+      context 'when the object has state :b' do
+        let(:object) { OpenStruct.new(state: :b) }
+
+        specify { expect(machine.state).to eq :b }
+      end
+    end
+
+    describe '#{state}?' do
+      before do
+        StateMachine.transition a: :b
+        StateMachine.transition b: :c
+      end
+
+      context 'when the object has state :a' do
+        let(:object) { OpenStruct.new(state: :a) }
+
+        specify { expect(machine.a?).to be_true }
+        specify { expect(machine.b?).to be_false }
+      end
+
+      context 'when the object has state :b' do
+        let(:object) { OpenStruct.new(state: :b) }
+
+        specify { expect(machine.b?).to be_true }
+        specify { expect(machine.a?).to be_false }
+      end
+    end
+
+    describe '#{state}!' do
+      let(:object) { OpenStruct.new(state: :a) }
+      before do
+        StateMachine.transition a: :b
+      end
+
+      it 'transitions the state' do
+        machine.b!
+        expect(machine.state).to eq :b
+      end
+    end
+
+    describe '#can_transition?' do
+      let(:object) { OpenStruct.new(state: :a) }
+      before do
+        StateMachine.transition a: :b
+        StateMachine.transition b: :c
+      end
+
+      context 'when asking about an allowed transition' do
+        specify { expect(machine.can_transition? :b).to be_true }
+      end
+
+      context 'when asking about a disallowed transition' do
+        specify { expect(machine.can_transition? :c).to be_false }
+      end
+    end
+
+    describe '#transition' do
+      context 'when the transition does not exist' do
+        it 'raises an unknown state error' do
+          expect { machine.transition(:no_state) }.to raise_error(UnknownState)
+        end
+
+        context 'but the attempted state does exist' do
+          before { StateMachine.transition a: :b }
+
+          it 'returns false' do
+            expect(machine.transition(:b)).to be_false
+          end
+        end
+      end
+
+      context 'when the transition does exist' do
+        before { object.state = :a }
+
+        context 'and no configuration is given' do
+          before { StateMachine.transition a: :b }
+
+          it 'transitions the state' do
+            machine.transition :b
+            expect(object.state).to eq :b
+          end
+        end
+
+        context 'and a guard is configured' do
+          let(:guard) { double :guard, new: guard_instance }
+          let(:guard_instance) { double :guard_instance, allowed?: nil }
+          before do
+            StateMachine.transition a: :b
+            StateMachine.transitions[{ a: :b }].guards << { guard: guard, params: {} }
+          end
+
+          context 'and the object satisfies the guard' do
+            before do
+              guard_instance.stub(:allowed?).and_return(true)
+              object.state = :a
+            end
+
+            it 'transitions the state' do
+              machine.transition :b
+              expect(object.state).to eq :b
+            end
+          end
+
+          context 'and the object does not satisfy the guard' do
+            before do
+              guard_instance.stub(:allowed?).and_return(false)
+              object.state = :a
+            end
+
+            it 'does not transition the state' do
+              machine.transition :b
+              expect(object.state).to eq :a
+            end
+          end
+        end
+
+        context 'and a finalizer is configured' do
+          before do
+            StateMachine.transition a: :b do |transition|
+              transition.persistence_on
+            end
+          end
+
+          context 'and the finalizer is successful' do
+            before do
+              object.state = :a
+              object.stub(:save).and_return(true)
+            end
+
+            it 'transitions the state' do
+              machine.transition :b
+              expect(object.state).to eq :b
+            end
+          end
+
+          context 'and the finalizer fails' do
+            before do
+              object.state = :a
+              object.stub(:save).and_return(false)
+            end
+
+            it 'does not transition the state' do
+              machine.transition :b
+              expect(object.state).to eq :a
+            end
+          end
+        end
+      end
+    end
+
+    describe '#transition!' do
+      context 'when the transition does not exist' do
+        it 'raises an unknown state error' do
+          expect { machine.transition!(:no_state) }.to raise_error(UnknownState)
+        end
+
+        context 'but the attempted state does exist' do
+          before { StateMachine.transition a: :b }
+
+          it 'returns false' do
+            expect { machine.transition!(:b) }.to raise_error(UnknownTransition)
+          end
+        end
+      end
+
+      context 'when the transition does exist' do
+        before { object.state = :a }
+
+        context 'and no configuration is given' do
+          before { StateMachine.transition a: :b }
+
+          it 'transitions the state' do
+            machine.transition! :b
+            expect(object.state).to eq :b
+          end
+        end
+
+        context 'and a guard is configured' do
+          let(:guard) { double :guard, new: guard_instance }
+          let(:guard_instance) { double :guard_instance, allowed?: nil }
+          before do
+            StateMachine.transition a: :b
+            StateMachine.transitions[{ a: :b }].guards << { guard: guard, params: {} }
+          end
+
+          context 'and the object satisfies the guard' do
+            before do
+              guard_instance.stub(:allowed?).and_return(true)
+              object.state = :a
+            end
+
+            it 'transitions the state' do
+              machine.transition! :b
+              expect(object.state).to eq :b
+            end
+          end
+
+          context 'and the object does not satisfy the guard' do
+            before do
+              guard_instance.stub(:allowed?).and_return(false)
+              object.state = :a
+            end
+
+            it 'does not transition the state' do
+              expect { machine.transition! :b }.to raise_error(GuardFailed)
+              expect(object.state).to eq :a
+            end
+          end
+        end
+
+        context 'and a finalizer is configured' do
+          before do
+            StateMachine.transition a: :b do |transition|
+              transition.persistence_on
+            end
+          end
+
+          context 'and the finalizer is successful' do
+            before do
+              object.state = :a
+              object.stub(:save).and_return(true)
+            end
+
+            it 'transitions the state' do
+              machine.transition! :b
+              expect(object.state).to eq :b
+            end
+          end
+
+          context 'and the finalizer fails' do
+            before do
+              object.state = :a
+              object.stub(:save).and_return(false)
+            end
+
+            it 'does not transition the state' do
+              expect { machine.transition! :b }.to raise_error(FinalizerFailed)
+              expect(object.state).to eq :a
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/end_state/transition_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'ostruct'
+
+module EndState
+  describe Transition do
+    subject(:transition) { Transition.new(state) }
+    let(:state) { :a }
+
+    describe '#custom_action' do
+      let(:custom) { double :custom }
+
+      it 'sets the action' do
+        transition.custom_action custom
+        expect(transition.action).to eq custom
+      end
+    end
+
+    describe '#guard' do
+      let(:guard) { double :guard }
+
+      it 'adds a guard' do
+        expect { transition.guard guard }.to change(transition.guards, :count).by(1)
+      end
+
+      context 'when params are provided' do
+        let(:params) { {} }
+
+        it 'adds a guard' do
+          expect { transition.guard guard, params }.to change(transition.guards, :count).by(1)
+        end
+      end
+    end
+
+    describe '#allowed?' do
+      let(:guard) { double :guard, new: guard_instance }
+      let(:guard_instance) { double :guard_instance, allowed?: nil }
+      before { transition.guards << { guard: guard, params: {} } }
+
+      context 'when all guards pass' do
+        let(:object) { double :object }
+        before { guard_instance.stub(:allowed?).and_return(true) }
+
+        specify { expect(transition.allowed? object).to be_true }
+      end
+
+      context 'when not all guards pass' do
+        let(:object) { double :object }
+        before { guard_instance.stub(:allowed?).and_return(false) }
+
+        specify { expect(transition.allowed? object).to be_false }
+      end
+    end
+
+    describe '#will_allow?' do
+      let(:guard) { double :guard, new: guard_instance }
+      let(:guard_instance) { double :guard_instance, will_allow?: nil }
+      before { transition.guards << { guard: guard, params: {} } }
+
+      context 'when all guards pass' do
+        let(:object) { double :object }
+        before { guard_instance.stub(:will_allow?).and_return(true) }
+
+        specify { expect(transition.will_allow? object).to be_true }
+      end
+
+      context 'when not all guards pass' do
+        let(:object) { double :object }
+        before { guard_instance.stub(:will_allow?).and_return(false) }
+
+        specify { expect(transition.will_allow? object).to be_false }
+      end
+    end
+
+    describe '#finalizer' do
+      let(:finalizer) { double :finalizer }
+
+      it 'adds a finalizer' do
+        expect { transition.finalizer finalizer }.to change(transition.finalizers, :count).by(1)
+      end
+
+      context 'when params are provided' do
+        let(:params) { {} }
+
+        it 'adds a finalizer' do
+          expect { transition.finalizer finalizer, params }.to change(transition.finalizers, :count).by(1)
+        end
+      end
+    end
+
+    describe '#persistence_on' do
+      it 'adds a Persistence finalizer' do
+        expect { transition.persistence_on }.to change(transition.finalizers, :count).by(1)
+      end
+    end
+
+    describe '#finalize' do
+      let(:finalizer) { double :finalizer, new: finalizer_instance }
+      let(:finalizer_instance) { double :finalizer_instance, call: nil, rollback: nil }
+      let(:object) { OpenStruct.new(state: :b) }
+      before { transition.finalizers << { finalizer: finalizer, params: {} } }
+
+      context 'when all finalizers succeed' do
+        before { finalizer_instance.stub(:call).and_return(true) }
+
+        specify { expect(transition.finalize object, :a).to be_true }
+      end
+
+      context 'when not all finalizers succeed' do
+        before { finalizer_instance.stub(:call).and_return(false) }
+
+        specify { expect(transition.finalize object, :a).to be_false }
+
+        it 'rolls them back' do
+          transition.finalize object, :a
+          expect(finalizer_instance).to have_received(:rollback)
+        end
+      end
+    end
+  end
+end

data/spec/end_state_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe EndState do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'end_state'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: end_state
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: A modular state machine with single responsibilities.
+email:
+- alex.peachey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- end_state.gemspec
+- examples/example1.rb
+- lib/end_state.rb
+- lib/end_state/action.rb
+- lib/end_state/errors.rb
+- lib/end_state/finalizer.rb
+- lib/end_state/finalizers.rb
+- lib/end_state/finalizers/persistence.rb
+- lib/end_state/guard.rb
+- lib/end_state/state_machine.rb
+- lib/end_state/transition.rb
+- lib/end_state/version.rb
+- spec/end_state/action_spec.rb
+- spec/end_state/finalizers/persistence_spec.rb
+- spec/end_state/state_machine_spec.rb
+- spec/end_state/transition_spec.rb
+- spec/end_state_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Originate/end_state
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A State Machine implementation
+test_files:
+- spec/end_state/action_spec.rb
+- spec/end_state/finalizers/persistence_spec.rb
+- spec/end_state/state_machine_spec.rb
+- spec/end_state/transition_spec.rb
+- spec/end_state_spec.rb
+- spec/spec_helper.rb