Opengov branch

.gitignore

@@ -1,3 +1,5 @@
 pkg
 .bundle
 .DS_Store
+Gemfile.lock
+gemfiles/*.lock

.travis.yml

@@ -1,6 +1,37 @@
 language: ruby
+
+before_install:
+ - rvm get head
+ - gem install bundler
+
+script: "bundle exec rake test"
+sudo: required
 rvm:
- - 1.9.2
  - 1.9.3
- - jruby-19mode
- - rbx-19mode
+ - 2.0.0
+ - 2.1.9
+ - 2.2.5
+ - 2.3.1
+ - ruby-head
+ - jruby
+ - jruby-9.1.0.0
+ - rbx
+gemfile:
+ - gemfiles/active_record_40.gemfile
+ - gemfiles/active_record_41.gemfile
+ - gemfiles/active_record_42.gemfile
+ - gemfiles/active_record_50.gemfile
+matrix:
+ allow_failures:
+ - rvm: ruby-head
+ - rvm: rbx
+ - rvm: jruby
+ - rvm: jruby-9.1.0.0
+ fast_finish: true
+ exclude:
+ - rvm: 1.9.3
+ gemfile: gemfiles/active_record_50.gemfile
+ - rvm: 2.0.0
+ gemfile: gemfiles/active_record_50.gemfile
+ - rvm: 2.1.9
+ gemfile: gemfiles/active_record_50.gemfile

Gemfile

@@ -1,20 +1,13 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "activerecord", "~>3.2"
+# Older bundler has a known error which prevents bundle install on ruby 1.9
+gem "bundler", ">=1.12.0"
 
-# Development dependencies
-gem "rake"
-gem "activesupport", "~>3.2"
-
-platforms :ruby do
- gem "sqlite3"
-end
 
-platforms :jruby do
- gem "activerecord-jdbcsqlite3-adapter"
+# Development dependencies
+group :development do
+ gem "sqlite3", :platforms => [:ruby]
+ gem "activerecord-jdbcsqlite3-adapter", :platforms => [:jruby]
 end
 
-group :test do
- gem "minitest"
- gem "autotest-growl"
-end
+gemspec

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Gonçalo Silva
+Copyright (c) 2014 Zachary Scott, Gonçalo Silva, Rick Olson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.markdown → README.md

@@ -1,14 +1,16 @@
 # ActsAsParanoid
 
-A simple plugin which hides records instead of deleting them, being able to recover them.
+[![Build Status](https://travis-ci.org/OpenGov/acts_as_paranoid.png?branch=opengov-master)](https://travis-ci.org/OpenGov/acts_as_paranoid)
 
-**This branch targets Rails 3.2.** If you're working with another version, switch to the corresponding branch.
+A Rails plugin to add soft delete.
 
-## Credits
+This gem can be used to hide records instead of deleting them, making them recoverable later.
 
-This plugin was inspired by [acts_as_paranoid](http://github.com/technoweenie/acts_as_paranoid) and [acts_as_active](http://github.com/fernandoluizao/acts_as_active).
+## Support
 
-While porting it to Rails 3, I decided to apply the ideas behind those plugins to an unified solution while removing a **lot** of the complexity found in them. I eventually ended up writing a new plugin from scratch.
+**This branch targets Rails 4.x. and 5.x**
+
+If you're working with another version, switch to the corresponding branch, or require an older version of the `acts_as_paranoid` gem.
 
 ## Usage
 
@@ -35,12 +37,18 @@ The values shown are the defaults. While *column* can be anything (as long as it
 
 If your column type is a `string`, you can also specify which value to use when marking an object as deleted by passing `:deleted_value` (default is "deleted"). Any records with a non-matching value in this column will be treated normally (ie: not deleted).
 
+If your column type is a `boolean`, it is possible to specify `allow_nulls` option which is `true` by default. When set to `false`, entities that have `false` value in this column will be considered not deleted, and those which have `true` will be considered deleted. When `true` everything that has a not-null value will be considered deleted.
+
 ### Filtering
 
-If a record is deleted by ActsAsParanoid, it won't be retrieved when accessing the database. So, `Paranoiac.all` will **not** include the deleted_records. if you want to access them, you have 2 choices:
+If a record is deleted by ActsAsParanoid, it won't be retrieved when accessing the database.
+
+So, `Paranoiac.all` will **not** include the **deleted records**.
+
+When you want to access them, you have 2 choices:
 
 ```ruby
-Paranoiac.only_deleted # retrieves the deleted records
+Paranoiac.only_deleted # retrieves only the deleted records
 Paranoiac.with_deleted # retrieves all records, deleted or not
 ```
 
@@ -65,7 +73,13 @@ paranoiac.destroy!
 Paranoiac.delete_all!(conditions)
 ```
 
-You can also permanently delete a record by calling `destroy` or `delete_all` on it **twice**. If a record was already deleted (hidden by ActsAsParanoid) and you delete it again, it will be removed from the database. Take this example:
+You can also permanently delete a record by calling `destroy_fully!` on the object.
+
+Alternatively you can permanently delete a record by calling `destroy` or `delete_all` on the object **twice**.
+
+If a record was already deleted (hidden by `ActsAsParanoid`) and you delete it again, it will be removed from the database.
+
+Take this example:
 
 ```ruby
 p = Paranoiac.first
@@ -81,7 +95,9 @@ Recovery is easy. Just invoke `recover` on it, like this:
 Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover
 ```
 
-All associations marked as `:dependent => :destroy` are also recursively recovered. If you would like to disable this behavior, you can call `recover` with the `recursive` option:
+All associations marked as `:dependent => :destroy` are also recursively recovered.
+
+If you would like to disable this behavior, you can call `recover` with the `recursive` option:
 
 ```ruby
 Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover(:recursive => false)
@@ -95,7 +111,13 @@ class Paranoiac < ActiveRecord::Base
 end
 ```
 
-By default, dependent records will be recovered if they were deleted within 2 minutes of the object upon which they depend. This restores the objects to the state before the recursive deletion without restoring other objects that were deleted earlier. The behavior is only available when both parent and dependant are using timestamp fields to mark deletion, which is the default behavior. This window can be changed with the `dependent_recovery_window` option:
+By default, dependent records will be recovered if they were deleted within 2 minutes of the object upon which they depend.
+
+This restores the objects to the state before the recursive deletion without restoring other objects that were deleted earlier.
+
+The behavior is only available when both parent and dependant are using timestamp fields to mark deletion, which is the default behavior.
+
+This window can be changed with the `dependent_recovery_window` option:
 
 ```ruby
 class Paranoiac < ActiveRecord::Base
@@ -123,9 +145,9 @@ ActiveRecord's built-in uniqueness validation does not account for records delet
 
 ```ruby
 class Paranoiac < ActiveRecord::Base
-  acts_as_paranoid
-  validates_as_paranoid
-  validates_uniqueness_of_without_deleted :name
+ acts_as_paranoid
+ validates_as_paranoid
+ validates_uniqueness_of_without_deleted :name
 end
 
 p1 = Paranoiac.create(:name => 'foo')
@@ -148,13 +170,15 @@ Paranoiac.with_deleted.first.deleted? #=> true
 
 ### Scopes
 
-As you've probably guessed, `with_deleted` and `only_deleted` are scopes. You can, however, chain them freely with other scopes you might have. This
+As you've probably guessed, `with_deleted` and `only_deleted` are scopes. You can, however, chain them freely with other scopes you might have.
+
+For example:
 
 ```ruby
 Paranoiac.pretty.with_deleted
 ```
 
-is exactly the same as
+This is exactly the same as:
 
 ```ruby
 Paranoiac.with_deleted.pretty
@@ -164,8 +188,8 @@ You can work freely with scopes and it will just work:
 
 ```ruby
 class Paranoiac < ActiveRecord::Base
- acts_as_paranoid
- scope :pretty, where(:pretty => true)
+ acts_as_paranoid
+ scope :pretty, where(:pretty => true)
 end
 
 Paranoiac.create(:pretty => true)
@@ -183,17 +207,21 @@ Paranoiac.pretty.only_deleted.count #=> 1
 
 ### Associations
 
-Associations are also supported. From the simplest behaviors you'd expect to more nifty things like the ones mentioned previously or the usage of the `:with_deleted` option with `belongs_to`
+Associations are also supported.
+
+From the simplest behaviors you'd expect to more nifty things like the ones mentioned previously or the usage of the `:with_deleted` option with `belongs_to`
 
 ```ruby
 class Parent < ActiveRecord::Base
- has_many :children, :class_name => "ParanoiacChild"
+ has_many :children, :class_name => "ParanoiacChild"
 end
 
 class ParanoiacChild < ActiveRecord::Base
- belongs_to :parent
- belongs_to :parent_including_deleted, :class_name => "Parent", :with_deleted => true
- # You cannot name association *_with_deleted
+ acts_as_paranoid
+ belongs_to :parent
+
+ # You may need to provide a foreign_key like this
+ belongs_to :parent_including_deleted, :class_name => "Parent", :foreign_key => 'parent_id', :with_deleted => true
 end
 
 parent = Parent.first
@@ -204,6 +232,32 @@ child.parent #=> nil
 child.parent_including_deleted #=> Parent (it works!)
 ```
 
+### Creating Custom Callbacks
+
+Define custom callbacks in lib/acts_as_paranoid/core.rb. Depending on the :after , :before callbacks required, use set_callbacks as shown below.
+
+```ruby
+def self.extended(base)
+ base.define_callbacks :soft_destroy, terminator: lambda { |target, result| result == false }
+end
+
+def before_soft_destroy(method)
+ set_callback :soft_destroy, :before, method
+end
+
+def after_soft_destroy(method)
+ set_callback :soft_destroy, :after, method
+end
+```
+usage in acts_as_paranoid class
+```ruby
+before_soft_destroy :peform_before_soft_destroy
+after_soft_destroy :peform_after_soft__destroy
+```
+### Custom callbacks
+- `before_soft_destroy` : This is executed before soft_destroy happens
+- `before_soft_destroy` : This is executed after marking the record to be soft destroyed
+
 ## Caveats
 
 Watch out for these caveats:
@@ -215,37 +269,33 @@ Watch out for these caveats:
 - `unscoped` will return all records, deleted or not
 - Assignment of `self.table_name` in a model must come before `acts_as_paranoid` or you will get SQL errors.
 
-# Support
-
-This gem supports the most recent versions of Rails and Ruby.
-
-## Rails
-
-For Rails 3.2 check the README at the [rails3.2](https://github.com/goncalossilva/rails3_acts_as_paranoid/tree/rails3.2) branch and add this to your Gemfile:
-
- gem "acts_as_paranoid", "~>0.4.0"
-
-For Rails 3.1 check the README at the [rails3.1](https://github.com/goncalossilva/rails3_acts_as_paranoid/tree/rails3.1) branch and add this to your Gemfile:
-
- gem "rails3_acts_as_paranoid", "~>0.1.4"
-
-For Rails 3.0 check the README at the [rails3.0](https://github.com/goncalossilva/rails3_acts_as_paranoid/tree/rails3.0) branch and add this to your Gemfile:
-
- gem "rails3_acts_as_paranoid", "~>0.0.9"
+# Specs
+To run specs for this repository, first get bundler and install dependencies
+```
+bundle install
+```
 
+If it complains about sqlite3 you may need to install the sqlite3 headers. Using `gem install sqlite3` should suggest how to do this.
 
-## Ruby
+```
+bundle exec rake test
+```
 
-This gem is tested on Ruby 1.9, JRuby and Rubinius (both in 1.9 mode). It *might* work fine in 1.8, but it's not officially supported.
+And all the specs should be green.
 
 # Acknowledgements
 
+* To [Rick Olson](https://github.com/technoweenie) for creating acts_as_paranoid
 * To [cheerfulstoic](https://github.com/cheerfulstoic) for adding recursive recovery
 * To [Jonathan Vaught](https://github.com/gravelpup) for adding paranoid validations
 * To [Geoffrey Hichborn](https://github.com/phene) for improving the overral code quality and adding support for after_commit
 * To [flah00](https://github.com/flah00) for adding support for STI-based associations (with :dependent)
 * To [vikramdhillon](https://github.com/vikramdhillon) for the idea and initial implementation of support for string column type
 * To [Craig Walker](https://github.com/softcraft-development) for Rails 3.1 support and fixing various pending issues
 * To [Charles G.](https://github.com/chuckg) for Rails 3.2 support and for making a desperately needed global code refactoring
+* To [Gonçalo Silva](https://github.com/goncalossilva) for supporting this gem prior to v0.4.3
+* To [Jean Boussier](https://github.com/byroot) for initial Rails 4.0.0 support
+* To [Matijs van Zuijlen](https://github.com/mvz) for Rails 4.1 and 4.2 support
+* To [Andrey Ponomarenko](https://github.com/sjke) for Rails 5 support
 
-Copyright © 2010 Gonçalo Silva, released under the MIT license
+See `LICENSE`.