nxt_state_machine 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b32ce5c0f8c968180650e6497e84076803948c832e84d5c63145ff10050c46
-  data.tar.gz: 5a5f210aaf9b8f0d8278a66851f4d3be8f278a4a448975252610b3eebe292b06
+  metadata.gz: 37f01d32a03c0c09b47018719f8b05b2439497034807ad0e6fa098a6d7d832ed
+  data.tar.gz: '02682339637194f92d32240b759e51cab84cd590a789af74c66109e27d5ce912'
 SHA512:
-  metadata.gz: fbbf6e38dc538a6e5018d9839c591ddf707cc5d348c310582680e8cf588715545214ebe1b16ab70dddad63a0cfa97ab7d66121752ffc1034813128fdb0f2e1e7
-  data.tar.gz: ef95346d040eb48905820314241e67009d846c00c71725cc2ab24948db0e426d7cdddb1fd55c01d7e63a15d465d0342adf9d35f888d6c62d1d21ba596f19bd54
+  metadata.gz: e777bbfeffb013b7591d0d2e18169a7311d324aefe7ad2a97f181b53926f6d6aa0f2a3cd08728ca1e544ac21b5ca5893ae4479c39ff93e54ac083a0b8399cdb5
+  data.tar.gz: 53ff5dd521de00050a1fe553c7dfd560f1cc8fde10e8cfc1cdea571873b22f4ac3be103ec1863314b64da0a04d95244a19f655e41794395dbcc4b8708f720a8e

data/Gemfile.lock

@@ -1,36 +1,36 @@
 PATH
   remote: .
   specs:
-    nxt_state_machine (0.1.6)
+    nxt_state_machine (0.1.7)
       activesupport
       nxt_registry (~> 0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
+    method_source (1.0.0)
     minitest (5.14.0)
-    nxt_registry (0.1.4)
+    nxt_registry (0.1.5)
       activesupport
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -51,7 +51,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -83,6 +83,10 @@ class ArticleWorkflow
         puts 'around transition exit'
       end
 
+      on_success from: any_state, to: :approved do |transition|
+        # This is the last callback in the chain - It runs outside of the active record transaction
+      end
+
       on_error CustomError from: any_state, to: :approved do |error, transition|
       end
     end
@@ -277,10 +281,10 @@ Transitions can be halted in callbacks and during the transition itself simply b
 
 ### Callbacks
 
-You can register `before_transition`, `around_transition` and `after_transition` callbacks. By defining the 
-:from and :to states you decide on which transitions the callback actually runs. Around callbacks need to call the
-proc object that they get passed in. Registering callbacks inside an event block or on the state_machine top level
-behaves exactly the same way and is only a matter of structure. The only thing that defines when callbacks run is
+You can register `before_transition`, `around_transition`, `after_transition` and `on_success` callbacks. 
+By defining the :from and :to states you decide on which transitions the callback actually runs. Around callbacks need 
+to call the proc object that they get passed in. Registering callbacks inside an event block or on the state_machine top
+level behaves exactly the same way and is only a matter of structure. The only thing that defines when callbacks run is
 the :from and :to parameters with which they are registered.
    
 
@@ -298,6 +302,11 @@ event :approve do
     block.call  
     puts 'around transition exit'
   end
+
+  # Use this to trigger another event after the transaction around the transition completed 
+  on_success from: any_state, to: :approved do |transition|
+    # This is the last callback in the chain - It runs outside of the active record transaction
+  end
 end
 ```
 

data/lib/nxt_state_machine/event.rb

@@ -18,6 +18,7 @@ module NxtStateMachine
     delegate :before_transition,
              :after_transition,
              :around_transition,
+             :on_success,
              :on_error,
              :on_error!,
              :any_state,

data/lib/nxt_state_machine/integrations/active_record.rb

@@ -65,7 +65,7 @@ module NxtStateMachine
 
         raise defused_error if defused_error
 
-        result
+        transition.run_success_callbacks || result
       rescue StandardError => error
         target.assign_attributes(state_attr => transition.from.to_s)
 

data/lib/nxt_state_machine/integrations/attr_accessor.rb

@@ -22,7 +22,7 @@ module NxtStateMachine
           result = set_state(target, transition, state_attr)
           transition.run_after_callbacks
 
-          result
+          transition.run_success_callbacks || result
         rescue StandardError => error
           target.send("#{state_attr}=", transition.from.enum)
 
@@ -38,7 +38,7 @@ module NxtStateMachine
           result = set_state(target, transition, state_attr)
           transition.run_after_callbacks
 
-          result
+          transition.run_success_callbacks || result
         rescue StandardError
           target.send("#{state_attr}=", transition.from.enum)
           raise

data/lib/nxt_state_machine/integrations/hash.rb

@@ -21,7 +21,7 @@ module NxtStateMachine
           transition.run_before_callbacks
           result = set_state(current_target, transition, state_attr)
           transition.run_after_callbacks
-          result
+          transition.run_success_callbacks || result
         rescue StandardError => error
           current_target[state_attr] = transition.from.enum
 
@@ -37,7 +37,7 @@ module NxtStateMachine
           result = set_state(current_target, transition, state_attr)
           transition.run_after_callbacks
 
-          result
+          transition.run_success_callbacks || result
         rescue StandardError
           current_target[state_attr] = transition.from.enum
           raise

data/lib/nxt_state_machine/state_machine.rb

@@ -117,6 +117,10 @@ module NxtStateMachine
       callbacks.register(from, to, :after, run, block)
     end
 
+    def on_success(from:, to:, run: nil, &block)
+      callbacks.register(from, to, :success, run, block)
+    end
+
     def defuse(errors = [], from:, to:)
       defuse_registry.register(from, to, errors)
     end
@@ -147,16 +151,23 @@ module NxtStateMachine
       run_callbacks(transition, :after, context)
     end
 
+    def run_success_callbacks(transition, context)
+      run_callbacks(transition, :success, context)
+    end
+
     def find_error_callback(error, transition)
       error_callback_registry.resolve(error, transition)
     end
 
     def run_callbacks(transition, kind, context)
       current_callbacks = callbacks.resolve(transition, kind)
+      return unless current_callbacks.any?
 
       current_callbacks.each do |callback|
         Callable.new(callback).bind(context).call(transition)
       end
+
+      true
     end
 
     def current_state_name(context)

data/lib/nxt_state_machine/transition.rb

@@ -11,9 +11,10 @@ module NxtStateMachine
       @set_state_method = set_state_method
       @context = context
       @block = block
+      @result = nil
     end
 
-    attr_reader :name, :from, :to, :block, :event
+    attr_reader :name, :from, :to, :block, :event, :result
 
     # This triggers the set state method
     def trigger
@@ -31,7 +32,7 @@ module NxtStateMachine
 
     # This must be used in set_state method to actually execute the transition within the around callback chain
     def execute(&block)
-      Transition::Proxy.new(event, state_machine,self, context).call(&block)
+      self.result = Transition::Proxy.new(event, state_machine,self, context).call(&block)
     end
 
     alias_method :with_around_callbacks, :execute
@@ -44,9 +45,13 @@ module NxtStateMachine
       state_machine.run_after_callbacks(self, context)
     end
 
+    def run_success_callbacks
+      state_machine.run_success_callbacks(self, context)
+    end
+
     private
 
     attr_reader :state_machine, :set_state_method, :context
-    attr_writer :block
+    attr_writer :block, :result
   end
 end

data/lib/nxt_state_machine/version.rb

@@ -1,3 +1,3 @@
 module NxtStateMachine
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport