soft_destroyable 0.1.8 → 0.5.0

data/README.textile

@@ -13,9 +13,12 @@ h3. Details
 
 This changes the behavior of the +destroy+ method to become a soft-destroy, which
 will set the +deleted_at+ attribute to <tt>Time.now</tt>, and the +deleted+ attribute to <tt>true</tt>
-It exposes the +revive+ method to reverse the effects of +destroy+.
+It exposes the +revive+ method to reverse the effects of +destroy+ (for :dependent => :destroy associations only).
 It also exposes the +destroy!+ method which can be used to <b>really</b> destroy an object and it's associations.
 
++revive+ will not revive child associations which have been destroyed by actions other a destroy of the parent.
+This requires the column attribute +revive_with_parent+.
+
 Standard ActiveRecord destroy callbacks are _not_ called, however you can override +before_soft_destroy+, +after_soft_destroy+,
 and +before_destroy!+ on your soft_destroyable models.
 
@@ -83,6 +86,10 @@ h3. Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request
 
-h3. Copyright
+h3. Contributors
+
+* "Mack Talcott":https://github.com/mtalcott
+
+ h3. Copyright
 
 Copyright (c) 2010-11 Michael Kintzer, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.5.0

data/lib/soft_destroyable.rb

@@ -5,9 +5,12 @@ require "#{File.dirname(__FILE__)}/soft_destroyable/is_soft_destroyable"
 #
 # This changes the behavior of the +destroy+ method to being a soft-destroy, which
 # will set the +deleted_at+ attribute to <tt>Time.now</tt>, and the +deleted+ attribute to <tt>true</tt>
-# It exposes the +revive+ method to reverse the effects of +destroy+.
+# It exposes the +revive+ method to reverse the effects of +destroy+ (for :dependent => :destroy associations only).
 # It also exposes the +destroy!+ method which can be used to <b>really</b> destroy an object and it's associations.
 #
+# +revive+ will not cascade revive child associations which have been destroyed by actions other a destroy of the parent.
+# This requires the column attribute +revive_with_parent+.
+#
 # Standard ActiveRecord destroy callbacks are _not_ called, however you can override +before_soft_destroy+, +after_soft_destroy+,
 # and +before_destroy!+ on your soft_destroyable models.
 #
@@ -109,7 +112,9 @@ module SoftDestroyable
     def revive
       transaction do
         cascade_revive
-        update_attributes(:deleted_at => nil, :deleted => false)
+        update_hash = {:deleted_at => nil, :deleted => false}
+        update_hash[:revive_with_parent] = true if respond_to?(:revive_with_parent)
+        update_attributes(update_hash)
       end
     end
 
