immortal 1.0.1 → 1.0.2

data/README.md

@@ -41,6 +41,7 @@ If you want to improve immortal
 
 ## CHANGELOG
 
+- 1.0.2 Added with/only_deleted singular association readers (see specs)
 - 1.0.1 Made compatible with Rails 3.1.X
 - 1.0.0 Changed the API, made it compatible with Rails 3.1, removed
   functionality

data/immortal.gemspec

@@ -3,8 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "immortal"
-  s.version     = '1.0.1'
-  s.platform    = Gem::Platform::RUBY
+  s.version     = '1.0.2'
   s.authors     = ["Jordi Romero", "Saimon Moore"]
   s.email       = ["jordi@jrom.net", "saimon@saimonmoore.net"]
   s.homepage    = "http://github.com/teambox/immortal"

data/lib/immortal.rb

@@ -1,3 +1,5 @@
+require 'immortal/belongs_to_builder'
+
 module Immortal
 
   def self.included(base)
@@ -5,6 +7,12 @@ module Immortal
     base.send :include, InstanceMethods
     base.class_eval do
       class << self
+
+        # Add with/how_deleted singular association readers
+        def belongs_to_mortal(name, options = {})
+          ::Immortal::BelongsToBuilder.build(self, name, options)
+        end
+
         # In has_many :through => join_model we have to explicitly add
         # the 'not deleted' scope, otherwise it will take all the rows
         # from the join model
@@ -17,6 +25,10 @@ module Immortal
         alias_method :has_many_immortal, :has_many
         alias_method :has_many, :has_many_mortal
 
+        alias_method :belongs_to_immortal, :belongs_to
+        alias_method :belongs_to, :belongs_to_mortal
+
+
         alias :mortal_delete_all :delete_all
         alias :delete_all :immortal_delete_all
       end

data/lib/immortal/belongs_to_builder.rb

@@ -0,0 +1,46 @@
+require 'active_record'
+require 'immortal/singular_association'
+
+module Immortal
+  class BelongsToBuilder < ::ActiveRecord::Associations::Builder::BelongsTo
+
+    def define_accessors
+      super
+      define_deletables
+    end
+
+    private
+
+      def define_deletables
+        define_with_deleted_reader
+        define_only_deleted_reader
+      end
+
+      def define_with_deleted_reader
+        name = self.name
+
+        model.redefine_method("#{name}_with_deleted") do |*params|
+          assoc = association(name)
+          assoc.send(:extend, SingularAssociation)
+          assoc.with_deleted_reader(*params)
+        end
+      end
+
+      def define_only_deleted_reader
+        name = self.name
+
+        model.redefine_method("#{name}_only_deleted") do |*params|
+
+          assoc = association(name)
+          assoc.send(:extend, SingularAssociation)
+          assoc.only_deleted_reader(*params)
+        end
+      end
+
+      module InstanceMethods
+
+      end #InstanceMethods
+
+  end
+end
+

data/lib/immortal/singular_association.rb

@@ -0,0 +1,57 @@
+module Immortal
+  module SingularAssociation
+    attr_reader :deleted_target
+
+    def with_deleted_reader(force_reload = false)
+      deleted_reader('with', force_reload)
+    end
+
+    def only_deleted_reader(force_reload = false)
+      deleted_reader('only', force_reload)
+    end
+
+    private
+
+        def deleted_reader(how, force_reload = false)
+          klass.uncached do
+            send(:"reload_#{how}_deleted")
+          end
+
+          deleted_target
+        end
+
+        def reload_with_deleted
+          reset
+          reset_scope
+          load_deleted_target('with')
+          self unless deleted_target.nil?
+        end
+
+        def reload_only_deleted
+          reset
+          reset_scope
+          load_deleted_target('only')
+          self unless deleted_target.nil?
+        end
+
+        def find_with_deleted_target
+          klass.unscoped do
+            scoped.first.tap { |record| set_inverse_instance(record) }
+          end
+        end
+
+        def find_only_deleted_target
+          klass.unscoped do
+            scoped.where(:deleted => true).first.tap { |record| set_inverse_instance(record) }
+          end
+        end
+
+        def load_deleted_target(how)
+          @deleted_target ||= send(:"find_#{how}_deleted_target")
+          deleted_target
+        rescue ActiveRecord::RecordNotFound
+          reset
+        end
+
+  end
+end

data/spec/immortal_spec.rb

@@ -198,4 +198,53 @@ describe Immortal do
     generated_sql.should include(join_sql2)
   end
 
+  it "should reload immortal polymorphic associations using default reader" do
+    node = ImmortalNode.create! :title => 'testing association 1'
+    target_1 = ImmortalSomeTarget.create! :title => 'target 1'
+    target_2 = ImmortalSomeOtherTarget.create! :title => 'target 2'
+
+    node.target.should be_nil
+    node.target = target_1
+    node.target.should == target_1
+
+    node.target_id = target_2.id
+    node.target_type = target_2.class.name
+
+    target_2.destroy
+    node.target.should be_nil
+  end
+
+  it "should reload immortal polymorphic associations using deleted reader" do
+    #setup
+    node = ImmortalNode.create! :title => 'testing association 1'
+    target_1 = ImmortalSomeTarget.create! :title => 'target 1'
+    target_2 = ImmortalSomeOtherTarget.create! :title => 'target 2'
+
+    #confirm initial state
+    node.target.should be_nil
+
+    #load target & confirm
+    node.target = target_1
+    node.target.should == target_1
+
+    #switch target indirectly
+    node.target_id = target_2.id
+    node.target_type = target_2.class.name
+
+    #don't assign directly and destroy new target
+    target_2.destroy
+
+    #Respect what's expected
+    node.target.should be_nil
+
+    #Ask for deleted target (or not deleted). Will NOT cache
+    node.target_with_deleted.should == target_2
+
+    #Ask only for deleted target. Will NOT cache
+    node.target_only_deleted.should == target_2
+
+    #Confirm we haven't invaded the target namespace
+    node.target.should be_nil
+  end
+
 end

data/spec/spec_helper.rb

@@ -36,11 +36,25 @@ begin
       t.timestamps
     end
     create_table :immortal_nodes do |t|
+      t.integer :target_id
+      t.string :target_type
       t.string :title
       t.integer :value
       t.boolean :deleted, :default => false
       t.timestamps
     end
+
+    create_table :immortal_some_targets do |t|
+      t.string :title
+      t.boolean :deleted, :default => false
+      t.timestamps
+    end
+
+    create_table :immortal_some_other_targets do |t|
+      t.string :title
+      t.boolean :deleted, :default => false
+      t.timestamps
+    end
   end
 ensure
   $stdout = old_stdout
@@ -61,8 +75,23 @@ class ImmortalNode < ActiveRecord::Base
   
   has_many :joins, :class_name => 'ImmortalJoin'
   has_many :models, :through => :joins, :source => :immortal_model
+
+  belongs_to :target, :polymorphic => true
+end
+
+class ImmortalSomeTarget < ActiveRecord::Base
+  include Immortal
+
+  has_many :immortal_nodes, :as => :target
 end
 
+class ImmortalSomeOtherTarget < ActiveRecord::Base
+  include Immortal
+
+  has_many :immortal_nodes, :as => :target
+end
+
+
 class ImmortalModel < ActiveRecord::Base
   include Immortal
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immortal
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70094483448900 !ruby/object:Gem::Requirement
+  requirement: &70147088431320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70094483448900
+  version_requirements: *70147088431320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70094483448420 !ruby/object:Gem::Requirement
+  requirement: &70147088430840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70094483448420
+  version_requirements: *70147088430840
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70094483448040 !ruby/object:Gem::Requirement
+  requirement: &70147088430460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094483448040
+  version_requirements: *70147088430460
 description: Typical paranoid gem built for Rails 3 and with the minimum code needed
   to satisfy acts_as_paranoid's API
 email:
@@ -61,6 +61,8 @@ files:
 - Rakefile
 - immortal.gemspec
 - lib/immortal.rb
+- lib/immortal/belongs_to_builder.rb
+- lib/immortal/singular_association.rb
 - spec/immortal_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/teambox/immortal