paranoia 2.2.1 → 2.6.0

data/lib/paranoia.rb

@@ -1,5 +1,10 @@
 require 'active_record' unless defined? ActiveRecord
 
+if [ActiveRecord::VERSION::MAJOR, ActiveRecord::VERSION::MINOR] == [5, 2] ||
+   ActiveRecord::VERSION::MAJOR > 5
+  require 'paranoia/active_record_5_2'
+end
+
 module Paranoia
   @@default_sentinel_value = nil
 
@@ -14,7 +19,6 @@ module Paranoia
 
   def self.included(klazz)
     klazz.extend Query
-    klazz.extend Callbacks
   end
 
   module Query
@@ -36,7 +40,7 @@ module Paranoia
       # these will not match != sentinel value because "NULL != value" is
       # NULL under the sql standard
       # Scoping with the table_name is mandatory to avoid ambiguous errors when joining tables.
-      scoped_quoted_paranoia_column = "#{self.table_name}.#{connection.quote_column_name(paranoia_column)}"
+      scoped_quoted_paranoia_column = "#{connection.quote_table_name(self.table_name)}.#{connection.quote_column_name(paranoia_column)}"
       with_deleted.where("#{scoped_quoted_paranoia_column} IS NULL OR #{scoped_quoted_paranoia_column} != ?", paranoia_sentinel_value)
     end
     alias_method :deleted, :only_deleted
@@ -53,30 +57,11 @@ module Paranoia
     end
   end
 
-  module Callbacks
-    def self.extended(klazz)
-      [:restore, :real_destroy].each do |callback_name|
-        klazz.define_callbacks callback_name
-
-        klazz.define_singleton_method("before_#{callback_name}") do |*args, &block|
-          set_callback(callback_name, :before, *args, &block)
-        end
-
-        klazz.define_singleton_method("around_#{callback_name}") do |*args, &block|
-          set_callback(callback_name, :around, *args, &block)
-        end
-
-        klazz.define_singleton_method("after_#{callback_name}") do |*args, &block|
-          set_callback(callback_name, :after, *args, &block)
-        end
-      end
-    end
-  end
-
-  def destroy
-    transaction do
-      run_callbacks(:destroy) do
-        result = delete
+  def paranoia_destroy
+    with_transaction_returning_status do
+      result = run_callbacks(:destroy) do
+        @_disable_counter_cache = deleted?
+        result = paranoia_delete
         next result unless result && ActiveRecord::VERSION::STRING >= '4.2'
         each_counter_cached_associations do |association|
           foreign_key = association.reflection.foreign_key.to_sym
@@ -84,12 +69,26 @@ module Paranoia
           next unless send(association.reflection.name)
           association.decrement_counters
         end
+        @_trigger_destroy_callback = true
+        @_disable_counter_cache = false
         result
       end
-    end
+      raise ActiveRecord::Rollback, "Not destroyed" unless self.deleted?
+      result
+    end || false
+  end
+  alias_method :destroy, :paranoia_destroy
+
+  def paranoia_destroy!
+    paranoia_destroy ||
+      raise(ActiveRecord::RecordNotDestroyed.new("Failed to destroy the record", self))
   end
 
-  def delete
+  def trigger_transactional_callbacks?
+    super || @_trigger_destroy_callback && paranoia_destroyed?
+  end
+
+  def paranoia_delete
     raise ActiveRecord::ReadOnlyRecord, "#{self.class} is marked as readonly" if readonly?
     if persisted?
       # if a transaction exists, add the record so that after_commit
@@ -101,18 +100,27 @@ module Paranoia
     end
     self
   end
+  alias_method :delete, :paranoia_delete
 
   def restore!(opts = {})
     self.class.transaction do
       run_callbacks(:restore) do
+        recovery_window_range = get_recovery_window_range(opts)
         # Fixes a bug where the build would error because attributes were frozen.
         # This only happened on Rails versions earlier than 4.1.
         noop_if_frozen = ActiveRecord.version < Gem::Version.new("4.1")
-        if (noop_if_frozen && !@attributes.frozen?) || !noop_if_frozen
+        if within_recovery_window?(recovery_window_range) && ((noop_if_frozen && !@attributes.frozen?) || !noop_if_frozen)
+          @_disable_counter_cache = !paranoia_destroyed?
           write_attribute paranoia_column, paranoia_sentinel_value
           update_columns(paranoia_restore_attributes)
+          each_counter_cached_associations do |association|
+            if send(association.reflection.name)
+              association.increment_counters
+            end
+          end
+          @_disable_counter_cache = false
         end
-        restore_associated_records if opts[:recursive]
+        restore_associated_records(recovery_window_range) if opts[:recursive]
       end
     end
 
@@ -120,14 +128,26 @@ module Paranoia
   end
   alias :restore :restore!
 
+  def get_recovery_window_range(opts)
+    return opts[:recovery_window_range] if opts[:recovery_window_range]
+    return unless opts[:recovery_window]
+    (deletion_time - opts[:recovery_window]..deletion_time + opts[:recovery_window])
+  end
+
+  def within_recovery_window?(recovery_window_range)
+    return true unless recovery_window_range
+    recovery_window_range.cover?(deletion_time)
+  end
+
   def paranoia_destroyed?
-    send(paranoia_column) != paranoia_sentinel_value
+    paranoia_column_value != paranoia_sentinel_value
   end
   alias :deleted? :paranoia_destroyed?
 
   def really_destroy!
-    transaction do
+    with_transaction_returning_status do
       run_callbacks(:real_destroy) do
+        @_disable_counter_cache = paranoia_destroyed?
         dependent_reflections = self.class.reflections.select do |name, reflection|
           reflection.options[:dependent] == :destroy
         end
@@ -143,7 +163,7 @@ module Paranoia
             association_data.really_destroy!
           end
         end
-        write_attribute(paranoia_column, current_time_from_proper_timezone)
+        update_columns(paranoia_destroy_attributes)
         destroy_without_paranoia
       end
     end
@@ -151,6 +171,10 @@ module Paranoia
 
   private
 
