permanent_records 1.1.0 → 2.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jack Danger Canty
+
+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,61 @@
+# PermanentRecords
+
+[http://github.com/JackDanger/permanent_records/](http://github.com/JackDanger/permanent_records/)
+
+This gem prevents any of your ActiveRecord data from being destroyed.
+Any model that you've given a "deleted_at" datetime column will have that column set rather than let the record be deleted.
+
+## Compatability: This gem works with Rails versions 1, 2, and 3
+
+## Does it make a lot of sense?
+
+Yes.
+
+    User.find(3).destroy          # sets the 'deleted_at' attribute to Time.now and returns a frozen record
+    User.find(3).destroy(:force)  # executes the real destroy method, the record will be removed from the database
+    User.destroy_all              # soft-deletes all User records
+    User.delete_all               # bye bye everything (no soft-deleting here)
+
+There are also two scopes provided for easily searching deleted and not deleted records:
+
+    User.deleted.find(...)        # only returns deleted records.
+    User.not_deleted.find(...)    # only returns non-deleted records.
+
+
+Note: Your normal finds will, by default, _include_ deleted records. You'll have to manually use the 'not_deleted' scope to avoid this:
+
+    User.find(1)                  # will find record number 1, even if it's deleted
+    User.not_deleted.find(1)      # This is probably what you want, it doesn't find deleted records
+
+## Is Everything Automated?
+
+
+Yes. You don't have to change ANY of your code to get permanent archiving of all your data with this gem. 
+When you call 'destroy' on any record  (or 'destroy_all' on a class or association) your records will
+all have a deleted_at timestamp set on them.
+
+
+## Can I easily undelete records?
+
+Yes. All you need to do is call the 'revive' method.
+
+
+    User.find(3).destroy
+    # the user is now deleted
+    User.find(3).revive
+    # the user is back to it's original state
+
+And if you had dependent records that were set to be destroyed along with the parent record:
+
+    class User < ActiveRecord::Base
+      has_many :comments, :dependent => :destroy
+    end
+    User.find(3).destory
+    # all the comments are destroyed as well
+    User.find(3).revive
+    # all the comments that were just destroyed are now back in pristine condition
+
+
+Patches welcome, forks celebrated.
+
+Copyright (c) 2010 Jack Danger Canty @ [http://jåck.com](http://jåck.com) of Cloops Inc., released under the MIT license

data/Rakefile

@@ -16,9 +16,13 @@ rescue LoadError
 end
 
 require 'rake/testtask'
-task :test do
-  exec "ruby test/permanent_records_test.rb"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << '-rubygems'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
 end
+task :spec => :test
 
 task :default => :test
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+2.0.0

data/lib/permanent_records.rb

@@ -1,16 +1,25 @@
 module PermanentRecords
   def self.included(base)
-    if base.respond_to?(:named_scope)
+
+    base.send :include, InstanceMethods
+
+    # Rails 3
+    if ActiveRecord::VERSION::MAJOR >= 3
+      base.scope :deleted, :conditions => 'deleted_at IS NOT NULL'
+      base.scope :not_deleted, :conditions => { :deleted_at => nil }
+      base.instance_eval { define_model_callbacks :revive }
+    # Rails 2.x.x
+    elsif base.respond_to?(:named_scope)
       base.named_scope :deleted, :conditions => 'deleted_at IS NOT NULL'
       base.named_scope :not_deleted, :conditions => { :deleted_at => nil }
+      base.instance_eval { define_callbacks :before_revive, :after_revive }
+      base.send :alias_method_chain, :destroy, :permanent_records
+    # Early Rails code
     else
-      base.extend LegacyScopes
+      base.extend EarlyRails
+      base.instance_eval { define_callbacks :before_revive, :after_revive }
     end
-    base.send :include, InstanceMethods
     base.instance_eval do
-      define_callbacks :before_revive, :after_revive
-      alias_method_chain :destroy, :permanent_record_force
-      alias_method_chain :destroy_without_callbacks, :permanent_record
       before_revive :revive_destroyed_dependent_records
       def is_permanent?
         columns.detect {|c| 'deleted_at' == c.name}
@@ -18,7 +27,7 @@ module PermanentRecords
     end
   end
   
-  module LegacyScopes
+  module EarlyRails
     def with_deleted
       with_scope :find => {:conditions => "#{quoted_table_name}.deleted_at IS NOT NULL"} do
         yield
@@ -50,7 +59,7 @@ module PermanentRecords
       end
     end
   end
-  
+
   module InstanceMethods
     
     def is_permanent?
@@ -60,11 +69,22 @@ module PermanentRecords
     def deleted?
       deleted_at if is_permanent?
     end
+
+    def destroyed?
+      deleted? || super
+    end
     
     def revive
-      run_callbacks :before_revive
-      set_deleted_at nil
-      run_callbacks :after_revive
+      # Rails 3
+      if ActiveRecord::VERSION::MAJOR >= 3
+        _run_revive_callbacks do
+          set_deleted_at nil
+        end
+      else
+        run_callbacks :before_revive
+        set_deleted_at nil
+        run_callbacks :after_revive
+      end
       self
     end
     
@@ -74,17 +94,31 @@ module PermanentRecords
       record.update_attribute(:deleted_at, value)
       @attributes, @attributes_cache = record.attributes, record.attributes
     end
-    
-    def destroy_with_permanent_record_force(force = nil)
-      @force_permanent_record_destroy = (:force == force)
-      destroy_without_permanent_record_force
+
+    def destroy(force = nil)
+      if ActiveRecord::VERSION::MAJOR >= 3
+        return super() unless is_permanent? && (:force != force)
+      end
+      destroy_with_permanent_records force
     end
-    
-    def destroy_without_callbacks_with_permanent_record
-      return destroy_without_callbacks_without_permanent_record if @force_permanent_record_destroy || !is_permanent?
+
+    def destroy_with_permanent_records(force = nil)
+      if ActiveRecord::VERSION::MAJOR < 3
+        return destroy_without_permanent_records unless is_permanent? && (:force != force)
+      end
       unless deleted? || new_record?
         set_deleted_at Time.now
       end
+      # Rails 3
+      if ActiveRecord::VERSION::MAJOR >= 3
+        _run_destroy_callbacks do
+          save
+        end
+      else
+        run_callbacks :before_destroy
+        save
+        run_callbacks :after_destroy
+      end
       self
     end
 
@@ -111,5 +145,6 @@ module PermanentRecords
     end
   end
 end
+
 ActiveRecord::Base.send :include, PermanentRecords
 

data/permanent_records.gemspec

@@ -1,58 +1,57 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{permanent_records}
-  s.version = "1.1.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jack Danger Canty"]
-  s.date = %q{2010-08-30}
+  s.date = %q{2011-04-10}
   s.description = %q{Never Lose Data. Rather than deleting rows this sets Record#deleted_at and gives you all the scopes you need to work with your data.}
   s.email = %q{gems@6brand.com}
   s.extra_rdoc_files = [
-    "README"
+    "LICENSE",
+    "README.markdown"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "MIT-LICENSE",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "install.rb",
-     "lib/permanent_records.rb",
-     "permanent_records.gemspec",
-     "test/database.yml",
-     "test/hole.rb",
-     "test/kitty.rb",
-     "test/mole.rb",
-     "test/muskrat.rb",
-     "test/permanent_records_test.rb",
-     "test/schema.rb",
-     "test/test_helper.rb",
-     "uninstall.rb"
+    "LICENSE",
+    "MIT-LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "install.rb",
+    "lib/permanent_records.rb",
+    "permanent_records.gemspec",
+    "test/database.yml",
+    "test/hole.rb",
+    "test/kitty.rb",
+    "test/mole.rb",
+    "test/muskrat.rb",
+    "test/permanent_records_test.rb",
+    "test/schema.rb",
+    "test/test_helper.rb",
+    "uninstall.rb"
   ]
   s.homepage = %q{http://github.com/JackDanger/permanent_records}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{Soft-delete your ActiveRecord records}
   s.test_files = [
     "test/hole.rb",
-     "test/kitty.rb",
-     "test/mole.rb",
-     "test/muskrat.rb",
-     "test/permanent_records_test.rb",
-     "test/schema.rb",
-     "test/test_helper.rb"
+    "test/kitty.rb",
+    "test/mole.rb",
+    "test/muskrat.rb",
+    "test/permanent_records_test.rb",
+    "test/schema.rb",
+    "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/test/test_helper.rb

@@ -4,8 +4,6 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 RAILS_ROOT = File.dirname(__FILE__)
 
-require 'rubygems'
-gem 'test-unit'
 require 'test/unit'
 require 'active_record'
 require 'active_record/fixtures'

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: permanent_records
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
-  - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Jack Danger Canty
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 -07:00
+date: 2011-04-30 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,12 +26,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- LICENSE
+- README.markdown
 files: 
 - .document
-- .gitignore
+- LICENSE
 - MIT-LICENSE
-- README
+- README.markdown
 - Rakefile
 - VERSION
 - init.rb
@@ -51,8 +53,8 @@ homepage: http://github.com/JackDanger/permanent_records
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -60,6 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -68,13 +71,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Soft-delete your ActiveRecord records

data/.gitignore

@@ -1 +0,0 @@
-test/debug.log

data/README

@@ -1,22 +0,0 @@
-PermanentRecords
-================
-
-This plugin prevents any of your records from being destroyed casually.
-Any model with a deleted_at datetime column will have that column set rather than being deleted.
-
-Usage
-=======
-
-User.find(3).destroy          # sets the 'deleted_at' attribute to Time.now and returns a frozen record
-User.find(3).destroy(:force)  # executes the real destroy method, the record will be removed from the database
-User.delete_all               # bye bye everything
-
-There are also two named scopes provided for easily searching deleted and not deleted records:
-
-User.send :with_deleted { User.find(:all) }     # only returns deleted records.
-User.send :with_not_deleted { User.find(:all) } # you guessed it.
-
-These are named so as to work smoothly with other scoping plugins like scope_out.
-
-
-Copyright (c) 2008 Jack Danger Canty of adPickles Inc., released under the MIT license