acts_as_paranoid 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bcd9a9f5f44fbc3890442360530b48ed39f94bd8cbe4f49d245a2c27510f7fd
-  data.tar.gz: 47c9aceb7415a3704b69b3bcaf7c8db64d402ecc9d1ef41352a70d0a386a819c
+  metadata.gz: 5e2b91eb0df1ed0d8cfb306f7272860c3f03e1da75259b202d222c1fece04927
+  data.tar.gz: 6dc0038fd41642f40e774e32eebe18ee5da6eae6750077781902aed17975ad1e
 SHA512:
-  metadata.gz: 78c376b394c50800f5f22db6a30a4dd607196a277266af7e24e04b209326e176471f916da360a1eb6e7e2c6573c506b211eccac42961a9a3ed686def7c105987
-  data.tar.gz: b0025f38c28cfc80fb852673f4913edf25273912ca83a768e000a15a745edfa9069d6fda490e31cc8ffe39975651d339d7ce82ac07f1065936ef6832f6b5eef1
+  metadata.gz: 1587bb00c56acbb5daf5929ef4588f89622eb83141258c2f686ce5ed55719849fa17064bc011cf6cd3720d05f7900f1121442ba6abb71cdcc977f637800b00dc
+  data.tar.gz: 026be4a7b7eec225d6a1113af33aa610438bc4f895d8539e1bf6159f8bfe07bda3add7733ecdec982ac85a4b28f1e3abc9a4cd85ab56f07bc6f9fcb4bd20211b

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 Notable changes to this project will be documented in this file.
 
+## 0.6.3
+
+* Update Travis CI configuration ([#137], by [Matijs van Zuijlen][mvz]).
+* Add predicate to check if record was soft deleted or hard deleted ([#136],
+  by [Aymeric Le Dorze][aymeric-ledorze]).
+* Add support for recover! method ([#75], by [vinoth][avinoth]).
+* Fix a record being dirty after destroying it ([#135], by
+  [Aymeric Le Dorze][aymeric-ledorze]).
+
 ## 0.6.2
 
 * Prevent recovery of non-deleted records
@@ -37,9 +46,14 @@ Notable changes to this project will be documented in this file.
 [AlexWheeler]: https://github.com/AlexWheeler
 [marycodes2]: https://github.com/marycodes2
 [valeriecodes]: https://github.com/valeriecodes
+[aymeric-ledorze]: https://github.com/aymeric-ledorze
+[avinoth]: https://github.com/avinoth
 
 <!-- issues & pull requests -->
 
+[#137]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/137
+[#136]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/136
+[#135]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/135
 [#133]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/133
 [#131]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/131
 [#124]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/124
@@ -47,3 +61,4 @@ Notable changes to this project will be documented in this file.
 [#119]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/119
 [#116]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/116
 [#114]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/114
+[#75]: https://github.com/ActsAsParanoid/acts_as_paranoid/pull/75

data/README.md

@@ -171,6 +171,22 @@ or in the recover statement
 Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover(:recovery_window => 30.seconds)
 ```
 
+### recover!
+
+You can invoke `recover!` if you wish to raise an error if the recovery fails. The error generally stems from ActiveRecord.
+
+```
+Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover!
+
+### => ActiveRecord::RecordInvalid: Validation failed: Name already exists
+```
+
+Optionally, you may also raise the error by passing `:raise_error => true` to the `recover` method. This behaves the same as `recover!`.
+
+```
+Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover(:raise_error => true)
+```
+
 ### Validation
 ActiveRecord's built-in uniqueness validation does not account for records deleted by ActsAsParanoid. If you want to check for uniqueness among non-deleted records only, use the macro `validates_as_paranoid` in your model. Then, instead of using `validates_uniqueness_of`, use `validates_uniqueness_of_without_deleted`. This will keep deleted records from counting against the uniqueness check.
 
@@ -263,6 +279,22 @@ child.parent #=> nil
 child.parent_including_deleted #=> Parent (it works!)
 ```
 
+### Callbacks
+
+There are couple of callbacks that you may use when dealing with deletion and recovery of objects. There is `before_recover` and `after_recover` which will be
+triggered before and after the recovery of an object respectively.
+
+Default ActiveRecord callbaks such as `before_destroy` and `after_destroy` will be triggered around `.destroy!` and `.destroy_fully!`.
+
+```
+class Paranoiac < ActiveRecord::Base
+  acts_as_paranoid
+
+  before_recover :set_counts
+  after_recover :update_logs
+end
+```
+
 ## Caveats
 
 Watch out for these caveats:

data/lib/acts_as_paranoid/core.rb

@@ -108,7 +108,7 @@ module ActsAsParanoid
     # Straight from ActiveRecord 5.1!
     def delete
       self.class.delete(id) if persisted?
-      @destroyed = true
+      stale_paranoid_value
       freeze
     end
 
@@ -124,7 +124,8 @@ module ActsAsParanoid
             decrement_counters_on_associations
           end
 
-          self.paranoid_value = self.class.delete_now_value
+          stale_paranoid_value
+          @destroyed = true
           freeze
         end
       end
@@ -144,7 +145,7 @@ module ActsAsParanoid
 
             @_trigger_destroy_callback = true
 
-            self.paranoid_value = self.class.delete_now_value
+            stale_paranoid_value
             self
           end
         end
@@ -161,7 +162,8 @@ module ActsAsParanoid
       return if !self.deleted?
       options = {
         :recursive => self.class.paranoid_configuration[:recover_dependent_associations],
-        :recovery_window => self.class.paranoid_configuration[:dependent_recovery_window]
+        :recovery_window => self.class.paranoid_configuration[:dependent_recovery_window],
+        :raise_error => false
       }.merge(options)
 
       self.class.transaction do
@@ -169,11 +171,21 @@ module ActsAsParanoid
           recover_dependent_associations(options[:recovery_window], options) if options[:recursive]
           increment_counters_on_associations
           self.paranoid_value = self.class.paranoid_configuration[:recovery_value]
-          self.save
+          if options[:raise_error]
+            self.save!
+          else
+            self.save
+          end
         end
       end
     end
 
+    def recover!(options={})
+      options[:raise_error] = true
+
+      recover(options)
+    end
+
     def recover_dependent_associations(window, options)
       self.class.dependent_associations.each do |reflection|
         next unless (klass = get_reflection_class(reflection)).paranoid?
@@ -219,7 +231,7 @@ module ActsAsParanoid
     end
 
     def deleted?
-      !if self.class.string_type_with_deleted_value?
+      @destroyed || !if self.class.string_type_with_deleted_value?
         paranoid_value != self.class.delete_now_value || paranoid_value.nil?
       elsif self.class.boolean_type_not_nullable?
         paranoid_value == false
@@ -230,6 +242,12 @@ module ActsAsParanoid
 
     alias_method :destroyed?, :deleted?
 
+    def deleted_fully?
+      @destroyed
+    end
+
+    alias_method :destroyed_fully?, :deleted_fully?
+
     private
 
     def get_reflection_class(reflection)
@@ -269,5 +287,10 @@ module ActsAsParanoid
     def decrement_counters_on_associations
         update_counters_on_associations :decrement_counter
     end
+
+    def stale_paranoid_value
+      self.paranoid_value = self.class.delete_now_value
+      clear_attribute_changes([self.class.paranoid_column])
+    end
   end
 end

data/lib/acts_as_paranoid/version.rb

@@ -1,3 +1,3 @@
 module ActsAsParanoid
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/test/test_core.rb

@@ -69,6 +69,13 @@ class ParanoidTest < ParanoidBaseTest
     assert_not_nil pt.paranoid_value
   end
 
+  def test_non_persisted_delete
+    pt = ParanoidTime.new
+    assert_nil pt.paranoid_value
+    pt.delete
+    assert_not_nil pt.paranoid_value
+  end
+
   def test_non_persisted_destroy!
     pt = ParanoidTime.new
     assert_nil pt.paranoid_value
@@ -94,6 +101,15 @@ class ParanoidTest < ParanoidBaseTest
     assert_equal 1, ParanoidString.count
   end
 
+  def test_recovery!
+    ParanoidBoolean.first.destroy
+    ParanoidBoolean.create(:name => 'paranoid')
+
+    assert_raise do
+      ParanoidBoolean.only_deleted.first.recover!
+    end
+  end
+
   def setup_recursive_tests
     @paranoid_time_object = ParanoidTime.first
 
@@ -265,6 +281,24 @@ class ParanoidTest < ParanoidBaseTest
     assert_equal 0, HasOneNotParanoid.count
   end
 
+  def test_dirty
+    pt = ParanoidTime.create
+    pt.destroy
+    assert_not pt.changed?
+  end
+
+  def test_delete_dirty
+    pt = ParanoidTime.create
+    pt.delete
+    assert_not pt.changed?
+  end
+
+  def test_destroy_fully_dirty
+    pt = ParanoidTime.create
+    pt.destroy_fully!
+    assert_not pt.changed?
+  end
+
   def test_deleted?
     ParanoidTime.first.destroy
     assert ParanoidTime.with_deleted.first.deleted?
@@ -273,6 +307,43 @@ class ParanoidTest < ParanoidBaseTest
     assert ParanoidString.with_deleted.first.deleted?
   end
 
+  def test_delete_deleted?
+    ParanoidTime.first.delete
+    assert ParanoidTime.with_deleted.first.deleted?
+
+    ParanoidString.first.delete
+    assert ParanoidString.with_deleted.first.deleted?
+  end
+
+  def test_destroy_fully_deleted?
+    object = ParanoidTime.first
+    object.destroy_fully!
+    assert object.deleted?
+
+    object = ParanoidString.first
+    object.destroy_fully!
+    assert object.deleted?
+  end
+
+  def test_deleted_fully?
+    ParanoidTime.first.destroy
+    assert_not ParanoidTime.with_deleted.first.deleted_fully?
+
+    ParanoidString.first.destroy
+    assert ParanoidString.with_deleted.first.deleted?
+  end
+
+  def test_delete_deleted_fully?
+    ParanoidTime.first.delete
+    assert_not ParanoidTime.with_deleted.first.deleted_fully?
+  end
+
+  def test_destroy_fully_deleted_fully?
+    object = ParanoidTime.first
+    object.destroy_fully!
+    assert object.deleted_fully?
+  end
+
   def test_paranoid_destroy_callbacks
     @paranoid_with_callback = ParanoidWithCallback.first
     ParanoidWithCallback.transaction do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_paranoid
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Zachary Scott
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Active Record plugin which allows you to hide and restore records without