paranoia 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 303721b73429fa8bacda1346701858f2439c8069
-  data.tar.gz: 789252f10b981c0260f18f06adba4798fe7dbc99
+  metadata.gz: 1bf4edf194a7572da8b0edc79105f4c62a37bfd2
+  data.tar.gz: dd084504c6c843de8ab3f7970570db894feac1ca
 SHA512:
-  metadata.gz: b9b84fe3194f415bf9871274646264d3aa68542310ee46e1abe9ff76f5c9c555cf6bf37f3e7aab09976c248b1456c9633af07c93a437b6e24f92faa29746198a
-  data.tar.gz: 22d720ab4dded670a75abc090fc098755526c7cec719515f053f5e94881c3d519286a285d7cadf8f77833ddac34ec4b13316b4d38d6dffa989b691b470ed70bb
+  metadata.gz: 9162181a3e8261387eefdfa78a512c0eee6fef54d19e2455673cb4b96f1fd673b8531b3357a1501967360610ae7b0cefecbe75cee06ae732af331639e7012535
+  data.tar.gz: 66b30b12969246dc8c820c32bc4a4df0f817ffa00ab99a48fcd152e9e9fcf503f5d1a2dce271b154bd11a15d3c1a61a39a6678c520036f006d900e79215cc396

data/README.md

