mongo_trails 17.0.0 → 17.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47992865a22a08835378021027077b45f22379edf107657c58ceef30a7434af8
-  data.tar.gz: c6f4f9b31d6ea8cb9aee967a82eacb9fe25b65b8dcec66bb106825a705ed5c13
+  metadata.gz: 943d508b66d94b893dc1a553eb9f974b17484294750410f3b0b986073c4de415
+  data.tar.gz: 784ec37eed06ee8ffc0674d2f82a9a59d07892bd652a4006ac51b702b7b6e02e
 SHA512:
-  metadata.gz: eed6a890f004082f77f1cff771e27e0dbf5644d658e396081eea482198eaefbbecaed03eebe79c3f9ded6bc13df2d5c9d88dc117cd31c6beb4fec261351b71de
-  data.tar.gz: edad164d6a99840e7ac132cbf6d4497a8ff116dd131b2d02e1a1f1f82102b187978b993cef5974962ecbd0fbb6b8abd9602c134a10ab092e5e097126dee6e02b
+  metadata.gz: d56c0b823e24c0b18da5dedbbffb79fb1ecd9dc86fdc47c5455353f6a9e50ad242e346aa40d1d1c628985c93ed00a4f13e0947720487bfe4dd13a32b56c3d814
+  data.tar.gz: b6846cf53080d5f5d11c22bc6bfdbf25904a676a019b64f78311c8d44f803d853d7d5d959b7bce9143b9925706d7ed200fb2e9b3112adbfcfa58aed67ad91ea0

data/README.md

@@ -33,6 +33,22 @@ require 'mongo_trails/mongo_support/config'
 
 Done!
 
