gravelpup-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,56 @@
+# 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
+
+## Caveats
+
+Watch out for these caveats:
+
+-   If you use default\_scope in your model, you need to include it after the `acts_as_paranoid` invocation
+-   You cannot use scopes named `with_deleted` and `only_deleted`
+
+Copyright © 2010 Gonçalo Silva, released under the MIT license

data/lib/rails3_acts_as_paranoid.rb

@@ -0,0 +1,71 @@
+require 'active_record'
+require 'validations/uniqueness_without_deleted'
+
+module ActsAsParanoid
+  def acts_as_paranoid(options = {})
+    raise ArgumentError, "Hash expected, got #{options.class.name}" if not options.is_a?(Hash) and not options.empty?
+
+    configuration = { :column => "deleted_at", :column_type => "time" }
+    configuration.update(options) unless options.nil?
+
+    type = case configuration[:column_type]
+      when "time" then "Time.now"
+      when "boolean" then "true"
+      else
+        raise ArgumentError, "'time' or 'boolean' expected for :column_type option, got #{configuration[:column_type]}"
+    end
+
+    class_eval <<-EOV
+      default_scope where("#{self.table_name}.#{configuration[:column]} IS ?", nil)
+
+      class << self
+        def with_deleted
+          self.unscoped.where("") #self.unscoped.reload
+        end
+
+        def only_deleted
+          self.unscoped.where("#{self.table_name}.#{configuration[:column]} IS NOT ?", nil)
+        end
+
+        def delete_all!(conditions = nil)
+          self.unscoped.delete_all!(conditions)
+        end
+
+        def delete_all(conditions = nil)
+          update_all ["#{configuration[:column]} = ?", #{type}], conditions
+        end
+      end
+
+      def destroy!
+        before_destroy() if respond_to?(:before_destroy)
+
+        #{self.name}.delete_all!(:id => self)
+
+        after_destroy() if respond_to?(:after_destroy)
+      end
+
+      def destroy
+        run_callbacks :destroy do
+          if self.#{configuration[:column]} == nil
+            #{self.name}.delete_all(:id => self.id)
+          else
+            #{self.name}.delete_all!(:id => self.id)
+          end
+        end
+      end
+
+      def recover
+        self.update_attribute(:#{configuration[:column]}, nil)
+      end
+      
+      ActiveRecord::Relation.class_eval do
+        alias_method :delete_all!, :delete_all
+        alias_method :destroy!, :destroy
+      end
+    EOV
+  end
+end
+
+# Extend ActiveRecord's functionality
+ActiveRecord::Base.send :extend, ActsAsParanoid
+ActiveRecord::Base.send :extend, ParanoidValidations::ClassMethods

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,85 @@
+--- !ruby/object:Gem::Specification 
+name: gravelpup-rails3_acts_as_paranoid
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- "Gon\xC3\xA7alo Silva"
+- Jonathan Vaught
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-08 00:00:00 -05: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 
+        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: 
+- jonathan.vaught@gmail.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/gravelpup/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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: gravelpup-rails3_acts_as_paranoid
+rubygems_version: 1.3.7
+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: []
+