soft_deletion 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa304747a0e4749f973d98933fde9fd02fecc120f058dedba835ae68920d7b95
-  data.tar.gz: c21df829755fe43cc19272fe307d32c5a0b62b5e8aa9148e2fd511d23b5532b4
+  metadata.gz: be5a857dd49c9d30a402c6d241e4b3c16c474c797c8bfefb42d97210dc16deaa
+  data.tar.gz: d3c386ce8a0604e556239b6f924b3c623c1e493958364b5eccf99c985f8611d6
 SHA512:
-  metadata.gz: f07e9ae9e39905458c04cd71a28be75b0f7f1dc9abce4d169adab2ed635f42b598e3b5f4677d46a42cade1f858f83baa1edc28b746e765e3c1d7fd99a88d8192
-  data.tar.gz: 9a4ddb8f61ba8f5cf4de6a0478e1cc12ec088cf6c8a61d2d1c71052f2aee5e1ea9fd674d5933457c2c03abddfb74f4963c5a1dd77ee9921b7a2423f6e5707c2e
+  metadata.gz: bacaea7cdb75414da79d3002ec07406c210ba63a0eb05b305c808aa410ae4235f34c883cc3ce2bcf39d9002253f689a35ca7c9306c5d68d755a6b79bbc011216
+  data.tar.gz: 928bf5bd616e71bea0ca5624ab07332fc3a2c09a3713718e8ce197c32f18cb5864fa222aa1bcdbdfe3556e765a2abf7107a56d6f1839c39458668aaf6d606e9a

data/Readme.md

@@ -44,8 +44,39 @@ user.products.count == 10
 
 # soft delete many
 User.soft_delete_all!(1,2,3,4)
+
+# get soft deleted records
+User.soft_deleted
+```
+
+To add the `deleted_at` to your model, you can either generate a migration using:
+
+```
+rails generate migration add_deleted_at_to_users deleted_at:datetime:index
+```
+
+or create a migration file yourself like:
+
+```Ruby
+class AddDeletedAtToUsers < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :deleted_at, :datetime
+    add_index :users, :deleted_at
+  end
+end
 ```
 
+By default `soft_deletion` does not change the `updated_at` value in the record. If you need this feature, you can use the `update_timestamp` option, passing the name of the column holding the timestamp to be updated, like, for example, `updated_at`:
+
+```Ruby
+require 'soft_deletion'
+
+class User < ActiveRecord::Base
+  has_soft_deletion update_timestamp: :updated_at
+end
+```
+
+
 TODO
 ====
  - has_many :through should delete join associations on soft_delete

data/lib/soft_deletion/core.rb

@@ -9,6 +9,7 @@ module SoftDeletion
       base.define_model_callbacks :soft_delete
       base.define_model_callbacks :soft_undelete
       base.cattr_accessor :soft_delete_default_scope
+      base.cattr_accessor :soft_deletion_update_timestamp
     end
 
     module ClassMethods
@@ -26,8 +27,16 @@ module SoftDeletion
         Thread.current[key] = nil
       end
 
+      def soft_deleted
+        with_deleted { where.not(deleted_at: nil) }
+      end
+
       def mark_as_soft_deleted_sql
-        { deleted_at: Time.now }
+        t = Time.now
+
+        {deleted_at: t}.tap do |h|
+          h[self.soft_deletion_update_timestamp] = t if self.soft_deletion_update_timestamp
+        end
       end
 
       def soft_delete_all!(ids_or_models)
@@ -58,6 +67,11 @@ module SoftDeletion
 
     def mark_as_deleted
       self.deleted_at ||= Time.now
+      if self.class.soft_deletion_update_timestamp
+        new_timestamp = [self.deleted_at, send(self.class.soft_deletion_update_timestamp)].compact.max
+
+        send("#{self.class.soft_deletion_update_timestamp}=", new_timestamp)
+      end
     end
 
     def mark_as_undeleted

data/lib/soft_deletion/setup.rb

@@ -27,6 +27,8 @@ module SoftDeletion
             end
           end
         end
+
+        self.soft_deletion_update_timestamp = options[:update_timestamp]
       end
     end
   end

data/lib/soft_deletion/version.rb

@@ -1,3 +1,3 @@
 module SoftDeletion
-  VERSION = '1.11.0'
+  VERSION = '1.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soft_deletion
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord