sequel-state-machine 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b067e5d260a2c467a1f1b8b4ec206054c29ab7fc54a86d2b5a89cc7a6620b1
-  data.tar.gz: aea214e6ab04cb78cffc4d580ae1de70011d9f0052562aa3649c217447d9ae0b
+  metadata.gz: 66c4bb795fc20985f7b8c94a41d85020f0a4cb74974f36df8434aa3f46ee6ebb
+  data.tar.gz: 2725ec4bc5941b310923dfb44b0397cba560af00022f85309b9fea6a5015599f
 SHA512:
-  metadata.gz: 9e8ee131d5e6da8495c7fb998ca81fbfdb43f8a6b7feb52bb919011e51d2d79c38ca190ba12fbf3d866d4aaf0484ae5db7601f903aec162736abdea1f6f05187
-  data.tar.gz: de91701d5ae07856d516c64963cfb988b12333c1e2bcc929f29d37cabad1cc779929cc9d07216fd6af6afb8780e19a2714b40dbb497918b32ca0e1971ce0cd64
+  metadata.gz: 0c346b5561103439e1b28490c9e86d11b59663d16693490ae5e08f2895b82fd62af22c6caf383ad19038769f5b881506eaf4e3c6a6a8fcd9ec47c56a89e71947
+  data.tar.gz: 8241f9061b035a9d17b025328e5639f50bb596462b3628e59b198c4bd32f188693339a307380b20a119c540a480389ead36e8f51dfb95a4bcb855471ac80e231

data/lib/sequel/plugins/state_machine.rb

@@ -83,6 +83,16 @@ module Sequel
           return alog
         end
 
+        # Commit pending changes to the audit log.
+        # This involves either:
+        # - Updating the last audit log step, if it matches our current criteria (event, from state, to state),
+        # - or creating a new audit log entry.
+        # This ensures that we have the following behavior:
+        # - Failed transitions - ie where from and to state are the same - do not add multiple audit log steps.
+        #   Only the latest failed transition is recorded.
+        # - Successful transitions are always recorded. If we transition, a->b->c,
+        #   and then reset the state machine to 'a' and transition a->b->c again,
+        #   we'd end up with 5 transitions (a->b->c->a->b->c).
         def commit_audit_log(transition)
           machine = self.class.state_machines.length > 1 ? transition.machine.name : nil
           StateMachines::Sequel.log(
@@ -90,14 +100,14 @@ module Sequel
           )
           current = self.current_audit_log(machine: machine)
 
-          last_saved = self.audit_logs.find do |a|
-            a.sequel_state_machine_get(:event) == transition.event.to_s &&
-              a.sequel_state_machine_get(:from_state) == transition.from &&
-              a.sequel_state_machine_get(:to_state) == transition.to
-          end
-          if last_saved
-            StateMachines::Sequel.log(self, :debug, "updating_audit_log", {audit_log_id: last_saved.id})
-            last_saved.update(**last_saved.sequel_state_machine_map_columns(
+          last_log = self.audit_logs.last
+          can_update_last = last_log &&
+            last_log.sequel_state_machine_get(:event) == transition.event.to_s &&
+            last_log.sequel_state_machine_get(:from_state) == transition.from &&
+            last_log.sequel_state_machine_get(:to_state) == transition.to
+          if can_update_last
+            StateMachines::Sequel.log(self, :debug, "updating_audit_log", {audit_log_id: last_log.id})
+            last_log.update(**last_log.sequel_state_machine_map_columns(
               at: Time.now,
               actor: StateMachines::Sequel.current_actor,
               messages: current.messages,

data/lib/state_machines/sequel/version.rb

@@ -2,6 +2,6 @@
 
 module StateMachines
   module Sequel
-    VERSION = "1.2.2"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-state-machine
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Lithic Tech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-25 00:00:00.000000000 Z
+date: 2022-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec