paranoia 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74da60de8afe27c56c43f9a2ad74eec282f1d0d7
-  data.tar.gz: fc3b097f03211f08ba1ad711e82d7c6ef20231ab
+  metadata.gz: 303721b73429fa8bacda1346701858f2439c8069
+  data.tar.gz: 789252f10b981c0260f18f06adba4798fe7dbc99
 SHA512:
-  metadata.gz: 1b98a9b12106d88e02d0d059143b56d7fe63dfa12d0362a83da656aef59b5940e5e9e9514caa2c6f51881f2ad306e76977d75efc22a8dcf60a2df04bebe931ce
-  data.tar.gz: 29a1b849c690b46339e75e5bdd2761bd6f070025c55f543abc7603a1104ebb0feb59b4cc04d70d5ed363f2f38a04de50fc630c5a26d8e31ae1b61287f73d56e4
+  metadata.gz: b9b84fe3194f415bf9871274646264d3aa68542310ee46e1abe9ff76f5c9c555cf6bf37f3e7aab09976c248b1456c9633af07c93a437b6e24f92faa29746198a
+  data.tar.gz: 22d720ab4dded670a75abc090fc098755526c7cec719515f053f5e94881c3d519286a285d7cadf8f77833ddac34ec4b13316b4d38d6dffa989b691b470ed70bb

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx

data/Gemfile

@@ -1,4 +1,13 @@
 source 'https://rubygems.org'
 
+gem 'sqlite3', :platforms => [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-test-unit'
+  gem 'rubinius-developer_tools'
+end
+
 # Specify your gem's dependencies in paranoia.gemspec
 gemspec

data/README.md

@@ -6,6 +6,8 @@ You would use either plugin / gem if you wished that when you called `destroy` o
 
 If you wish to actually destroy an object you may call destroy! on it or simply call destroy twice on the same object.
 
+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.
+
 ## Installation & Usage
 
 For Rails 3, please use version 1 of Paranoia:
@@ -66,9 +68,23 @@ class Client < ActiveRecord::Base
 end
 ```
 
-Hey presto, it's there!
+Hey presto, it's there! Calling `destroy` will now set the `deleted_at` column:
+
 
-If you want a method to be called on destroy, simply provide a _before\_destroy_ callback:
+```
+>> client.deleted_at => nil
+>> client.destroy => client
+>> client.deleted_at => [current timestamp]
+```
+
+If you really want it gone *gone*, call `destroy!`
+
+```
+>> client.deleted_at => nil
+>> client.destroy! => client
+```
+
+If you want a method to be called on destroy, simply provide a `before_destroy` callback:
 
 ```ruby
 class Client < ActiveRecord::Base
@@ -84,6 +100,70 @@ class Client < ActiveRecord::Base
 end
 ```
 
+If you want to use a column other than `deleted_at`, you can pass it as an option:
+
+```ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid column: :destroyed_at
+
+  ...
+end
+```
+
+If you want to access soft-deleted associations, override the getter method:
+
+```ruby
+def product
+  Product.unscoped { super }
+end
+```
+
+If you want to find all records, even those which are deleted:
+
+```ruby
+Client.with_deleted
+```
+
+If you want to find only the deleted records:
+
+```ruby
+Client.only_deleted
+```
+
+If you want to check if a record is soft-deleted:
+
+```ruby
+client.destroyed?
+```
+
+If you want to restore a record:
+
+```ruby
+Client.restore(id)
+```
+
+If you want to restore a whole bunch of records:
+
+```ruby
+Client.restore([id1, id2, ..., idN])
+```
+
+If you want to restore a record and their dependently destroyed associated records:
+
+```ruby
+Client.restore(id, :recursive => true)
+```
+
+If you want callbacks to trigger before a restore:
+
+```ruby
+before_restore :callback_name_goes_here
+```
+
+For more information, please look at the tests.
+
+## Acts As Paranoid Migration
+
 You can replace the older acts_as_paranoid methods as follows:
 
 | Old Syntax                 | New Syntax                     |

data/lib/paranoia.rb

@@ -15,15 +15,15 @@ module Paranoia
     end
 
     def only_deleted
-      with_deleted.where("#{self.table_name}.deleted_at IS NOT NULL")
+      with_deleted.where("#{self.table_name}.#{paranoia_column} IS NOT NULL")
     end
     alias :deleted :only_deleted
 
-    def restore(id)
+    def restore(id, opts = {})
       if id.is_a?(Array)
-        id.map { |one_id| restore(one_id) }
+        id.map { |one_id| restore(one_id, opts) }
       else
-        only_deleted.find(id).restore!
+        only_deleted.find(id).restore!(opts)
       end
     end
   end
@@ -47,41 +47,77 @@ module Paranoia
   end
 
   def destroy
-    run_callbacks(:destroy) { delete }
+    run_callbacks(:destroy) { touch_paranoia_column(true) }
   end
 
   def delete
     return if new_record?
-    destroyed? ? destroy! : update_attribute_or_column(:deleted_at, Time.now)
+    touch_paranoia_column(false)
   end
 
-  def restore!
-    run_callbacks(:restore) { update_column :deleted_at, nil }
+  def restore!(opts = {})
+    ActiveRecord::Base.transaction do
+      run_callbacks(:restore) do
+        update_column paranoia_column, nil
+        restore_associated_records if opts[:recursive]
+      end
+    end
   end
   alias :restore :restore!
 
   def destroyed?
-    !!deleted_at
+    !!send(paranoia_column)
   end
 
   alias :deleted? :destroyed?
 
   private
 
-  # Rails 3.1 adds update_column. Rails > 3.2.6 deprecates update_attribute, gone in Rails 4.
-  def update_attribute_or_column(*args)
-    self.class.unscoped do
-      respond_to?(:update_column) ? update_column(*args) : update_attribute(*args)
+  # touch paranoia column.
+  # 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)
+    end
+  end
+
+  # restore associated records that have been soft deleted when
+  # we called #destroy
+  def restore_associated_records
+    destroyed_associations = self.class.reflect_on_all_associations.select do |association|
+      association.options[:dependent] == :destroy
+    end
+
+    destroyed_associations.each do |association|
+      association = send(association.name)
+
+      if association.paranoid?
+        association.only_deleted.each { |record| record.restore(:recursive => true) }
+      end
     end
   end
 end
 
 class ActiveRecord::Base
-  def self.acts_as_paranoid
-    alias :destroy! :destroy
+  def self.acts_as_paranoid(options={})
+    alias :ar_destroy :destroy
+    alias :destroy! :ar_destroy
     alias :delete! :delete
     include Paranoia
-    default_scope { where(self.quoted_table_name + '.deleted_at IS NULL') }
+    class_attribute :paranoia_column
+
+    self.paranoia_column = options[:column] || :deleted_at
+    default_scope { where(self.quoted_table_name + ".#{paranoia_column} IS NULL") }
+
+    before_restore {
+      self.class.notify_observers(:before_restore, self) if self.class.respond_to?(:notify_observers)
+    }
+    after_restore {
+      self.class.notify_observers(:after_restore, self) if self.class.respond_to?(:notify_observers)
+    }
   end
 
   def self.paranoid?
@@ -98,4 +134,10 @@ class ActiveRecord::Base
   def persisted?
     paranoid? ? !new_record? : super
   end
+
+  private
+
+  def paranoia_column
+    self.class.paranoia_column
+  end
 end

data/lib/paranoia/version.rb

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

data/paranoia.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '~> 3.2'
 
   s.add_development_dependency 'bundler', '>= 1.0.0'
-  s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rake'
 
   s.files = `git ls-files`.split("\n")

data/test/paranoia_test.rb

@@ -17,6 +17,8 @@ ActiveRecord::Base.connection.execute 'CREATE TABLE related_models (id INTEGER N
 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)'
 ActiveRecord::Base.connection.execute 'CREATE TABLE jobs (id INTEGER NOT NULL PRIMARY KEY, employer_id INTEGER NOT NULL, employee_id INTEGER NOT NULL, deleted_at DATETIME)'
+ActiveRecord::Base.connection.execute 'CREATE TABLE custom_column_models (id INTEGER NOT NULL PRIMARY KEY, destroyed_at DATETIME)'
+ActiveRecord::Base.connection.execute 'CREATE TABLE non_paranoid_models (id INTEGER NOT NULL PRIMARY KEY, parent_model_id INTEGER)'
 
 class ParanoiaTest < Test::Unit::TestCase
   def test_plain_model_class_is_not_paranoid
@@ -59,6 +61,37 @@ class ParanoiaTest < Test::Unit::TestCase
     assert_equal 0, model.class.unscoped.count
   end
 
+  # Anti-regression test for #81, which would've introduced a bug to break this test.
+  def test_destroy_behavior_for_plain_models_callbacks
+    model = CallbackModel.new
+    model.save
+    model.remove_called_variables     # clear called callback flags
+    model.destroy
+
+    assert_equal nil, model.instance_variable_get(:@update_callback_called)
+    assert_equal nil, model.instance_variable_get(:@save_callback_called)
+    assert_equal nil, model.instance_variable_get(:@validate_called)
+
+    assert model.instance_variable_get(:@destroy_callback_called)
+    assert model.instance_variable_get(:@after_destroy_callback_called)
+    assert model.instance_variable_get(:@after_commit_callback_called)
+  end
+
+
+  def test_delete_behavior_for_plain_models_callbacks
+    model = CallbackModel.new
+    model.save
+    model.remove_called_variables     # clear called callback flags
+    model.delete
+
+    assert_equal nil, model.instance_variable_get(:@update_callback_called)
+    assert_equal nil, model.instance_variable_get(:@save_callback_called)
+    assert_equal nil, model.instance_variable_get(:@validate_called)
+    assert_equal nil, model.instance_variable_get(:@destroy_callback_called)
+    assert_equal nil, model.instance_variable_get(:@after_destroy_callback_called)
+    assert_equal nil, model.instance_variable_get(:@after_commit_callback_called)
+  end
+
   def test_destroy_behavior_for_paranoid_models
     model = ParanoidModel.new
     assert_equal 0, model.class.count
@@ -88,6 +121,23 @@ class ParanoiaTest < Test::Unit::TestCase
     assert_equal [p1, p3], parent1.paranoid_models.with_deleted
   end
 
+  def test_destroy_behavior_for_custom_column_models
+    model = CustomColumnModel.new
+    assert_equal 0, model.class.count
+    model.save!
+    assert_nil model.destroyed_at
+    assert_equal 1, model.class.count
+    model.destroy
+
+    assert_equal false, model.destroyed_at.nil?
+    assert model.destroyed?
+
+    assert_equal 0, model.class.count
+    assert_equal 1, model.class.unscoped.count
+    assert_equal 1, model.class.only_deleted.count
+    assert_equal 1, model.class.deleted.count
+  end
+
   def test_destroy_behavior_for_featureful_paranoid_models
     model = get_featureful_model
     assert_equal 0, model.class.count
@@ -165,14 +215,14 @@ class ParanoiaTest < Test::Unit::TestCase
     model = CallbackModel.new
     model.save
     model.delete
-    assert_equal nil, model.instance_variable_get(:@callback_called)
+    assert_equal nil, model.instance_variable_get(:@destroy_callback_called)
   end
 
   def test_destroy_behavior_for_callbacks
     model = CallbackModel.new
     model.save
     model.destroy
-    assert model.instance_variable_get(:@callback_called)
+    assert model.instance_variable_get(:@destroy_callback_called)
   end
 
   def test_restore
@@ -190,13 +240,14 @@ class ParanoiaTest < Test::Unit::TestCase
     assert_equal false, model.destroyed?
   end
 
+  # Regression test for #92
   def test_destroy_twice
     model = ParanoidModel.new
     model.save
     model.destroy
     model.destroy
 
-    assert_equal 0, ParanoidModel.unscoped.where(id: model.id).count
+    assert_equal 1, ParanoidModel.unscoped.where(id: model.id).count
   end
 
   def test_restore_behavior_for_callbacks
@@ -256,6 +307,50 @@ class ParanoiaTest < Test::Unit::TestCase
     refute c.destroyed?
   end
 
+  def test_restore_with_associations
+    parent = ParentModel.create
+    first_child = parent.very_related_models.create
+    second_child = parent.non_paranoid_models.create
+
+    parent.destroy
+    assert_equal false, parent.deleted_at.nil?
+    assert_equal false, first_child.reload.deleted_at.nil?
+    assert_equal true, second_child.destroyed?
+
+    parent.restore!
+    assert_equal true, parent.deleted_at.nil?
+    assert_equal false, first_child.reload.deleted_at.nil?
+    assert_equal true, second_child.destroyed?
+
+    parent.destroy
+    parent.restore(:recursive => true)
+    assert_equal true, parent.deleted_at.nil?
+    assert_equal true, first_child.reload.deleted_at.nil?
+    assert_equal true, second_child.destroyed?
+
+    parent.destroy
+    ParentModel.restore(parent.id, :recursive => true)
+    assert_equal true, parent.reload.deleted_at.nil?
+    assert_equal true, first_child.reload.deleted_at.nil?
+    assert_equal true, second_child.destroyed?
+  end
+
+  def test_observers_notified
+    a = ParanoidModelWithObservers.create
+    a.destroy
+    a.restore!
+
+    assert a.observers_notified.select {|args| args == [:before_restore, a]}
+    assert a.observers_notified.select {|args| args == [:after_restore, a]}
+  end
+
+  def test_observers_not_notified_if_not_supported
+    a = ParanoidModelWithObservers.create
+    a.destroy
+    a.restore!
+    # essentially, we're just ensuring that this doesn't crash
+  end
+
   private
   def get_featureful_model
     FeaturefulModel.new(:name => 'not empty')
@@ -283,13 +378,26 @@ end
 
 class CallbackModel < ActiveRecord::Base
   acts_as_paranoid
-  before_destroy {|model| model.instance_variable_set :@callback_called, true }
+  before_destroy {|model| model.instance_variable_set :@destroy_callback_called, true }
   before_restore {|model| model.instance_variable_set :@restore_callback_called, true }
+  before_update  {|model| model.instance_variable_set :@update_callback_called, true }
+  before_save    {|model| model.instance_variable_set :@save_callback_called, true}
+
+  after_destroy  {|model| model.instance_variable_set :@after_destroy_callback_called, true }
+  after_commit   {|model| model.instance_variable_set :@after_commit_callback_called, true }
+
+  validate       {|model| model.instance_variable_set :@validate_called, true }
+
+  def remove_called_variables
+    instance_variables.each {|name| (name.to_s.end_with?('_called')) ? remove_instance_variable(name) : nil}
+  end
 end
 
 class ParentModel < ActiveRecord::Base
   acts_as_paranoid
   has_many :related_models
+  has_many :very_related_models, :class_name => 'RelatedModel', dependent: :destroy
+  has_many :non_paranoid_models, dependent: :destroy
 end
 
 class RelatedModel < ActiveRecord::Base
@@ -314,3 +422,24 @@ class Job < ActiveRecord::Base
   belongs_to :employer
   belongs_to :employee
 end
+
+class CustomColumnModel < ActiveRecord::Base
+  acts_as_paranoid column: :destroyed_at
+end
+
+class NonParanoidModel < ActiveRecord::Base
+end
+
+class ParanoidModelWithObservers < ParanoidModel
+  def observers_notified
+    @observers_notified ||= []
+  end
+
+  def self.notify_observer(*args)
+    observers_notified << args
+  end
+end
+
+class ParanoidModelWithoutObservers < ParanoidModel
+  self.class.send(remove_method :notify_observers) if method_defined?(:notify_observers)
+end

metadata

@@ -1,69 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: paranoia
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - radarlistener@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Paranoia is a re-implementation of acts_as_paranoid for Rails 3, using
@@ -77,8 +63,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -96,17 +82,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: paranoia
-rubygems_version: 2.1.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Paranoia is a re-implementation of acts_as_paranoid for Rails 3, using much,