+  def each_counter_cached_associations
+    !(defined?(@_disable_counter_cache) && @_disable_counter_cache) ? super : []
+  end
+
   def paranoia_restore_attributes
     {
       paranoia_column => paranoia_sentinel_value
@@ -169,7 +193,7 @@ module Paranoia
 
   # restore associated records that have been soft deleted when
   # we called #destroy
-  def restore_associated_records
+  def restore_associated_records(recovery_window_range = nil)
     destroyed_associations = self.class.reflect_on_all_associations.select do |association|
       association.options[:dependent] == :destroy
     end
@@ -180,9 +204,11 @@ module Paranoia
       unless association_data.nil?
         if association_data.paranoid?
           if association.collection?
-            association_data.only_deleted.each { |record| record.restore(:recursive => true) }
+            association_data.only_deleted.each do |record|
+              record.restore(:recursive => true, :recovery_window_range => recovery_window_range)
+            end
           else
-            association_data.restore(:recursive => true)
+            association_data.restore(:recursive => true, :recovery_window_range => recovery_window_range)
           end
         end
       end
@@ -200,18 +226,32 @@ module Paranoia
 
         association_class = association_class_name.constantize
         if association_class.paranoid?
-          association_class.only_deleted.where(association_find_conditions).first.try!(:restore, recursive: true)
+          association_class.only_deleted.where(association_find_conditions).first
+            .try!(:restore, recursive: true, :recovery_window_range => recovery_window_range)
         end
       end
     end
 
-    clear_association_cache if destroyed_associations.present?
+    if ActiveRecord.version.to_s > '7'
+      # Method deleted in https://github.com/rails/rails/commit/dd5886d00a2d5f31ccf504c391aad93deb014eb8
+      @association_cache.clear if persisted? && destroyed_associations.present?
+    else
+      clear_association_cache if destroyed_associations.present?
+    end
   end
 end
 
 ActiveSupport.on_load(:active_record) do
   class ActiveRecord::Base
     def self.acts_as_paranoid(options={})
+      if included_modules.include?(Paranoia)
+        puts "[WARN] #{self.name} is calling acts_as_paranoid more than once!"
+
+        return
+      end
+
+      define_model_callbacks :restore, :real_destroy
+
       alias_method :really_destroyed?, :destroyed?
       alias_method :really_delete, :delete
       alias_method :destroy_without_paranoia, :destroy
@@ -258,9 +298,17 @@ ActiveSupport.on_load(:active_record) do
       self.class.paranoia_column
     end
 
+    def paranoia_column_value
+      send(paranoia_column)
+    end
+
     def paranoia_sentinel_value
       self.class.paranoia_sentinel_value
     end
+
+    def deletion_time
+      paranoia_column_value.acts_like?(:time) ? paranoia_column_value : deleted_at
+    end
   end
 end
 
@@ -269,8 +317,8 @@ require 'paranoia/rspec' if defined? RSpec
 module ActiveRecord
   module Validations
     module UniquenessParanoiaValidator
-      def build_relation(klass, table, attribute, value)
-        relation = super(klass, table, attribute, value)
+      def build_relation(klass, *args)
+        relation = super
         return relation unless klass.respond_to?(:paranoia_column)
         arel_paranoia_scope = klass.arel_table[klass.paranoia_column].eq(klass.paranoia_sentinel_value)
         if ActiveRecord::VERSION::STRING >= "5.0"
@@ -284,5 +332,14 @@ module ActiveRecord
     class UniquenessValidator < ActiveModel::EachValidator
       prepend UniquenessParanoiaValidator
     end
+
+    class AssociationNotSoftDestroyedValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        # if association is soft destroyed, add an error
+        if value.present? && value.paranoia_destroyed?
+          record.errors.add(attribute, 'has been soft-deleted')
+        end
+      end
+    end
   end
 end

data/paranoia.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.summary     = "Paranoia is a re-implementation of acts_as_paranoid for Rails 3, 4, and 5, using much, much, much less code."
   s.description = <<-DSC
-    Paranoia is a re-implementation of acts_as_paranoid for Rails 3, 4, and 5,
+    Paranoia is a re-implementation of acts_as_paranoid for Rails 4, 5, 6, and 7,
     using much, much, much less code. You would use either plugin / gem if you
     wished that when you called destroy on an Active Record object that it
     didn't actually destroy it, but just "hid" the record. Paranoia does this
@@ -22,14 +22,19 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency 'activerecord', '>= 4.0', '< 5.1'
+  s.add_dependency 'activerecord', '>= 5.1', '< 7.1'
 
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rake"
 
-  s.files        = `git ls-files`.split("\n")
+
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)})  }
+    files
+  end
+
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paranoia
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.6.0
 platform: ruby
 authors:
 - radarlistener@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
-      Paranoia is a re-implementation of acts_as_paranoid for Rails 3, 4, and 5,
+      Paranoia is a re-implementation of acts_as_paranoid for Rails 4, 5, 6, and 7,
       using much, much, much less code. You would use either plugin / gem if you
       wished that when you called destroy on an Active Record object that it
       didn't actually destroy it, but just "hid" the record. Paranoia does this
@@ -73,19 +73,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/paranoia.rb
+- lib/paranoia/active_record_5_2.rb
 - lib/paranoia/rspec.rb
 - lib/paranoia/version.rb
 - paranoia.gemspec
-- test/paranoia_test.rb
 homepage: https://github.com/rubysherpas/paranoia
 licenses:
 - MIT
@@ -98,15 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Paranoia is a re-implementation of acts_as_paranoid for Rails 3, 4, and 5,

data/.travis.yml

@@ -1,26 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - jruby-9.1.6.0
-
-env:
-  matrix:
-    - RAILS='~> 4.1.16'
-    - RAILS='~> 4.2.7.1'
-    - RAILS='~> 5.0.0.1'
-
-matrix:
-  exclude:
-    - env: RAILS='~> 5.0.0.1'
-      rvm: 2.1.10
-  allow_failures:
-    - env: RAILS='~> 4.1.16'
-      rvm: jruby-9.1.6.0
-    - env: RAILS='~> 4.2.7.1'
-      rvm: jruby-9.1.6.0
-    - env: RAILS='~> 5.0.0.1'
-      rvm: jruby-9.1.6.0