end_state 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd9f6c8fbf5f8ec9fd075dabbd2011aa51420465
-  data.tar.gz: 12ba88eafad32a520b119756773f723482054536
+  metadata.gz: 809272ea728fbfd921f3cf13974883104447861e
+  data.tar.gz: 9660e13251dccad1d37fa22c5e5bfdf7cbe917ad
 SHA512:
-  metadata.gz: 569f287932d9c85bb81ff72bfba03e8c5d78d1ea03d492a2ba8379213f794e5fe12f445ee13eab17036c775789a9a88c4525256b71738ca07601c48850c6ea9d
-  data.tar.gz: 497920437e5eea536f63249ffe9bf84875793ab2e39c276cbf1d56e627953a90a05967500acb503f03802b3ad115d5bc4d680f7e528e51052a89c9eb6cd21681
+  metadata.gz: 6f452a250ae2e681e53b79902312903ab8a98ad19c2cf37d72748af0208f6405170cb8b1470c96b6ce7e0e6ef84bfd04f424af9d5bea60633a789758c0c132a0
+  data.tar.gz: 3103761a9adc01570e0d4788a961dc594d72b706eacc34f99a69d15e1a5df52c4a3aa64ba3035140840a63a60de3dd42941990669152f667ab80a8409790fba9

data/README.md

@@ -193,6 +193,29 @@ 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.
 
+## Testing
+
+Included is a custom RSpec matcher for testing your machines.
+
+In your `spec_helper.rb` add:
+
+```ruby
+require 'end_state_matchers'
+```
+
+In the spec for your state machine:
+
+```ruby
+describe Machine do
+  specify { expect(Machine).to have_transition(a: :b).with_guard(MyGuard) }
+  specify { expect(Machine).to have_transition(a: :b).with_finalizer(MyFinalizer) }
+  specify { expect(Machine).to have_transition(a: :b).with_guard(MyGuard).with_finalizer(MyFinalizer) }
+  specify { expect(Machine).to have_transition(a: :b).with_guards(MyGuard, AnotherGuard) }
+  specify { expect(Machine).to have_transition(a: :b).with_finalizers(MyFinalizer, AnotherFinalizer) }
+  specify { expect(Machine).not_to have_transition(a: :c) }
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/Originate/end_state/fork )

data/examples/machine_spec.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'end_state'
+require 'end_state_matchers'
+
+class Easy < EndState::Guard
+  def will_allow?
+    true
+  end
+end
+
+class NoOp < EndState::Finalizer
+  def call
+    true
+  end
+end
+
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.guard Easy
+    t.finalizer NoOp
+  end
+end
+
+describe Machine do
+  specify { expect(Machine).to have_transition(a: :b).with_guard(Easy).with_finalizer(NoOp) }
+  specify { expect(Machine).to have_transition(a: :b).with_guards(Easy, Easy).with_finalizers(NoOp, NoOp) }
+  specify { expect(Machine).not_to have_transition(a: :c) }
+end

data/lib/end_state/version.rb

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

data/lib/end_state_matchers.rb

@@ -0,0 +1,87 @@
+module EndStateMatchers
+  def have_transition(transition)
+    TransitionMatcher.new(transition)
+  end
+
+  class TransitionMatcher
+    attr_reader :transition, :machine, :failure_messages, :guards, :finalizers
+
+    def initialize(transition)
+      @transition = transition
+      @failure_messages = []
+      @guards = []
+      @finalizers = []
+    end
+
+    def matches?(actual)
+      @machine = actual
+      verify
+    end
+
+    def failure_message
+      failure_messages.join("\n")
+    end
+
+    def description
+      "have transition :#{transition.keys.first} => :#{transition.values.first}"
+    end
+
+    def with_guard(guard)
+      @guards << guard
+      self
+    end
+
+    def with_guards(*guards)
+      @guards += Array(guards)
+      self
+    end
+
+    def with_finalizer(finalizer)
+      @finalizers << finalizer
+      self
+    end
+
+    def with_finalizers(*finalizers)
+      @finalizers += Array(finalizers)
+      self
+    end
+
+    private
+
+    def verify
+      result = true
+      if machine.transitions.keys.include? transition
+        result = (result && verify_guards) if guards.any?
+        result = (result && verify_finalizers) if finalizers.any?
+        result
+      else
+        failure_messages << "expected that #{machine.name} would have transition :#{transition.keys.first} => :#{transition.values.first}"
+        false
+      end
+    end
+
+    def verify_guards
+      result = true
+      guards.each do |guard|
+        unless machine.transitions[transition].guards.any? { |g| g[:guard] == guard }
+          failure_messages << "expected that transition :#{transition.keys.first} => :#{transition.values.first} would have guard #{guard.name}"
+          result = false
+        end
+      end
+      result
+    end
+
+    def verify_finalizers
+      result = true
+      finalizers.each do |finalizer|
+        unless machine.transitions[transition].finalizers.any? { |f| f[:finalizer] == finalizer }
+          failure_messages << "expected that transition :#{transition.keys.first} => :#{transition.values.first} would have finalizer #{finalizer.name}"
+          result = false
+        end
+      end
+      result
+    end
+  end
+end
+
+include EndStateMatchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: end_state
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - end_state.gemspec
 - examples/example1.rb
+- examples/machine_spec.rb
 - lib/end_state.rb
 - lib/end_state/action.rb
 - lib/end_state/errors.rb
@@ -94,6 +95,7 @@ files:
 - lib/end_state/state_machine.rb
 - lib/end_state/transition.rb
 - lib/end_state/version.rb
+- lib/end_state_matchers.rb
 - spec/end_state/action_spec.rb
 - spec/end_state/finalizers/persistence_spec.rb
 - spec/end_state/state_machine_spec.rb