soft_destroyable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-11 Michael Kintzer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,18 @@
+SoftDestroyable
+===============
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010-11 Michael Kintzer, released under the MIT license

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the soft_destroyable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the soft_destroyable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "SoftDestroyable #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "soft_destroyable"
+    gem.summary = "Rails 3 ActiveRecord compatible soft destroy implementation"
+    gem.description = "Rails 3 ActiveRecord compatible soft destroy implementation supporting dependent associations"
+    gem.email = "rockrep@yahoo.com"
+    gem.homepage = "http://github.com/rockrep/soft_destroyable"
+    gem.authors = ["Michael Kintzer"]
+    gem.add_development_dependency "rails", ">=3.0"
+    gem.add_development_dependency "sqlite3", ">=1.3.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require "soft_destroyable"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/soft_destroyable/is_soft_destroyable.rb

@@ -0,0 +1,30 @@
+module SoftDestroyable
+  # Simply adds a flag to determine whether a model class is soft_destroyable.
+  module IsSoftDestroyable
+    def self.extended(base) # :nodoc:
+      base.class_eval do
+        class << self
+          alias_method_chain :soft_destroyable, :flag
+        end
+      end
+    end
+
+    # Overrides the +soft_destroyable+ method to first define the +soft_destroyable?+ class method before
+    # deferring to the original +soft_destroyable+.
+    def soft_destroyable_with_flag(*args)
+      soft_destroyable_without_flag(*args)
+
+      class << self
+        def soft_destroyable?
+          true
+        end
+      end
+    end
+
+    # For all ActiveRecord::Base models that do not call the +soft_destroyable+ method, the +soft_destroyable?+
+    # method will return false.
+    def soft_destroyable?
+      false
+    end
+  end
+end

data/lib/soft_destroyable/table_definition.rb

@@ -0,0 +1,15 @@
+module SoftDestroyable
+  module TableDefinition
+
+    # provide a migration short-cut for defining the required soft-destroyable columns
+    # can be used inside of a create_table or change_table (to add the columns)
+    #
+    # If you want to index on either of these fields, you need to handle that separately
+    def soft_destroyable
+      column "deleted", :boolean, :default => false
+      column "deleted_at", :datetime
+    end
+
+  end
+end
+

data/lib/soft_destroyable.rb

@@ -0,0 +1,299 @@
+require "#{File.dirname(__FILE__)}/soft_destroyable/table_definition"
+require "#{File.dirname(__FILE__)}/soft_destroyable/is_soft_destroyable"
+
+# Allows one to annotate an ActiveRecord module as being 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 also exposes the +destroy!+ method which can be used to <b>really</b> destroy an object and it's associations.
+#
+# 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.
+#
+# Standard ActiveRecord dependent options :destroy, :restrict, :nullify, :delete_all, and :delete are supported.
+# +revive+ will _not_ undo the effects of +nullify+, +delete_all+, and +delete+.   +restrict+ is _not_ effected by the
+# +deleted?+ state.  In other words, deleted child models will still restrict destroying the parent.
+#
+# The +delete+ operation is _not_ modified by this module.
+#
+# The operations: +destroy+, +destroy!+, and +revive+ are automatically delegated to the dependent association records.
+# in a single transaction.
+#
+# Examples:
+#   class Parent
+#     has_many :children, :dependent => :restrict
+#     has_many :animals, :dependent => :nullify
+#     soft_destroyable
+#
+#
+# Author: Michael Kintzer
+#
+
+module SoftDestroyable
+
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      extend IsSoftDestroyable
+    end
+  end
+
+  module ClassMethods
+
+    def soft_destroyable(options = {})
+      return if soft_destroyable?
+
+      scope :not_deleted, where(:deleted => false)
+      scope :deleted, where(:deleted => true)
+
+      include InstanceMethods
+      extend SingletonMethods
+    end
+  end
+
+  module SingletonMethods
+
+    # returns an array of association symbols that must be managed by soft_destroyable on
+    # destroy and destroy!
+    def soft_dependencies
+      has_many_dependencies + has_one_dependencies
+    end
+
+    def restrict_dependencies
+      with_restrict_option(:has_many).map(&:name) + with_restrict_option(:has_one).map(&:name)
+    end
+
+    private
+
+    def non_through_dependent_associations(type)
+      reflect_on_all_associations(type).reject { |k, v|
+        k.class == ActiveRecord::Reflection::ThroughReflection }.reject { |k, v| k.options[:dependent].nil? }
+    end
+
+    def has_many_dependencies
+      non_through_dependent_associations(:has_many).map(&:name)
+    end
+
+    def has_one_dependencies
+      non_through_dependent_associations(:has_one).map(&:name)
+    end
+
+    def with_restrict_option(type)
+      non_through_dependent_associations(type).reject { |k, v| k.options[:dependent] != :restrict }
+    end
+
+  end
+
+  module InstanceMethods
+
+    # overrides the normal ActiveRecord::Transactions#destroy.
+    # can be recovered with +revive+
+    def destroy
+      before_soft_destroy
+      result = soft_destroy
+      after_soft_destroy
+      result
+    end
+
+    # not a recoverable operation
+    def destroy!
+      transaction do
+        before_destroy!
+        cascade_destroy!
+        delete
+      end
+    end
+
+    # un-does the effect of +destroy+.  Does not undo nullify on dependents
+    def revive
+      transaction do
+        cascade_revive
+        update_attributes(:deleted_at => nil, :deleted => false)
+      end
+    end
+
+    def soft_dependencies
+      self.class.soft_dependencies
+    end
+
+    def restrict_dependencies
+      self.class.restrict_dependencies
+    end
+
+    # override
+    def before_soft_destroy
+      # empty
+    end
+
+    # override
+    def after_soft_destroy
+      # empty
+    end
+
+    # override
+    def before_destroy!
+      # empty
+    end
+
+    private
+
+    def non_restrict_dependencies
+      soft_dependencies.reject { |assoc_sym| restrict_dependencies.include?(assoc_sym) }
+    end
+
+    def soft_destroy
+      transaction do
+        cascade_soft_destroy
+        update_attributes(:deleted_at => Time.now, :deleted => true)
+      end
+    end
+
+    def cascade_soft_destroy
+      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
+          end
+        else
+          wrap_with_callbacks(assoc_obj, "soft_destroy") do
+            # no-op
+          end
+        end
+      }
+    end
+
+    def cascade_destroy!
+      cascade_to_soft_dependents { |assoc_obj|
+      # cascade destroy! to soft dependencies objects
+        if assoc_obj.respond_to?(:destroy!)
+          wrap_with_callbacks(assoc_obj, "destroy!") do
+            assoc_obj.destroy!
+          end
+        else
+          wrap_with_callbacks(assoc_obj, "destroy!") do
+            assoc_obj.destroy
+          end
+        end
+      }
+    end
+
+    def cascade_revive
+      cascade_to_soft_dependents { |assoc_obj|
+        assoc_obj.revive if assoc_obj.respond_to?(:revive)
+      }
+    end
+
+    def cascade_to_soft_dependents(&block)
+      return unless block_given?
+
+      # fail fast on :dependent => :restrict
+      restrict_dependencies.each { |assoc_sym| handle_restrict(assoc_sym) }
+
+      non_restrict_dependencies.each do |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)
+          when :delete_all
+            handle_delete_all(reflection, association)
+          when :delete
+            handle_delete(reflection, association)
+          else
+        end
+
+      end
+      # reload as dependent associations may have updated
+      reload if self.id
+    end
+
+    def handle_destroy(reflection, association, &block)
+      case reflection.macro
+        when :has_many
+          association.each { |assoc_obj| yield(assoc_obj) }
+        when :has_one
+          # handle non-nil has_one
+          yield(association) if association
+        else
+      end
+    end
+
+    def handle_restrict(assoc_sym)
+      reflection  = reflection_for(assoc_sym)
+      association = send(reflection.name)
+      case reflection.macro
+        when :has_many
+          restrict_on_non_empty_has_many(reflection, association)
+        when :has_one
+          restrict_on_nil_has_one(reflection, association)
+        else
+      end
+    end
+
+    def handle_nullify(reflection, association)
+      return unless association
+      case reflection.macro
+        when :has_many
+          self.class.send(:nullify_has_many_dependencies,
+                          self,
+                          reflection.name,
+                          reflection.klass,
+                          reflection.primary_key_name,
+                          reflection.dependent_conditions(self, self.class, nil))
+        when :has_one
+          association.update_attributes(reflection.primary_key_name => nil)
+        else
+      end
+
+    end
+
+    def handle_delete_all(reflection, association)
+      return unless association
+      self.class.send(:delete_all_has_many_dependencies,
+                      self,
+                      reflection.name,
+                      reflection.klass,
+                      reflection.dependent_conditions(self, self.class, nil))
+    end
+
+    def handle_delete(reflection, association)
+      return unless association
+      association.update_attribute(reflection.primary_key_name, nil)
+    end
+
+    def wrap_with_callbacks(assoc_obj, action)
+      return unless block_given?
+      assoc_obj.send("before_#{action}".to_sym) if assoc_obj.respond_to?("before_#{action}".to_sym)
+      yield
+      assoc_obj.send("after_#{action}".to_sym) if assoc_obj.respond_to?("after_#{action}".to_sym)
+    end
+
+    def reflection_for(assoc_sym)
+      self.class.reflect_on_association(assoc_sym)
+    end
+
+    def restrict_on_non_empty_has_many(reflection, association)
+      return unless association
+      raise ActiveRecord::DeleteRestrictionError.new(reflection) if !association.empty?
+    end
+
+    def restrict_on_nil_has_one(reflection, association)
+      raise ActiveRecord::DeleteRestrictionError.new(reflection) if !association.nil?
+    end
+
+  end
+
+  ActiveRecord::Base.send :include, SoftDestroyable
+  [ActiveRecord::ConnectionAdapters::TableDefinition, ActiveRecord::ConnectionAdapters::Table].each { |base|
+    base.send(:include, SoftDestroyable::TableDefinition)
+  }
+
+  class SoftDestroyError < StandardError
+
+  end
+
+end

data/spec/support/soft_destroy_spec_helper.rb

@@ -0,0 +1,111 @@
+# Utility module for Specing Database constraints
+#
+# Would like to rewrite these at some point to be more RSpec 'matcherish' so they would read more BDD-like.
+#
+#  Author: Michael Kintzer
+#  August 31, 2010
+
+module SoftDestroySpecHelper
+
+  # Ensures that the model class is annotated as +soft_destroyable+
+  # and that the model behaves appropriately to destroy and revive
+  def asserts_soft_destroy?(model_klass, new_record_args={})
+    model_klass = model_klass.constantize if model_klass.is_a?(String)
+
+    model_klass.respond_to?(:not_deleted).should be_true
+
+    current_count         = model_klass.count
+    current_deleted_count = model_klass.deleted.count
+
+    # create a new record
+    obj                   = model_klass.create!(new_record_args)
+
+    # verify the database migration
+    asserts_soft_destroy_migration?(obj)
+
+    model_klass.count.should == 1 + current_count
+
+    # verify soft destroy behaves correctly, and the record still exists and is correctly marked
+    obj.destroy.should be_true
+    obj.reload
+    obj.deleted_at.should_not be_nil
+    obj.deleted?.should be_true
+
+    # verify counts are correct
+    model_klass.count.should == 1 + current_count
+    model_klass.not_deleted.count.should == 0 + current_count
+    model_klass.deleted.count.should == 1 + current_deleted_count
+
+    # verify revive behaves correctly
+    obj.revive
+    obj.reload
+    obj.deleted_at.should be_nil
+    obj.deleted?.should be_false
+
+    # verify counts are correct
+    model_klass.count.should == 1 + current_count
+    model_klass.not_deleted.count.should == 1 + current_count
+    model_klass.deleted.count.should == 0 + current_deleted_count
+  end
+
+  # Ensures that the model class soft destroys the associated dependent association on +destroy+
+  # This helper only valid if :dependent => :destroy
+  def asserts_soft_destroy_associations?(model_obj, association_symbol, new_association_record)
+    # save model_obj in case it hasn't been yet
+    model_obj.save
+    association_reflection           = model_obj.class.reflect_on_association(association_symbol.to_sym)
+    association_reflection.options[:dependent].should == :destroy
+    assign_association(model_obj, association_reflection, new_association_record)
+
+    unless new_association_record.respond_to?(:revive)
+      # if associated_klass is NOT soft_destroyable, then calling destroy on parent is a NO-OP so associated_klass should
+      # NOT receive a destroy call
+      new_association_record.expects(:destroy).never
+    end
+
+    model_obj.destroy
+
+    if new_association_record.respond_to?(:revive)
+      # if associated_klass IS soft_destroyable, then the new_association_record should be deleted
+      new_association_record.deleted?.should be_true
+    end
+  end
+
+  # Ensures that the model class hard destroys the associated dependent association on +destroy!+
+  # This helper only valid if :dependent => :destroy
+  def asserts_hard_destroy_associations?(model_obj, association_symbol, new_association_record)
+    # save model obj in case it hasn't been yet
+    model_obj.save
+    association_reflection = model_obj.class.reflect_on_association(association_symbol.to_sym)
+    association_reflection.options[:dependent].should == :destroy
+    assign_association(model_obj, association_reflection, new_association_record)
+    association_reflection.klass.where(association_reflection.primary_key_name => model_obj.id).count.should > 0
+    model_obj.destroy!
+    association_reflection.klass.where(association_reflection.primary_key_name => model_obj.id).count.should == 0
+  end
+
+  private
+
+  # verifies the table contains the expected soft destroy fields,
+  # and they have the appropriate defaults
+  def asserts_soft_destroy_migration?(obj)
+    obj.respond_to?(:deleted_at).should be_true
+    obj.respond_to?(:deleted).should be_true
+    obj.deleted_at.should be_nil
+    obj.deleted?.should be_false
+  end
+
+  # Assigns the new_association_record to the model_obj
+  def assign_association(model_obj, association_reflection, new_association_record)
+    case association_reflection.macro
+      when :has_many
+        model_obj.send(association_reflection.name) << new_association_record
+      when :has_one
+        model_obj.send("#{association_reflection.name}=", new_association_record)
+      else
+        raise NotImplementedError.new("Association #{association_reflection.macro} not handled")
+    end
+    new_association_record.id.should_not be_nil
+  end
+
+end

data/test/basic_test.rb

@@ -0,0 +1,33 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+
+class BasicTest < Test::Unit::TestCase
+
+  def setup
+    @fred   = Parent.create!(:name => "fred")
+  end
+
+  def teardown
+    Parent.delete_all
+  end
+
+  def test_destroy
+    @fred.destroy
+    fred = Parent.where(:name => "fred").first
+    assert_not_nil fred
+    assert_equal fred.deleted, true
+    assert_not_nil fred.deleted_at
+  end
+
+  def test_revive
+    @fred.destroy
+    assert Parent.deleted.include?(@fred)
+    @fred.revive
+    assert !Parent.deleted.include?(@fred)
+  end
+
+  def test_destroy!
+    @fred.destroy!
+    assert_nil Parent.where(:name => "fred").first
+  end
+
+end

data/test/callback_test.rb

@@ -0,0 +1,52 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+
+
+class CallbackTest < Test::Unit::TestCase
+
+  def setup
+    @fred   = CallbackParent.create!(:name => "fred")
+  end
+
+  def teardown
+    CallbackChild.delete_all
+    SoftCallbackChild.delete_all
+    CallbackParent.delete_all
+  end
+
+  def test_callback_before_soft_destroy_for_soft_children
+    @fred.soft_callback_children << pebbles = SoftCallbackChild.new(:name => "pebbles")
+    assert_raise PreventSoftDestroyError do
+      @fred.destroy
+    end
+    assert_equal @fred.reload.deleted?, false
+    assert_equal pebbles.reload.deleted?, false
+  end
+
+  def test_callback_before_destroy_bang_for_soft_children
+    @fred.soft_callback_children << pebbles = SoftCallbackChild.new(:name => "pebbles")
+    assert_raise PreventDestroyBangError do
+      @fred.destroy!
+    end
+    assert_equal @fred.reload.deleted?, false
+    assert_equal pebbles.reload.deleted?, false
+  end
+
+  def test_callback_before_soft_destroy
+    @fred.callback_children << pebbles = CallbackChild.new(:name => "pebbles")
+    assert_raise PreventSoftDestroyError do
+      @fred.destroy
+    end
+    assert_equal @fred.reload.deleted?, false
+    assert_not_nil pebbles.reload
+  end
+
+  def test_callback_before_destroy!
+    @fred.callback_children << pebbles = CallbackChild.new(:name => "pebbles")
+    assert_raise PreventDestroyBangError do
+      @fred.destroy!
+    end
+    assert_equal @fred.reload.deleted?, false
+    assert_not_nil pebbles.reload
+  end
+
+end