journaled 5.1.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d27e8931e64963620ecd1fd44c4a46c244470a6715dc19c56a7a1a29aaa97b6
-  data.tar.gz: f95df32775abd3f65cb8d526c60fae948fc69425957a378e4007765fdade14c0
+  metadata.gz: 677d0f45ee5a62e362e5889cfee0745e6645be394617b60585302ccbf28099a0
+  data.tar.gz: 30c02276b17d9cfce2534f530806b2b037c42e0b3708ef0d10b194f295f09e74
 SHA512:
-  metadata.gz: 1cd4a144b2cc6dbb398b082dfe97b93829ab5d0e2ad7c22fb807ff63be9d9f5e1b24278db14eb947ce247c92f8fd09e135010ce9bc546e6e34589f98fdccaeb9
-  data.tar.gz: 10da7fde07cfe2e7d654978a99c0734976f7199efd1d1d5e6aa11684d30d537d625acf238e0f636f8dec75b298920a8bf3f64a8c41105ddab40f624b03f1e8d6
+  metadata.gz: a8b5fb2a36241ea80bfe6f07965fe048e9b5f246ff71e77c61259d78f9739e41b20a3dcf669a2ab1514169c95e01d2b8e21ac885beaa943243b6abc2ad673deb
+  data.tar.gz: 65baecc64ef3f99fae2e45e5133ec844cf16fcaad2463b103d8d03ad95eb32de52bde0341a58c07c65a25935359e80913806d68b12cea2de74f48517ce2d177a

data/README.md

@@ -345,6 +345,15 @@ Journaled::AuditLog.with_snapshots do
 end
 ```
 
+Snapshots can also be enabled globally for all _deletion_ operations. Since
+`changes` will be empty on deletion, you should consider using this if you care
+about the contents of any records being deleted (and/or don't have a full audit
+trail from their time of creation):
+
+```ruby
+Journaled::AuditLog.snapshot_on_deletion = true
+```
+
 Events with snapshots will continue to populate the `changes` field, but will
 additionally contain a snapshot with the full state of the user:
 
@@ -673,6 +682,14 @@ This feature can be disabled conditionally:
 Journaled.transactional_batching_enabled = false
 ```
 
+And can then be enabled via the following block:
+
+```ruby
+Journaled.with_transactional_batching do
+  # your code
+end
+```
+
 Backwards compatibility has been included for background jobs enqueued by
 version 4.0 and above, but **has been dropped for jobs emitted by versions prior
 to 4.0**. (Again, be sure to upgrade only one major version at a time.)

data/app/models/journaled/audit_log/event.rb

@@ -58,7 +58,8 @@ module Journaled
       end
 
       def snapshot
-        filtered_attributes if record._log_snapshot || AuditLog.snapshots_enabled
+        filtered_attributes if record._log_snapshot || AuditLog.snapshots_enabled ||
+          (database_operation == 'delete' && AuditLog.snapshot_on_deletion)
       end
 
       def actor

data/lib/journaled/audit_log.rb

@@ -18,6 +18,7 @@ module Journaled
     mattr_accessor(:default_enqueue_opts) { {} }
     mattr_accessor(:excluded_classes) { DEFAULT_EXCLUDED_CLASSES.dup }
     thread_mattr_accessor(:snapshots_enabled) { false }
+    thread_mattr_accessor(:snapshot_on_deletion) { false }
     thread_mattr_accessor(:_disabled) { false }
     thread_mattr_accessor(:_force) { false }
 
@@ -82,7 +83,7 @@ module Journaled
 
       def dup
         super.tap do |config|
-          config.ignored_columns = ignored_columns.dup
+          config.ignored_columns = ignored_columns.dup # rubocop:disable Rails/IgnoredColumnsAssignment
           config.enqueue_opts = enqueue_opts.dup
         end
       end

data/lib/journaled/connection.rb

@@ -2,11 +2,11 @@ module Journaled
   module Connection
     class << self
       def available?
-        Journaled.transactional_batching_enabled && transaction_open?
+        Journaled.transactional_batching_enabled? && transaction_open?
       end
 
       def stage!(event)
-        raise TransactionSafetyError, <<~MSG unless transaction_open?
+        raise TransactionSafetyError, <<~MSG unless available?
           Transaction not available! By default, journaled event batching requires an open database transaction.
         MSG
 

data/lib/journaled/version.rb

@@ -1,3 +1,3 @@
 module Journaled
-  VERSION = "5.1.1".freeze
+  VERSION = "5.3.0".freeze
 end

data/lib/journaled.rb

@@ -16,7 +16,19 @@ module Journaled
   mattr_accessor(:http_open_timeout) { 2 }
   mattr_accessor(:http_read_timeout) { 60 }
   mattr_accessor(:job_base_class_name) { 'ActiveJob::Base' }
-  mattr_accessor(:transactional_batching_enabled) { true }
+  mattr_writer(:transactional_batching_enabled) { true }
+
+  def self.transactional_batching_enabled?
+    Thread.current[:journaled_transactional_batching_enabled] || @@transactional_batching_enabled
+  end
+
+  def self.with_transactional_batching
+    value_was = Thread.current[:journaled_transactional_batching_enabled]
+    Thread.current[:journaled_transactional_batching_enabled] = true
+    yield
+  ensure
+    Thread.current[:journaled_transactional_batching_enabled] = value_was
+  end
 
   def self.development_or_test?
     %w(development test).include?(Rails.env)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob