acts_as_paranoid 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a57d617e3e2f52608fefad1c84bba5d6825d1b9ea96e681ade8739461ef35796
-  data.tar.gz: 549ef0573150ba7f30740a6145cb6b52ef2916b3584199fc0bab8eba17271eb0
+  metadata.gz: b0a0cec714f9701fb054580a39b677e73a3cfd3fa1909afd29dfedbbfdcb82d0
+  data.tar.gz: bef6e1c18c141b3035d5a4b3c33cad22a398d06250f1f09730ae39662e48a0ca
 SHA512:
-  metadata.gz: 13ac9918fc0dc45e93d02ad799f20fe9c13afd4eba4a0b81c52201bc495a690dc80b1ab9ba9e700b7d072a61c5973dcf8d134a1049c581d61c1c0120f4444d59
-  data.tar.gz: 6bba5d24a72d45b5de90670e1c577d6172160d1ee5d3850a3d9dd3845eb2fd73060a6d441d738b99dc9aea516189a6807c0406f377997dddf8ac443f88db6fbd
+  metadata.gz: 804904753df983b7e366d4a6af8f4c80b24cda018a2cd2534721f7d943cc23556a9a1a9c77a7f37de335c60a3fde99639036315f235b303a60fdefc871e693b9
+  data.tar.gz: 40e9a9229af5706aa62e319e49c74b60b2d89e8880d46f6106ec51ef44e1e4811715b514b5e691500abc65805dd521c6741130f8eba0b892d2738cfe8efca23a

data/CHANGELOG.md

@@ -2,6 +2,51 @@
 
 Notable changes to this project will be documented in this file.
 
+## 0.8.0
+
+* Do not set `paranoid_value` when destroying fully ([#238], by [Aymeric Le Dorze][aymeric-ledorze])
+* Make helper methods for dependent associations private ([#239], by [Matijs van Zuijlen][mvz])
+* Raise ActiveRecord::RecordNotDestroyed if destroy returns false ([#240], by [Hao Liu][leomayleomay])
+* Make unscoping by `with_deleted` less blunt ([#241], by [Matijs van Zuijlen][mvz])
+* Drop support for Ruby 2.4 and 2.5 ([#243] and [#245] by [Matijs van Zuijlen][mvz])
+* Remove deprecated methods ([#244] by [Matijs van Zuijlen][mvz])
+* Remove test files from the gem ([#261] by [Matijs van Zuijlen][mvz])
+* Add support for Rails 7 ([#262] by [Vederis Leunardus][cloudsbird])
+
+## 0.7.3
+
+## Improvements
+
+* Fix deletion time scopes ([#212] by [Matijs van Zuijlen][mvz])
+* Reload `has_one` associations after dependent recovery ([#214],
+  by [Matijs van Zuijlen][mvz])
+* Make dependent recovery work when parent is non-optional ([#227],
+  by [Matijs van Zuijlen][mvz])
+* Avoid querying nil `belongs_to` associations when recovering ([#219],
+  by [Matijs van Zuijlen][mvz])
+* On relations, deprecate `destroy!` in favour of `destroy_fully!` ([#222],
+  by [Matijs van Zuijlen][mvz])
+* Deprecate the undocumented `:recovery_value` setting. Calculate the correct
+  value instead. ([#220], by [Matijs van Zuijlen][mvz])
+
+## Developer experience
+
+* Log ActiveRecord activity to a visible log during tests ([#218],
+  by [Matijs van Zuijlen][mvz])
+
+## 0.7.2
+
+* Do not set boolean column to NULL on recovery if nulls are not allowed
+  ([#193], by [Shodai Suzuki][soartec-lab])
+* Add a CONTRIBUTING.md file ([#207], by [Matijs van Zuijlen][mvz])
+
+## 0.7.1
+
+* Support Rails 6.1 ([#191], by [Matijs van Zuijlen][mvz])
+* Support `belongs_to` with both `:touch` and `:counter_cache` options ([#208],
+  by [Matijs van Zuijlen][mvz] with [Paul Druziak][pauldruziak])
+* Support Ruby 3.0 ([#209], by [Matijs van Zuijlen][mvz])
+
 ## 0.7.0
 
 ### Breaking changes
@@ -70,21 +115,46 @@ Notable changes to this project will be documented in this file.
 [AlexWheeler]: https://github.com/AlexWheeler
 [RomainAlexandre]: https://github.com/RomainAlexandre
 [avinoth]: https://github.com/avinoth
+[cloudsbird]: https://github.com/cloudsbird
 [aymeric-ledorze]: https://github.com/aymeric-ledorze
 [danielricecodes]: https://github.com/danielricecodes
 [jbryant92]: https://github.com/jbryant92
 [kevinmcalear]: https://github.com/kevinmcalear
+[leomayleomay]: https://github.com/leomayleomay
 [marycodes2]: https://github.com/marycodes2
 [mvz]: https://github.com/mvz
 [nedcampion]: https://github.com/nedcampion
 [ri4a]: https://github.com/ri4a
+[pauldruziak]: https://github.com/pauldruziak
 [shadydealer]: https://github.com/shadydealer
+[soartec-lab]: https://github.com/soartec-lab
 [thebravoman]: https://github.com/thebravoman
 [valeriecodes]: https://github.com/valeriecodes
 [wtfspm]: https://github.com/wtfspm
 
 <!-- issues & pull requests -->
 
+[#262]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/262
+[#261]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/261
+[#245]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/245
+[#244]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/244
+[#243]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/243
+[#241]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/241
+[#240]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/240
+[#239]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/239
+[#238]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/238
+[#227]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/227
+[#222]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/222
+[#220]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/220
+[#219]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/219
+[#218]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/218
+[#214]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/214
+[#212]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/212
+[#209]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/209
+[#208]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/208
+[#207]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/207
+[#193]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/193
+[#191]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/191
 [#175]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/175
 [#173]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/173
 [#171]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/171

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to ActsAsParanoid
+
+We welcome all contributions to ActsAsParanoid. Below are some guidelines to
+help the process of handling issues and pull requests go smoothly.
+
+## Issues
+
+When creating an issue, please provide as much information as possible, and
+follow the guidelines below to make it easier for us to figure out what's going
+on. If you miss any of these points we will probably ask you to improve the
+ticket.
+
+- Include a clear title describing the problem
+- Describe what you are trying to achieve
+- Describe what you did, preferably including relevant code
+- Describe what you expected to happen
+- Describe what happened instead, possibly including relevant output
+- Use [code blocks](https://github.github.com/gfm/#fenced-code-blocks) to
+  format any code and output in your ticket to make it readable.
+
+## Pull requests
+
+If you have an idea for a particular feature, it's probably best to create a
+GitHub issue for it before trying to implement it yourself. That way, we can
+discuss the feature and whether it makes sense to include in ActsAsParanoid itself
+before putting in the work to implement it.
+
+To send pull requests or patches, please follow the instructions below.
+**If you get stuck, please make a pull request anyway and we'll try to
+help out.**
+
+- Make sure `rake test` runs without reporting any failures.
+- Add tests for your feature. Otherwise, we can't see if it works or if we
+  break it later.
+- Create a separate branch for your feature based off of latest master.
+- Do not include changes that are irrelevant to your feature in the same
+  commit.
+- Keep an eye on the build results in GitHub Actions. If the build fails and it
+  seems due to your changes, please update your pull request with a fix.
+
+### The review process
+
+- We will try to review your pull request as soon as possible but we can make no
+  guarantees. Feel free to ping us now and again.
+- We will probably ask you to rebase your branch on current master at some point
+  during the review process.
+  If you are unsure how to do this,
+  [this in-depth guide](https://git-rebase.io/) should help out.
+- If you have any unclear commit messages, work-in-progress commits, or commits
+  that just fix a mistake in a previous commits, we will ask you to clean up
+  the history.
+  Again, [the git-rebase guide](https://git-rebase.io/) should help out.
+- At the end of the review process we may still choose not to merge your pull
+  request. For example, this could happen if we decide the proposed feature
+  should not be part of ActsAsParanoid, or if the technical implementation does not
+  match where we want to go with the architecture the project.
+- We will generally not merge any pull requests that make the build fail, unless
+  it's very clearly not related to the changes in the pull request.

data/README.md

@@ -9,9 +9,9 @@ recoverable later.
 
 ## Support
 
-**This branch targets Rails 5.2+ and Ruby 2.4+ only**
+**This branch targets Rails 5.2+ and Ruby 2.5+ only**
 
-If you're working with Rails 5.1 and earlier, or with Ruby 2.3 or earlier,
+If you're working with Rails 5.1 and earlier, or with Ruby 2.4 or earlier,
 please switch to the corresponding branch or require an older version of the
 `acts_as_paranoid` gem.
 
@@ -27,7 +27,7 @@ please switch to the corresponding branch or require an older version of the
 #### Install gem:
 
 ```ruby
-gem 'acts_as_paranoid', '~> 0.7.0'
+gem 'acts_as_paranoid'
 ```
 
 ```shell
@@ -255,9 +255,9 @@ Paranoiac.create(name: 'foo').destroy
 Paranoiac.with_deleted.first.deleted? #=> true
 ```
 
-After the first call to .destroy the object is deleted?
+After the first call to `.destroy` the object is `deleted?`.
 
-You can check if the object is fully destroyed with destroyed_fully? or deleted_fully?. 
+You can check if the object is fully destroyed with `destroyed_fully?` or `deleted_fully?`.
 
 ```ruby
 Paranoiac.create(name: 'foo').destroy

data/lib/acts_as_paranoid/core.rb

@@ -88,6 +88,14 @@ module ActsAsParanoid
         end
       end
 
+      def recovery_value
+        if boolean_type_not_nullable?
+          false
+        else
+          nil
+        end
+      end
+
       protected
 
       def define_deleted_time_scopes
@@ -96,19 +104,25 @@ module ActsAsParanoid
         }
 
         scope :deleted_after_time, lambda { |time|
-          where("#{table_name}.#{paranoid_column} > ?", time)
+          only_deleted
+            .where("#{table_name}.#{paranoid_column} > ?", time)
         }
         scope :deleted_before_time, lambda { |time|
-          where("#{table_name}.#{paranoid_column} < ?", time)
+          only_deleted
+            .where("#{table_name}.#{paranoid_column} < ?", time)
         }
       end
 
       def without_paranoid_default_scope
         scope = all
 
+        # unscope avoids applying the default scope when using this scope for associations
         scope = scope.unscope(where: paranoid_column)
-        # Fix problems with unscope group chain
-        scope = scope.unscoped if scope.to_sql.include? paranoid_default_scope.to_sql
+
+        paranoid_where_clause =
+          ActiveRecord::Relation::WhereClause.new([paranoid_default_scope])
+
+        scope.where_clause = all.where_clause - paranoid_where_clause
 
         scope
       end
@@ -138,11 +152,10 @@ module ActsAsParanoid
             # Handle composite keys, otherwise we would just use
             # `self.class.primary_key.to_sym => self.id`.
             self.class
-              .delete_all!(Hash[[Array(self.class.primary_key), Array(id)].transpose])
+              .delete_all!([Array(self.class.primary_key), Array(id)].transpose.to_h)
             decrement_counters_on_associations
           end
 
-          stale_paranoid_value
           @destroyed = true
           freeze
         end
@@ -150,6 +163,12 @@ module ActsAsParanoid
     end
 
     def destroy!
+      destroy || raise(
+        ActiveRecord::RecordNotDestroyed.new("Failed to destroy the record", self)
+      )
+    end
+
+    def destroy
       if !deleted?
         with_transaction_returning_status do
           run_callbacks :destroy do
@@ -157,7 +176,7 @@ module ActsAsParanoid
               # Handle composite keys, otherwise we would just use
               # `self.class.primary_key.to_sym => self.id`.
               self.class
-                .delete_all(Hash[[Array(self.class.primary_key), Array(id)].transpose])
+                .delete_all([Array(self.class.primary_key), Array(id)].transpose.to_h)
               decrement_counters_on_associations
             end
 
@@ -172,8 +191,6 @@ module ActsAsParanoid
       end
     end
 
-    alias destroy destroy!
-
     def recover(options = {})
       return if !deleted?
 
@@ -185,16 +202,16 @@ module ActsAsParanoid
 
       self.class.transaction do
         run_callbacks :recover do
-          if options[:recursive]
-            recover_dependent_associations(options[:recovery_window], options)
-          end
           increment_counters_on_associations
-          self.paranoid_value = self.class.paranoid_configuration[:recovery_value]
-          if options[:raise_error]
-            save!
-          else
-            save
-          end
+          deleted_value = paranoid_value
+          self.paranoid_value = self.class.recovery_value
+          result = if options[:raise_error]
+                     save!
+                   else
+                     save
+                   end
+          recover_dependent_associations(deleted_value, options) if options[:recursive]
+          result
         end
       end
     end
@@ -205,34 +222,6 @@ module ActsAsParanoid
       recover(options)
     end
 
-    def recover_dependent_associations(window, options)
-      self.class.dependent_associations.each do |reflection|
-        next unless (klass = get_reflection_class(reflection)).paranoid?
-
-        scope = klass.only_deleted.merge(get_association_scope(reflection: reflection))
-
-        # We can only recover by window if both parent and dependant have a
-        # paranoid column type of :time.
-        if self.class.paranoid_column_type == :time && klass.paranoid_column_type == :time
-          scope = scope.deleted_inside_time_window(paranoid_value, window)
-        end
-
-        scope.each do |object|
-          object.recover(options)
-        end
-      end
-    end
-
-    def destroy_dependent_associations!
-      self.class.dependent_associations.each do |reflection|
-        next unless (klass = get_reflection_class(reflection)).paranoid?
-
-        klass
-          .only_deleted.merge(get_association_scope(reflection: reflection))
-          .each(&:destroy!)
-      end
-    end
-
     def deleted?
       return true if @destroyed
 
@@ -255,32 +244,68 @@ module ActsAsParanoid
 
     private
 
-    def get_association_scope(reflection:)
-      ActiveRecord::Associations::AssociationScope.scope(association(reflection.name))
+    def recover_dependent_associations(deleted_value, options)
+      self.class.dependent_associations.each do |reflection|
+        recover_dependent_association(reflection, deleted_value, options)
+      end
     end
 
-    def get_reflection_class(reflection)
-      if reflection.macro == :belongs_to && reflection.options.include?(:polymorphic)
-        send(reflection.foreign_type).constantize
-      else
-        reflection.klass
+    def destroy_dependent_associations!
+      self.class.dependent_associations.each do |reflection|
+        assoc = association(reflection.name)
+        next unless (klass = assoc.klass).paranoid?
+
+        klass
+          .only_deleted.merge(get_association_scope(assoc))
+          .each(&:destroy!)
       end
     end
 
+    def recover_dependent_association(reflection, deleted_value, options)
+      assoc = association(reflection.name)
+      return unless (klass = assoc.klass).paranoid?
+
+      if reflection.belongs_to? && attributes[reflection.association_foreign_key].nil?
+        return
+      end
+
+      scope = klass.only_deleted.merge(get_association_scope(assoc))
+
+      # We can only recover by window if both parent and dependant have a
+      # paranoid column type of :time.
+      if self.class.paranoid_column_type == :time && klass.paranoid_column_type == :time
+        scope = scope.deleted_inside_time_window(deleted_value, options[:recovery_window])
+      end
+
+      recovered = false
+      scope.each do |object|
+        object.recover(options)
+        recovered = true
+      end
+
+      assoc.reload if recovered && reflection.has_one? && assoc.loaded?
+    end
+
+    def get_association_scope(dependent_association)
+      ActiveRecord::Associations::AssociationScope.scope(dependent_association)
+    end
+
     def paranoid_value=(value)
       write_attribute(self.class.paranoid_column, value)
     end
 
     def update_counters_on_associations(method_sym)
-      return unless [:decrement_counter, :increment_counter].include? method_sym
-
       each_counter_cached_association_reflection do |assoc_reflection|
+        reflection_options = assoc_reflection.options
+        next unless reflection_options[:counter_cache]
+
         associated_object = send(assoc_reflection.name)
         next unless associated_object
 
         counter_cache_column = assoc_reflection.counter_cache_column
         associated_object.class.send(method_sym, counter_cache_column,
                                      associated_object.id)
+        associated_object.touch if reflection_options[:touch]
       end
     end
 

data/lib/acts_as_paranoid/relation.rb

@@ -29,7 +29,7 @@ module ActsAsParanoid
           end
         end
 
-        def destroy!(id_or_array)
+        def destroy_fully!(id_or_array)
           where(primary_key => id_or_array).orig_delete_all
         end
       end

data/lib/acts_as_paranoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsParanoid
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/acts_as_paranoid.rb

@@ -27,18 +27,18 @@ module ActsAsParanoid
       column_type: "time",
       recover_dependent_associations: true,
       dependent_recovery_window: 2.minutes,
-      recovery_value: nil,
       double_tap_destroys_fully: true
     }
     if options[:column_type] == "string"
       paranoid_configuration.merge!(deleted_value: "deleted")
     end
-    paranoid_configuration.merge!(allow_nulls: true) if options[:column_type] == "boolean"
+
     paranoid_configuration.merge!(options) # user options
 
     unless %w[time boolean string].include? paranoid_configuration[:column_type]
-      raise ArgumentError, "'time', 'boolean' or 'string' expected" \
-        " for :column_type option, got #{paranoid_configuration[:column_type]}"
+      raise ArgumentError,
+            "'time', 'boolean' or 'string' expected for :column_type option," \
+            " got #{paranoid_configuration[:column_type]}"
     end
 
     return if paranoid?