acts_as_paranoid 0.1.3

data/CHANGELOG

@@ -0,0 +1,15 @@
+*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/README

@@ -0,0 +1,16 @@
+= acts_as_paranoid
+
+Overrides some basic methods for the current model so that calling #destroy sets a 'deleted_at' field to the 
+current timestamp.  ActiveRecord is required.
+
+== Download
+
+Gem installation:
+
+  gem install acts_as_paranoid --source=http://techno-weenie.net/code
+  
+Get a gzipped tar at http://techno-weenie.net/code/pkg
+
+== Usage
+
+RDocs are online at http://techno-weenie.net/code/doc/acts_as_paranoid/.

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/lib/acts_as_paranoid.rb

@@ -0,0 +1,112 @@
+module ActiveRecord #: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(:all, :with_deleted => true)
+    #   # SELECT * FROM widgets
+    #
+    #   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.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
+          return if self.included_modules.include?(ActiveRecord::Acts::Paranoid::ParanoidMethods) # don't let AR call this twice
+          class_eval do
+            alias_method :destroy_without_callbacks!, :destroy_without_callbacks
+            class << self
+              alias_method :original_find, :find
+              alias_method :count_with_deleted, :count
+            end
+            include ParanoidMethods
+          end
+        end
+      end
+    
+      module ParanoidMethods #:nodoc:
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+      
+        module ClassMethods
+          def find(*args)
+            options = extract_options_from_args!(args)
+            call_original_find = lambda { original_find(*(args << options)) }
+            
+            if !options[:with_deleted]
+              constrain = "#{table_name}.deleted_at IS NULL"
+              constrains = (scope_constrains.nil? or scope_constrains[:conditions].nil? or scope_constrains[:conditions] == constrain) ?
+                constrain :
+                "#{scope_constrains[:conditions]} AND #{constrain}"
+              constrain(:conditions => constrains) { return call_original_find.call }
+            end
+            
+            call_original_find.call
+          end
+
+          def find_with_deleted(*args)
+            original_find(*(args << extract_options_from_args!(args).merge(:with_deleted => true)))
+          end
+
+          def count(conditions = nil, joins = nil)
+            constrain(:conditions => "#{table_name}.deleted_at IS NULL") { count_with_deleted(conditions, joins) }
+          end
+        end
+
+        def destroy_without_callbacks
+          unless new_record?
+            sql = self.class.send(:sanitize_sql,
+              ["UPDATE #{self.class.table_name} SET deleted_at = ? WHERE id = ?", 
+                self.class.default_timezone == :utc ? Time.now.utc : Time.now, id])
+            self.connection.update(sql)
+          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
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Acts::Paranoid
+end

data/test/abstract_unit.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support/binding_of_caller'
+require 'active_support/breakpoint'
+require 'connection'
+require 'acts_as_paranoid'
+
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(File.dirname(__FILE__) + "/fixtures/", table_names) { yield }
+    else
+      Fixtures.create_fixtures(File.dirname(__FILE__) + "/fixtures/", table_names)
+    end
+  end
+end
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+Test::Unit::TestCase.use_instantiated_fixtures = false
+Test::Unit::TestCase.use_transactional_fixtures = (ENV['AR_TX_FIXTURES'] == "yes")
+

data/test/connections/native_db2/connection.rb

@@ -0,0 +1,14 @@
+print "Using native DB2\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'arparanoid'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "db2",
+  :host     => "localhost",
+  :username => "arunit",
+  :password => "arunit",
+  :database => db1
+)

data/test/connections/native_mysql/connection.rb

@@ -0,0 +1,14 @@
+print "Using native MySQL\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'activerecord_paranoid'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql",
+  :host     => "localhost",
+  :username => "rails",
+  :password => "",
+  :database => db1
+)

data/test/connections/native_oci/connection.rb

@@ -0,0 +1,15 @@
+print "Using OCI Oracle\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new STDOUT
+ActiveRecord::Base.logger.level = Logger::WARN
+
+db1 = 'activerecord_paranoid'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'oci',
+  :host     => '',          # can use an oracle SID
+  :username => 'arunit',
+  :password => 'arunit',
+  :database => db1
+)

data/test/connections/native_postgresql/connection.rb

@@ -0,0 +1,14 @@
+print "Using native PostgreSQL\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'activerecord_paranoid'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "postgresql",
+  :host     => nil, 
+  :username => "postgres",
+  :password => "postgres", 
+  :database => db1
+)

data/test/connections/native_sqlite/connection.rb

@@ -0,0 +1,34 @@
+print "Using native SQlite\n"
+require 'logger'
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+class SqliteError < StandardError
+end
+
+BASE_DIR = File.expand_path(File.dirname(__FILE__) + '/../../fixtures')
+sqlite_test_db  = "#{BASE_DIR}/activerecord_paranoid.sqlite"
+
+def make_connection(clazz, db_file, db_definitions_file)
+  unless File.exist?(db_file)
+    puts "SQLite database not found at #{db_file}. Rebuilding it."
+    sqlite_command = %Q{sqlite #{db_file} "create table a (a integer); drop table a;"}
+    puts "Executing '#{sqlite_command}'"
+    raise SqliteError.new("Seems that there is no sqlite executable available") unless system(sqlite_command)
+    clazz.establish_connection(
+        :adapter => "sqlite",
+        :dbfile  => db_file)
+    script = File.read("#{BASE_DIR}/db_definitions/#{db_definitions_file}")
+    # SQLite-Ruby has problems with semi-colon separated commands, so split and execute one at a time
+    script.split(';').each do
+      |command|
+      clazz.connection.execute(command) unless command.strip.empty?
+    end
+  else
+    clazz.establish_connection(
+        :adapter => "sqlite",
+        :dbfile  => db_file)
+  end
+end
+
+make_connection(ActiveRecord::Base, sqlite_test_db, 'sqlite.sql')
+

data/test/connections/native_sqlite3/connection.rb

@@ -0,0 +1,33 @@
+print "Using native SQLite3\n"
+require 'logger'
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+class SqliteError < StandardError
+end
+
+BASE_DIR = File.expand_path(File.dirname(__FILE__) + '/../../fixtures')
+sqlite_test_db  = "#{BASE_DIR}/activerecord_paranoid.sqlite3"
+
+def make_connection(clazz, db_file, db_definitions_file)
+  unless File.exist?(db_file)
+    puts "SQLite3 database not found at #{db_file}. Rebuilding it."
+    sqlite_command = %Q{sqlite3 #{db_file} "create table a (a integer); drop table a;"}
+    puts "Executing '#{sqlite_command}'"
+    raise SqliteError.new("Seems that there is no sqlite3 executable available") unless system(sqlite_command)
+    clazz.establish_connection(
+        :adapter => "sqlite3",
+        :dbfile  => db_file)
+    script = File.read("#{BASE_DIR}/db_definitions/#{db_definitions_file}")
+    # SQLite-Ruby has problems with semi-colon separated commands, so split and execute one at a time
+    script.split(';').each do
+      |command|
+      clazz.connection.execute(command) unless command.strip.empty?
+    end
+  else
+    clazz.establish_connection(
+        :adapter => "sqlite3",
+        :dbfile  => db_file)
+  end
+end
+
+make_connection(ActiveRecord::Base, sqlite_test_db, 'sqlite.sql')

data/test/connections/native_sqlserver/connection.rb

@@ -0,0 +1,14 @@
+print "Using native SQLServer\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'activerecord_paranoid'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlserver",
+  :host     => "localhost",
+  :username => "sa",
+  :password => "",
+  :database => db1
+)

data/test/connections/native_sqlserver_odbc/connection.rb

@@ -0,0 +1,15 @@
+print "Using native SQLServer via ODBC\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+dsn1 = 'activerecord_paranoid'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlserver",
+  :mode     => "ODBC",
+  :host     => "localhost",
+  :username => "sa",
+  :password => "",
+  :dsn => dsn1
+)

data/test/fixtures/categories.yml

@@ -0,0 +1,9 @@
+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'

data/test/fixtures/categories_widgets.yml

@@ -0,0 +1,6 @@
+cw_1:
+  category_id: 1
+  widget_id: 1
+cw_2:
+  category_id: 2
+  widget_id: 1

data/test/fixtures/db_definitions/postgresql.drop.sql

@@ -0,0 +1,3 @@
+drop table categories_widgets;
+drop table categories;
+drop table widgets;

data/test/fixtures/db_definitions/postgresql.sql

@@ -0,0 +1,19 @@
+CREATE TABLE widgets (
+  id         SERIAL,
+  title      VARCHAR(50),
+  deleted_at TIMESTAMP
+);
+SELECT setval('widgets_id_seq', 100);
+
+CREATE TABLE categories (
+  id         SERIAL,
+  widget_id  INT,
+  title      VARCHAR(50),
+  deleted_at TIMESTAMP
+);
+SELECT setval('categories_id_seq', 100);
+
+CREATE TABLE categories_widgets (
+  category_id INT,
+  widget_id   INT
+);

