statesman 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f79354b244926e7be655b02df501cfed437ab2da6e869ec8db35097bb5ef372
-  data.tar.gz: 2b6ad54a68b6bca463c00c9e09a83d2d2d9d47d984fad212da77b0b0fd8a18a9
+  metadata.gz: 137c7306b24f584a5b3e442ef5326ac210518c6ec64b3955106803b4d9bcddcc
+  data.tar.gz: 88cc9d95d0b6ff92a257e7afdc9510bd372b562e0aeaa92403bc51b762485f1f
 SHA512:
-  metadata.gz: e66962ac0dd871627bdf6c53c5282e140bd109c3fcd0ba2ebd25504c490e3ddf2050132aabdf143c35aff09330e229afe8ec57c7d7fc43552bcff8140f8f0fa0
-  data.tar.gz: 9e3fa636071bcd530b177e80bf1014071d38601da2076e5258ffed22f41eec388255db2b03b79710130624c5fb6c60009af511b76d478be718f5fc69a6f0e933
+  metadata.gz: 6c5f8ad449fcea9f476d990048348eb766e2b65cf6f188118fc45162764f64656f6fec5ea65fbd797a999b517402501b5edbe2d45a834d5dcaf492f566b47f53
+  data.tar.gz: '038b822e77c6a07df87cc8d4ab792b8bf5f7c61ed7f38548a6751d579fca3b988ef32a8f2cd6d609cf25b521218a87952cf4590400584add3031ff4cfe895eff'

data/CHANGELOG.md