@@ -4,9 +4,9 @@ Paranoia is a re-implementation of [acts\_as\_paranoid](http://github.com/techno
 
 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 by setting a `deleted_at` field to the current time when you `destroy` a record, and hides it by scoping all queries on your model to only include records which do not have a `deleted_at` field.
 
-If you wish to actually destroy an object you may call destroy! on it or simply call destroy twice on the same object.
+If you wish to actually destroy an object you may call `really_destroy!`. **WARNING**: This will also *really destroy* all `dependent: destroy` records, so please aim this method away from face when using.**
 
-If a record has `has_many` associations defined AND those associations have `dependent: :destroy` set on them, then they will also be soft-deleted. If they don't have that, then they will not be deleted.
+If a record has `has_many` associations defined AND those associations have `dependent: :destroy` set on them, then they will also be soft-deleted if ``acts_as_paranoid`` is set,  otherwise the normal destroy will be called. 
 
 ## Installation & Usage
 
@@ -25,7 +25,7 @@ gem 'paranoia', '~> 2.0'
 Of course you can install this from GitHub as well:
 
 ```ruby
-gem 'paranoia', :github => 'radar/paranoia', :branch => 'master'
+gem 'paranoia', :github => 'radar/paranoia', :branch => 'rails3'
 # or
 gem 'paranoia', :github => 'radar/paranoia', :branch => 'rails4'
 ```
@@ -43,7 +43,7 @@ Updating is as simple as `bundle update paranoia`.
 Run:
 
 ```shell
-rails generate migration AddDeletedAtToClients deleted_at:datetime
+rails generate migration AddDeletedAtToClients deleted_at:datetime:index
 ```
 
 and now you have a migration
@@ -52,6 +52,7 @@ and now you have a migration
 class AddDeletedAtToClients < ActiveRecord::Migration
   def change
     add_column :clients, :deleted_at, :datetime
+    add_index :clients, :deleted_at
   end
 end
 ```

data/lib/paranoia.rb

@@ -1,3 +1,5 @@
+require 'active_record' unless defined? ActiveRecord
+
 module Paranoia
   def self.included(klazz)
     klazz.extend Query
@@ -47,7 +49,8 @@ module Paranoia
   end
 
   def destroy
-    run_callbacks(:destroy) { touch_paranoia_column(true) }
+    callbacks_result = run_callbacks(:destroy) { touch_paranoia_column(true) }
+    callbacks_result ? self : false
   end
 
   def delete
@@ -77,10 +80,15 @@ module Paranoia
   # insert time to paranoia column.
   # @param with_transaction [Boolean] exec with ActiveRecord Transactions.
   def touch_paranoia_column(with_transaction=false)
-    if with_transaction
-      with_transaction_returning_status { touch(paranoia_column) }
-    else
-      touch(paranoia_column)
+    # This method is (potentially) called from really_destroy
+    # The object the method is being called on may be frozen
+    # Let's not touch it if it's frozen.
+    unless self.frozen?
+      if with_transaction
+        with_transaction_returning_status { touch(paranoia_column) }
+      else
+        touch(paranoia_column)
+      end
     end
   end
 
@@ -92,10 +100,16 @@ module Paranoia
     end
 
     destroyed_associations.each do |association|
-      association = send(association.name)
-
-      if association.paranoid?
-        association.only_deleted.each { |record| record.restore(:recursive => true) }
+      association_data = send(association.name)
+
+      unless association_data.nil?
+        if association_data.paranoid?
+          if association.collection?
+            association_data.only_deleted.each { |record| record.restore(:recursive => true) }
+          else
+            association_data.restore(:recursive => true)
+          end
+        end
       end
     end
   end
@@ -103,9 +117,25 @@ end
 
 class ActiveRecord::Base
   def self.acts_as_paranoid(options={})
+    alias :really_destroyed? :destroyed?
     alias :ar_destroy :destroy
     alias :destroy! :ar_destroy
     alias :delete! :delete
+    def really_destroy!
+      dependent_reflections = self.reflections.select do |name, reflection|
+        reflection.options[:dependent] == :destroy
+      end
+      if dependent_reflections.any?
+        dependent_reflections.each do |name, _|
+          associated_records = self.send(name)
+          # Paranoid models will have this method, non-paranoid models will not
+          associated_records = associated_records.with_deleted if associated_records.respond_to?(:with_deleted)
+          associated_records.each(&:really_destroy!)
+        end
+      end
+      destroy!
+    end
+
     include Paranoia
     class_attribute :paranoia_column
 
@@ -141,3 +171,5 @@ class ActiveRecord::Base
     self.class.paranoia_column
   end
 end
+
+require 'paranoia/rspec' if defined? RSpec

data/lib/paranoia/rspec.rb

@@ -0,0 +1,13 @@
+require 'rspec/expectations'
+
+# Validate the subject's class did call "acts_as_paranoid"
+RSpec::Matchers.define :act_as_paranoid do
+  match { |subject| subject.class.ancestors.include?(Paranoia) }
+
+  failure_message { "expected #{subject.class} to use `acts_as_paranoid`" }
+  failure_message_when_negated { "expected #{subject.class} not to use `acts_as_paranoid`" }
+
+  # RSpec 2 compatibility:
+  alias_method :failure_message_for_should, :failure_message
+  alias_method :failure_message_for_should_not, :failure_message_when_negated
+end

data/lib/paranoia/version.rb

@@ -1,3 +1,3 @@
 module Paranoia
-  VERSION = '1.3.3'
+  VERSION = '1.3.4'
 end

data/paranoia.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = '>= 1.3.6'
   s.rubyforge_project = 'paranoia'
 
-  s.add_dependency 'activerecord', '~> 3.2'
+  s.add_dependency 'activerecord', '~> 3.1'
 
   s.add_development_dependency 'bundler', '>= 1.0.0'
   s.add_development_dependency 'rake'

data/test/paranoia_test.rb

@@ -10,9 +10,11 @@ FileUtils.rm_f DB_FILE
 ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => DB_FILE
 ActiveRecord::Base.connection.execute 'CREATE TABLE parent_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE paranoid_models (id INTEGER NOT NULL PRIMARY KEY, parent_model_id INTEGER, deleted_at DATETIME)'
+ActiveRecord::Base.connection.execute 'CREATE TABLE paranoid_model_with_belongs (id INTEGER NOT NULL PRIMARY KEY, parent_model_id INTEGER, deleted_at DATETIME, paranoid_model_with_has_one_id INTEGER)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE featureful_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME, name VARCHAR(32))'
 ActiveRecord::Base.connection.execute 'CREATE TABLE plain_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE callback_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)'
+ActiveRecord::Base.connection.execute 'CREATE TABLE fail_callback_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE related_models (id INTEGER NOT NULL PRIMARY KEY, parent_model_id INTEGER NOT NULL, deleted_at DATETIME)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE employers (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE employees (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)'
@@ -100,6 +102,7 @@ class ParanoiaTest < Test::Unit::TestCase
     model.destroy
 
     assert_equal false, model.deleted_at.nil?
+    assert_equal false, model.really_destroyed?
 
     assert_equal 0, model.class.count
     assert_equal 1, model.class.unscoped.count
@@ -250,6 +253,20 @@ class ParanoiaTest < Test::Unit::TestCase
     assert_equal 1, ParanoidModel.unscoped.where(id: model.id).count
   end
 
+  def test_destroy_return_value_on_success
+    model = ParanoidModel.create
+    return_value = model.destroy
+
+    assert_equal(return_value, model)
+  end
+
+  def test_destroy_return_value_on_failure
+    model = FailCallbackModel.create
+    return_value = model.destroy
+
+    assert_equal(return_value, false)
+  end
+
   def test_restore_behavior_for_callbacks
     model = CallbackModel.new
     model.save
@@ -265,7 +282,7 @@ class ParanoiaTest < Test::Unit::TestCase
     assert model.instance_variable_get(:@restore_callback_called)
   end
 
-  def test_real_destroy
+  def test_really_destroy
     model = ParanoidModel.new
     model.save
     model.destroy!
@@ -273,6 +290,40 @@ class ParanoiaTest < Test::Unit::TestCase
     assert_equal 0, ParanoidModel.unscoped.where(id: model.id).count
   end
 
+  def test_really_destroyed
+    model = ParanoidModel.new
+    model.save
+    model.destroy!
+
+    assert model.really_destroyed?
+  end
+
+  def test_real_destroy_dependent_destroy
+    parent = ParentModel.create
+    child = parent.very_related_models.create
+    parent.really_destroy!
+    refute RelatedModel.unscoped.exists?(child.id)
+  end
+
+  def test_real_destroy_dependent_destroy_after_normal_destroy
+    parent = ParentModel.create
+    child = parent.very_related_models.create
+    parent.destroy
+    parent.really_destroy!
+    refute RelatedModel.unscoped.exists?(child.id)
+  end
+
+  def test_real_destroy_dependent_destroy_after_normal_destroy_does_not_delete_other_children
+    parent_1 = ParentModel.create
+    child_1 = parent_1.very_related_models.create
+
+    parent_2 = ParentModel.create
+    child_2 = parent_2.very_related_models.create
+    parent_1.destroy
+    parent_1.really_destroy!
+    assert RelatedModel.unscoped.exists?(child_2.id)
+  end
+
   def test_real_delete
     model = ParanoidModel.new
     model.save
@@ -335,6 +386,39 @@ class ParanoiaTest < Test::Unit::TestCase
     assert_equal true, second_child.destroyed?
   end
 
+  # regression tests for #118
+  def test_restore_with_has_one_association
+    # setup and destroy test objects
+    hasOne = ParanoidModelWithHasOne.create
+    belongsTo = ParanoidModelWithBelong.create
+    hasOne.paranoid_model_with_belong = belongsTo
+    hasOne.save!
+
+    hasOne.destroy
+    assert_equal false, hasOne.deleted_at.nil?
+    assert_equal false, belongsTo.deleted_at.nil?
+
+    # Does it restore has_one associations?
+    hasOne.restore(:recursive => true)
+    hasOne.save!
+
+    assert_equal true, hasOne.reload.deleted_at.nil?
+    assert_equal true, belongsTo.reload.deleted_at.nil?, "#{belongsTo.deleted_at}"
+    assert ParanoidModelWithBelong.with_deleted.reload.count != 0, "There should be a record"
+  end
+
+  def test_restore_with_nil_has_one_association
+    # setup and destroy test object
+    hasOne = ParanoidModelWithHasOne.create
+    hasOne.destroy
+    assert_equal false, hasOne.reload.deleted_at.nil?
+
+    # Does it raise NoMethodException on restore of nil
+    hasOne.restore(:recursive => true)
+    
+    assert hasOne.reload.deleted_at.nil?
+  end
+
   def test_observers_notified
     a = ParanoidModelWithObservers.create
     a.destroy
@@ -368,6 +452,13 @@ class ParanoidModel < ActiveRecord::Base
   acts_as_paranoid
 end
 
+class FailCallbackModel < ActiveRecord::Base
+  belongs_to :parent_model
+  acts_as_paranoid
+
+  before_destroy { |_| false }
+end
+
 class FeaturefulModel < ActiveRecord::Base
   acts_as_paranoid
   validates :name, :presence => true, :uniqueness => true
@@ -443,3 +534,13 @@ end
 class ParanoidModelWithoutObservers < ParanoidModel
   self.class.send(remove_method :notify_observers) if method_defined?(:notify_observers)
 end
+
+# refer back to regression test for #118
+class ParanoidModelWithHasOne < ParanoidModel
+  has_one :paranoid_model_with_belong, :dependent => :destroy
+end
+
+class ParanoidModelWithBelong < ActiveRecord::Base
+  acts_as_paranoid
+  belongs_to :paranoid_model_with_has_one
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paranoia
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - radarlistener@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - README.md
 - Rakefile
 - lib/paranoia.rb
+- lib/paranoia/rspec.rb
 - lib/paranoia/version.rb
 - paranoia.gemspec
 - test/paranoia_test.rb
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: paranoia
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Paranoia is a re-implementation of acts_as_paranoid for Rails 3, using much,