acts_as_paranoid 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73cbdef60cb81f9506a3763c13b0380f83169b8c68f0b914305d828b90202d25
-  data.tar.gz: 2023f4db3125ff3db3dd9dc7b0fb0142e92d6f8f54bc433557d5dd0dc40fb853
+  metadata.gz: be004bb0de25cdda73697fa22c07d0a64e1d98c071506d4b0a608a3d3231e103
+  data.tar.gz: 9334fe5730d07f94d087f3e6f1d4803126224a4106cc378d9f6263fc15295d93
 SHA512:
-  metadata.gz: 1c7b2ff7d8655621915c11630012ff946a196b46fd0a175facad75d90aa4f6ecae1ae6df1e627f9cf778faa46d26fb559b275e62101a4ba402007d545014f43d
-  data.tar.gz: ec47e5232127609e3e83b9bf22b142a821e955b55a77e082f21ceaeb5e62c390253fee6815cfc3a4a795257eb68c15f29eb5adbad8e511703718e4278d84e52c
+  metadata.gz: c3e7ebd79d467118c9c91374088f3fe3a203ae6ca914fa036646fb77e7f4c1c9ba4e1c653dc2311ac1bd53bbf2517cb1a00ee06b32e0f09d6937bfb1ea8f6247
+  data.tar.gz: 99c7d3d41d9a94b26d2fed6ce5b01ea2fddfbc09bd958d9ca990a7b2d92c466a876e23011db5f7fda02b4efb9cd417b9a8dfe62a432757e788e7a89c898dbcd0

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 Notable changes to this project will be documented in this file.
 
+## 0.8.1
+
+* Officially support Ruby 3.1 ([#268], by [Matijs van Zuijlen][mvz])
+* Fix association building for `belongs_to` with `:with_deleted` option ([#277], by [Matijs van Zuijlen][mvz])
+
+## 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
@@ -83,10 +120,12 @@ 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
@@ -100,6 +139,24 @@ Notable changes to this project will be documented in this file.
 
 <!-- issues & pull requests -->
 
+[#277]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/277
+[#268]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/268
+[#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

data/CONTRIBUTING.md

@@ -5,10 +5,10 @@ help the process of handling issues and pull requests go smoothly.
 
 ## Issues
 
-When creating an issue, please try to provide as much information as possible.
-Also, please 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.
+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
@@ -25,20 +25,31 @@ 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.
 
-If you want to send pull requests or patches, try to follow the instructions
-below. **If you get stuck, please make a pull request anyway and we'll try to
+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.
+- Make sure `bundle exec rake` runs without reporting any failures.
 - Add tests for your feature. Otherwise, we can't see if it works or if we
   break it later.
-- Make sure latest master merges cleanly with your branch. Things might
-  have moved around since you forked.
-- Try not to include changes that are irrelevant to your feature in the
-  same commit.
+- 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.
 
+### Testing your changes
+
+You can run the test suite with the latest version of all dependencies by running the following:
+
+- Run `bundle install` if you haven't done so already, or `bundle update` to update the dependencies
+- Run `bundle exec rake` to run the tests
+
+To run the tests suite for a particular version of ActiveRecord use
+[appraisal](https://github.com/thoughtbot/appraisal). For example, to run the
+specs with ActiveRecord 6.1, run `appraisal active_record_61 rake`. See appraisal's
+documentation for details.
+
 ### The review process
 
 - We will try to review your pull request as soon as possible but we can make no

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

data/lib/acts_as_paranoid/association_reflection.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActsAsParanoid
+  # Override for ActiveRecord::Reflection::AssociationReflection
+  #
+  # This makes automatic finding of inverse associations work where the
+  # inverse is a belongs_to association with the :with_deleted option set.
+  #
+  # Specifying :with_deleted for the belongs_to association would stop the
+  # inverse from being calculated because it sets scope where there was none,
+  # and normally an association having a scope means ActiveRecord will not
+  # automatically find the inverse association.
+  #
+  # This override adds an exception to that rule only for the case where the
+  # scope was added just to support the :with_deleted option.
+  module AssociationReflection
+    if ActiveRecord::VERSION::MAJOR < 7
+      def can_find_inverse_of_automatically?(reflection)
+        options = reflection.options
+
+        if reflection.macro == :belongs_to && options[:with_deleted]
+          return false if options[:inverse_of] == false
+          return false if options[:foreign_key]
+
+          !options.fetch(:original_scope)
+        else
+          super
+        end
+      end
+    else
+      def scope_allows_automatic_inverse_of?(reflection, inverse_reflection)
+        if reflection.scope
+          options = reflection.options
+          return true if options[:with_deleted] && !options.fetch(:original_scope)
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/acts_as_paranoid/associations.rb

@@ -19,32 +19,45 @@ module ActsAsParanoid
 
         with_deleted = options.delete(:with_deleted)
         if with_deleted
-          if scope
-            old_scope = scope
-            scope = proc do |*args|
-              if old_scope.arity == 0
-                instance_exec(&old_scope).with_deleted
-              else
-                old_scope.call(*args).with_deleted
-              end
-            end
-          else
-            scope = proc do
-              if respond_to? :with_deleted
-                self.with_deleted
-              else
-                all
-              end
-            end
-          end
+          original_scope = scope
+          scope = make_scope_with_deleted(scope)
         end
 
         result = belongs_to_without_deleted(target, scope, **options)
 
-        result.values.last.options[:with_deleted] = with_deleted if with_deleted
+        if with_deleted
+          options = result.values.last.options
+          options[:with_deleted] = with_deleted
+          options[:original_scope] = original_scope
+        end
 
         result
       end
+
+      private
+
+      def make_scope_with_deleted(scope)
+        if scope
+          old_scope = scope
+          scope = proc do |*args|
+            if old_scope.arity == 0
+              instance_exec(&old_scope).with_deleted
+            else
+              old_scope.call(*args).with_deleted
+            end
+          end
+        else
+          scope = proc do
+            if respond_to? :with_deleted
+              with_deleted
+            else
+              all
+            end
+          end
+        end
+
+        scope
+      end
     end
   end
 end

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
@@ -142,7 +156,6 @@ module ActsAsParanoid
             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
@@ -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,18 +244,52 @@ 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

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.2"
+  VERSION = "0.8.1"
 end

data/lib/acts_as_paranoid.rb

@@ -5,6 +5,7 @@ require "acts_as_paranoid/core"
 require "acts_as_paranoid/associations"
 require "acts_as_paranoid/validations"
 require "acts_as_paranoid/relation"
+require "acts_as_paranoid/association_reflection"
 
 module ActsAsParanoid
   def paranoid?
@@ -27,22 +28,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")
-    elsif options[:column_type] == "boolean" && !options[:allow_nulls]
-      paranoid_configuration.merge!(recovery_value: false)
-    elsif options[:column_type] == "boolean"
-      paranoid_configuration.merge!(allow_nulls: true)
     end
 
     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?
@@ -67,3 +64,6 @@ ActiveRecord::Relation.include ActsAsParanoid::Relation
 
 # Push the recover callback onto the activerecord callback list
 ActiveRecord::Callbacks::CALLBACKS.push(:before_recover, :after_recover)
+
+ActiveRecord::Reflection::AssociationReflection
+  .prepend ActsAsParanoid::AssociationReflection