@@ -1,6 +1,31 @@
+## v5.1.0, 22th November 2019
+
+- Correct `Statesman::Adapters::ActiveRecordQueries` error text [@Bramjetten](https://github.com/gocardless/statesman/pull/376)
+- Removes duplicate `map` call [Isaac Seymour](https://github.com/gocardless/statesman/pull/362)
+- Update changelog with instructions of how to use `ActiveRecordQueries` added
+  in v5.0.0
+- Pass exception into `after_transition_failure` and `after_guard_failure` callbacks [@credric-cordenier](https://github.com/gocardless/statesman/pull/378)
+
 ## v5.0.0, 11th November 2019
 
 - Adds new syntax and restrictions to ActiveRecordQueries [PR#358](https://github.com/gocardless/statesman/pull/358). With the introduction of this, defining `self.transition_class` or `self.initial_state` is deprecated and will be removed in the next major release.
+  Change
+  ```ruby
+    include Statesman::Adapters::ActiveRecordQueries
+    def self.initial_state
+      :initial
+    end
+    def self.transition_class
+      MyTransition
+    end
+  ```
+  to
+  ```ruby
+    include Statesman::Adapters::ActiveRecordQueries[
+      initial_state: :inital,
+      transition_class: MyTransition
+    ]
+  ```
 
 ## v4.1.4, 11th November 2019
 

data/README.md

@@ -1,4 +1,4 @@
-![Statesman](http://f.cl.ly/items/410n2A0S3l1W0i3i0o2K/statesman.png)
+<p align="center"><img src="http://f.cl.ly/items/410n2A0S3l1W0i3i0o2K/statesman.png" alt="Statesman"></p>
 
 A statesmanlike state machine library.
 
@@ -30,7 +30,7 @@ protection.
 To get started, just add Statesman to your `Gemfile`, and then run `bundle`:
 
 ```ruby
-gem 'statesman', '~> 5.0.0'
+gem 'statesman', '~> 5.1.0'
 ```
 
 ## Usage
@@ -257,28 +257,28 @@ transition has been committed to the database.
 
 #### `Machine.after_transition_failure`
 ```ruby
-Machine.after_transition_failure(from: :some_state, to: :another_state) do |object|
-  Logger.info("transition failed for #{object.id}")
+Machine.after_transition_failure(from: :some_state, to: :another_state) do |object, exception|
+  Logger.info("transition to #{exception.to} failed for #{object.id}")
 end
 ```
 Define a callback to run if `Statesman::TransitionFailedError` is raised
 during the execution of transition callbacks. `to` and `from`
 parameters are optional, a nil parameter means run after all transitions.
-The model object is passed as an argument to the callback.
+The model object, and exception are passed as arguments to the callback.
 This is executed outside of the transaction wrapping other callbacks.
 If using `transition!` the exception is re-raised after these callbacks are
 executed.
 
 #### `Machine.after_guard_failure`
 ```ruby
-Machine.after_guard_failure(from: :some_state, to: :another_state) do |object|
-  Logger.info("guard failed for #{object.id}")
+Machine.after_guard_failure(from: :some_state, to: :another_state) do |object, exception|
+  Logger.info("guard failed during transition to #{exception.to} for #{object.id}")
 end
 ```
 Define a callback to run if `Statesman::GuardFailedError` is raised
 during the execution of guard callbacks. `to` and `from`
 parameters are optional, a nil parameter means run after all transitions.
-The model object is passed as an argument to the callback.
+The model object, and exception are passed as arguments to the callback.
 This is executed outside of the transaction wrapping other callbacks.
 If using `transition!` the exception is re-raised after these callbacks are
 executed.

data/lib/statesman/adapters/active_record_queries.rb

@@ -8,7 +8,7 @@ module Statesman
 
         raise NotImplementedError,
               "#{missing_methods.join(', ')} method(s) should be defined on " \
-              "the model. Alternatively, use the new form of `extend " \
+              "the model. Alternatively, use the new form of `include " \
               "Statesman::Adapters::ActiveRecordQueries[" \
               "transition_class: MyTransition, " \
               "initial_state: :some_state]`"
@@ -62,7 +62,7 @@ module Statesman
 
         def define_in_state(base, query_builder)
           base.define_singleton_method(:in_state) do |*states|
-            states = states.flatten.map(&:to_s)
+            states = states.flatten
 
             joins(most_recent_transition_join).
               where(query_builder.states_where(states), states)
@@ -71,7 +71,7 @@ module Statesman
 
         def define_not_in_state(base, query_builder)
           base.define_singleton_method(:not_in_state) do |*states|
-            states = states.flatten.map(&:to_s)
+            states = states.flatten
 
             joins(most_recent_transition_join).
               where("NOT (#{query_builder.states_where(states)})", states)

data/lib/statesman/exceptions.rb

@@ -2,7 +2,7 @@ module Statesman
   class InvalidStateError < StandardError; end
   class InvalidTransitionError < StandardError; end
   class InvalidCallbackError < StandardError; end
-  class GuardFailedError < StandardError; end
+
   class TransitionFailedError < StandardError
     def initialize(from, to)
       @from = from
@@ -15,6 +15,20 @@ module Statesman
       "Cannot transition from '#{from}' to '#{to}'"
     end
   end
+
+  class GuardFailedError < StandardError
+    def initialize(from, to)
+      @from = from
+      @to = to
+    end
+
+    attr_reader :from, :to
+
+    def message
+      "Guard on transition from: '#{from}' to '#{to}' returned false"
+    end
+  end
+
   class TransitionConflictError < StandardError; end
   class MissingTransitionAssociation < StandardError; end
 

data/lib/statesman/guard.rb

@@ -4,10 +4,7 @@ require_relative "exceptions"
 module Statesman
   class Guard < Callback
     def call(*args)
-      unless super(*args)
-        raise GuardFailedError,
-              "Guard on transition from: '#{from}' to '#{to}' returned false"
-      end
+      raise GuardFailedError.new(from, to) unless super(*args)
     end
   end
 end

data/lib/statesman/machine.rb

@@ -231,15 +231,20 @@ module Statesman
       @storage_adapter.create(initial_state, new_state, metadata)
 
       true
-    rescue TransitionFailedError
-      execute(:after_transition_failure, initial_state, new_state)
+    rescue TransitionFailedError => e
+      execute_on_failure(:after_transition_failure, initial_state, new_state, e)
       raise
-    rescue GuardFailedError
-      execute(:after_guard_failure, initial_state, new_state)
+    rescue GuardFailedError => e
+      execute_on_failure(:after_guard_failure, initial_state, new_state, e)
       raise
     end
 
-    def execute(phase, initial_state, new_state, transition = nil)
+    def execute_on_failure(phase, initial_state, new_state, exception)
+      callbacks = callbacks_for(phase, from: initial_state, to: new_state)
+      callbacks.each { |cb| cb.call(@object, exception) }
+    end
+
+    def execute(phase, initial_state, new_state, transition)
       callbacks = callbacks_for(phase, from: initial_state, to: new_state)
       callbacks.each { |cb| cb.call(@object, transition) }
     end

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "5.0.0".freeze
+  VERSION = "5.1.0".freeze
 end

data/spec/statesman/machine_spec.rb

@@ -680,6 +680,24 @@ describe Statesman::Machine do
           end
         end
 
+        context "which covers all transitions" do
+          let(:result) { true }
+          let(:guard_cb) { ->(*_args) { false } }
+
+          before { machine.guard_transition(from: :x, to: :y, &guard_cb) }
+
+          it "raises an exception with the transition information" do
+            expect(guard_cb).to receive(:call).once.with(
+              my_model, instance.last_transition, {}
+            ).and_return(false)
+            expect { instance.transition_to!(:y) }.
+              to raise_error(
+                an_instance_of(Statesman::GuardFailedError).
+                and(having_attributes(from: "x", to: ["y"])),
+              )
+          end
+        end
+
         context "which passes" do
           it "changes state" do
             instance.transition_to!(:y)
@@ -703,7 +721,7 @@ describe Statesman::Machine do
 
             it "calls the failure callback" do
               expect(guard_failure_cb).to receive(:call).once.with(
-                my_model, nil
+                my_model, instance_of(Statesman::GuardFailedError)
               ).and_return(guard_failure_result)
               expect { instance.transition_to!(:y) }.
                 to raise_error(Statesman::GuardFailedError)
@@ -722,8 +740,9 @@ describe Statesman::Machine do
         end
 
         it "raises and exception and calls the callback" do
-          expect(transition_failed_cb).to receive(:call).once.
-            with(my_model, nil).and_return(true)
+          expect(transition_failed_cb).to receive(:call).once.with(
+            my_model, instance_of(Statesman::TransitionFailedError)
+          ).and_return(true)
           expect { instance.transition_to!(:z) }.
             to raise_error(Statesman::TransitionFailedError)
         end
@@ -749,7 +768,7 @@ describe Statesman::Machine do
     context "when it is unsuccesful" do
       before do
         allow(instance).to receive(:transition_to!).
-          and_raise(Statesman::GuardFailedError)
+          and_raise(Statesman::GuardFailedError.new(:x, :some_state))
       end
 
       it { is_expected.to be_falsey }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter