goldstar-is_paranoid 0.9.0.1 → 0.9.6.1

data/.gitignore

@@ -0,0 +1,4 @@
+is_paranoid.db
+pkg
+*.gem
+doc/

data/CHANGELOG

@@ -1,5 +1,17 @@
 This will only document major changes.  Please see the commit log for minor changes.
 
+-2009-09-25
+* fixing bug with has_many :through not respecting is_paranoid conditions (thanks, Ben Johnson)
+
+-2009-09-18
+* making is_paranoid play nice with habtm relationships
+
+-2009-09-17
+* fixed when primary key was not "id" (ie: "uuid") via Thibaud Guillaume-Gentil
+
+-2009-09-15
+* added support for has_many associations (i.e. @r2d2.components_with_destroyed) via Amiel Martin
+
 -2009-06-13
 * added support for is_paranoid conditions being maintained on preloaded associations
 * destroy and restore now return self (to be more in keeping with other ActiveRecord methods) via Brent Dillingham
@@ -28,4 +40,4 @@ This will only document major changes.  Please see the commit log for minor chan
 * requiring specific syntax to include calculations
 
 -2009-03-21
-* initial release
+* initial release

data/README.textile

@@ -1,5 +1,19 @@
+h1. NOTICE:  this library is no longer supported or actively developed by the original author.  It never made it to a 1.0 stable version.  Use it at your own risk and write lots of tests.
+
+You can read more here:  http://blog.semanticart.com/killing_is_paranoid/
+
 h1. is_paranoid ( same as it ever was )
 
+h3. advice and disclaimer
+
+You should always declare is_paranoid before any associations in your model unless you have a good reason for doing otherwise.  Some relationships might not behave properly if you fail to do so.  If you know what you're doing (and have written tests) and want to supress the warning then you can pass :suppress_load_order_warning => true as an option.
+
+<pre>
+  is_paranoid :suppress_load_order_warning => true
+</pre>
+
+You should never expect _any_ library to work or behave exactly how you want it to:  test, test, test and file an issue if you have any problems.  Bonus points if you include sample failing code.  Extra bonus points if you send a pull request that implements a feature/fixes a bug.
+
 h3. and you may ask yourself, well, how did I get here?
 
 Sometimes you want to delete something in ActiveRecord, but you realize you might need it later (for an undo feature, or just as a safety net, etc.).  There are a plethora of plugins that accomplish this, the most famous of which is the venerable acts_as_paranoid which is great but not really actively developed any more.  What's more, acts_as_paranoid was written for an older version of ActiveRecord and, with default_scope in 2.3, it is now possible to do the same thing with significantly less complexity.  Thus, *is_paranoid*.
@@ -17,7 +31,7 @@ If you're working with Rails, in your environment.rb, add the following to your
 <pre>
 Rails::Initializer.run do |config|
   # ...
-  config.gem "jchupp-is_paranoid", :lib => 'is_paranoid', :version => ">= 0.0.1"
+  config.gem "semanticart-is_paranoid", :lib => 'is_paranoid', :version => ">= 0.0.1"
 end
 </pre>
 
@@ -91,7 +105,7 @@ And now the validates_uniqueness_of will ignore items that are destroyed.
 
 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.
+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 file an issue or send a pull request.
 
 Currently on the todo list:
 * add options for merging additional default_scope options (i.e. order, etc.)
@@ -100,4 +114,4 @@ 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. 
 
-[defscope]http://ryandaigle.com/articles/2008/11/18/what-s-new-in-edge-rails-default-scoping
+[defscope]http://ryandaigle.com/articles/2008/11/18/what-s-new-in-edge-rails-default-scoping

data/Rakefile

@@ -11,7 +11,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = %q{goldstar-is_paranoid}
-    s.summary = %q{ActiveRecord 2.3 compatible gem "allowing you to hide and restore records without actually deleting them."  Yes, like acts_as_paranoid, only with less code and less complexity.  This particular Goldstar version is patched to not emit warnings with Rails 2.3.10.}
+    s.summary = %q{ActiveRecord 2.3 compatible gem "allowing you to hide and restore records without actually deleting them."  Yes, like acts_as_paranoid, only with less code and less complexity.}
     s.email = %q{jeff@semanticart.com}
     s.homepage = %q{http://github.com/jchupp/is_paranoid/}
     s.description = ""

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 0
+:patch: 6
 :major: 0
-:build: 1
 :minor: 9
+:build: 1

data/is_paranoid.gemspec

@@ -1,40 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{is_paranoid}
-  s.version = "0.9.0"
+  s.version = "0.9.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeffrey Chupp"]
-  s.date = %q{2009-06-13}
+  s.date = %q{2009-09-26}
   s.description = %q{}
   s.email = %q{jeff@semanticart.com}
   s.extra_rdoc_files = [
     "README.textile"
   ]
   s.files = [
-    "README.textile",
-    "Rakefile",
-    "VERSION.yml",
-    "lib/is_paranoid.rb",
-    "spec/database.yml",
-    "spec/is_paranoid_spec.rb",
-    "spec/models.rb",
-    "spec/schema.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "init.rb",
+     "is_paranoid.gemspec",
+     "lib/is_paranoid.rb",
+     "spec/database.yml",
+     "spec/is_paranoid_spec.rb",
+     "spec/models.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/jchupp/is_paranoid/}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{ActiveRecord 2.3 compatible gem "allowing you to hide and restore records without actually deleting them."  Yes, like acts_as_paranoid, only with less code and less complexity.}
   s.test_files = [
     "spec/is_paranoid_spec.rb",
-    "spec/models.rb",
-    "spec/schema.rb",
-    "spec/spec_helper.rb"
+     "spec/models.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/is_paranoid.rb

@@ -15,6 +15,10 @@ module IsParanoid
     class_inheritable_accessor :destroyed_field, :field_destroyed, :field_not_destroyed
     self.destroyed_field, self.field_destroyed, self.field_not_destroyed = opts[:field]
 
+    if self.reflect_on_all_associations.size > 0 && ! opts[:suppress_load_order_warning]
+      warn "is_paranoid warning in class #{self}:  You should declare is_paranoid before your associations"
+    end
+
     # This is the real magic. All calls made to this model will append
     # the conditions deleted_at => nil (or whatever your destroyed_field
     # and field_not_destroyed are). All exceptions require using
@@ -27,6 +31,25 @@ module IsParanoid
   end
 
   module ClassMethods
+    def is_or_equals_not_destroyed
+      if [nil, 'NULL'].include?(field_not_destroyed)
+        'IS NULL'
+      else
+        "= #{field_not_destroyed}"
+      end
+    end
+
+    # ensure that we respect the is_paranoid conditions when being loaded as a has_many :through
+    # NOTE: this only works if is_paranoid is declared before has_many relationships.
+    def has_many(association_id, options = {}, &extension)
+       if options.key?(:through)
+        conditions = "#{options[:through].to_s.pluralize}.#{destroyed_field} #{is_or_equals_not_destroyed}"
+        options[:conditions] = "(" + [options[:conditions], conditions].compact.join(") AND (") + ")"
+      end
+      super
+    end
+
+
     # Actually delete the model, bypassing the safety net. Because
     # this method is called internally by Model.delete(id) and on the
     # delete method in each instance, we don't need to specify those
@@ -60,8 +83,8 @@ module IsParanoid
       options.reverse_merge!({:include_destroyed_dependents => true}) unless options[:include]
       with_exclusive_scope do
         update_all(
-        "#{destroyed_field} = #{connection.quote(field_not_destroyed)}",
-        "id = #{id}"
+          "#{destroyed_field} = #{connection.quote(field_not_destroyed)}",
+          primary_key.to_sym => id
         )
       end
 
@@ -176,15 +199,30 @@ module IsParanoid
 
         self.class.send(
           :include,
-          Module.new{                                 # Example:
-            define_method name do |*args|             # def android_with_destroyed
-              parent_klass.first_with_destroyed(      #   Android.first_with_destroyed(
-                :conditions => {                      #     :conditions => {
-                  parent_klass.primary_key =>         #       :id =>
-                    self.send(assoc.primary_key_name) #         self.send(:android_id)
-                }                                     #     }
-              )                                       #   )
-            end                                       # end
+          Module.new {
+						if assoc.macro.to_s =~ /^has/
+							parent_method = assoc.macro.to_s =~ /^has_one/ ? 'first_with_destroyed' : 'all_with_destroyed'
+							                                            # Example:
+	            define_method name do |*args|               # def android_with_destroyed
+	              parent_klass.send("#{parent_method}",     #   Android.all_with_destroyed(
+	                :conditions => {                        #     :conditions => {
+	                  assoc.primary_key_name =>             #       :person_id =>
+	                    self.send(parent_klass.primary_key) #         self.send(:id)
+	                }                                       #     }
+	              )                                         #   )
+	            end                                         # end
+	
+						else
+                                                          # Example:
+	            define_method name do |*args|               # def android_with_destroyed
+	              parent_klass.first_with_destroyed(        #   Android.first_with_destroyed(
+	                :conditions => {                        #     :conditions => {
+	                  parent_klass.primary_key =>           #       :id =>
+	                    self.send(assoc.primary_key_name)   #         self.send(:android_id)
+	                }                                       #     }
+	              )                                         #   )
+	            end                                         # end
+						end
           }
         )
         self.send(name, *args, &block)
@@ -194,10 +232,10 @@ module IsParanoid
     end
 
     # Mark the model deleted_at as now.
-    def destroy_without_callbacks
+    def alt_destroy_without_callbacks
       self.class.update_all(
         "#{destroyed_field} = #{self.class.connection.quote(( field_destroyed.respond_to?(:call) ? field_destroyed.call : field_destroyed))}",
-        "id = #{self.id}"
+        self.class.primary_key.to_sym => self.id
       )
       self
     end
@@ -209,7 +247,7 @@ module IsParanoid
     # separately.
     def destroy
       return false if callback(:before_destroy) == false
-      result = destroy_without_callbacks
+      result = alt_destroy_without_callbacks
       callback(:after_destroy)
       self
     end

data/spec/database.yml

@@ -1,3 +1,3 @@
 test:
   :adapter: sqlite3
-  :dbfile: is_paranoid.db
+  :database: is_paranoid.db

data/spec/is_paranoid_spec.rb

@@ -17,6 +17,8 @@ describe IsParanoid do
 
     @r2d2.memories.create(:name => 'A pretty sunset')
     @c3p0.sticker = Sticker.create(:name => 'OMG, PONIES!')
+    @tatooine = Place.create(:name => "Tatooine")
+    @r2d2.places << @tatooine
   end
 
   describe 'non-is_paranoid models' do
@@ -69,6 +71,32 @@ describe IsParanoid do
         }.should change(Android, :count).from(2).to(0)
         Android.count_with_destroyed.should == 2
       end
+
+      it "shouldn't have problems with has_many :through relationships" do
+        # TODO: this spec can be cleaner and more specific, replace it later
+        # Dings use a boolean non-standard is_paranoid field
+        # Scratch uses the defaults.  Testing both ensures compatibility
+        [[:dings, Ding], [:scratches, Scratch]].each do |method, klass|
+          @r2d2.dings.should == []
+
+          dent = Dent.create(:description => 'really terrible', :android_id => @r2d2.id)
+          item = klass.create(:description => 'quite nasty', :dent_id => dent.id)
+          @r2d2.reload
+          @r2d2.send(method).should == [item]
+
+          dent.destroy
+          @r2d2.reload
+          @r2d2.send(method).should == []
+        end
+      end
+
+      it "should not choke has_and_belongs_to_many relationships" do
+        @r2d2.places.should include(@tatooine)
+        @tatooine.destroy
+        @r2d2.reload
+        @r2d2.places.should_not include(@tatooine)
+        Place.all_with_destroyed.should include(@tatooine)
+      end
     end
   end
 
@@ -203,6 +231,13 @@ describe IsParanoid do
       end
     end
 
+		it "should be able to access destroyed children" do
+			comps = @r2d2.components
+			comps.to_s # I have no idea why this makes it pass, but hey, here it is
+			@r2d2.components.first.destroy
+			@r2d2.components_with_destroyed.should == comps
+		end
+
     it "should return nil if no destroyed parent exists" do
       sticker = Sticker.new(:name => 'Rainbows')
       # because the default relationship works this way, i.e.
@@ -274,4 +309,11 @@ describe IsParanoid do
     end
 
   end
+
+  describe "alternate primary key" do
+    it "should destroy without problem" do
+      uuid = Uuid.create(:name => "foo")
+      uuid.destroy.should be_true
+    end
+  end
 end

data/spec/models.rb

@@ -4,12 +4,15 @@ class Person < ActiveRecord::Base #:nodoc:
 end
 
 class Android < ActiveRecord::Base #:nodoc:
+  is_paranoid
   validates_uniqueness_of :name
   has_many :components, :dependent => :destroy
   has_one :sticker
   has_many :memories, :foreign_key => 'parent_id'
-
-  is_paranoid
+  has_many :dents
+  has_many :dings, :through => :dents
+  has_many :scratches, :through => :dents
+  has_and_belongs_to_many :places
 
   # this code is to ensure that our destroy and restore methods
   # work without triggering before/after_update callbacks
@@ -19,6 +22,23 @@ class Android < ActiveRecord::Base #:nodoc:
   end
 end
 
+class Dent < ActiveRecord::Base #:nodoc:
+  is_paranoid
+  belongs_to :android
+  has_many :dings
+  has_many :scratches
+end
+
+class Ding < ActiveRecord::Base #:nodoc:
+  is_paranoid :field => [:not_deleted, true, false]
+  belongs_to :dent
+end
+
+class Scratch < ActiveRecord::Base #:nodoc:
+  is_paranoid
+  belongs_to :dent
+end
+
 class Component < ActiveRecord::Base #:nodoc:
   is_paranoid
   belongs_to :android, :dependent => :destroy
@@ -41,7 +61,7 @@ class Memory < ActiveRecord::Base #:nodoc:
   belongs_to :android, :class_name => "Android", :foreign_key => "parent_id"
 end
 
-class Sticker < ActiveRecord::Base #:nodoc
+class Sticker < ActiveRecord::Base #:nodoc:
   MM_NAME = "You've got method_missing"
 
   # this simply serves to ensure that we don't break method_missing
@@ -60,6 +80,14 @@ class AndroidWithScopedUniqueness < ActiveRecord::Base #:nodoc:
   is_paranoid
 end
 
+class Place < ActiveRecord::Base #:nodoc:
+  is_paranoid
+  has_and_belongs_to_many :androids
+end
+
+class AndroidsPlaces < ActiveRecord::Base #:nodoc:
+end
+
 class Ninja < ActiveRecord::Base #:nodoc:
   validates_uniqueness_of :name, :scope => :visible
   is_paranoid :field => [:visible, false, true]
@@ -91,4 +119,14 @@ class UndestroyablePirate < ActiveRecord::Base #:nodoc:
   def before_destroy
     false
   end
-end
+end
+
+class Uuid < ActiveRecord::Base #:nodoc:
+  set_primary_key "uuid"
+
+  def before_create
+    self.uuid = "295b3430-85b8-012c-cfe4-002332cf7d5e"
+  end
+
+  is_paranoid
+end

data/spec/schema.rb

@@ -7,6 +7,34 @@ ActiveRecord::Schema.define(:version => 20090317164830) do
     t.datetime "updated_at"
   end
 
+  create_table "dents", :force => true do |t|
+    t.integer  "android_id"
+    t.string   "description"
+    t.datetime "deleted_at"
+  end
+
+  create_table "dings", :force => true do |t|
+    t.integer  "dent_id"
+    t.string   "description"
+    t.boolean  "not_deleted"
+  end
+
+  create_table "scratches", :force => true do |t|
+    t.integer  "dent_id"
+    t.string   "description"
+    t.datetime "deleted_at"
+  end
+
+  create_table "androids_places", :force => true, :id => false do |t|
+    t.integer  "android_id"
+    t.integer  "place_id"
+  end
+
+  create_table "places", :force => true do |t|
+    t.string   "name"
+    t.datetime "deleted_at"
+  end
+
   create_table "people", :force => true do |t|
     t.string   "name"
     t.datetime "created_at"
@@ -48,4 +76,11 @@ ActiveRecord::Schema.define(:version => 20090317164830) do
     t.string   "name"
     t.boolean  "alive", :default => true
   end
+
+  create_table "uuids", :id => false, :force => true  do |t|
+    t.string   "uuid",     :limit => 36,  :primary => true
+    t.string   "name"
+    t.datetime "deleted_at"
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require "#{File.dirname(__FILE__)}/../lib/is_paranoid"
-require 'active_record'
+require 'activerecord'
 require 'yaml'
 require 'spec'
 
@@ -11,4 +11,4 @@ end
 
 # Open ActiveRecord connection
 connect('test')
-load(File.dirname(__FILE__) + "/schema.rb")
+load(File.dirname(__FILE__) + "/schema.rb")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: goldstar-is_paranoid
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 9
-  - 0
+  - 6
   - 1
-  version: 0.9.0.1
+  version: 0.9.6.1
 platform: ruby
 authors: 
 - Jeffrey Chupp
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 -05:00
+date: 2010-11-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ extensions: []
 extra_rdoc_files: 
 - README.textile
 files: 
+- .gitignore
 - CHANGELOG
 - MIT-LICENSE
 - README.textile
@@ -48,8 +49,8 @@ homepage: http://github.com/jchupp/is_paranoid/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -76,7 +77,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ActiveRecord 2.3 compatible gem "allowing you to hide and restore records without actually deleting them."  Yes, like acts_as_paranoid, only with less code and less complexity.  This particular Goldstar version is patched to not emit warnings with Rails 2.3.10.
+summary: ActiveRecord 2.3 compatible gem "allowing you to hide and restore records without actually deleting them."  Yes, like acts_as_paranoid, only with less code and less complexity.
 test_files: 
 - spec/is_paranoid_spec.rb
 - spec/models.rb