sequel-state-machine 1.2.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b067e5d260a2c467a1f1b8b4ec206054c29ab7fc54a86d2b5a89cc7a6620b1
-  data.tar.gz: aea214e6ab04cb78cffc4d580ae1de70011d9f0052562aa3649c217447d9ae0b
+  metadata.gz: d5f7df6f4992d44e4fe205af0b2f52e510738ab27ca5e8b281908b095ccf2a96
+  data.tar.gz: ea9d6726c70aef22d907dbba0dd8e7dec1cc7cced63e0c425df997ed01312f64
 SHA512:
-  metadata.gz: 9e8ee131d5e6da8495c7fb998ca81fbfdb43f8a6b7feb52bb919011e51d2d79c38ca190ba12fbf3d866d4aaf0484ae5db7601f903aec162736abdea1f6f05187
-  data.tar.gz: de91701d5ae07856d516c64963cfb988b12333c1e2bcc929f29d37cabad1cc779929cc9d07216fd6af6afb8780e19a2714b40dbb497918b32ca0e1971ce0cd64
+  metadata.gz: b338921fe0d5784d5d3f397539ca806cf929be159727dae311c0ad61123b4997809ec15fe1e7586c7e8851894b1d35deda749f6f7fb6afba32f4b1da1e62266e
+  data.tar.gz: d6d58511606654d184e4cb9562ffc4a2d3ed7d8a6eab7c4607ed23ca8401a0bfef1499d3d372cf89983d5659d62c512f619119c024170450d7ec80dd11737e9c

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,19 +100,20 @@ 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})
+            mapped_values = last_log.sequel_state_machine_map_columns(
               at: Time.now,
               actor: StateMachines::Sequel.current_actor,
-              messages: current.messages,
+              messages: current.messages || (current.class.state_machine_messages_supports_array ? [] : ""),
               reason: current.reason,
-            ))
+            )
+            last_log.update(**mapped_values)
           else
             StateMachines::Sequel.log(self, :debug, "creating_audit_log", {})
             current.set(**current.sequel_state_machine_map_columns(
@@ -124,7 +135,7 @@ module Sequel
             audlog.messages << message
           else
             audlog.messages ||= ""
-            audlog.messages += (audlog.messages.empty? ? message : (message + "\n"))
+            audlog.messages += (audlog.messages.empty? ? message : ("\n" + message))
           end
           audlog.reason = reason if reason
           return audlog

data/lib/sequel/plugins/state_machine_audit_log.rb

@@ -76,7 +76,7 @@ module Sequel
 
         def full_message
           msg = self.sequel_state_machine_get(:messages)
-          return self.class.state_machine_messages_supports_array ? msg.join(", ") : msg
+          return self.class.state_machine_messages_supports_array ? msg.join("\n") : msg
         end
 
         def sequel_state_machine_get(unmapped)

data/lib/state_machines/sequel/version.rb

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

data/lib/state_machines/sequel.rb

@@ -16,7 +16,7 @@ module StateMachines
         if obj.respond_to?(:audit_logs) && !obj.audit_logs.empty?
           @audit_log = obj.audit_logs.max_by(&:id)
           msg += ": #{@audit_log.full_message}"
-          msg = msg.tr("\n", " ").strip
+          msg = msg.gsub("\n", ", ").strip
         end
         super(obj, msg)
       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.4.0
 platform: ruby
 authors:
 - Lithic Tech
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-25 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,56 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.13.3
 - !ruby/object:Gem::Dependency
   name: rubocop-sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.59'
+- !ruby/object:Gem::Dependency
+  name: sequel-postgres-pr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +183,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +198,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Hook together the excellent Ruby Sequel ORM to the state-machines library,
   with auditing and other tools.