@@ -153,7 +158,13 @@ module SoftDestroyable
       cascade_to_soft_dependents { |assoc_obj|
         if assoc_obj.respond_to?(:destroy) && assoc_obj.respond_to?(:revive)
           wrap_with_callbacks(assoc_obj, "soft_destroy") do
-            assoc_obj.destroy
+            if assoc_obj.deleted? && assoc_obj.respond_to?(:revive_with_parent?)
+              # if assoc_obj already deleted, and we are cascading a delete, just update the attribute revive_with_parent to false
+              # so we know not to revive this object on a cascade of revive
+              assoc_obj.update_attributes(:revive_with_parent => false)
+            else
+              assoc_obj.destroy
+            end
           end
         else
           wrap_with_callbacks(assoc_obj, "soft_destroy") do
@@ -179,30 +190,32 @@ module SoftDestroyable
     end
 
     def cascade_revive
-      cascade_to_soft_dependents { |assoc_obj|
-        assoc_obj.revive if assoc_obj.respond_to?(:revive)
+      cascade_to_soft_dependents(true) { |assoc_obj|
+        assoc_obj.revive if assoc_obj.respond_to?(:revive) && (!assoc_obj.respond_to?(:revive_with_parent?) ||
+            assoc_obj.revive_with_parent?)
       }
     end
 
-    def cascade_to_soft_dependents(&block)
+    # cascade of revive only applied to :dependent => :destroy associations
+    def cascade_to_soft_dependents(reviving = false, &block)
       return unless block_given?
 
       # fail fast on :dependent => :restrict
-      restrict_dependencies.each { |assoc_sym| handle_restrict(assoc_sym) }
+      restrict_dependencies.each { |assoc_sym| handle_restrict(assoc_sym) } unless reviving
 
       non_restrict_dependencies.each do |assoc_sym|
-        reflection  = reflection_for(assoc_sym)
+        reflection = reflection_for(assoc_sym)
         association = send(reflection.name)
 
         case reflection.options[:dependent]
           when :destroy
             handle_destroy(reflection, association, &block)
           when :nullify
-            handle_nullify(reflection, association)
+            handle_nullify(reflection, association) unless reviving
           when :delete_all
-            handle_delete_all(reflection, association)
+            handle_delete_all(reflection, association) unless reviving
           when :delete
-            handle_delete(reflection, association)
+            handle_delete(reflection, association) unless reviving
           else
         end
 
@@ -223,7 +236,7 @@ module SoftDestroyable
     end
 
     def handle_restrict(assoc_sym)
-      reflection  = reflection_for(assoc_sym)
+      reflection = reflection_for(assoc_sym)
       association = send(reflection.name)
       case reflection.macro
         when :has_many
@@ -278,7 +291,7 @@ module SoftDestroyable
 
     def restrict_on_non_empty_has_many(reflection, association)
       return unless association
-      association.each {|assoc_obj|
+      association.each { |assoc_obj|
         if assoc_obj.respond_to?(:deleted?)
           raise ActiveRecord::DeleteRestrictionError.new(reflection) if !assoc_obj.deleted?
         else

data/lib/soft_destroyable/table_definition.rb

@@ -8,6 +8,12 @@ module SoftDestroyable
     def soft_destroyable
       column "deleted", :boolean, :default => false
       column "deleted_at", :datetime
+      column "revive_with_parent", :boolean, :default => true
+    end
+
+    # useful on migration's for tables which were migrated with 'soft_destroyable' prior to revive_with_parent
+    def revive_tracking
+      column "revive_with_parent", :boolean, :default => true
     end
 
   end

data/soft_destroyable.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{soft_destroyable}
-  s.version = "0.1.8"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Kintzer"]

data/test/class_method_test.rb

@@ -12,7 +12,7 @@ class ClassMethodTest < Test::Unit::TestCase
   end
 
   def test_soft_dependencies
-    assert_equal 20, Parent.soft_dependencies.count
+    assert_equal 21, Parent.soft_dependencies.count
 
     assert Parent.soft_dependencies.include? :soft_children
     assert Parent.soft_dependencies.include? :children
@@ -37,7 +37,9 @@ class ClassMethodTest < Test::Unit::TestCase
     assert Parent.soft_dependencies.include? :soft_parent_sports
     assert Parent.soft_dependencies.include? :parent_sports
     assert Parent.soft_dependencies.include? :soft_parent_nickname
-    assert Parent.soft_dependencies.include? :parent_nickname   
+    assert Parent.soft_dependencies.include? :parent_nickname
+
+    assert Parent.soft_dependencies.include? :soft_no_revive_with_parent_attribute_children
   end
 
   def test_soft_dependency_order

data/test/dependent_delete_all_test.rb

@@ -52,4 +52,26 @@ class DependentDeleteAllTest < Test::Unit::TestCase
     assert_equal 0, SoftDeleteAllChild.where(:name => "bambam", :parent_id => @fred.id).count
   end
 
+  # revive
+
+  def test_revive_does_not_delete_all_has_many_delete_all_soft_children
+    @fred.destroy
+    assert_equal true, @fred.deleted?
+    @fred.soft_delete_all_children << dino = SoftDeleteAllChild.new(:name => "dino")
+    assert_equal 1, @fred.reload.soft_delete_all_children.count
+    @fred.revive
+    assert_equal false, @fred.deleted?
+    assert_equal 1, SoftDeleteAllChild.where(:name => "dino", :parent_id => @fred.id).count
+  end
+
+  def test_revive_does_not_delete_all_has_many_delete_all_children
+    @fred.destroy
+    assert_equal true, @fred.deleted?
+    @fred.delete_all_children << dino = DeleteAllChild.new(:name => "dino")
+    assert_equal 1, @fred.reload.delete_all_children.count
+    @fred.revive
+    assert_equal false, @fred.deleted?
+    assert_equal 1, DeleteAllChild.where(:name => "dino", :parent_id => @fred.id).count
+  end
+
 end

data/test/dependent_delete_test.rb

@@ -46,4 +46,22 @@ class DependentDeleteTest < Test::Unit::TestCase
     assert_equal 0, DeleteOne.where(:name => "pebbles", :parent_id => @fred.id).count
   end
 
+  # revive
+
+  def test_revive_does_not_delete_all_has_one_soft_delete_one
+    @fred.destroy
+    @fred.soft_delete_one = bambam = SoftDeleteOne.new(:name => "bambam")
+    assert_equal bambam, @fred.reload.soft_delete_one
+    @fred.revive
+    assert_equal bambam, @fred.reload.soft_delete_one
+  end
+
+  def test_revive_does_not_delete_all_has_one_delete_one
+    @fred.destroy
+    @fred.delete_one = bambam = DeleteOne.new(:name => "bambam")
+    assert_equal bambam, @fred.reload.delete_one
+    @fred.revive
+    assert_equal bambam, @fred.reload.delete_one
+  end
+
 end

data/test/dependent_destroy_test.rb

@@ -92,4 +92,33 @@ class DependentDestroyTest < Test::Unit::TestCase
     assert_nil One.find_by_name("bambam")
   end
 
+  # revive
+
+  def test_revive_has_many_soft_children
+    @fred.soft_children << pebbles = SoftChild.new(:name => "pebbles")
+    @fred.soft_children << bambam = SoftChild.new(:name => "bambam")
+    assert_equal @fred.reload.soft_children.count, 2
+    @fred.destroy
+    assert_equal @fred.deleted?, true
+    assert_equal pebbles.reload.deleted?, true
+    assert_equal bambam.reload.deleted?, true
+    @fred.soft_children << dino = SoftChild.new(:name => "dino")
+    @fred.revive
+    assert_equal @fred.deleted?, false
+    assert_equal pebbles.reload.deleted?, false
+    assert_equal bambam.reload.deleted?, false
+    assert_equal dino.reload.deleted?, false
+  end
+
+  def test_revive_has_soft_ones
+    @fred.soft_one = bambam = SoftOne.new(:name => "bambam")
+    assert_equal @fred.reload.soft_one, SoftOne.where(:name => "bambam", :parent_id => @fred.id).first
+    @fred.destroy
+    assert_equal @fred.deleted?, true
+    assert_equal SoftOne.where(:name => "bambam").first.deleted?, true
+    @fred.revive
+    assert_equal @fred.deleted?, false
+    assert_equal SoftOne.where(:name => "bambam").first.deleted?, false
+  end
+
 end

data/test/dependent_nullify_test.rb

@@ -93,4 +93,39 @@ class DependentNullifyTest < Test::Unit::TestCase
     assert_nil bambam.reload.parent
   end
 
+  # revive
+
+  def test_revive_does_not_nullify_has_many_nullify_soft_children
+    @fred.destroy
+    @fred.soft_nullify_children << pebbles = SoftNullifyChild.new(:name => "pebbles")
+    assert_equal @fred, pebbles.reload.parent
+    @fred.revive
+    assert_equal @fred, pebbles.reload.parent
+  end
+
+  def test_revive_does_not_nullify_has_many_nullify_children
+    @fred.destroy
+    @fred.nullify_children << pebbles = NullifyChild.new(:name => "pebbles")
+    assert_equal @fred, pebbles.reload.parent
+    @fred.revive
+    assert_equal @fred, pebbles.reload.parent
+  end
+
+  def test_revive_does_not_nullify_has_soft_nullify_ones
+    @fred.destroy
+    @fred.soft_nullify_one = bambam = SoftNullifyOne.new(:name => "bambam")
+    assert_equal bambam, @fred.reload.soft_nullify_one
+    @fred.revive
+    assert_equal bambam, @fred.reload.soft_nullify_one
+  end
+
+  def test_revive_does_not_nullify_has_nullify_ones
+    @fred.destroy
+    @fred.nullify_one = bambam = NullifyOne.new(:name => "bambam")
+    assert_equal bambam, @fred.reload.nullify_one
+    @fred.revive
+    assert_equal bambam, @fred.reload.nullify_one
+  end
+
+
 end

data/test/dependent_restrict_test.rb

@@ -152,5 +152,50 @@ class DependentRestrictTest < Test::Unit::TestCase
     assert_equal false, @fred.deleted?
     assert_not_nil RestrictOne.find_by_name("bambam")
   end
-
+  
+  # revive
+  
+  def test_revive_has_many_restrict_children_not_empty
+    assert_can_revive do
+      @fred.restrict_children << pebbles = RestrictChild.new(:name => "pebbles")
+      assert_equal pebbles, @fred.restrict_children.first
+    end
+  end
+  
+  def test_revive_has_many_restrict_soft_children_not_all_deleted
+    assert_can_revive do
+      @fred.soft_restrict_children << pebbles = SoftRestrictChild.new(:name => "pebbles")
+      assert_equal pebbles, @fred.soft_restrict_children.first
+    end
+  end
+  
+  def test_revive_has_restrict_ones_not_nil
+    assert_can_revive do
+      @fred.restrict_one = bambam = RestrictOne.new(:name => "bambam")
+      assert_equal bambam, @fred.restrict_one
+    end
+  end
+  
+  def test_revive_has_soft_restrict_ones_not_deleted
+    assert_can_revive do
+      @fred.soft_restrict_one = bambam = SoftRestrictOne.new(:name => "bambam")
+      assert_equal bambam, @fred.soft_restrict_one
+    end
+  end
+  
+  private
+  
+  def assert_can_revive
+    assert_equal true, @fred.destroy
+    yield if block_given?
+    # assert_not_raise ActiveRecord::DeleteRestrictionError do
+      @fred.revive
+    # end
+    assert_equal false, @fred.deleted?
+  end
+  
+  def assert_true value
+    assert_equal true, value
+  end
+  
 end

data/test/test_helper.rb

@@ -190,6 +190,14 @@ def setup_db
       t.references :callback_parent
     end
 
+    # used to test behavior of soft_destroy migration without revive_with_parent column
+    create_table :soft_no_revive_with_parent_attribute_children do |t|
+      t.string :name
+      t.references :parent
+      t.boolean :deleted, :default => false
+      t.datetime :deleted_at
+    end
+
     # todo: HasAndBelongsToMany?
   end
 end
@@ -236,6 +244,8 @@ class Parent < ActiveRecord::Base
   has_one :soft_delete_one, :dependent => :delete
   has_one :delete_one, :dependent => :delete
 
+  has_many :soft_no_revive_with_parent_attribute_children, :dependent => :destroy
+
   soft_destroyable
 end
 
@@ -393,3 +403,8 @@ class CallbackChild < ActiveRecord::Base
     raise PreventDestroyBangError.new
   end
 end
+
+class SoftNoReviveWithParentAttributeChild < ActiveRecord::Base
+  belongs_to :parent
+  soft_destroyable
+end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 8
-  version: 0.1.8
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Michael Kintzer