+## Restores
+
+Paper Trail records `create`, `update` and `destroy`, but a soft-deleted record brought back by [Paranoia](https://github.com/rubysherpas/paranoia) is restored with `update_columns`, which Paper Trail never sees. Include `MongoTrails::Restorable` in a Paranoia model to record a version with event `restore` (`MongoTrails::RESTORE_EVENT`) each time it is restored:
+
+```ruby
+class Post < ActiveRecord::Base
+  acts_as_paranoid
+  has_paper_trail
+  include MongoTrails::Restorable # after acts_as_paranoid, which defines the restore callbacks
+end
+```
+
+The version's changes are the columns Paranoia writes on restore (`paranoia_restore_attributes`), from their deleted values to the restored ones. Associated records Paranoia leaves deleted (outside the recovery window) get no version. Paranoia is not a dependency of this gem.
+
+To record a restore done some other way, call `record.paper_trail.record_restore(changes)` with each restored column mapped to `[before, after]`, for example `{ 'deleted_at' => [deleted_at, nil] }`. Like `record_update_columns`, it does nothing while Paper Trail is disabled and respects the record size limit.
+
 ## Config Options
 
 `PaperTrail.config.mongo_config = { hosts: ['localhost:27017'], database: 'my_test_db' }` - Options for MongoDB connection

data/gemfiles/rails_7.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mongo_trails (17.0.0)
+    mongo_trails (17.0.1)
       mongoid (>= 7, < 10)
       ostruct
       paper_trail (>= 16, < 18)
@@ -172,7 +172,7 @@ CHECKSUMS
   mcp (0.8.0) sha256=ae8bd146bb8e168852866fd26f805f52744f6326afb3211e073f78a95e0c34fb
   minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
   mongo (2.25.0) sha256=b4663884d23523d24f50c579846956444410f939093e8c2a95fa4b76bb929053
-  mongo_trails (17.0.0)
+  mongo_trails (17.0.1)
   mongoid (9.1.0) sha256=ef7b50f4c84e636850c3431bc3c92f98481f4e1d147ff06a1c21242d0b242a9e
   ostruct (0.6.3) sha256=95a2ed4a4bd1d190784e666b47b2d3f078e4a9efda2fccf18f84ddc6538ed912
   paper_trail (17.0.0) sha256=1c2842061d3874ca7015908e821e2aa14f9b982af2acb2a7974713bf79021c85

data/gemfiles/rails_8.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mongo_trails (17.0.0)
+    mongo_trails (17.0.1)
       mongoid (>= 7, < 10)
       ostruct
       paper_trail (>= 16, < 18)
@@ -172,7 +172,7 @@ CHECKSUMS
   mcp (0.8.0) sha256=ae8bd146bb8e168852866fd26f805f52744f6326afb3211e073f78a95e0c34fb
   minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
   mongo (2.25.0) sha256=b4663884d23523d24f50c579846956444410f939093e8c2a95fa4b76bb929053
-  mongo_trails (17.0.0)
+  mongo_trails (17.0.1)
   mongoid (9.1.0) sha256=ef7b50f4c84e636850c3431bc3c92f98481f4e1d147ff06a1c21242d0b242a9e
   ostruct (0.6.3) sha256=95a2ed4a4bd1d190784e666b47b2d3f078e4a9efda2fccf18f84ddc6538ed912
   paper_trail (17.0.0) sha256=1c2842061d3874ca7015908e821e2aa14f9b982af2acb2a7974713bf79021c85

data/gemfiles/rails_8_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mongo_trails (17.0.0)
+    mongo_trails (17.0.1)
       mongoid (>= 7, < 10)
       ostruct
       paper_trail (>= 16, < 18)

data/gemfiles/rails_8_paper_trail_16.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mongo_trails (17.0.0)
+    mongo_trails (17.0.1)
       mongoid (>= 7, < 10)
       ostruct
       paper_trail (>= 16, < 18)
@@ -175,7 +175,7 @@ CHECKSUMS
   mcp (0.8.0) sha256=ae8bd146bb8e168852866fd26f805f52744f6326afb3211e073f78a95e0c34fb
   minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
   mongo (2.25.0) sha256=b4663884d23523d24f50c579846956444410f939093e8c2a95fa4b76bb929053
-  mongo_trails (17.0.0)
+  mongo_trails (17.0.1)
   mongoid (9.1.0) sha256=ef7b50f4c84e636850c3431bc3c92f98481f4e1d147ff06a1c21242d0b242a9e
   ostruct (0.6.3) sha256=95a2ed4a4bd1d190784e666b47b2d3f078e4a9efda2fccf18f84ddc6538ed912
   paper_trail (16.0.0) sha256=e9b9f0fb1b8b590c8231cfa931b282ba92f90e066e393930a5e1c61ae4c5019d

data/lib/mongo_trails/record_trail.rb

@@ -43,8 +43,23 @@ module PaperTrail
     def record_update_columns(changes)
       return unless enabled?
 
-      event = Events::Update.new(@record, false, false, changes)
-      data = event.data.merge(data_for_update_columns)
+      save_update_columns_version(changes)
+    end
+
+    # Records a 'restore' version for a soft-deleted record brought back outside Paper Trail's callbacks,
+    # e.g. by Paranoia, which writes with update_columns. `changes` maps each restored column to
+    # [before, after], such as { 'deleted_at' => [deleted_at, nil] }.
+    def record_restore(changes)
+      return unless enabled?
+
+      save_update_columns_version(changes, event: MongoTrails::RESTORE_EVENT)
+    end
+
+    private
+
+    def save_update_columns_version(changes, event: nil)
+      data = Events::Update.new(@record, false, false, changes).data.merge(data_for_update_columns)
+      data[:event] = event if event
       versions_assoc = @record.send(@record.class.versions_association_name)
       version = versions_assoc.new(data)
       return if exceeds_record_size_limit?(version)
@@ -53,8 +68,6 @@ module PaperTrail
       version.save_version
     end
 
-    private
-
     def exceeds_record_size_limit?(version)
       size_limit = PaperTrail.config.mongo_trails_config&.dig(:record_size_limit)
       size_limit && size_limit.to_i < version.to_json.to_s.bytesize

data/lib/mongo_trails/restorable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module MongoTrails
+  # Paper Trail event of the version recorded when a soft-deleted record is restored (RecordTrail#record_restore)
+  RESTORE_EVENT = 'restore'
+
+  # Records a 'restore' version when a Paranoia model is restored. Paranoia restores with update_columns,
+  # which Paper Trail never sees, so the version history would otherwise jump from 'destroy' to the next update.
+  #
+  #   class Post < ActiveRecord::Base
+  #     acts_as_paranoid
+  #     has_paper_trail
+  #     include MongoTrails::Restorable
+  #   end
+  #
+  # Include it after acts_as_paranoid, which defines the restore callbacks. The version's changes are the columns
+  # Paranoia writes on restore (paranoia_restore_attributes), from their deleted values to the restored ones.
+  # Paranoia runs the callbacks for associated records outside the recovery window too, so only a record that
+  # was actually restored gets a version.
+  module Restorable
+    extend ActiveSupport::Concern
+
+    included do
+      before_restore :remember_mongo_trails_deleted_attributes
+      after_restore :record_mongo_trails_restore
+    end
+
+    private
+
+    def remember_mongo_trails_deleted_attributes
+      @mongo_trails_deleted_attributes = paranoia_destroyed? ? attributes.slice(*mongo_trails_restore_columns) : nil
+    end
+
+    def record_mongo_trails_restore
+      deleted_attributes = @mongo_trails_deleted_attributes
+      @mongo_trails_deleted_attributes = nil
+      return if deleted_attributes.nil? || paranoia_destroyed?
+
+      paper_trail.record_restore(deleted_attributes.to_h { |column, value| [column, [value, self[column]]] })
+    end
+
+    def mongo_trails_restore_columns
+      send(:paranoia_restore_attributes).keys.map(&:to_s)
+    end
+  end
+end

data/lib/mongo_trails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MongoTrails
-  VERSION = '17.0.0'
+  VERSION = '17.0.1'
 end

data/lib/mongo_trails.rb

@@ -12,6 +12,7 @@ require 'mongo_trails/events/base'
 require 'mongo_trails/model_config'
 require 'mongo_trails/version_concern'
 require 'mongo_trails/record_trail'
+require 'mongo_trails/restorable'
 
 ActiveSupport.on_load(:active_record) do
   require 'mongo_trails/mongo_support/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_trails
 version: !ruby/object:Gem::Version
-  version: 17.0.0
+  version: 17.0.1
 platform: ruby
 authors:
 - Alex Tsirel
@@ -123,6 +123,7 @@ files:
 - lib/mongo_trails/mongo_support/version_commit_wrap.rb
 - lib/mongo_trails/mongo_support/write_version_worker.rb
 - lib/mongo_trails/record_trail.rb
+- lib/mongo_trails/restorable.rb
 - lib/mongo_trails/version.rb
 - lib/mongo_trails/version_concern.rb
 - mongo_trails.gemspec