jchupp-is_paranoid 0.0.2 → 0.3.0

data/README.textile

@@ -8,11 +8,11 @@ h3. and you may ask yourself, how do I work this?
 
 You should read the specs, or the RDOC, or even the source itself (which is very readable), but for the lazy, here's the hand-holding:
 
-You need ActiveRecord 2.3 and you need to properly install this gem.  Then you need a model with a deleted_at timestamp column on its database table.  If that column is null, the item isn't deleted.  If it has a timestamp, it should count as deleted.
+You need ActiveRecord 2.3 and you need to properly install this gem.  Then you need a model with a field to serve as a flag column on its database table.  For this example we'll use a timestamp named "deleted_at".  If that column is null, the item isn't deleted.  If it has a timestamp, it should count as deleted.
 
 So let's assume we have a model Automobile that has a deleted_at column on the automobiles table.
 
-If you're working with Rails, in your environment.rb, add the following to your initializer block.
+If you're working with Rails, in your environment.rb, add the following to your initializer block (you may want to change the version number).
 
 <pre>
 Rails::Initializer.run do |config|
@@ -57,10 +57,37 @@ One thing to note, destroying is always undo-able, but deleting is not.
   # And you may say to yourself, "My god!  What have I done?"
 </pre>
 
+All calculations and finds are created via a define_method call in method_missing.  So you don't get a bunch of unnecessary methods defined unless you use them.  Any find/count/sum/etc. _with_destroyed calls should work and you can also do find/count/sum/etc._destroyed_only.
+
+h3. Specifying alternate rules for what should be considered destroyed
+
+"deleted_at" as a timestamp is what acts_as_paranoid uses to define what is and isn't destroyed (see above), but you can specify alternate options with is_paranoid.  In the is_paranoid line of your model you can specify the field, the value the field should have if the entry should count as destroyed, and the value the field should have if the entry is not destroyed.  Consider the following models:
+
+<pre>
+  class Pirate < ActiveRecord::Base
+    is_paranoid :field => [:alive, false, true]
+  end
+
+  class DeadPirate < ActiveRecord::Base
+    set_table_name :pirates
+    is_paranoid :field => [:alive, true, false]
+  end
+</pre>
+
+These two models share the same table, but when we are finding Pirates, we're only interested in those that are alive.  To break it down, we specify :alive as our field to check, false as what the model field should be marked at when destroyed and true to what the field should be if they're not destroyed.  DeadPirates are specified as the opposite.  Check out the specs if you're still confused.
+
+h3. Note:
+
+validates_uniqueness_of does not ignore items marked with a deleted_at flag.  This is a behavior difference between is_paranoid and acts_as_paranoid.  I'm going to treat this as a bug until I get a chance to make it an optional feature.  Be aware of it.
+
 h3. and you may ask yourself, where does that highway go to?
 
 If you find any bugs, have any ideas of features you think are missing, or find things you're like to see work differently, feel free to send me a message or a pull request.
 
+Currently on the todo list:
+* deal with validates_uniqueness_of issue
+* add options for merging additional default_scope options (i.e. order, etc.)
+
 h3. Thanks
 
 Thanks to Rick Olson for acts_as_paranoid which is obviously an inspiration in concept and execution, Ryan Bates for mentioning the idea of using default_scope for this on Ryan Daigle's "post introducing default_scope":defscope, and the Talking Heads for being the Talking Heads. 

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 3
+:patch: 0
+:major: 0

data/lib/is_paranoid.rb

@@ -13,44 +13,45 @@ module IsParanoid
     #  class Android < ActiveRecord::Base
     #    is_paranoid
     #  end
-    def is_paranoid
-      class_eval do
+    #
+    # If you want to include ActiveRecord::Calculations to include your
+    # destroyed models, do is_paranoid :with_calculations => true and you
+    # will get sum_with_deleted, count_with_deleted, etc.
+    def is_paranoid opts = {}
+      opts[:field] ||= [:deleted_at, Proc.new{Time.now.utc}, nil]
+      class_inheritable_accessor :destroyed_field, :field_destroyed, :field_not_destroyed
+      self.destroyed_field, self.field_destroyed, self.field_not_destroyed = opts[:field]
+
+      include Work
+    end
+  end
+
+  module Work
+    def self.included(base)
+      base.class_eval do
         # This is the real magic.  All calls made to this model will append
         # the conditions deleted_at => nil.  Exceptions require using
         # exclusive_scope (see self.delete_all, self.count_with_destroyed,
         # and self.find_with_destroyed )
-        default_scope :conditions => {:deleted_at => nil}
+        default_scope :conditions => {destroyed_field => field_not_destroyed}
 
         # Actually delete the model, bypassing the safety net.  Because
-        # this method is called internally by Model.delete and on the
+        # this method is called internally by Model.delete(id) and on the
         # delete method in each instance, we don't need to specify those
         # methods separately
         def self.delete_all conditions = nil
-          self.with_exclusive_scope do
-            super conditions
-          end
-        end
-
-        # Return a count that includes the soft-deleted models.
-        def self.count_with_destroyed *args
-          self.with_exclusive_scope { count(*args) }
-        end
-
-        # Return instances of all models matching the query regardless
-        # of whether or not they have been soft-deleted.
-        def self.find_with_destroyed *args
-          self.with_exclusive_scope { find(*args) }
+          self.with_exclusive_scope { super conditions }
         end
 
         # Mark the model deleted_at as now.
         def destroy_without_callbacks
-          self.update_attribute(:deleted_at, Time.now.utc)
+          self.update_attribute(destroyed_field, ( field_destroyed.respond_to?(:call) ? field_destroyed.call : field_destroyed))
         end
 
         # Override the default destroy to allow us to flag deleted_at.
         # This preserves the before_destroy and after_destroy callbacks.
         # Because this is also called internally by Model.destroy_all and
-        # the destroy Model.destroy, we don't need to specify those methods
+        # the Model.destroy(id), we don't need to specify those methods
         # separately.
         def destroy
           return false if callback(:before_destroy) == false
@@ -62,7 +63,40 @@ module IsParanoid
         # Set deleted_at flag on a model to nil, effectively undoing the
         # soft-deletion.
         def restore
-          self.update_attribute(:deleted_at, nil)
+          self.update_attribute(destroyed_field, field_not_destroyed)
+        end
+
+        # find_with_destroyed and other blah_with_destroyed and
+        # blah_destroyed_only methods are defined here
+        def self.method_missing name, *args
+          if name.to_s =~ /^(.*)(_destroyed_only|_with_destroyed)$/ and self.respond_to?($1)
+            self.extend(Module.new{
+              if $2 == '_with_destroyed'                            # Example:
+                define_method name do |*args|                       #  def count_with_destroyed(*args)
+                  self.with_exclusive_scope{ self.send($1, *args) } #     self.with_exclusive_scope{ self.send(:count, *args) }
+                end                                                 #  end
+              else
+                # Example:
+                #  def count_destroyed_only(*args)
+                #    self.with_exclusive_scope do
+                #      with_scope({:find => { :conditions => ["#{destroyed_field} IS NOT ?", nil] }}) do
+                #        self.send(:count, *args)
+                #      end
+                #    end
+                #  end
+                define_method name do |*args|
+                  self.with_exclusive_scope do
+                    with_scope({:find => { :conditions => ["#{destroyed_field} IS NOT ?", field_not_destroyed] }}) do
+                      self.send($1, *args)
+                    end
+                  end
+                end
+              end
+            })
+            self.send(name, *args)
+          else
+            super(name, *args)
+          end
         end
       end
     end

data/spec/{android_spec.rb → is_paranoid_spec.rb}

@@ -5,9 +5,27 @@ class Person < ActiveRecord::Base
 end
 
 class Android < ActiveRecord::Base
+  validates_uniqueness_of :name
   is_paranoid
 end
 
+class NoCalculation < ActiveRecord::Base
+  is_paranoid
+end
+
+class Ninja < ActiveRecord::Base
+  is_paranoid :field => [:visible, false, true]
+end
+
+class Pirate < ActiveRecord::Base
+  is_paranoid :field => [:alive, false, true]
+end
+
+class DeadPirate < ActiveRecord::Base
+  set_table_name :pirates
+  is_paranoid :field => [:alive, true, false]
+end
+
 describe Android do
   before(:each) do
     Android.delete_all
@@ -50,7 +68,13 @@ describe Android do
   it "should be able to find deleted items via find_with_destroyed" do
     @r2d2.destroy
     Android.find(:first, :conditions => {:name => 'R2D2'}).should be_blank
-    Android.find_with_destroyed(:first, :conditions => {:name => 'R2D2'}).should_not be_blank
+    Android.first_with_destroyed(:conditions => {:name => 'R2D2'}).should_not be_blank
+  end
+
+  it "should be able to find only deleted items via find_destroyed_only" do
+    @r2d2.destroy
+    Android.all_destroyed_only.size.should == 1
+    Android.first_destroyed_only.should == @r2d2
   end
 
   it "should have a proper count inclusively and exclusively of deleted items" do
@@ -73,4 +97,38 @@ describe Android do
       @r2d2.restore
     }.should change(Android, :count).from(1).to(2)
   end
+
+  it "should respond to various calculations" do
+    @r2d2.destroy
+    Android.sum('id').should == @c3p0.id
+    Android.sum_with_destroyed('id').should == @r2d2.id + @c3p0.id
+
+    Android.average_with_destroyed('id').should == (@r2d2.id + @c3p0.id) / 2.0
+  end
+
+  # Note:  this isn't necessarily ideal, this just serves to demostrate
+  # how it currently works
+  it "should not ignore deleted items in validation checks" do
+    @r2d2.destroy
+    lambda{
+      Android.create!(:name => 'R2D2')
+    }.should raise_error(ActiveRecord::RecordInvalid)
+  end
+  
+  it "should allow specifying alternate fields and field values" do
+    ninja = Ninja.create(:name => 'Esteban')
+    ninja.destroy
+    Ninja.first.should be_blank
+    Ninja.find_with_destroyed(:first).should == ninja
+    
+    pirate = Pirate.create(:name => 'Reginald')
+    pirate.destroy
+    Pirate.first.should be_blank
+    Pirate.find_with_destroyed(:first).should == pirate
+
+    DeadPirate.first.id.should == pirate.id
+    lambda{
+      DeadPirate.first.destroy
+    }.should change(Pirate, :count).from(0).to(1)
+  end
 end

data/spec/schema.rb

@@ -12,4 +12,14 @@ ActiveRecord::Schema.define(:version => 20090317164830) do
     t.datetime "created_at"
     t.datetime "updated_at"
   end
+
+  create_table "ninjas", :force => true do |t|
+    t.string   "name"
+    t.boolean  "visible", :default => true
+  end
+
+  create_table "pirates", :force => true do |t|
+    t.string   "name"
+    t.boolean  "alive", :default => true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jchupp-is_paranoid
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jeffrey Chupp
@@ -9,20 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-20 00:00:00 -07:00
+date: 2009-03-28 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.0
-    version: 
-description: 
+dependencies: []
+
+description: ""
 email: jeff@semanticart.com
 executables: []
 
@@ -31,20 +22,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/is_paranoid.rb
 - README.textile
-- Rakefile
-- MIT-LICENSE
-- spec/android_spec.rb
+- VERSION.yml
+- lib/is_paranoid.rb
 - spec/database.yml
+- spec/is_paranoid_spec.rb
+- spec/schema.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/schema.rb
 has_rdoc: true
 homepage: http://github.com/jchupp/is_paranoid/
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/MIT-LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2009 Jeffrey Chupp
-
-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/Rakefile

@@ -1,14 +0,0 @@
-require "spec"
-require "spec/rake/spectask"
-require 'lib/is_paranoid.rb'
-
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-task :install do
-  rm_rf "*.gem"
-  puts `gem build is_paranoid.gemspec`
-  puts `sudo gem install is_paranoid-0.0.1.gem`
-end