ar-simple-idmap 0.2.2 → 0.2.4

data/.gitignore

@@ -1,4 +1,7 @@
 spec/debug.log
 .DS_Store
-spec/db/*.sqlite*
+spec/*.sqlite*
+pkg
+rdoc
+testapp
 *~

data/README

@@ -1,10 +1,8 @@
-IdentityMap
-===========
+= IdentityMap
 
 Adds simple hand controlled identity map for ActiveRecord.
 
-Installing
-==========
+== Installing
 
 in Rails 2.3 in config/environment.rb
 
@@ -14,8 +12,7 @@ in Rails 3 in Gemfile
 
     gem 'ar-simple-idmap', :require => 'identity_map'
 
-Enabling
-========    
+== Enabling
     
 To enable in ApplicationController (it is not enabled by default).
 
@@ -73,10 +70,17 @@ you could temporary disable it:
       # all things here goes without identity map
       # not only for Client
     end
+    
+    class ClientsController
+      def strange_action
+        without_identity_map do
+          do_strange_things_without_identity_map
+        end
+      end
+    end
 
 
-Copyright
-=========
+== Copyright
 
 inspired by http://github.com/pjdavis/identity-map
 Copyright (c) 2010 Sokolov Yura aka funny_falcon, released under the MIT license.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.4

data/lib/identity_map/action_controller/dispatcher.rb

@@ -1,54 +1,116 @@
-module ActionController
-  class Base
-  	module IdentityMap
-  	  module InstanceMethods
-		def with_identity_map
-		  ActiveRecord::Base.with_id_map {
-			yield
-		  }
-		end
-		
-		def without_identity_map
-		  ActiveRecord::Base.without_id_map {
-			yield
-		  }
-		end
-	  end
-  	  
-  	  module ClassMethods
-  	  	def use_identity_map(*args)
-  	  	  around_filter :with_identity_map, *args
-  	  	end
-  	  	
-  	  	def dont_use_identity_map(*args)
-  	  	  around_filter :without_identity_map, *args
-  	  	end
-  	  	
-  	  	def use_dispater_identity_map
-  	  	  if defined? ::ActionDispatch
-  	  	  	ActionDispatch::Callbacks.before :create_identity_map
-  	  	  	ActionDispatch::Callbacks.after :remove_identity_map
-  	  	  else
-  	  	  	ActionController::Dispatcher.before_dispatch :create_identity_map
-  	  	  	ActionController::Dispatcher.after_dispatch :remove_identity_map
-  	  	  end
-  	  	end
-  	  end
-  	  
+module ActionController # :nodoc:
+  class Base # :nodoc:
+    module IdentityMap # :nodoc:
+      module InstanceMethods
+        # Execute block with identity map.
+        #
+        # If it called with +true+, then new instance of identity map would be used
+        # regardless of any present.
+        #
+        # If it called with +false+, then it only ensures that identity map created if absent.
+        #
+        # Default is +true+
+        #
+        # Typical usage is around filter, which is most times better than direct call.
+        # 
+        # Usage:
+        #   class ThingsController
+        #     def action1
+        #       with_identity_map do
+        #         #some_actions
+        #       end
+        #     end
+        #     #around_filter :with_identity_map, :only => :action2
+        #     use_identity_map :only => :action2
+        #     def action2
+        #       #some_actions
+        #     end
+        #   end
+        #
+        # Method declared as a helper method, so could be used in a views.  
+        def with_identity_map( fresh = true )
+          ActiveRecord::Base.with_id_map(fresh) {
+            yield
+          }
+        end
+        
+        # Temporary disables identity map.
+        #
+        # Could be used if identity map introduced undesired behaviour.
+        #
+        # Usage:
+        #   class ThingsController
+        #     def action1
+        #       without_identity_map do
+        #         #some_actions
+        #       end
+        #     end
+        #     around_filter :without_identity_map, :only => :action2
+        #     def action2
+        #       #some_actions
+        #     end
+        #   end
+        # Method declared as a helper method, so could be used in a views.  
+        def without_identity_map
+          ActiveRecord::Base.without_id_map {
+            yield
+          }
+        end
+      end
+      
+      module ClassMethods
+        # Puts around filter which is enable identity map usage for actions.
+        #
+        # <tt>use_identity_map *args</tt> is shorthand for <tt>around_filter :with_identity_map, *args</tt>
+        #
+        # Typically you could put it in a ApplicationController
+        #   class ApplicationController
+        #     use_identity_map
+        #   end
+        def use_identity_map(*args)
+          around_filter :with_identity_map, *args
+        end
+        
+        # Puts around filter which is disable identity map usage for actions.
+        #
+        # <tt>dont_use_identity_map *args</tt> is shorthand for <tt>around_filter :without_identity_map, *args</tt>
+        #
+        # Typically you would call it if undesired behaviour were introduced by identity_map
+        #   class ThingsController
+        #     dont_use_identity_map :only => :some_strange_action
+        #   end
+        def dont_use_identity_map(*args)
+          around_filter :without_identity_map, *args
+        end
+        
+        # Put identity map creation onto lower level, actually on a dispatcher
+        # may be for use in a Metal or Rack actions
+        def use_dispatcher_identity_map
+          if defined? ::ActionDispatch
+            ActionDispatch::Callbacks.before :create_identity_map
+            ActionDispatch::Callbacks.after :remove_identity_map
+          else
+            ActionController::Dispatcher.before_dispatch :create_identity_map
+            ActionController::Dispatcher.after_dispatch :remove_identity_map
+          end
+        end
+      end
+      
 
-  	end
-  	extend IdentityMap::ClassMethods
-  	include IdentityMap::InstanceMethods
+    end
+    extend IdentityMap::ClassMethods
+    include IdentityMap::InstanceMethods
+    helper_method :with_identity_map, :without_identity_map
   end
 end
-
+# :enddoc:
 module DispatcherMethods
   def create_identity_map
-	ActiveRecord::Base.create_identity_map
+    ActiveRecord::Base.create_identity_map
   end
   
   def remove_identity_map
-	ActiveRecord::Base.drop_identity_map
+    ActiveRecord::Base.drop_identity_map
   end
 end
 

data/lib/identity_map/active_record/base.rb

@@ -1,22 +1,37 @@
-module ActiveRecord
-  class Base
-    module IdentityMap
+module ActiveRecord # :nodoc:
+  class Base # :nodoc:
+    module IdentityMap # :nodoc:
       module ClassMethods
         private
-          def use_id_map
+          # Prepares model for work with identity map. 
+          # If you want to turn on identity map for certain classes (recomended)
+          # you should do like this:
+          #
+          #   class Address
+          #     use_id_map
+          #   end
+          #
+          # If you want to turn on identity map for all ActiveRecord models (not recomended)
+          # you should put in some initializator:
+          #
+          #   class ActiveRecord::Base
+          #     use_id_map
+          #   end
+          def use_id_map() # :doc:
             unless is_a? IdMapClassMethods
-                extend IdMapClassMethods
-                include IdMapInstanceMethods
-                class << self
-                  alias_method_chain :find, :identity_map
-                  alias_method_chain :instantiate, :identity_map
-                end
-                alias_method_chain :create, :identity_map
-                alias_method_chain :destroy, :identity_map
+              extend IdMapClassMethods
+              include IdMapInstanceMethods
+              class << self
+                alias_method_chain :find, :identity_map
+                alias_method_chain :instantiate, :identity_map
+              end
+              alias_method_chain :create, :identity_map
+              alias_method_chain :destroy, :identity_map
             end
           end
       end
       
+      # :enddoc:
       module IdMapClassMethods
 
         def id_map
@@ -29,10 +44,17 @@ module ActiveRecord
         end
         
         private
+        
+          def fetch_single(map, id)
+            if (obj = map[id]) && obj.attribute_names == column_names
+              obj
+            end
+          end
+        
           def fetch_from_map(map, ids)
             result, not_cached = [], []
             ids.each do |id|
-              if ( obj = map[id] )
+              if ( obj = fetch_single(map, id) )
                 result << obj
               else
                 not_cached << id
@@ -74,7 +96,7 @@ module ActiveRecord
                     end
                   end
                 else
-                  map[ids]
+                  fetch_single(map, ids)
                 end
               end
             end || find_without_identity_map(*args)

data/lib/identity_map/cache.rb

@@ -1,89 +1,116 @@
-module ActiveRecord
-  class Base
-  	module ThreadIdentityMap
-	  class ClassIdMap
-		def initialize(klass)
-		  @objects = {}
-		  @object = klass.allocate
-		  @object.instance_variable_set(:@attributes, {:id=>nil})
-		  @object.instance_variable_set(:@attributes_cache, {})
-		end
-		
-		def [](id)
-		  @object.id = id
-		  @objects[@object.id]
-		end
-		
-		def []=(id, v)
-		  @object.id = id
-		  @objects[@object.id] = v
-		end
-		
-		def delete(id)
-		  @object.id = id
-		  @objects.delete(@object.id)
-		end
-	  end
-	  
-	  class IdMap
-	  
-		def initialize
-		  @objects = {}
-		end
-	  
-		def for_class(klass)
-		  @objects[ klass.base_class ] ||= ClassIdMap.new(klass)
-		end
-		
-	  end
-	  
-	  module ClassMethods
-	  	def create_identity_map
-	  	  set_thread_id_map IdMap.new
-	  	end
-	  	
-	  	def drop_identity_map
-	  	  set_thread_id_map nil
-	  	end
-	  	
-		def with_id_map( fresh = true)
-		  old = thread_id_map
-		  create_identity_map if fresh || old.nil?
-		  yield
-		ensure
-		  set_thread_id_map old
-		end
-		
-		def without_id_map
-		  old = thread_id_map
-		  drop_identity_map
-		  yield
-		ensure
-		  set_thread_id_map old
-		end
-		
-#		def uncached_with_identity_map( &block )
-#		  without_id_map do
-#		  	uncached_without_identity_map &block
-#		  end
-#		end
-		
-		protected
-		
-		  def thread_id_map
-			Thread.current[:ar_identity_map]
-		  end
-		  
-		  def thread_id_map=(v)
-			Thread.current[:ar_identity_map] = v
-		  end
-		  
-		  alias set_thread_id_map thread_id_map=
-		
-	  end
+module ActiveRecord # :nodoc:
+  class Base # :nodoc:
+    module ThreadIdentityMap # :nodoc:
+      # ClassIdMap do the job of properly use typecasted +id+ value of model object
+      # for search in a cache
+      class ClassIdMap
+        def initialize(klass)
+          @objects = {}
+          @object = klass.allocate
+          @object.instance_variable_set(:@attributes, {:id=>nil})
+          @object.instance_variable_set(:@attributes_cache, {})
+        end
+        
+        def [](id)
+          @object.id = id
+          @objects[@object.id]
+        end
+        
+        def []=(id, v)
+          @object.id = id
+          @objects[@object.id] = v
+        end
+        
+        def delete(id)
+          @object.id = id
+          @objects.delete(@object.id)
+        end
+      end
+      
+      # Manages separated object caches for each model
+      class IdMap
+      
+        def initialize
+          @objects = {}
+        end
+      
+        def for_class(klass)
+          @objects[ klass.base_class ] ||= ClassIdMap.new(klass)
+        end
+        
+      end
+      
+      module ClassMethods
+        # Creates new identity map and put it in thread local storage
+        #
+        # For most use cases +with_id_map+ should be used instead.
+        #
+        # Usage:
+        #   ActiveRecord::Base.create_identity_map
+        def create_identity_map
+          set_thread_id_map IdMap.new
+        end
+        
+        # Remove identity map from thread local storage
+        #
+        # For most use cases +without_id_map+ should be used instead.
+        #
+        # Usage:
+        #   ActiveRecord::Base.drop_identity_map
+        def drop_identity_map
+          set_thread_id_map nil
+        end
+        
+        # Execute block with identity map.
+        #
+        # If it called with +true+, then new instance of identity map would be used
+        # regardless of any present.
+        #
+        # If it called with +false+, then it only ensures that identity map created if absent.
+        #
+        # Default is +true+
+        #
+        # Usage:
+        #   ActiveRecord::Base.with_id_map do
+        #     #do_some_actions
+        #   end
+        def with_id_map( fresh = true)
+          old = thread_id_map
+          create_identity_map if fresh || old.nil?
+          yield
+        ensure
+          set_thread_id_map old
+        end
+        
+        # Execute block with identity map turned off.
+        #
+        # Usage:
+        #   ActiveRecord::Base.without_id_map do
+        #     #do_some_actions
+        #   end
+        def without_id_map
+          old = thread_id_map
+          drop_identity_map
+          yield
+        ensure
+          set_thread_id_map old
+        end
+        
+        protected
+        
+          def thread_id_map
+            Thread.current[:ar_identity_map]
+          end
+          
+          def thread_id_map=(v)
+            Thread.current[:ar_identity_map] = v
+          end
+          
+          alias set_thread_id_map thread_id_map=
+        
+      end
     end
-	
-	extend ThreadIdentityMap::ClassMethods
-#	self.class.send :alias_method_chain, :uncached, :identity_map
+    
+    extend ThreadIdentityMap::ClassMethods
   end
 end

data/spec/identity_map_spec.rb

@@ -12,124 +12,132 @@ describe "Customers" do
 		c1.__id__.should == c2.__id__
 	end
     
-    it "should fetch loaded model from cache" do
-        c1 = Customer.first
-        Customer.connection.should_not_receive(:select_all)
-        c2 = Customer.find(c1.id)
-    end
+  it "should fetch loaded model from cache" do
+    c1 = Customer.first
+    Customer.connection.should_not_receive(:select_all)
+    c2 = Customer.find(c1.id)
+  end
 	
 	it "should work for has_many associations" do
 		p1 = PhoneNumber.first
 		ps = Customer.first.phone_numbers
-        p2 = ps.first
+    p2 = ps.first
 		p1.__id__.should == p2.__id__
 	end
 	
 	it "should work for belongs_to assocations" do
 		d1 = Customer.first
 		p1 = PhoneNumber.first
-        Customer.connection.should_not_receive(:select_all)
-        d2 = p1.customer
+    Customer.connection.should_not_receive(:select_all)
+    d2 = p1.customer
 		d1.__id__.should == d2.target.__id__
 	end
     
-    it "should fetch same model with not handled conditions" do
-        d1 = Customer.first
-        d2 = Customer.find(:first, :conditions=>["id = ?", d1.id])
-        d1.__id__.should == d2.__id__
-    end
+  it "should fetch same model with not handled conditions" do
+    d1 = Customer.first
+    d2 = Customer.find(:first, :conditions=>["id = ?", d1.id])
+    d1.__id__.should == d2.__id__
+  end
+  
+  it "should refetch to fill missed attributes" do
+    d1 = Customer.find(:first, :select => 'id, name')
+    d1.read_attribute(:value).should be_nil
+    d2 = Customer.find(d1.id)
+    d2.__id__.should == d1.__id__
+    d1.value.should_not be_nil
+  end
 	
-    describe "creation and deletion:" do
-        before(:each) do
-            @billy = Customer.create(:name => "billy")
-        end
-        
-        it "should work for creating objects" do
-            c2 = Customer.find_by_name("billy")
-            @billy.__id__.should == c2.__id__
-            Customer.connection.should_not_receive(:select_all)
-            c3 = Customer.find(@billy.id)
-            @billy.__id__.should == c3.__id__
-        end
-	
-        it "should work for destroyed objects" do
-            @billy.destroy
-            c2 = Customer.find_by_id(@billy.id)
-            c2.should be_nil
-        end
-        
-        it "should reload adequatly" do
-            Customer.connection.update_sql('update customers set value=2;')
-            @billy.reload
-            @billy.value.should == 2
-        end
-        
-        it "should leave changed columns" do
-            @billy.value = 3
-            b = Customer.find_by_name("billy")
-            b.value.should == 3
-            b.value_changed?.should be_true
-            b.changes.should == {'value'=>[1,3]}
-            Customer.connection.update_sql('update customers set value=2;')
-            b = Customer.find_by_name("billy")
-            b.changes.should == {'value'=>[2,3]}
-        end
-        
-        after(:each) do
-            @billy.destroy unless @billy.destroyed?
-        end
+  context "creation and deletion:" do
+    before(:each) do
+      @billy = Customer.create(:name => "billy")
+    end
+    
+    it "should work for creating objects" do
+      c2 = Customer.find_by_name("billy")
+      @billy.__id__.should == c2.__id__
+      Customer.connection.should_not_receive(:select_all)
+      c3 = Customer.find(@billy.id)
+      @billy.__id__.should == c3.__id__
+    end
+
+    it "should work for destroyed objects" do
+      @billy.destroy
+      c2 = Customer.find_by_id(@billy.id)
+      c2.should be_nil
+    end
+    
+    it "should reload adequatly" do
+      Customer.connection.update_sql('update customers set value=2;')
+      @billy.reload
+      @billy.value.should == 2
+    end
+    
+    it "should leave changed columns" do
+      @billy.value = 3
+      b = Customer.find_by_name("billy")
+      b.value.should == 3
+      b.value_changed?.should be_true
+      b.changes.should == {'value'=>[1,3]}
+      Customer.connection.update_sql('update customers set value=2;')
+      b = Customer.find_by_name("billy")
+      b.changes.should == {'value'=>[2,3]}
+    end
+    
+    after(:each) do
+      @billy.destroy unless @billy.destroyed?
+    end
 	end
     
-    describe "switching identity map:" do
-        it "should disable id_map with `without_id_map`" do
-            c1, c2, c3 = Customer.first, nil, nil
-            Customer.without_id_map do
-              c2 = Customer.first
-              c3 = Customer.first
-            end
-            c1.__id__.should_not == c2.__id__
-            c1.__id__.should_not == c3.__id__
-            c3.__id__.should_not == c2.__id__
-        end
-        
-        it "should use current id_map with `with_id_map(false)`" do
-            c1, c2, c3 = Customer.first, nil, nil
-            Customer.with_id_map(false) do
-              c2 = Customer.first
-              Customer.connection.should_not_receive(:select_all)
-              c3 = Customer.find(c2.id)
-            end
-            c1.__id__.should == c2.__id__
-            c1.__id__.should == c3.__id__
-            c3.__id__.should == c2.__id__
-        end
-        
-        it "should create new id_map with `with_id_map`" do
-            c1, c2, c3 = Customer.first, nil, nil
-            Customer.with_id_map do
-              c2 = Customer.first
-              Customer.connection.should_not_receive(:select_all)
-              c3 = Customer.find(c2.id)
-            end
-            c1.__id__.should_not == c2.__id__
-            c1.__id__.should_not == c3.__id__
-            c3.__id__.should == c2.__id__
-        end
-        
-        it "should reenable id_map with `with_id_map`" do
-            c1, c2, c3 = Customer.first, nil, nil
-            Customer.without_id_map do
-                Customer.with_id_map do
-                  c2 = Customer.first
-                  Customer.connection.should_not_receive(:select_all)
-                  c3 = Customer.find(c2.id)
-                end
-            end
-            c1.__id__.should_not == c2.__id__
-            c1.__id__.should_not == c3.__id__
-            c3.__id__.should == c2.__id__
+  context "switching identity map:" do
+    it "should disable id_map with `without_id_map`" do
+      c1, c2, c3 = Customer.first, nil, nil
+      Customer.without_id_map do
+        c2 = Customer.first
+        c3 = Customer.first
+      end
+      c1.__id__.should_not == c2.__id__
+      c1.__id__.should_not == c3.__id__
+      c3.__id__.should_not == c2.__id__
+    end
+    
+    it "should use current id_map with `with_id_map(false)`" do
+      c1, c2, c3 = Customer.first, nil, nil
+      Customer.with_id_map(false) do
+        c2 = Customer.first
+        Customer.connection.should_not_receive(:select_all)
+        c3 = Customer.find(c2.id)
+      end
+      c1.__id__.should == c2.__id__
+      c1.__id__.should == c3.__id__
+      c3.__id__.should == c2.__id__
+    end
+    
+    it "should create new id_map with `with_id_map`" do
+      c1, c2, c3 = Customer.first, nil, nil
+      Customer.with_id_map do
+        c2 = Customer.first
+        Customer.connection.should_not_receive(:select_all)
+        c3 = Customer.find(c2.id)
+      end
+      c1.__id__.should_not == c2.__id__
+      c1.__id__.should_not == c3.__id__
+      c3.__id__.should == c2.__id__
+    end
+    
+    it "should reenable id_map with `with_id_map`" do
+      c1, c2, c3 = Customer.first, nil, nil
+      Customer.without_id_map do
+        Customer.with_id_map do
+          c2 = Customer.first
+          Customer.connection.should_not_receive(:select_all)
+          c3 = Customer.find(c2.id)
         end
+      end
+      c1.__id__.should_not == c2.__id__
+      c1.__id__.should_not == c3.__id__
+      c3.__id__.should == c2.__id__
     end
+  end
     
 	after(:each) do
 		ActiveRecord::Base.drop_identity_map

data/spec/spec.opts

@@ -1,4 +1,2 @@
 --colour
---format progress
---loadby mtime
---reverse
+--format nested

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
 require 'rubygems'
-require 'spec'
+begin
+  require 'spec'
+rescue LoadError
+  require 'rspec'
+end
 require 'active_support'
 require 'active_support/test_case'
 require 'active_record'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar-simple-idmap
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Sokolov Yura aka funny_falcon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-26 00:00:00 +04:00
+date: 2010-09-21 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,6 @@ files:
 - VERSION
 - init.rb
 - install.rb
-- lib/autotest/discover.rb
 - lib/identity_map.rb
 - lib/identity_map/action_controller/dispatcher.rb
 - lib/identity_map/active_record/base.rb
@@ -91,5 +90,5 @@ signing_key:
 specification_version: 3
 summary: Simple identity map for ActiveRecord
 test_files: 
-- spec/spec_helper.rb
 - spec/identity_map_spec.rb
+- spec/spec_helper.rb

data/lib/autotest/discover.rb

@@ -1,5 +0,0 @@
-$:.push(File.join(File.dirname(__FILE__), %w[.. .. rspec]))
-
-Autotest.add_discovery do
-  "rspec"
-end