data/test/fixtures/db_definitions/sqlite.drop.sql

@@ -0,0 +1,3 @@
+DROP TABLE 'categories_widgets';
+DROP TABLE 'categories';
+DROP TABLE 'widgets';

data/test/fixtures/db_definitions/sqlite.sql

@@ -0,0 +1,17 @@
+CREATE TABLE 'widgets' (
+  'id'         INTEGER NOT NULL PRIMARY KEY,
+  'title'      VARCHAR(50),
+  'deleted_at' DATETIME
+);
+
+CREATE TABLE 'categories' (
+  'id'         INTEGER NOT NULL PRIMARY KEY,
+  'widget_id'  INTEGER,
+  'title'      VARCHAR(50),
+  'deleted_at' DATETIME
+);
+
+CREATE TABLE 'categories_widgets' (
+  'category_id' INTEGER,
+  'widget_id' INTEGER
+);

data/test/fixtures/widgets.yml

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

data/test/paranoid_test.rb

@@ -0,0 +1,80 @@
+require 'abstract_unit'
+
+class Widget < ActiveRecord::Base
+  has_many :categories, :dependent => true
+  has_and_belongs_to_many :habtm_categories, :class_name => 'Category'
+  acts_as_paranoid
+end
+
+class Category < ActiveRecord::Base
+  belongs_to :widget
+  acts_as_paranoid
+end
+
+class ParanoidTest < Test::Unit::TestCase
+  fixtures :widgets, :categories, :categories_widgets
+
+  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.count_with_deleted
+    assert_equal 2, Category.count_with_deleted
+  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_with_deleted
+    # Category doesn't get destroyed because the dependent before_destroy callback uses #destroy
+    assert_equal 2, Category.count_with_deleted
+  end
+  
+  def test_should_not_count_deleted
+    assert_equal 1, Widget.count
+    assert_equal 1, Widget.count(['title=?', 'widget 1'])
+    assert_equal 2, Widget.count_with_deleted
+  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_associations
+    assert_equal 2, Category.count_with_deleted('widget_id=1')
+    
+    assert_equal 1, widgets(:widget_1).categories.size
+    assert_equal [categories(:category_1)], widgets(:widget_1).categories
+    
+    assert_equal 1, widgets(:widget_1).habtm_categories.size
+    assert_equal [categories(:category_1)], widgets(:widget_1).habtm_categories
+  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
+end

data/test/tests.rb

@@ -0,0 +1,2 @@
+$:.unshift "../lib"
+Dir["**/*_test.rb"].each { |f| load f }

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: acts_as_paranoid
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+date: 2005-09-18
+summary: acts_as_paranoid keeps models from actually being deleted by setting a deleted_at field.
+require_paths: 
+  - lib
+email: technoweenie@gmail.com
+homepage: http://techno-weenie.net
+rubyforge_project: 
+description: 
+autorequire: acts_as_paranoid
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Rick Olson
+files: 
+  - lib/acts_as_paranoid.rb
+  - test/abstract_unit.rb
+  - test/connections
+  - test/fixtures
+  - test/paranoid_test.rb
+  - test/tests.rb
+  - test/connections/native_db2
+  - test/connections/native_mysql
+  - test/connections/native_oci
+  - test/connections/native_postgresql
+  - test/connections/native_sqlite
+  - test/connections/native_sqlite3
+  - test/connections/native_sqlserver
+  - test/connections/native_sqlserver_odbc
+  - test/connections/native_db2/connection.rb
+  - test/connections/native_mysql/connection.rb
+  - test/connections/native_oci/connection.rb
+  - test/connections/native_postgresql/connection.rb
+  - test/connections/native_sqlite/connection.rb
+  - test/connections/native_sqlite3/connection.rb
+  - test/connections/native_sqlserver/connection.rb
+  - test/connections/native_sqlserver_odbc/connection.rb
+  - test/fixtures/activerecord_paranoid.sqlite
+  - test/fixtures/categories.yml
+  - test/fixtures/categories_widgets.yml
+  - test/fixtures/db_definitions
+  - test/fixtures/widgets.yml
+  - test/fixtures/db_definitions/postgresql.drop.sql
+  - test/fixtures/db_definitions/postgresql.sql
+  - test/fixtures/db_definitions/sqlite.drop.sql
+  - test/fixtures/db_definitions/sqlite.sql
+  - README
+  - MIT-LICENSE
+  - CHANGELOG
+  - RUNNING_UNIT_TESTS
+test_files: 
+  - test/tests.rb
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []