Commit 6b745177 by Ryan Bigg

Merge pull request #22 from parndt/patch-2

Added GitHub flavouring to your Markdown!
parents 3c081874 50e0b614
......@@ -8,7 +8,9 @@ You would use either plugin / gem if you wished that when you called `destroy` o
Put this in your Gemfile:
gem 'paranoia'
```ruby
gem 'paranoia'
```
Then run `bundle`. Done.
......@@ -18,25 +20,34 @@ Updating is as simple as `bundle update paranoia`.
In your _Gemfile_:
gem 'paranoia'
```ruby
gem 'paranoia'
```
Then run:
bundle install
```shell
bundle install
```
#### Rails 2:
In your _config/environment.rb_:
config.gem 'paranoia'
```ruby
config.gem 'paranoia'
```
Then run:
rake gems:install
```shell
rake gems:install
```
#### Run your migrations for the desired models
class AddDeletedAtToClient < ActiveRecord::Migration
```ruby
class AddDeletedAtToClient < ActiveRecord::Migration
def self.up
add_column :clients, :deleted_at, :datetime
end
......@@ -44,23 +55,27 @@ Then run:
def self.down
remove_column :clients, :deleted_at
end
end
end
```
### Usage
#### In your model:
class Client < ActiveRecord::Base
```ruby
class Client < ActiveRecord::Base
acts_as_paranoid
...
end
end
```
Hey presto, it's there!
If you want a method to be called on destroy, simply provide a _before\_destroy_ callback:
class Client < ActiveRecord::Base
```ruby
class Client < ActiveRecord::Base
acts_as_paranoid
before_destroy :some_method
......@@ -70,17 +85,20 @@ If you want a method to be called on destroy, simply provide a _before\_destroy_
end
...
end
end
```
You can replace the older acts_as_paranoid methods as follows:
find_with_deleted(:all) # => unscoped
find_with_deleted(:first) # => unscoped.first
find_with_deleted(id) # => unscoped.find(id)
```ruby
find_with_deleted(:all) # => unscoped
find_with_deleted(:first) # => unscoped.first
find_with_deleted(id) # => unscoped.find(id)
find_only_deleted(:all) # => only_deleted
find_only_deleted(:first) # => only_deleted.first
find_only_deleted(id) # => only_deleted.find(id)
find_only_deleted(:all) # => only_deleted
find_only_deleted(:first) # => only_deleted.first
find_only_deleted(id) # => only_deleted.find(id)
```
## License
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment