phene-rails3_acts_as_paranoid 0.0.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gonçalo Silva
+
+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.markdown

@@ -0,0 +1,113 @@
+# ActsAsParanoid
+
+A simple plugin which hides records instead of deleting them, being able to recover them.
+
+## Credits
+
+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).
+
+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.
+
+## Usage
+
+You can enable ActsAsParanoid like this:
+
+    class Paranoiac < ActiveRecord::Base
+      acts_as_paranoid
+    end
+
+### Options
+
+You can also specify the name of the column to store it's *deletion* and the type of data it holds:
+
+-   :column => 'deleted_at'
+-   :type => 'time'
+
+The values shown are the defaults. While *column* can be anything (as long as it exists in your database), *type* is restricted to "boolean" or "time".
+
+### 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:
+
+    Paranoiac.only_deleted # retrieves the deleted records
+    Paranoiac.with_deleted # retrieves all records, deleted or not
+
+### Real deletion
+
+In order to really delete a record, just use:
+
+    paranoiac.destroy!
+    Paranoiac.delete_all!(conditions)
+
+You can also definitively 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:
+
+    Paranoiac.first.destroy # does NOT delete the first record, just hides it
+    Paranoiac.only_deleted.destroy # deletes the first record from the database
+
+### Recovery
+
+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:
+
+    Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover(:recursive => false)
+
+If you would like to change the default behavior for a model, you can use the `recover_dependent_associations` option
+
+    class Paranoiac < ActiveRecord::Base
+        acts_as_paranoid :recover_dependent_associations => false
+    end
+
+By default when using timestamp fields to mark deletion, dependent records will be recovered if they were deleted within 5 seconds 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.  This window can be changed with the `dependent_recovery_window` option
+
+    class Paranoiac < ActiveRecord::Base
+        acts_as_paranoid
+        has_many :paranoids, :dependent => :destroy
+    end
+
+    class Paranoid < ActiveRecord::Base
+        belongs_to :paranoic
+
+        # Paranoid objects will be recovered alongside Paranoic objects 
+        # if they were deleted within 1 minute of the Paranoic object
+        acts_as_paranoid :dependent_recovery_window => 1.minute
+    end
+
+or in the recover statement
+
+    Paranoiac.only_deleted.where("name = ?", "not dead yet").first.recover(:recovery_window => 30.seconds)
+
+### Validation
+ActiveRecord's built-in uniqueness validation does not account for records deleted by ActsAsParanoid. If you want to check for uniqueness among non-deleted records only, use the macro `validates_as_paranoid` in your model. Then, instead of using `validates_uniqueness_of`, use `validates_uniqueness_of_without_deleted`. This will keep deleted records from counting against the uniqueness check.
+
+    class Paranoiac < ActiveRecord::Base
+      acts_as_paranoid
+      validates_as_paranoid
+      validates_uniqueness_of_without_deleted :name
+    end
+  
+    Paranoiac.create(:name => 'foo').destroy
+    Paranoiac.new(:name => 'foo').valid? #=> true
+    
+
+### Status
+Once you retrieve data using `with_deleted` scope you can check deletion status using `deleted?` helper:
+
+    Paranoiac.create(:name => 'foo').destroy
+    Paranoiac.with_deleted.first.deleted? #=> true
+
+## Caveats
+
+Watch out for these caveats:
+
+-   You cannot use default\_scope in your model. It is possible to work around this caveat, but it's not pretty. Have a look at [this article](http://joshuaclayton.github.com/code/default_scope/activerecord/is_paranoid/multiple-default-scopes.html) if you really need to have your own default scope.
+-   You cannot use scopes named `with_deleted` and `only_deleted`
+
+## Acknowledgements
+
+* To [cheerfulstoic](https://github.com/cheerfulstoic) for adding recursive recovery
+* To [Jonathan Vaught](https://github.com/gravelpup) for adding paranoid validations
+
+Copyright © 2010 Gonçalo Silva, released under the MIT license

data/lib/rails3_acts_as_paranoid.rb

@@ -0,0 +1,169 @@
+require 'active_record'
+require 'validations/uniqueness_without_deleted'
+
+module ActsAsParanoid
+  
+  def paranoid?
+    self.included_modules.include?(InstanceMethods)
+  end
+  
+  def validates_as_paranoid
+    extend ParanoidValidations::ClassMethods
+  end
+  
+  def acts_as_paranoid(options = {})
+    raise ArgumentError, "Hash expected, got #{options.class.name}" if not options.is_a?(Hash) and not options.empty?
+    
+    return if paranoid?
+    
+    class << self
+      attr_accessor :paranoid_configuration, :paranoid_column_reference
+    end
+     
+    @paranoid_configuration = { :column => "deleted_at", :column_type => "time", :recover_dependent_associations => true, :dependent_recovery_window => 5.minutes }.merge(options)
+
+    raise ArgumentError, "'time' or 'boolean' expected for :column_type option, got #{paranoid_configuration[:column_type]}" unless ['time', 'boolean'].include? paranoid_configuration[:column_type]
+
+    @paranoid_column_reference = "#{self.table_name}.#{paranoid_configuration[:column]}"
+
+    ActiveRecord::Relation.class_eval do
+      alias_method :delete_all!, :delete_all
+      alias_method :destroy!, :destroy
+    end
+    
+    default_scope where("#{paranoid_column_reference} IS ?", nil)
+    
+    scope :deleted_around, lambda {|value, window|
+      if self.class.respond_to?(:paranoid?) && self.class.paranoid?
+        if self.class.paranoid_column_type == 'time' && ![true, false].include?(value)
+          self.where("#{self.class.paranoid_column} > ? AND #{self.class.paranoid_column} < ?", (value - window), (value + window))
+        else
+          self.only_deleted
+        end
+      end
+    }
+    
+    include InstanceMethods
+    extend ClassMethods
+  end
+
+  module ClassMethods
+    
+    def with_deleted
+      self.unscoped.reload
+    end
+
+    def only_deleted
+      self.unscoped.where("#{paranoid_column_reference} IS NOT ?", nil)
+    end
+
+    def delete_all!(conditions = nil)
+      self.unscoped.delete_all!(conditions)
+    end
+
+    def delete_all(conditions = nil)
+      update_all ["#{paranoid_configuration[:column]} = ?", delete_now_value], conditions
+    end
+
+    def paranoid_column
+      paranoid_configuration[:column].to_sym
+    end
+
+    def paranoid_column_type
+      paranoid_configuration[:column_type].to_sym
+    end
+
+    def dependent_associations
+      self.reflect_on_all_associations.select {|a| [:delete_all, :destroy].include?(a.options[:dependent]) }
+    end
+  
+    def delete_now_value
+      case paranoid_configuration[:column_type]
+        when "time" then Time.now
+        when "boolean" then true
+      end
+    end
+  
+  end
+  
+  module InstanceMethods
+    
+    def paranoid_value
+      self.send(self.class.paranoid_column)
+    end
+  
+    def destroy!
+      with_transaction_returning_status do
+        run_callbacks :destroy do
+          self.class.delete_all!(:id => self)
+          self.paranoid_value = self.class.delete_now_value
+          freeze
+        end
+      end
+    end
+
+    def destroy
+      with_transaction_returning_status do
+        run_callbacks :destroy do
+          if paranoid_value == nil
+            self.class.delete_all(:id => self.id)
+          else
+            self.class.delete_all!(:id => self.id)
+          end
+          self.paranoid_value = self.class.delete_now_value
+        end
+      end
+    end
+
+    def recover(options = {})
+      options = {
+                  :recursive => self.class.paranoid_configuration[:recover_dependent_associations],
+                  :recovery_window => self.class.paranoid_configuration[:dependent_recovery_window]
+                }.merge(options)
+
+      self.class.transaction do
+        recover_dependent_associations(options[:recovery_window], options) if options[:recursive]
+
+        self.update_attributes(self.class.paranoid_column.to_sym => nil)
+      end
+    end
+
+    def recover_dependent_associations(window, options)
+      self.class.dependent_associations.each do |association|
+        if association.collection? && self.send(association.name).paranoid?
+          self.send(association.name).unscoped do
+            self.send(association.name).deleted_around(paranoid_value, window).each do |object|
+              object.recover(options) if object.respond_to?(:recover)
+            end
+          end
+        elsif association.macro == :has_one && association.klass.paranoid?
+          association.klass.unscoped do
+            object = association.klass.deleted_around(paranoid_value, window).send('find_by_'+association.primary_key_name, self.id)
+            object.recover(options) if object && object.respond_to?(:recover)
+          end
+        elsif association.klass.paranoid?
+          association.klass.unscoped do
+            id = self.send(association.primary_key_name)
+            object = association.klass.deleted_around(paranoid_value, window).find_by_id(id)
+            object.recover(options) if object && object.respond_to?(:recover)
+          end
+        end
+      end
+    end
+
+    def deleted?
+      !paranoid_value.nil?
+    end
+    alias_method :destroyed?, :deleted?
+    
+  private
+    def paranoid_value=(value)
+      self.send("#{self.class.paranoid_column}=", value)
+    end
+    
+  end
+  
+end
+
+# Extend ActiveRecord's functionality
+ActiveRecord::Base.send :extend, ActsAsParanoid

data/lib/validations/uniqueness_without_deleted.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/array/wrap'
+
+module ParanoidValidations
+  class UniquenessWithoutDeletedValidator < ActiveRecord::Validations::UniquenessValidator
+    def validate_each(record, attribute, value)
+      finder_class = find_finder_class_for(record)
+
+      if value && record.class.serialized_attributes.key?(attribute.to_s)
+        value = YAML.dump value
+      end
+
+      sql, params = mount_sql_and_params(finder_class, record.class.quoted_table_name, attribute, value)
+
+      # This is the only changed line from the base class version - it does finder_class.unscoped
+      relation = finder_class.where(sql, *params)
+      
+      Array.wrap(options[:scope]).each do |scope_item|
+        scope_value = record.send(scope_item)
+        relation = relation.where(scope_item => scope_value)
+      end
+
+      if record.persisted?
+        # TODO : This should be in Arel
+        relation = relation.where("#{record.class.quoted_table_name}.#{record.class.primary_key} <> ?", record.send(:id))
+      end
+
+      if relation.exists?
+        record.errors.add(attribute, :taken, options.except(:case_sensitive, :scope).merge(:value => value))
+      end
+    end
+  end
+
+  module ClassMethods
+    def validates_uniqueness_of_without_deleted(*attr_names)
+      validates_with UniquenessWithoutDeletedValidator, _merge_attributes(attr_names)
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: phene-rails3_acts_as_paranoid
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Geoffrey Hichborn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Active Record (>=3.0) plugin which allows you to hide and restore records without actually deleting them. Check its GitHub page for more in-depth information.
+email: 
+- geoff@socialcast.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rails3_acts_as_paranoid.rb
+- lib/validations/uniqueness_without_deleted.rb
+- LICENSE
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/phene/rails3_acts_as_paranoid
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib/validations
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: phene-rails3_acts_as_paranoid
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Active Record (>=3.0) plugin which allows you to hide and restore records without actually deleting them.
+test_files: []
+