has_state_machine 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aad95d7b489183fa7a7c49af178871cb5cc169dbc3a9ae6bd4a93f7ce48ebea
-  data.tar.gz: 180dbc281d868326a908955013b17fcc935e54de43dbb367212f017e642b994d
+  metadata.gz: 902498121bd57b97de373beaa68557c3591de8a221d524af5b9033be1cca8a73
+  data.tar.gz: fb4806d204772d488c4fb2bc69360cd989edf4c8a5312508b37868d961adf059
 SHA512:
-  metadata.gz: 1eca09471018292e2cc4f41a6a53ec2cf12bc087de32af80595901099a4b589131b529bbf53891de89eacc86c5a9a3c16ca7102f31faec63443003c697c45a7e
-  data.tar.gz: 1b5a1e0a93e9f0648deac92b4fcba653ffeec037e9b3959092e71b5f9b391c93118e352ced5e7c1f44f385ceed1130ab62f1fde11dc4282ea2fb17097e66d47a
+  metadata.gz: 1baeee9d74f64325427b52e2e867cab05db7848f384316b8175cbb5d49a2c4030dcf905020ac8091c495f6cfa20f8dcae657bcffd78b86987e9c867665f5cf42
+  data.tar.gz: 7e998865b342452f802266b3408bd673b26fb622672ed48ff18cb384259c34a7ec1f591a9ed99efb12f33364e5a1c9bff33d9b95bd4fbac3794ff9d3f2ccdd25

data/README.md

@@ -96,6 +96,13 @@ module Workflow
       # after_transition callbacks as well.
       Rails.logger.info "== Transitioned from #{previous_state} ==\n"
     end
+
+    # after_transition_commit runs only once the transition has been
+    # committed: after the record is saved for normal transitions, and
+    # outside the transaction for transactional transitions (see below).
+    after_transition_commit do
+      MyJob.perform_later(object)
+    end
   end
 end
 ```
@@ -206,10 +213,20 @@ module Workflow
       rollback_transition unless notified_watchers?
     end
 
+    after_transition_commit do
+      enqueue_external_work
+    end
+
     private
 
+    def enqueue_external_work
+      # Any work you want to happen only after the transition is committed.
+      # Enqueuing a job, calling an external API, sending a webhook, etc.
+    end
+
     def notified_watchers?
-      #...
+      # Any dependent work that you want to run that should play a part in determining
+      # whether the transition was successful or not and needs to be rolled back.
     end
   end
 end

data/lib/has_state_machine/state.rb

@@ -15,6 +15,11 @@ module HasStateMachine
     # for use on a HasStateMachine::State instance.
     define_model_callbacks :transition, only: %i[before after]
 
+    ##
+    # Defines the after_transition_commit callback. It runs only after a
+    # transition has committed.
+    define_model_callbacks :transition_commit, only: %i[after]
+
     ##
     # possible_transitions - Retrieves the next available transitions for a given state.
     # transactional? - Determines whether or not the transition should happen with a transactional block.
@@ -80,25 +85,34 @@ module HasStateMachine
 
     ##
     # Makes the actual transition from one state to the next and
-    # runs the before and after transition callbacks.
+    # runs the before and after transition callbacks. The
+    # after_transition_commit callbacks run after the update completes
+    # and only when it succeeds.
     def perform_transition!
-      run_callbacks :transition do
-        object.update("#{object.state_attribute}": state)
+      run_callbacks :transition_commit do
+        run_callbacks :transition do
+          object.update("#{object.state_attribute}": state)
+        end
       end
     end
 
     ##
     # Makes the actual transition from one state to the next and
     # runs the before and after transition callbacks in a transaction
-    # to allow for roll backs.
+    # to allow for roll backs. The after_transition_commit callbacks run
+    # outside the transaction and only when it commits (not on rollback).
     def perform_transactional_transition!
-      ActiveRecord::Base.transaction(requires_new: true, joinable: false) do
-        run_callbacks :transition do
-          rollback_transition unless object.update("#{object.state_attribute}": state)
+      run_callbacks :transition_commit do
+        ActiveRecord::Base.transaction(requires_new: true, joinable: false) do
+          run_callbacks :transition do
+            rollback_transition unless object.update("#{object.state_attribute}": state)
+          end
         end
-      end
 
-      object.reload.public_send(object.state_attribute) == state
+        @previous_state = previous_state
+
+        object.reload.public_send(object.state_attribute) == state
+      end
     end
 
     private
@@ -112,7 +126,7 @@ module HasStateMachine
     # it has been transitioned to the new state. Useful in
     # after_transition blocks
     def previous_state
-      object.previous_changes[object.state_attribute]&.first
+      @previous_state.presence || object.previous_changes[object.state_attribute]&.first
     end
 
     def state_instance(desired_state, transient_values)

data/lib/has_state_machine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HasStateMachine
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_state_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Hargett
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 description: HasStateMachine uses ruby classes to make creating a finite state machine
   in your ActiveRecord models a breeze.
 email: