delete_paranoid 0.0.3 → 1.0.0

data/README.rdoc

@@ -6,11 +6,25 @@ Soft Delete ActiveRecord instances.
   class Blog < ActiveRecord::Base
     acts_as_paranoid
   end
+  blog = Blog.create! :name => 'foo'
 
-  blog = Blog.create :name => 'foo'
-  blog.destroy #soft delete the record
+  # soft delete the instance
+  blog.destroy
+
+  # query database for results *including* soft deleted objects
+  Blog.with_deleted do
+    Blog.all
+  end
+
+  # permenantly delete the instance from the database
+  Blog.delete! blog.id
 
 == Features
+* simple configuration
+* preserves existing ActiveRecord API.  No magical new API's to use when you want to soft delete a record
+* automatically exclude soft deleted records from database queries (by default)
+* support for querying database for all records (including soft deleted ones)
+* support for permenantly deleting record from database
 
 == Contributing
 

data/delete_paranoid.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<bundler>, [">= 0"])
   s.add_development_dependency(%q<sqlite3-ruby>, ["~> 1.3.2"])
   s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+  s.add_development_dependency(%q<timecop>, [">= 0"])
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/delete_paranoid.rb

@@ -1,53 +1,42 @@
+require 'active_support/all'
 require 'active_record'
 
+module ActiveRecord
+  class Relation
+    alias_method :delete_all!, :delete_all
+    def delete_all(conditions = nil)
+      delete_all!(conditions) unless @klass.paranoid?
+      update_all({:deleted_at => Time.now.utc}, conditions)
+    end
+  end
+end
+
 module DeleteParanoid
   module ActiveRecordExtensions
     def acts_as_paranoid
-      class << self
-        alias_method :delete_all!, :delete_all
-      end
-      alias_method :destroy!, :destroy
       default_scope where(:deleted_at => nil)
+
       extend DeleteParanoid::ClassMethods
-      include DeleteParanoid::InstanceMethods  
+    end
+
+    def paranoid?
+      false
     end
   end
-  
+
   module ClassMethods
+    # permenantly delete the record from the database
+    def delete!(id_or_array)
+      where(self.primary_key => id_or_array).delete_all!
+    end
+    # allow for queries within block to find soft deleted records
     def with_deleted
       self.unscoped do
         yield
       end
     end
-    
-    def delete_all(conditions = nil)
-      update_all ["deleted_at = ?", Time.now.utc], conditions
-    end
-
-    def destroy_all!(conditions = nil)
-      if conditions
-        where(conditions).destroy_all!
-      else
-        to_a.each {|object| object.destroy! }.tap { reset }
-      end
-    end
-  end
-  
-  module InstanceMethods
-    def destroy
-      if persisted?
-        with_transaction_returning_status do
-          _run_destroy_callbacks do
-            self.deleted_at = Time.now.utc
-            self.class.delete_all :id => self.id
-            @destroyed = true
-          end
-        end
-      else
-        @destroyed = true
-      end
-      
-      freeze
+    def paranoid?
+      true
     end
   end
 end

data/lib/delete_paranoid/version.rb

@@ -1,3 +1,3 @@
 module DeleteParanoid
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/test/helper.rb

@@ -11,6 +11,7 @@ require 'test/unit'
 require 'shoulda'
 require 'mocha'
 require "ruby-debug"
+require 'timecop'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -20,22 +21,19 @@ require 'database_setup'
 class Test::Unit::TestCase
   
   def self.should_soft_destroy(subject)
-    should "assign deleted_at on #{subject}" do
-      assert_not_nil instance_variable_get(:"@#{subject}").deleted_at
-    end
     should "set #{subject} to destroyed" do
       assert instance_variable_get(:"@#{subject}").destroyed?
     end
     should "freeze #{subject}" do
       assert instance_variable_get(:"@#{subject}").frozen?
     end
-    should "not be found normally" do
+    should "not find #{subject} normally" do
       destroyed_subject = instance_variable_get(:"@#{subject}")
       assert_raises ActiveRecord::RecordNotFound do
         destroyed_subject.class.find destroyed_subject.id
       end
     end
-    should "be found when in with_deleted block" do
+    should "find #{subject} when in with_deleted block" do
       destroyed_subject = instance_variable_get(:"@#{subject}")
       destroyed_subject.class.with_deleted do
         assert_nothing_raised ActiveRecord::RecordNotFound do
@@ -46,13 +44,13 @@ class Test::Unit::TestCase
   end
   
   def self.should_hard_destroy(subject)
-    should "not be retrievable" do
+    should "not find #{subject} normally" do
       destroyed_subject = instance_variable_get(:"@#{subject}")
       assert_raises ActiveRecord::RecordNotFound do
         destroyed_subject.class.find destroyed_subject.id
       end
     end
-    should "not be retrievable in with_deleted block" do
+    should "not find #{subject} in with_deleted block" do
       destroyed_subject = instance_variable_get(:"@#{subject}")
       destroyed_subject.class.with_deleted do
         assert_raises ActiveRecord::RecordNotFound do

data/test/test_delete_paranoid.rb

@@ -11,39 +11,84 @@ class TestDeleteParanoid < Test::Unit::TestCase
   class Comment < ActiveRecord::Base
     acts_as_paranoid
     attr_accessible :text
+    belongs_to :blog
     include CallbackTester
   end
-  
-  context 'with paranoid instance' do
-    setup do
-      @blog = Blog.new
+
+  class User < ActiveRecord::Base
+  end
+  context 'with non-paranoid activerecord class' do
+    should 'not be paranoid' do
+      assert !User.paranoid?
     end
-    should 'have destroy! method' do
-      assert @blog.respond_to? :destroy!
+  end
+  context 'with paranoid activerecord class' do
+    should 'be paranoid' do
+      assert Blog.paranoid?
     end
   end
-  context 'with paranoid class' do
-    should 'have delete_all! method' do
-      assert Blog.respond_to? :delete_all!
+  context 'with instance of paranoid class' do
+    setup do
+      @blog = Blog.create! :title => 'foo'
     end
-
-    context 'when on instance destroyed softly' do
+    context 'when destroying instance' do
       setup do
-        @blog = Blog.create! :title => 'foo'
-        @blog.destroy
+        @now = Time.now.utc
+        Timecop.travel @now do
+          @blog.destroy
+        end
       end
       
       should_soft_destroy :blog
       should_trigger_destroy_callbacks :blog
       should_not_trigger_update_callbacks :blog
+      should 'save deleted_at timestamp on database record' do
+        blog = Blog.find_by_sql(['SELECT deleted_at FROM blogs WHERE id = ?', @blog.id]).first
+        assert_not_nil blog
+        assert_not_nil blog.deleted_at
+        assert_equal @now.to_i, blog.deleted_at.to_i
+      end
     end
-    
-    context 'when an instance with dependents is destroyed softly' do
+    context 'when destroying instance with destroy_all' do
       setup do
-        @comment = Comment.create! :text => 'bar'
-        @blog = Blog.create!(:title => 'foo').tap do |blog|
-          blog.comments << @comment
+        Blog.destroy_all :id => @blog.id
+      end
+      should "not find instance normally" do
+        assert_raises ActiveRecord::RecordNotFound do
+          Blog.find @blog.id
+        end
+      end
+      should "find instance when in with_deleted block" do
+        Blog.with_deleted do
+          assert_nothing_raised ActiveRecord::RecordNotFound do
+            Blog.find @blog.id
+          end
         end
+      end
+    end
+    context "when destroying instance with delete_all!" do
+      setup do
+        @blog = Blog.create! :title => 'foo'
+        Blog.where({:id => @blog.id}).delete_all!
+      end
+      should_hard_destroy :blog
+    end
+    context "when destroying instance with delete!" do
+      setup do
+        @blog = Blog.create! :title => 'foo'
+        Blog.delete! @blog.id
+      end
+      should_hard_destroy :blog
+    end
+  end
+
+  context 'with paranoid instance that has dependents' do
+    setup do
+      @blog = Blog.create!(:title => 'foo')
+      @comment = @blog.comments.create! :text => 'bar'
+    end
+    context 'when destroying paranoid instance' do
+      setup do
         @blog.destroy
       end
 
@@ -53,36 +98,17 @@ class TestDeleteParanoid < Test::Unit::TestCase
       
       should_soft_destroy :comment
       should_trigger_destroy_callbacks :comment
-      # should_not_trigger_update_callbacks :comment
     end
-    
-    context "when on instance destroyed hardly" do
-      setup do
-        @blog = Blog.create! :title => 'foo'
-        @blog.destroy!
-      end
-
-      should_hard_destroy :blog
-      should_trigger_destroy_callbacks :blog
-      should_not_trigger_update_callbacks :blog
-    end
-    
-    context 'when an instance with dependents is destroyed hardly' do
+    context 'when destroying paranoid instance with delete_all!' do
        setup do
-         @comment = Comment.create! :text => 'bar'
-         @blog = Blog.create!(:title => 'foo').tap do |blog|
-           blog.comments << @comment
-         end
-         @blog.destroy!
+         Blog.where({:id => @blog.id}).delete_all!
        end
 
        should_hard_destroy :blog
-       should_trigger_destroy_callbacks :blog
-       should_not_trigger_update_callbacks :blog
-       # should_hard_destroy :comment
-       should_trigger_destroy_callbacks :comment
-       # should_not_trigger_update_callbacks :comment
+       should 'not destroy associated comment' do
+         assert_not_nil @comment.reload
+         assert_nil @comment.blog
+       end
      end
-    
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: delete_paranoid
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-04 00:00:00 -05:00
+date: 2011-04-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: flag database records as deleted and hide them from subsequent queries
 email: 
 - ryan@codecrate.com