mtoros-acts_as_paranoid 0.0.1

data/CHANGELOG

@@ -0,0 +1,74 @@
+* (4 Oct 2007)
+
+Update for Edge rails: remove support for legacy #count args 
+
+* (2 Feb 2007)
+
+Add support for custom primary keys [Jeff Dean]
+
+* (2 July 2006)
+
+Add paranoid delete_all implementation [Marshall Roch]
+
+* (23 May 2006)
+
+Allow setting of future dates for content expiration.
+
+* (15 May 2006)
+
+Added support for dynamic finders
+
+* (28 Mar 2006)
+
+Updated for Rails 1.1.  I love removing code.
+
+  Refactored #find method
+  Nested Scopes
+
+*0.3.1* (20 Dec 2005)
+
+* took out deleted association code for 'chainsaw butchery of base classes' [sorry Erik Terpstra]
+* verified tests pass on Rails 1.0
+
+*0.3* (27 Nov 2005)
+
+* Deleted models will find deleted associations by default now [Erik Terpstra]
+* Added :group as valid option for find [Michael Dabney]
+* Changed the module namespace to Caboose::Acts::Paranoid
+
+*0.2.0* (6 Nov 2005)
+
+* Upgrade to Rails 1.0 RC4.  ActiveRecord::Base#constrain has been replaced with scope_with.
+
+*0.1.7* (22 Oct 2005)
+
+* Added :with_deleted as a valid option of ActiveRecord::Base#find
+
+*0.1.6* (25 Sep 2005)
+
+* Fixed bug where nested constrains would get clobbered after multiple queries
+
+*0.1.5* (22 Sep 2005)
+
+* Fixed bug where acts_as_paranoid would clobber other constrains
+* Simplified acts_as_paranoid mixin including.
+
+*0.1.4* (18 Sep 2005)
+
+* First RubyForge release
+
+*0.1.3* (18 Sep 2005)
+
+* ignore multiple calls to acts_as_paranoid on the same model
+
+*0.1.2* (18 Sep 2005)
+
+* fixed a bug that kept you from selecting the first deleted record
+
+*0.1.1* (18 Sep 2005)
+
+* Fixed bug that kept you from selecting deleted records by ID
+
+*0.1* (17 Sep 2005)
+
+* Initial gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Rick Olson
+
+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/Manifest

@@ -0,0 +1,20 @@
+Manifest
+README.rdoc
+MIT-LICENSE
+CHANGELOG
+RUNNING_UNIT_TESTS
+init.rb
+Rakefile
+lib/caboose/acts/belongs_to_with_deleted_association.rb
+lib/caboose/acts/has_many_through_without_deleted_association.rb
+lib/caboose/acts/paranoid.rb
+lib/caboose/acts/paranoid_find_wrapper.rb
+test/fixtures/categories.yml
+test/fixtures/categories_widgets.yml
+test/fixtures/taggings.yml
+test/fixtures/tags.yml
+test/fixtures/widgets.yml
+test/database.yml
+test/paranoid_test.rb
+test/schema.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1 @@
+empty

data/RUNNING_UNIT_TESTS

@@ -0,0 +1,41 @@
+== Creating the test database
+
+The default name for the test databases is "activerecord_paranoid". If you 
+want to use another database name then be sure to update the connection 
+adapter setups you want to test with in test/connections/<your database>/connection.rb. 
+When you have the database online, you can import the fixture tables with 
+the test/fixtures/db_definitions/*.sql files.
+
+Make sure that you create database objects with the same user that you specified in i
+connection.rb otherwise (on Postgres, at least) tests for default values will fail.
+
+== Running with Rake
+
+The easiest way to run the unit tests is through Rake. The default task runs
+the entire test suite for all the adapters. You can also run the suite on just
+one adapter by using the tasks test_mysql_ruby, test_ruby_mysql, test_sqlite, 
+or test_postresql. For more information, checkout the full array of rake tasks with "rake -T"
+
+Rake can be found at http://rake.rubyforge.org
+
+== Running by hand
+
+Unit tests are located in test directory. If you only want to run a single test suite, 
+or don't want to bother with Rake, you can do so with something like:
+
+   cd test; ruby -I "connections/native_mysql" base_test.rb
+   
+That'll run the base suite using the MySQL-Ruby adapter. Change the adapter
+and test suite name as needed.
+
+== Faster tests
+
+If you are using a database that supports transactions, you can set the
+"AR_TX_FIXTURES" environment variable to "yes" to use transactional fixtures.
+This gives a very large speed boost. With rake:
+
+  rake AR_TX_FIXTURES=yes
+
+Or, by hand:
+
+  AR_TX_FIXTURES=yes ruby -I connections/native_sqlite3 base_test.rb

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+ 
+begin
+  require 'echoe'
+
+  Echoe.new('acts_as_paranoid', '0.0.1') do |p|
+    p.summary        = "Fork of acts_as_paranoid"
+    p.description    = "check acts_as_paranoid"
+    p.author         = ['Marko Toros']
+    p.email          = "mtoros@gmail.com"
+    p.url            = ""
+  end
+rescue LoadError => boom8
+  puts "You are missing a dependency required for meta-operations on this gem."
+  puts "#{boom.to_s.capitalize}."
+end

data/acts_as_paranoid.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_paranoid}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marko Toros"]
+  s.date = %q{2009-01-20}
+  s.description = %q{check acts_as_paranoid}
+  s.email = %q{mtoros@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "lib/caboose/acts/belongs_to_with_deleted_association.rb", "lib/caboose/acts/has_many_through_without_deleted_association.rb", "lib/caboose/acts/paranoid.rb", "lib/caboose/acts/paranoid_find_wrapper.rb"]
+  s.files = ["Manifest", "README.rdoc", "MIT-LICENSE", "CHANGELOG", "RUNNING_UNIT_TESTS", "init.rb", "Rakefile", "lib/caboose/acts/belongs_to_with_deleted_association.rb", "lib/caboose/acts/has_many_through_without_deleted_association.rb", "lib/caboose/acts/paranoid.rb", "lib/caboose/acts/paranoid_find_wrapper.rb", "test/fixtures/categories.yml", "test/fixtures/categories_widgets.yml", "test/fixtures/taggings.yml", "test/fixtures/tags.yml", "test/fixtures/widgets.yml", "test/database.yml", "test/paranoid_test.rb", "test/schema.rb", "test/test_helper.rb", "acts_as_paranoid.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_paranoid", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_paranoid}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Fork of acts_as_paranoid}
+  s.test_files = ["test/test_helper.rb", "test/paranoid_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1,34 @@
+class << ActiveRecord::Base
+  def belongs_to_with_deleted(association_id, options = {})
+    with_deleted = options.delete :with_deleted
+    returning belongs_to_without_deleted(association_id, options) do
+      if with_deleted
+        reflection = reflect_on_association(association_id)
+        association_accessor_methods(reflection,            Caboose::Acts::BelongsToWithDeletedAssociation)
+        association_constructor_method(:build,  reflection, Caboose::Acts::BelongsToWithDeletedAssociation)
+        association_constructor_method(:create, reflection, Caboose::Acts::BelongsToWithDeletedAssociation)
+      end
+    end
+  end
+  
+  def has_many_without_deleted(association_id, options = {}, &extension)
+    with_deleted = options.delete :with_deleted
+    returning has_many_with_deleted(association_id, options, &extension) do
+      if options[:through] && !with_deleted
+        reflection = reflect_on_association(association_id)
+        collection_reader_method(reflection, Caboose::Acts::HasManyThroughWithoutDeletedAssociation)
+        collection_accessor_methods(reflection, Caboose::Acts::HasManyThroughWithoutDeletedAssociation, false)
+      end
+    end
+  end
+  
+  alias_method_chain :belongs_to, :deleted
+  alias_method :has_many_with_deleted, :has_many
+  alias_method :has_many, :has_many_without_deleted
+  alias_method :exists_with_deleted?, :exists?
+end
+ActiveRecord::Base.send :include, Caboose::Acts::Paranoid
+ActiveRecord::Base.send :include, Caboose::Acts::ParanoidFindWrapper
+class << ActiveRecord::Base
+  alias_method_chain :acts_as_paranoid, :find_wrapper
+end

data/lib/caboose/acts/belongs_to_with_deleted_association.rb

@@ -0,0 +1,14 @@
+module Caboose # :nodoc:
+  module Acts # :nodoc:
+    class BelongsToWithDeletedAssociation < ActiveRecord::Associations::BelongsToAssociation
+      private
+        def find_target
+          @reflection.klass.find_with_deleted(
+            @owner[@reflection.primary_key_name], 
+            :conditions => conditions,
+            :include    => @reflection.options[:include]
+          )
+        end
+    end
+  end
+end

data/lib/caboose/acts/has_many_through_without_deleted_association.rb

@@ -0,0 +1,27 @@
+module Caboose # :nodoc:
+  module Acts # :nodoc:
+    class HasManyThroughWithoutDeletedAssociation < ActiveRecord::Associations::HasManyThroughAssociation
+      protected
+        def current_time
+          ActiveRecord::Base.default_timezone == :utc ? Time.now.utc : Time.now
+        end
+
+        def construct_conditions
+          return super unless @reflection.through_reflection.klass.paranoid?
+          table_name = @reflection.through_reflection.table_name
+          conditions = construct_quoted_owner_attributes(@reflection.through_reflection).map do |attr, value|
+            "#{table_name}.#{attr} = #{value}"
+          end
+
+          deleted_attribute = @reflection.through_reflection.klass.deleted_attribute
+          quoted_current_time = @reflection.through_reflection.klass.quote_value(
+            current_time,
+            @reflection.through_reflection.klass.columns_hash[deleted_attribute.to_s])
+          conditions << "#{table_name}.#{deleted_attribute} IS NULL OR #{table_name}.#{deleted_attribute} > #{quoted_current_time}"
+
+          conditions << sql_conditions if sql_conditions
+          "(" + conditions.join(') AND (') + ")"
+        end
+    end
+  end
+end

data/lib/caboose/acts/paranoid.rb

@@ -0,0 +1,196 @@
+module Caboose #:nodoc:
+  module Acts #:nodoc:
+    # Overrides some basic methods for the current model so that calling #destroy sets a 'deleted_at' field to the current timestamp.
+    # This assumes the table has a deleted_at date/time field.  Most normal model operations will work, but there will be some oddities.
+    #
+    #   class Widget < ActiveRecord::Base
+    #     acts_as_paranoid
+    #   end
+    #
+    #   Widget.find(:all)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NULL
+    #
+    #   Widget.find(:first, :conditions => ['title = ?', 'test'], :order => 'title')
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NULL AND title = 'test' ORDER BY title LIMIT 1
+    #
+    #   Widget.find_with_deleted(:all)
+    #   # SELECT * FROM widgets
+    #
+    #   Widget.find_only_deleted(:all)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NOT NULL
+    #
+    #   Widget.find_with_deleted(1).deleted?
+    #   # Returns true if the record was previously destroyed, false if not 
+    #
+    #   Widget.count
+    #   # SELECT COUNT(*) FROM widgets WHERE widgets.deleted_at IS NULL
+    #
+    #   Widget.count ['title = ?', 'test']
+    #   # SELECT COUNT(*) FROM widgets WHERE widgets.deleted_at IS NULL AND title = 'test'
+    #
+    #   Widget.count_with_deleted
+    #   # SELECT COUNT(*) FROM widgets
+    #
+    #   Widget.count_only_deleted
+    #   # SELECT COUNT(*) FROM widgets WHERE widgets.deleted_at IS NOT NULL
+    #
+    #   Widget.delete_all
+    #   # UPDATE widgets SET deleted_at = '2005-09-17 17:46:36'
+    #
+    #   Widget.delete_all!
+    #   # DELETE FROM widgets
+    #
+    #   @widget.destroy
+    #   # UPDATE widgets SET deleted_at = '2005-09-17 17:46:36' WHERE id = 1
+    #
+    #   @widget.destroy!
+    #   # DELETE FROM widgets WHERE id = 1
+    # 
+    module Paranoid
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_paranoid(options = {})
+          unless paranoid? # don't let AR call this twice
+            cattr_accessor :deleted_attribute
+            self.deleted_attribute = options[:with] || :deleted_at
+            alias_method :destroy_without_callbacks!, :destroy_without_callbacks
+            class << self
+              alias_method :find_every_with_deleted,    :find_every
+              alias_method :calculate_with_deleted,     :calculate
+              alias_method :delete_all!,                :delete_all
+            end
+          end
+          include InstanceMethods
+        end
+
+        def paranoid?
+          self.included_modules.include?(InstanceMethods)
+        end
+      end
+
+      module InstanceMethods #:nodoc:
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def find_with_deleted(*args)
+            options = args.extract_options!
+            validate_find_options(options)
+            set_readonly_option!(options)
+            options[:with_deleted] = true # yuck!
+
+            case args.first
+              when :first then find_initial(options)
+              when :all   then find_every(options)
+              else             find_from_ids(args, options)
+            end
+          end
+
+          def find_only_deleted(*args)
+            options = args.extract_options!
+            validate_find_options(options)
+            set_readonly_option!(options)
+            options[:only_deleted] = true # yuck!
+
+            case args.first
+              when :first then find_initial(options)
+              when :all   then find_every(options)
+              else             find_from_ids(args, options)
+            end
+          end
+
+          def exists?(*args)
+            with_deleted_scope { exists_with_deleted?(*args) }
+          end
+
+          def exists_only_deleted?(*args)
+            with_only_deleted_scope { exists_with_deleted?(*args) }
+          end
+
+          def count_with_deleted(*args)
+            calculate_with_deleted(:count, *construct_count_options_from_args(*args))
+          end
+
+          def count_only_deleted(*args)
+            with_only_deleted_scope { count_with_deleted(*args) }
+          end
+
+          def count(*args)
+            with_deleted_scope { count_with_deleted(*args) }
+          end
+
+          def calculate(*args)
+            with_deleted_scope { calculate_with_deleted(*args) }
+          end
+
+          def delete_all(conditions = nil)
+            self.update_all ["#{self.deleted_attribute} = ?", current_time], conditions
+          end
+
+          protected
+            def current_time
+              default_timezone == :utc ? Time.now.utc : Time.now
+            end
+
+            def with_deleted_scope(&block)
+              with_scope({:find => { :conditions => ["#{table_name}.#{deleted_attribute} IS NULL OR #{table_name}.#{deleted_attribute} > ?", current_time] } }, :merge, &block)
+            end
+
+            def with_only_deleted_scope(&block)
+              with_scope({:find => { :conditions => ["#{table_name}.#{deleted_attribute} IS NOT NULL AND #{table_name}.#{deleted_attribute} <= ?", current_time] } }, :merge, &block)
+            end
+
+          private
+            # all find calls lead here
+            def find_every(options)
+              options.delete(:with_deleted) ? 
+                find_every_with_deleted(options) :
+                options.delete(:only_deleted) ? 
+                  with_only_deleted_scope { find_every_with_deleted(options) } :
+                  with_deleted_scope { find_every_with_deleted(options) }
+            end
+        end
+
+        def destroy_without_callbacks
+          unless new_record?
+            self.class.update_all self.class.send(:sanitize_sql, ["#{self.class.deleted_attribute} = ?", (self.deleted_at = self.class.send(:current_time))]), ["#{self.class.primary_key} = ?", id]
+          end
+          freeze
+        end
+
+        def destroy_with_callbacks!
+          return false if callback(:before_destroy) == false
+          result = destroy_without_callbacks!
+          callback(:after_destroy)
+          result
+        end
+
+        def destroy!
+          transaction { destroy_with_callbacks! }
+        end
+
+        def deleted?
+          !!read_attribute(:deleted_at)
+        end
+
+        def recover!
+          self.deleted_at = nil
+          save!
+        end
+        
+        def recover_with_associations!(*associations)
+          self.recover!
+          associations.to_a.each do |assoc|
+            self.send(assoc).find_with_deleted(:all).each do |a|
+              a.recover! if a.class.paranoid?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caboose/acts/paranoid_find_wrapper.rb

@@ -0,0 +1,94 @@
+module Caboose #:nodoc:
+  module Acts #:nodoc:
+    # Adds a wrapper find method which can identify :with_deleted or :only_deleted options
+    # and would call the corresponding acts_as_paranoid finders find_with_deleted or
+    # find_only_deleted methods.
+    #
+    # With this wrapper you can easily change from using this pattern:
+    #
+    #   if some_condition_enabling_access_to_deleted_records?
+    #     @post = Post.find_with_deleted(params[:id])
+    #   else
+    #     @post = Post.find(params[:id])
+    #   end
+    #
+    # to this:
+    #
+    #   @post = Post.find(params[:id], :with_deleted => some_condition_enabling_access_to_deleted_records?)
+    #
+    # Examples
+    #
+    #   class Widget < ActiveRecord::Base
+    #     acts_as_paranoid
+    #   end
+    #
+    #   Widget.find(:all)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NULL
+    #
+    #   Widget.find(:all, :with_deleted => false)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NULL
+    #
+    #   Widget.find_with_deleted(:all)
+    #   # SELECT * FROM widgets
+    #
+    #   Widget.find(:all, :with_deleted => true)
+    #   # SELECT * FROM widgets
+    #
+    #   Widget.find_only_deleted(:all)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NOT NULL
+    #
+    #   Widget.find(:all, :only_deleted => true)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NOT NULL
+    #
+    #   Widget.find(:all, :only_deleted => false)
+    #   # SELECT * FROM widgets WHERE widgets.deleted_at IS NULL
+    #
+    module ParanoidFindWrapper
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_paranoid_with_find_wrapper(options = {})
+          unless paranoid? # don't let AR call this twice
+            acts_as_paranoid_without_find_wrapper(options)
+            class << self
+              alias_method :find_without_find_wrapper, :find
+              alias_method :validate_find_options_without_find_wrapper, :validate_find_options
+            end
+          end
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods #:nodoc:
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          # This is a wrapper for the regular "find" so you can pass acts_as_paranoid related
+          # options and determine which finder to call.
+          def find(*args)
+            options = args.extract_options!
+            # Determine who to call.
+            finder_option = VALID_PARANOID_FIND_OPTIONS.detect { |key| options.delete(key) } || :without_find_wrapper
+            finder_method = "find_#{finder_option}".to_sym
+            # Put back the options in the args now that they don't include the extended keys.
+            args << options
+            send(finder_method, *args)
+          end
+
+          protected
+
+            VALID_PARANOID_FIND_OPTIONS = [:with_deleted, :only_deleted]
+
+            def validate_find_options(options) #:nodoc:
+              cleaned_options = options.reject { |k, v| VALID_PARANOID_FIND_OPTIONS.include?(k) }
+              validate_find_options_without_find_wrapper(cleaned_options)
+            end
+        end
+      end
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: acts_as_paranoid_plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: acts_as_paranoid_plugin.sqlite3.db
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: acts_as_paranoid_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: acts_as_paranoid_plugin_test

data/test/fixtures/categories.yml

@@ -0,0 +1,19 @@
+category_1:
+  id: 1
+  widget_id: 1
+  title: 'category 1'
+category_2:
+  id: 2
+  widget_id: 1
+  title: 'category 2'
+  deleted_at: '2005-01-01 00:00:00'
+category_3:
+  id: 3
+  widget_id: 2
+  title: 'category 3'
+  deleted_at: '2005-01-01 00:00:00'
+category_4:
+  id: 4
+  widget_id: 2
+  title: 'category 4'
+  deleted_at: '2005-01-01 00:00:00'

data/test/fixtures/categories_widgets.yml

@@ -0,0 +1,12 @@
+cw_1:
+  category_id: 1
+  widget_id: 1
+cw_2:
+  category_id: 2
+  widget_id: 1
+cw_3:
+  category_id: 3
+  widget_id: 2
+cw_4:
+  category_id: 4
+  widget_id: 2

data/test/fixtures/taggings.yml

@@ -0,0 +1,9 @@
+tagging_1:
+  id: 1
+  tag_id: 1
+  widget_id: 1
+  deleted_at: '2005-01-01 00:00:00'
+tagging_2:
+  id: 2
+  tag_id: 2
+  widget_id: 1

data/test/fixtures/tags.yml

@@ -0,0 +1,6 @@
+tag_1:
+  id: 1
+  name: 'tag 1'
+tag_2:
+  id: 2
+  name: 'tag 1'

data/test/fixtures/widgets.yml

@@ -0,0 +1,8 @@
+widget_1:
+  id: 1
+  title: 'widget 1'
+widget_2:
+  id: 2
+  title: 'deleted widget 2'
+  deleted_at: '2005-01-01 00:00:00'
+  category_id: 3

data/test/paranoid_test.rb

@@ -0,0 +1,287 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Widget < ActiveRecord::Base
+  acts_as_paranoid
+  has_many :categories, :dependent => :destroy
+  has_and_belongs_to_many :habtm_categories, :class_name => 'Category'
+  has_one :category
+  belongs_to :parent_category, :class_name => 'Category'
+  has_many :taggings
+  has_many :tags, :through => :taggings
+  has_many :any_tags, :through => :taggings, :class_name => 'Tag', :source => :tag, :with_deleted => true
+end
+
+class Category < ActiveRecord::Base
+  belongs_to :widget
+  belongs_to :any_widget, :class_name => 'Widget', :foreign_key => 'widget_id', :with_deleted => true
+  acts_as_paranoid
+
+  def self.search(name, options = {})
+    find :all, options.merge(:conditions => ['LOWER(title) LIKE ?', "%#{name.to_s.downcase}%"])
+  end
+
+  def self.search_with_deleted(name, options = {})
+    find_with_deleted :all, options.merge(:conditions => ['LOWER(title) LIKE ?', "%#{name.to_s.downcase}%"])
+  end
+end
+
+class Tag < ActiveRecord::Base
+  has_many :taggings
+  has_many :widgets, :through => :taggings
+end
+
+class Tagging < ActiveRecord::Base
+  belongs_to :tag
+  belongs_to :widget
+  acts_as_paranoid
+end
+
+class NonParanoidAndroid < ActiveRecord::Base
+end
+
+class ParanoidTest < Test::Unit::TestCase
+  fixtures :widgets, :categories, :categories_widgets, :tags, :taggings
+  
+  def test_should_recognize_with_deleted_option
+    assert_equal [1, 2], Widget.find(:all, :with_deleted => true).collect { |w| w.id }
+    assert_equal [1], Widget.find(:all, :with_deleted => false).collect { |w| w.id }
+  end
+  
+  def test_should_recognize_only_deleted_option
+    assert_equal [2], Widget.find(:all, :only_deleted => true).collect { |w| w.id }
+    assert_equal [1], Widget.find(:all, :only_deleted => false).collect { |w| w.id }
+  end
+  
+  def test_should_exists_with_deleted
+    assert Widget.exists_with_deleted?(2)
+    assert !Widget.exists?(2)
+  end
+
+  def test_should_exists_only_deleted
+    assert Widget.exists_only_deleted?(2)
+    assert !Widget.exists_only_deleted?(1)
+  end
+
+  def test_should_count_with_deleted
+    assert_equal 1, Widget.count
+    assert_equal 2, Widget.count_with_deleted
+    assert_equal 1, Widget.count_only_deleted
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+  end
+
+  def test_should_set_deleted_at
+    assert_equal 1, Widget.count
+    assert_equal 1, Category.count
+    widgets(:widget_1).destroy
+    assert_equal 0, Widget.count
+    assert_equal 0, Category.count
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+    assert_equal 4, Category.calculate_with_deleted(:count, :all)
+  end
+  
+  def test_should_destroy
+    assert_equal 1, Widget.count
+    assert_equal 1, Category.count
+    widgets(:widget_1).destroy!
+    assert_equal 0, Widget.count
+    assert_equal 0, Category.count
+    assert_equal 1, Widget.count_only_deleted
+    assert_equal 1, Widget.calculate_with_deleted(:count, :all)
+    # Category doesn't get destroyed because the dependent before_destroy callback uses #destroy
+    assert_equal 4, Category.calculate_with_deleted(:count, :all)
+  end
+  
+  def test_should_delete_all
+    assert_equal 1, Widget.count
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+    assert_equal 1, Category.count
+    Widget.delete_all
+    assert_equal 0, Widget.count
+    # delete_all doesn't call #destroy, so the dependent callback never fires
+    assert_equal 1, Category.count
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+  end
+  
+  def test_should_delete_all_with_conditions
+    assert_equal 1, Widget.count
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+    Widget.delete_all("id < 3")
+    assert_equal 0, Widget.count
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+  end
+  
+  def test_should_delete_all2
+    assert_equal 1, Category.count
+    assert_equal 4, Category.calculate_with_deleted(:count, :all)
+    Category.delete_all!
+    assert_equal 0, Category.count
+    assert_equal 0, Category.calculate_with_deleted(:count, :all)
+  end
+  
+  def test_should_delete_all_with_conditions2
+    assert_equal 1, Category.count
+    assert_equal 4, Category.calculate_with_deleted(:count, :all)
+    Category.delete_all!("id < 3")
+    assert_equal 0, Category.count
+    assert_equal 2, Category.calculate_with_deleted(:count, :all)    
+  end
+  
+  def test_should_not_count_deleted
+    assert_equal 1, Widget.count
+    assert_equal 1, Widget.count(:all, :conditions => ['title=?', 'widget 1'])
+    assert_equal 2, Widget.calculate_with_deleted(:count, :all)
+    assert_equal 1, Widget.count_only_deleted
+  end
+  
+  def test_should_find_only_deleted
+    assert_equal [2], Widget.find_only_deleted(:all).collect { |w| w.id }
+    assert_equal [1, 2], Widget.find_with_deleted(:all, :order => 'id').collect { |w| w.id }
+  end
+  
+  def test_should_not_find_deleted
+    assert_equal [widgets(:widget_1)], Widget.find(:all)
+    assert_equal [1, 2], Widget.find_with_deleted(:all, :order => 'id').collect { |w| w.id }
+  end
+  
+  def test_should_not_find_deleted_has_many_associations
+    assert_equal 1, widgets(:widget_1).categories.size
+    assert_equal [categories(:category_1)], widgets(:widget_1).categories
+  end
+  
+  def test_should_not_find_deleted_habtm_associations
+    assert_equal 1, widgets(:widget_1).habtm_categories.size
+    assert_equal [categories(:category_1)], widgets(:widget_1).habtm_categories
+  end
+  
+  def test_should_not_find_deleted_has_many_through_associations
+    assert_equal 1, widgets(:widget_1).tags.size
+    assert_equal [tags(:tag_2)], widgets(:widget_1).tags
+  end
+  
+  def test_should_find_has_many_through_associations_with_deleted
+    assert_equal 2, widgets(:widget_1).any_tags.size
+    assert_equal Tag.find(:all), widgets(:widget_1).any_tags
+  end
+
+  def test_should_not_find_deleted_belongs_to_associations
+    assert_nil Category.find_with_deleted(3).widget
+  end
+
+  def test_should_find_belongs_to_assocation_with_deleted
+    assert_equal Widget.find_with_deleted(2), Category.find_with_deleted(3).any_widget
+  end
+
+  def test_should_find_first_with_deleted
+    assert_equal widgets(:widget_1), Widget.find(:first)
+    assert_equal 2, Widget.find_with_deleted(:first, :order => 'id desc').id
+  end
+  
+  def test_should_find_single_id
+    assert Widget.find(1)
+    assert Widget.find_with_deleted(2)
+    assert_raises(ActiveRecord::RecordNotFound) { Widget.find(2) }
+  end
+  
+  def test_should_find_multiple_ids
+    assert_equal [1,2], Widget.find_with_deleted(1,2).sort_by { |w| w.id }.collect { |w| w.id }
+    assert_equal [1,2], Widget.find_with_deleted([1,2]).sort_by { |w| w.id }.collect { |w| w.id }
+    assert_raises(ActiveRecord::RecordNotFound) { Widget.find(1,2) }
+  end
+  
+  def test_should_ignore_multiple_includes
+    Widget.class_eval { acts_as_paranoid }
+    assert Widget.find(1)
+  end
+
+  def test_should_not_override_scopes_when_counting
+    assert_equal 1, Widget.send(:with_scope, :find => { :conditions => "title = 'widget 1'" }) { Widget.count }
+    assert_equal 0, Widget.send(:with_scope, :find => { :conditions => "title = 'deleted widget 2'" }) { Widget.count }
+    assert_equal 1, Widget.send(:with_scope, :find => { :conditions => "title = 'deleted widget 2'" }) { Widget.calculate_with_deleted(:count, :all) }
+  end
+
+  def test_should_not_override_scopes_when_finding
+    assert_equal [1], Widget.send(:with_scope, :find => { :conditions => "title = 'widget 1'" }) { Widget.find(:all) }.ids
+    assert_equal [],  Widget.send(:with_scope, :find => { :conditions => "title = 'deleted widget 2'" }) { Widget.find(:all) }.ids
+    assert_equal [2], Widget.send(:with_scope, :find => { :conditions => "title = 'deleted widget 2'" }) { Widget.find_with_deleted(:all) }.ids
+  end
+
+  def test_should_allow_multiple_scoped_calls_when_finding
+    Widget.send(:with_scope, :find => { :conditions => "title = 'deleted widget 2'" }) do
+      assert_equal [2], Widget.find_with_deleted(:all).ids
+      assert_equal [2], Widget.find_with_deleted(:all).ids, "clobbers the constrain on the unmodified find"
+      assert_equal [], Widget.find(:all).ids
+      assert_equal [], Widget.find(:all).ids, 'clobbers the constrain on a paranoid find'
+    end
+  end
+
+  def test_should_allow_multiple_scoped_calls_when_counting
+    Widget.send(:with_scope, :find => { :conditions => "title = 'deleted widget 2'" }) do
+      assert_equal 1, Widget.calculate_with_deleted(:count, :all)
+      assert_equal 1, Widget.calculate_with_deleted(:count, :all), "clobbers the constrain on the unmodified find"
+      assert_equal 0, Widget.count
+      assert_equal 0, Widget.count, 'clobbers the constrain on a paranoid find'
+    end
+  end
+
+  def test_should_give_paranoid_status
+    assert Widget.paranoid?
+    assert !NonParanoidAndroid.paranoid?
+  end
+
+  def test_should_give_record_status
+    assert_equal false, Widget.find(1).deleted? 
+    Widget.find(1).destroy
+    assert Widget.find_with_deleted(1).deleted?
+  end
+
+  def test_should_find_deleted_has_many_assocations_on_deleted_records_by_default
+    w = Widget.find_with_deleted 2
+    assert_equal 2, w.categories.find_with_deleted(:all).length
+    assert_equal 2, w.categories.find_with_deleted(:all).size
+  end
+  
+  def test_should_find_deleted_habtm_assocations_on_deleted_records_by_default
+    w = Widget.find_with_deleted 2
+    assert_equal 2, w.habtm_categories.find_with_deleted(:all).length
+    assert_equal 2, w.habtm_categories.find_with_deleted(:all).size
+  end
+
+  def test_dynamic_finders
+    assert     Widget.find_by_id(1)
+    assert_nil Widget.find_by_id(2)
+  end
+
+  def test_custom_finder_methods
+    w = Widget.find_with_deleted(:all).inject({}) { |all, w| all.merge(w.id => w) }
+    assert_equal [1],       Category.search('c').ids
+    assert_equal [1,2,3,4], Category.search_with_deleted('c', :order => 'id').ids
+    assert_equal [1],       widgets(:widget_1).categories.search('c').collect(&:id)
+    assert_equal [1,2],     widgets(:widget_1).categories.search_with_deleted('c').ids
+    assert_equal [],        w[2].categories.search('c').ids
+    assert_equal [3,4],     w[2].categories.search_with_deleted('c').ids
+  end
+  
+  def test_should_recover_record
+    Widget.find(1).destroy
+    assert_equal true, Widget.find_with_deleted(1).deleted? 
+    
+    Widget.find_with_deleted(1).recover!
+    assert_equal false, Widget.find(1).deleted?
+  end
+  
+  def test_should_recover_record_and_has_many_associations
+    Widget.find(1).destroy
+    assert_equal true, Widget.find_with_deleted(1).deleted?
+    assert_equal true, Category.find_with_deleted(1).deleted?
+    
+    Widget.find_with_deleted(1).recover_with_associations!(:categories)
+    assert_equal false, Widget.find(1).deleted?
+    assert_equal false, Category.find(1).deleted?
+  end
+end
+
+class Array
+  def ids
+    collect &:id
+  end
+end

data/test/schema.rb

@@ -0,0 +1,30 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :widgets, :force => true do |t|
+    t.column :title, :string, :limit => 50
+    t.column :category_id, :integer
+    t.column :deleted_at, :timestamp
+  end
+
+  create_table :categories, :force => true do |t|
+    t.column :widget_id, :integer
+    t.column :title, :string, :limit => 50
+    t.column :deleted_at, :timestamp
+  end
+
+  create_table :categories_widgets, :force => true, :id => false do |t|
+    t.column :category_id, :integer
+    t.column :widget_id, :integer
+  end
+  
+  create_table :tags, :force => true do |t|
+    t.column :name, :string, :limit => 50
+  end
+  
+  create_table :taggings, :force => true do |t|
+    t.column :tag_id, :integer
+    t.column :widget_id, :integer
+    t.column :deleted_at, :timestamp
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
+require 'rubygems'
+require 'active_record/fixtures'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+
+  # Turn off transactional fixtures if you're working with MyISAM tables in MySQL
+  self.use_transactional_fixtures = true
+  
+  # Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david)
+  self.use_instantiated_fixtures  = false
+
+  # Add more helper methods to be used by all tests here...
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: mtoros-acts_as_paranoid
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marko Toros
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: check acts_as_paranoid
+email: mtoros@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG
+- lib/caboose/acts/belongs_to_with_deleted_association.rb
+- lib/caboose/acts/has_many_through_without_deleted_association.rb
+- lib/caboose/acts/paranoid.rb
+- lib/caboose/acts/paranoid_find_wrapper.rb
+files: 
+- Manifest
+- README.rdoc
+- MIT-LICENSE
+- CHANGELOG
+- RUNNING_UNIT_TESTS
+- init.rb
+- Rakefile
+- lib/caboose/acts/belongs_to_with_deleted_association.rb
+- lib/caboose/acts/has_many_through_without_deleted_association.rb
+- lib/caboose/acts/paranoid.rb
+- lib/caboose/acts/paranoid_find_wrapper.rb
+- test/fixtures/categories.yml
+- test/fixtures/categories_widgets.yml
+- test/fixtures/taggings.yml
+- test/fixtures/tags.yml
+- test/fixtures/widgets.yml
+- test/database.yml
+- test/paranoid_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- acts_as_paranoid.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Acts_as_paranoid
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: acts_as_paranoid
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Fork of acts_as_paranoid
+test_files: 
+- test/test_helper.rb
+- test/paranoid_test.rb