Rails3

.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx

Gemfile

@@ -1,4 +1,13 @@
-source :gemcutter
+source 'https://rubygems.org'
+
+gem 'sqlite3', :platforms => [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-test-unit'
+  gem 'rubinius-developer_tools'
+end
 
 # Specify your gem's dependencies in paranoia.gemspec
 gemspec

README.md

@@ -4,12 +4,30 @@ Paranoia is a re-implementation of [acts\_as\_paranoid](http://github.com/techno
 
 You would use either plugin / gem if you wished that when you called `destroy` on an Active Record object that it didn't actually destroy it, but just "hid" the record. Paranoia does this by setting a `deleted_at` field to the current time when you `destroy` a record, and hides it by scoping all queries on your model to only include records which do not have a `deleted_at` field.
 
+If you wish to actually destroy an object you may call `really_destroy!`. **WARNING**: This will also *really destroy* all `dependent: destroy` records, so please aim this method away from face when using.**
+
+If a record has `has_many` associations defined AND those associations have `dependent: :destroy` set on them, then they will also be soft-deleted if ``acts_as_paranoid`` is set,  otherwise the normal destroy will be called. 
+
 ## Installation & Usage
 
-Put this in your Gemfile:
+For Rails 3, please use version 1 of Paranoia:
+
+```ruby
+gem 'paranoia', '~> 1.0'
+```
+
+For Rails 4, please use version 2 of Paranoia:
+
+```ruby
+gem 'paranoia', '~> 2.0'
+```
+
+Of course you can install this from GitHub as well:
 
 ```ruby
-gem 'paranoia'
+gem 'paranoia', :github => 'radar/paranoia', :branch => 'rails3'
+# or
+gem 'paranoia', :github => 'radar/paranoia', :branch => 'rails4'
 ```
 
 Then run:
@@ -25,7 +43,7 @@ Updating is as simple as `bundle update paranoia`.
 Run:
 
 ```shell
-rails generate migration AddDeletedAtToClients deleted_at:datetime
+rails generate migration AddDeletedAtToClients deleted_at:datetime:index
 ```
 
 and now you have a migration
@@ -34,6 +52,7 @@ and now you have a migration
 class AddDeletedAtToClients < ActiveRecord::Migration
   def change
     add_column :clients, :deleted_at, :datetime
+    add_index :clients, :deleted_at
   end
 end
 ```
@@ -50,9 +69,23 @@ class Client < ActiveRecord::Base
 end
 ```
 
-Hey presto, it's there!
+Hey presto, it's there! Calling `destroy` will now set the `deleted_at` column:
+
+
+```
+>> client.deleted_at => nil
+>> client.destroy => client
+>> client.deleted_at => [current timestamp]
+```
 
-If you want a method to be called on destroy, simply provide a _before\_destroy_ callback:
+If you really want it gone *gone*, call `destroy!`
+
+```
+>> client.deleted_at => nil
+>> client.destroy! => client
+```
+
+If you want a method to be called on destroy, simply provide a `before_destroy` callback:
 
 ```ruby
 class Client < ActiveRecord::Base
@@ -68,6 +101,70 @@ class Client < ActiveRecord::Base
 end
 ```
 
+If you want to use a column other than `deleted_at`, you can pass it as an option:
+
+```ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid column: :destroyed_at
+
+  ...
+end
+```
+
+If you want to access soft-deleted associations, override the getter method:
+
+```ruby
+def product
+  Product.unscoped { super }
+end
+```
+
+If you want to find all records, even those which are deleted:
+
+```ruby
+Client.with_deleted
+```
+
+If you want to find only the deleted records:
+
+```ruby
+Client.only_deleted
+```
+
+If you want to check if a record is soft-deleted:
+
+```ruby
+client.destroyed?
+```
+
+If you want to restore a record:
+
+```ruby
+Client.restore(id)
+```
+
+If you want to restore a whole bunch of records:
+
+```ruby
+Client.restore([id1, id2, ..., idN])
+```
+
+If you want to restore a record and their dependently destroyed associated records:
+
+```ruby
+Client.restore(id, :recursive => true)
+```
+
+If you want callbacks to trigger before a restore:
+
+```ruby
+before_restore :callback_name_goes_here
+```
+
+For more information, please look at the tests.
+
+## Acts As Paranoid Migration
+
 You can replace the older acts_as_paranoid methods as follows:
 
 | Old Syntax                 | New Syntax                     |