interlock 1.2 → 1.3

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v1.3. Add basic finder memoization.
+
 v1.2. Add compatibility with Memcached client.
 
 v1.1. Add :perform => false option. Cache :content_for. Test nested view_cache blocks. Don't assign conventional dependency when called from the view, because we don't know what the controller might have already specified.

data/Manifest

@@ -6,8 +6,10 @@ lib/interlock/action_view.rb
 lib/interlock/active_record.rb
 lib/interlock/config.rb
 lib/interlock/core_extensions.rb
+lib/interlock/finders.rb
 lib/interlock/interlock.rb
 lib/interlock/lock.rb
+lib/interlock/pass_through_store.rb
 lib/interlock.rb
 LICENSE
 Manifest
@@ -77,6 +79,7 @@ test/integration/server_test.rb
 test/setup.rb
 test/teardown.rb
 test/test_helper.rb
+test/unit/finder_test.rb
 test/unit/interlock_test.rb
 test/unit/lock_test.rb
 TODO

data/README

@@ -19,11 +19,15 @@ If you use this software, please {make a donation}[http://blog.evanweaver.com/do
 
 Note that Rails 2.0.2 is required for caching <tt>content_for</tt> or nesting <tt>view_cache</tt> blocks.
 
-== What it does
+== Features
 
-Interlock makes your view fragments and associated controller blocks march along together. If a fragment is fresh, the controller behavior won't run. This eliminates duplicate effort from your request cycle. Your controller blocks run so infrequently that you can use regular ActiveRecord finders and not worry about object caching at all.
+Interlock is an intelligent fragment cache for Rails. 
 
-Interlock automatically tracks invalidation dependencies based on the model lifecyle, and supports arbitrary levels of scoping per-block. It also caches <tt>content_for</tt> calls, unlike regular Rails.
+It works by making your view fragments and associated controller blocks march along together. If a fragment is fresh, the controller behavior won't run. This eliminates duplicate effort from your request cycle. Your controller blocks run so infrequently that you can use regular ActiveRecord finders and not worry about object caching at all.
+
+Invalidations are automatically tracked based on the model lifecyle, and you can scope any block to an arbitrary level. Interlock also caches <tt>content_for</tt> calls, unlike regular Rails, and can optionally cache simple finders.
+
+Interlock uses a tiered caching layer so that multiple lookups of a key only hit memcached once per request.
 
 == Installation
   
@@ -87,6 +91,18 @@ You can use multiple instance variables in one block, of course. Just make sure
 
 See ActionController::Base and ActionView::Helpers::CacheHelper for more details.
 
+== Caching finders
+
+Interlock 1.3 adds the ability to cache simple finder lookups. Add this line in <tt>config/memcached.yml</tt>:
+
+  with_finders: true
+  
+Now, whenever you call <b>find</b>, <b>find_by_id</b>, or <b>find_all_by_id</b> with a single id or an array of ids, the cache will be used. The cache key for each record invalidates when the record is saved or destroyed. Memcached's multiget mode is used for maximum performance.
+
+If you pass any parameters other than ids, or use dynamic finders, the cache will not be used. This means that <tt>:include</tt> works as expected and does not require complicated invalidation. 
+
+See Interlock::Finders for more.
+
 == Notes
 
 You will not see any actual cache reuse in development mode unless you set <tt>config.action_controller.perform_caching = true</tt> in <tt>config/environments/development.rb</tt>.

data/TODO

@@ -1,6 +1,11 @@
 
-* Add test coverage of STI child classes
+Soon:
+
+* Throw a nice error message when the requested memcache client cannot be found
 * Add anti-dogpiling logic
-* Possibly memoize single-id finders, either per-action or globally with automatic invalidations
+
+Someday:
+
+* Add test coverage of STI child classes
 * Figure out how to cache Builder blocks
 * Figure out how to cache RJS

data/interlock.gemspec

@@ -1,26 +1,26 @@
 
-# Gem::Specification for Interlock-1.2
+# Gem::Specification for Interlock-1.3
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{interlock}
-  s.version = "1.2"
+  s.version = "1.3"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [""]
-  s.date = %q{2008-02-04}
+  s.date = %q{2008-03-02}
   s.description = %q{A Rails plugin for maintainable and high-efficiency caching.}
   s.email = %q{}
-  s.files = ["CHANGELOG", "examples/memcached.yml", "init.rb", "lib/interlock/action_controller.rb", "lib/interlock/action_view.rb", "lib/interlock/active_record.rb", "lib/interlock/config.rb", "lib/interlock/core_extensions.rb", "lib/interlock/interlock.rb", "lib/interlock/lock.rb", "lib/interlock.rb", "LICENSE", "Manifest", "README", "tasks/interlock.rake", "test/integration/app/app/controllers/application.rb", "test/integration/app/app/controllers/eval_controller.rb", "test/integration/app/app/controllers/items_controller.rb", "test/integration/app/app/helpers/application_helper.rb", "test/integration/app/app/helpers/eval_helper.rb", "test/integration/app/app/helpers/items_helper.rb", "test/integration/app/app/models/item.rb", "test/integration/app/app/views/items/detail.rhtml", "test/integration/app/app/views/items/list.rhtml", "test/integration/app/app/views/items/recent.rhtml", "test/integration/app/app/views/items/show.rhtml", "test/integration/app/app/views/layouts/application.html.erb", "test/integration/app/app/views/shared/_related.rhtml", "test/integration/app/config/boot.rb", "test/integration/app/config/database.yml", "test/integration/app/config/environment.rb", "test/integration/app/config/environments/development.rb", "test/integration/app/config/environments/production.rb", "test/integration/app/config/environments/test.rb", "test/integration/app/config/initializers/inflections.rb", "test/integration/app/config/initializers/mime_types.rb", "test/integration/app/config/memcached.yml", "test/integration/app/config/routes.rb", "test/integration/app/db/migrate/001_create_items.rb", "test/integration/app/doc/README_FOR_APP", "test/integration/app/public/404.html", "test/integration/app/public/422.html", "test/integration/app/public/500.html", "test/integration/app/public/dispatch.cgi", "test/integration/app/public/dispatch.fcgi", "test/integration/app/public/dispatch.rb", "test/integration/app/public/favicon.ico", "test/integration/app/public/images/rails.png", "test/integration/app/public/index.html", "test/integration/app/public/javascripts/application.js", "test/integration/app/public/javascripts/controls.js", "test/integration/app/public/javascripts/dragdrop.js", "test/integration/app/public/javascripts/effects.js", "test/integration/app/public/javascripts/prototype.js", "test/integration/app/public/robots.txt", "test/integration/app/Rakefile", "test/integration/app/README", "test/integration/app/script/about", "test/integration/app/script/console", "test/integration/app/script/destroy", "test/integration/app/script/generate", "test/integration/app/script/performance/benchmarker", "test/integration/app/script/performance/profiler", "test/integration/app/script/performance/request", "test/integration/app/script/plugin", "test/integration/app/script/process/inspector", "test/integration/app/script/process/reaper", "test/integration/app/script/process/spawner", "test/integration/app/script/runner", "test/integration/app/script/server", "test/integration/app/test/fixtures/items.yml", "test/integration/app/test/functional/eval_controller_test.rb", "test/integration/app/test/functional/items_controller_test.rb", "test/integration/app/test/test_helper.rb", "test/integration/app/test/unit/item_test.rb", "test/integration/server_test.rb", "test/setup.rb", "test/teardown.rb", "test/test_helper.rb", "test/unit/interlock_test.rb", "test/unit/lock_test.rb", "TODO", "interlock.gemspec"]
+  s.files = ["CHANGELOG", "examples/memcached.yml", "init.rb", "lib/interlock/action_controller.rb", "lib/interlock/action_view.rb", "lib/interlock/active_record.rb", "lib/interlock/config.rb", "lib/interlock/core_extensions.rb", "lib/interlock/finders.rb", "lib/interlock/interlock.rb", "lib/interlock/lock.rb", "lib/interlock/pass_through_store.rb", "lib/interlock.rb", "LICENSE", "Manifest", "README", "tasks/interlock.rake", "test/integration/app/app/controllers/application.rb", "test/integration/app/app/controllers/eval_controller.rb", "test/integration/app/app/controllers/items_controller.rb", "test/integration/app/app/helpers/application_helper.rb", "test/integration/app/app/helpers/eval_helper.rb", "test/integration/app/app/helpers/items_helper.rb", "test/integration/app/app/models/item.rb", "test/integration/app/app/views/items/detail.rhtml", "test/integration/app/app/views/items/list.rhtml", "test/integration/app/app/views/items/recent.rhtml", "test/integration/app/app/views/items/show.rhtml", "test/integration/app/app/views/layouts/application.html.erb", "test/integration/app/app/views/shared/_related.rhtml", "test/integration/app/config/boot.rb", "test/integration/app/config/database.yml", "test/integration/app/config/environment.rb", "test/integration/app/config/environments/development.rb", "test/integration/app/config/environments/production.rb", "test/integration/app/config/environments/test.rb", "test/integration/app/config/initializers/inflections.rb", "test/integration/app/config/initializers/mime_types.rb", "test/integration/app/config/memcached.yml", "test/integration/app/config/routes.rb", "test/integration/app/db/migrate/001_create_items.rb", "test/integration/app/doc/README_FOR_APP", "test/integration/app/public/404.html", "test/integration/app/public/422.html", "test/integration/app/public/500.html", "test/integration/app/public/dispatch.cgi", "test/integration/app/public/dispatch.fcgi", "test/integration/app/public/dispatch.rb", "test/integration/app/public/favicon.ico", "test/integration/app/public/images/rails.png", "test/integration/app/public/index.html", "test/integration/app/public/javascripts/application.js", "test/integration/app/public/javascripts/controls.js", "test/integration/app/public/javascripts/dragdrop.js", "test/integration/app/public/javascripts/effects.js", "test/integration/app/public/javascripts/prototype.js", "test/integration/app/public/robots.txt", "test/integration/app/Rakefile", "test/integration/app/README", "test/integration/app/script/about", "test/integration/app/script/console", "test/integration/app/script/destroy", "test/integration/app/script/generate", "test/integration/app/script/performance/benchmarker", "test/integration/app/script/performance/profiler", "test/integration/app/script/performance/request", "test/integration/app/script/plugin", "test/integration/app/script/process/inspector", "test/integration/app/script/process/reaper", "test/integration/app/script/process/spawner", "test/integration/app/script/runner", "test/integration/app/script/server", "test/integration/app/test/fixtures/items.yml", "test/integration/app/test/functional/eval_controller_test.rb", "test/integration/app/test/functional/items_controller_test.rb", "test/integration/app/test/test_helper.rb", "test/integration/app/test/unit/item_test.rb", "test/integration/server_test.rb", "test/setup.rb", "test/teardown.rb", "test/test_helper.rb", "test/unit/finder_test.rb", "test/unit/interlock_test.rb", "test/unit/lock_test.rb", "TODO", "interlock.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/interlock/}
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
   s.rubygems_version = %q{1.0.1}
   s.summary = %q{A Rails plugin for maintainable and high-efficiency caching.}
-  s.test_files = ["test/integration/server_test.rb", "test/unit/interlock_test.rb", "test/unit/lock_test.rb"]
+  s.test_files = ["test/integration/server_test.rb", "test/unit/finder_test.rb", "test/unit/interlock_test.rb", "test/unit/lock_test.rb"]
 end
 
 
@@ -35,7 +35,7 @@ end
 #   p.url = "http://blog.evanweaver.com/files/doc/fauna/interlock/"  
 #   p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"  
 #   p.test_pattern = ["test/integration/*.rb", "test/unit/*.rb"]
-#   p.rdoc_pattern = ["README", "CHANGELOG", "TODO", "LICENSE", "lib/interlock/memcached.rb", "lib/interlock/interlock.rb", "lib/interlock/action_controller.rb", "lib/interlock/active_record.rb", "lib/interlock/action_view.rb", "lib/interlock/config.rb"]
+#   p.rdoc_pattern = ["README", "CHANGELOG", "TODO", "LICENSE", "lib/interlock/lock.rb", "lib/interlock/interlock.rb", "lib/interlock/action_controller.rb", "lib/interlock/active_record.rb", "lib/interlock/finders.rb", "lib/interlock/action_view.rb", "lib/interlock/config.rb"]
 #   p.clean_pattern += ['test/integration/app/coverage', 'test/integration/app/db/schema.rb',
 #                       'test/integration/app/vendor/plugins/interlock']
 # end
@@ -44,13 +44,15 @@ end
 # task "test_all" do  
 #   ['memcache-client', 'memcached'].each do |client|
 #     ENV['CLIENT'] = client
-#     ENV['PRODUCTION'] = 'false'
-#     STDERR.puts "#{'='*80}\nDevelopment mode: #{client}\n#{'='*80}"
-#     system("rake test:multi_rails:all")
-#   
-#     ENV['PRODUCTION'] = 'true'
-#     STDERR.puts "#{'='*80}\nProduction mode: #{client}\n#{'='*80}"
-#     system("rake test:multi_rails:all")
+#     ['false', 'true'].each do |finder|
+#       ENV['FINDERS'] = finder    
+#       ['false', 'true'].each do |env|
+#         ENV['PRODUCTION'] = env
+#         mode = env == 'false' ? "Development" : "Production"
+#         STDERR.puts "#{'='*80}\n#{mode} mode, #{client}, finders #{finder}\n#{'='*80}"
+#         system("rake test:multi_rails:all")
+#       end
+#     end
 #   end
 # end
 # 

data/lib/interlock/action_controller.rb

@@ -217,9 +217,8 @@ And in the <tt>show.html.erb</tt> view:
   
           content.first
         rescue Interlock::FragmentConsistencyError => e
-          # XXX Needs test coverage
           # Delete the bogus key
-          begin; CACHE.delete key; rescue; end
+          Interlock.invalidate(key)
           # Reraise the error
           raise e
         end      

data/lib/interlock/active_record.rb

@@ -14,16 +14,23 @@ module ActiveRecord #:nodoc:
     #
     
     def expire_interlock_keys
+      
+      # Fragments
       (CACHE.get(Interlock.dependency_key(self.class.base_class)) || {}).each do |key, scope|
         if scope == :all or (scope == :id and key.field(4) == self.to_param.to_s)
           Interlock.say key, "invalidated by rule #{self.class} -> #{scope.inspect}."
           Interlock.invalidate key
         end
       end
+      
+      # Models
+      if Interlock.config[:with_finders]
+        Interlock.invalidate(self.class.caching_key(self.id))
+      end
     end
     
     before_save :expire_interlock_keys
     after_destroy :expire_interlock_keys
-
+            
   end
 end

data/lib/interlock/config.rb

@@ -5,10 +5,11 @@ module Interlock
     :ttl => 1.day,
     :namespace => 'app',
     :servers => ['127.0.0.1:11211'],
-    :client => 'memcache-client'
+    :client => 'memcache-client',
+    :with_finders => false
   }    
   
-  CLIENT_KEYS = [ #:nodoc:
+  CLIENT_KEYS = [ 
     :hash,
     :no_block,
     :buffer_requests,
@@ -16,7 +17,7 @@ module Interlock
     :tcp_nodelay,
     :distribution,
     :namespace
-  ]
+  ] 
 
   mattr_accessor :config 
   @@config = DEFAULTS
@@ -42,14 +43,15 @@ module Interlock
           Interlock.config.merge!(config[RAILS_ENV.to_sym] || {})
         end
         
-        memcached!
-        rails!
+        install_memcached
+        install_fragments        
+        install_finders if Interlock.config[:with_finders]
       end
   
       # 
       # Configure memcached for this app.
       #
-      def memcached!
+      def install_memcached
         Interlock.config[:namespace] << "-#{RAILS_ENV}"
   
         unless defined? Object::CACHE
@@ -95,11 +97,11 @@ module Interlock
           include Interlock::Lock
           
           def read(*args)
-            get args.first
+            get args.first.to_s
           end
           
           def write(name, content, options = {})             
-            set(name, 
+            set(name.to_s, 
               content, 
               options.is_a?(Hash) ? options[:ttl] : Interlock.config[:ttl] )
           end          
@@ -110,7 +112,7 @@ module Interlock
       #
       # Configure Rails to use the memcached store for fragments, and optionally, sessions.
       #    
-      def rails!
+      def install_fragments
         # Memcached fragment caching is mandatory        
         ActionView::Helpers::CacheHelper.class_eval do
           def cache(name, options = nil, &block)
@@ -127,6 +129,21 @@ module Interlock
           ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS.update 'cache' => CACHE      
         end      
       end    
+      
+      #
+      # Configure ActiveRecord#find caching.
+      #
+      def install_finders
+        # RAILS_DEFAULT_LOGGER.warn "** using interlock finder caches"      
+        class << ActiveRecord::Base
+          private      
+          alias :find_via_db :find
+          remove_method :find
+          
+          public
+          include Interlock::Finders
+        end        
+      end
 
     end      
   end

data/lib/interlock/finders.rb

@@ -0,0 +1,131 @@
+
+module Interlock
+  module Finders
+
+    #
+    # Cached find. 
+    # 
+    # Any other options besides ids short-circuit the cache, include an empty trailing Hash.
+    #    
+    def find(*args)
+      return find_via_db(*args) if args.last.is_a? Hash or args.first.is_a? Symbol
+      records = find_via_cache(args.flatten, true)
+
+      if args.length > 1 or args.first.is_a? Array
+        records
+      else
+        records.first
+      end      
+      
+    end
+    
+    #
+    # Cached find_by_id. Short-circuiting works the same as find.
+    #
+    def find_by_id(*args)
+      return method_missing(:find_by_id, *args) if args.last.is_a? Hash
+      find_via_cache(args, false).first
+    end
+    
+    #
+    # Cached find_all_by_id. Ultrasphinx uses this. Short-circuiting works the same as find.
+    #    
+    def find_all_by_id(*args)
+      return method_missing(:find_all_by_id, *args) if args.last.is_a? Hash 
+      find_via_cache(args, false)
+    end
+    
+    #
+    # Build the model cache key for a particular id.
+    #
+    def caching_key(id)
+      Interlock.caching_key(
+        self.name,
+        "find",
+        id,
+        "default"
+      )
+    end    
+        
+    private
+    
+    def find_via_cache(ids, should_raise) #:doc:
+      results = []
+
+      ordered_keys_to_ids = ids.map { |id| [caching_key(id), id.to_i] }
+      keys_to_ids = Hash[*ordered_keys_to_ids.flatten]
+
+      records = {}
+      
+      if ActionController::Base.perform_caching
+        load_from_local_cache(records, keys_to_ids)
+        load_from_memcached(records, keys_to_ids)
+      end
+      
+      load_from_db(records, keys_to_ids)
+      
+      # Put them in order
+      
+      ordered_keys_to_ids.each do |key, |
+        record = records[key]
+        raise ActiveRecord::RecordNotFound, "Couldn't find #{self.name} with ID=#{keys_to_ids[key]}" if should_raise and !record
+        results << record
+      end
+      
+      results      
+    end
+    
+    def load_from_local_cache(current, keys_to_ids) #:doc:            
+      # Load from the local cache      
+      records = {}
+      keys_to_ids.each do |key, |
+        record = Interlock.local_cache.read(key, nil)
+        records[key] = record if record
+      end      
+      current.merge!(records)        
+    end
+
+    def load_from_memcached(current, keys_to_ids) #:doc:
+      # Drop to memcached if necessary
+      if current.size < keys_to_ids.size
+        records = {}
+        missed = keys_to_ids.reject { |key, | current[key] }      
+        
+        records = CACHE.get_multi(*missed.keys)
+        
+        # Set missed to the caches
+        records.each do |key, value|
+          Interlock.say key, "is loading from memcached", "model"
+          Interlock.local_cache.write(key, value, nil)
+        end
+                
+        current.merge!(records)
+      end    
+    end
+
+    def load_from_db(current, keys_to_ids) #:doc:
+      # Drop to db if necessary
+      if current.size < keys_to_ids.size
+        missed = keys_to_ids.reject { |key, | current[key] }
+        ids_to_keys = keys_to_ids.invert
+
+        # Load from the db
+        records = find_all_by_id(missed.values, {})
+        records = Hash[*(records.map do |record|
+          [ids_to_keys[record.id], record]
+        end.flatten)]
+        
+        # Set missed to the caches
+        records.each do |key, value|
+          Interlock.say key, "is loading from the db", "model"
+          Interlock.local_cache.write(key, value, nil)
+          CACHE.set key, value
+        end
+        
+        current.merge!(records)
+      end    
+    end
+    
+  end
+end
+  

data/lib/interlock/interlock.rb

@@ -26,6 +26,11 @@ module Interlock
   ILLEGAL_KEY_CHARACTERS_PATTERN = /\s/
   
   mattr_accessor :local_cache
+  
+  # Install the pass-through store. This is used in the console and test 
+  # environment. In a server environment, the controller callbacks install
+  # the memory store before each request.  
+  @@local_cache = Interlock::PassThroughStore.new
     
   class << self
     #
@@ -89,8 +94,8 @@ module Interlock
       end
     end
 
-    def say(key, msg) #:nodoc:
-      RAILS_DEFAULT_LOGGER.warn "** fragment #{key.inspect[1..-2]} #{msg}"
+    def say(key, msg, type = "fragment") #:nodoc:
+      RAILS_DEFAULT_LOGGER.warn "** #{type} #{key.inspect[1..-2]} #{msg}"
     end
      
     #   
@@ -128,6 +133,9 @@ module Interlock
     # Invalidate a particular key.
     #
     def invalidate(key)
+      # Console and tests do not install the local cache
+      Interlock.local_cache.delete(key) if Interlock.local_cache
+
       ActionController::Base.fragment_cache_store.delete key
     end    
     

data/lib/interlock/pass_through_store.rb

@@ -0,0 +1,19 @@
+
+module Interlock
+  #
+  # A stub class so that does not cache, for use in the test environment and the console
+  # when the MemoryStore is not available.
+  #
+  class PassThroughStore
+    
+    # Do nothing.
+    def nothing(*args)
+      nil
+    end
+    
+    alias :read :nothing
+    alias :write :nothing
+    alias :delete :nothing
+
+  end
+end

data/lib/interlock.rb

@@ -6,8 +6,10 @@ require 'interlock/core_extensions'
 require 'interlock/config'
 require 'interlock/interlock'
 require 'interlock/lock'
+require 'interlock/pass_through_store'
 require 'interlock/action_controller'
 require 'interlock/action_view'
+require 'interlock/finders'
 require 'interlock/active_record'
 
 begin

data/test/integration/app/config/memcached.yml

@@ -3,6 +3,7 @@ defaults:
   namespace: interlock
   sessions: true
   client: <%= ENV['CLIENT'] || 'memcached' %>
+  with_finders: <%= ENV['FINDERS'] || true %>
 development:
   servers: 
     - 127.0.0.1:43042

data/test/integration/server_test.rb

@@ -18,7 +18,7 @@ class ServerTest < Test::Unit::TestCase
   end
   
   
-  ### Tests
+  ### Fragment caching tests
   
   def test_render
     assert_match(/Welcome/, browse)
@@ -115,41 +115,45 @@ class ServerTest < Test::Unit::TestCase
     assert_match(/any:any:all:related invalidated/, log)
     assert_match(/any:any:all:related is running the controller block/, log)
   end
-  
-  def test_caching_of_content_for
-    assert_match(/Interlock Test:\s*\d\s*Items/m, browse("items"))
-    assert_match(/all:untagged is running the controller block/, log)
-    assert_match(/all:untagged wrote/, log)
     
-    truncate
-    assert_match(/Interlock Test:\s*\d\s*Items/m, browse("items"))
-    # Make sure we didn't copy the content_for too many times
-    assert_no_match(/Interlock Test:\s*\d\s*Items\s*\d\s*Items/m, browse("items"))
-    assert_no_match(/all:untagged is running the controller block/, log)
-    assert_match(/all:untagged read from memcached/, log)
-  end  
-  
-  def test_nested_view_caches
-    assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
-    assert_match(/detail:1:outer is running the controller block/, log)
-    assert_match(/detail:1:inner is running the controller block/, log)
+  unless ENV['RAILS_GEM_VERSION'] == "1.2.6"
+    # This functionality not supported on 1.2.6
+  
+    def test_caching_of_content_for
+      assert_match(/Interlock Test:\s*\d\s*Items/m, browse("items"))
+      assert_match(/all:untagged is running the controller block/, log)
+      assert_match(/all:untagged wrote/, log)
+      
+      truncate
+      assert_match(/Interlock Test:\s*\d\s*Items/m, browse("items"))
+      # Make sure we didn't copy the content_for too many times
+      assert_no_match(/Interlock Test:\s*\d\s*Items\s*\d\s*Items/m, browse("items"))
+      assert_no_match(/all:untagged is running the controller block/, log)
+      assert_match(/all:untagged read from memcached/, log)
+    end  
     
-    truncate
-    assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
-    assert_no_match(/detail:1:outer is running the controller block/, log)
-    assert_no_match(/detail:1:inner is running the controller block/, log)
-
-    truncate
-    remote_eval("Item.find(2).save!")
-    assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
-    assert_match(/detail:1:outer is running the controller block/, log)
-    assert_no_match(/detail:1:inner is running the controller block/, log)
-
-    truncate
-    remote_eval("Item.find(1).save!")
-    assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
-    assert_match(/detail:1:outer is running the controller block/, log)
-    assert_match(/detail:1:inner is running the controller block/, log)    
+    def test_nested_view_caches
+      assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
+      assert_match(/detail:1:outer is running the controller block/, log)
+      assert_match(/detail:1:inner is running the controller block/, log)
+      
+      truncate
+      assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
+      assert_no_match(/detail:1:outer is running the controller block/, log)
+      assert_no_match(/detail:1:inner is running the controller block/, log)
+  
+      truncate
+      remote_eval("Item.find(2).save!")
+      assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
+      assert_match(/detail:1:outer is running the controller block/, log)
+      assert_no_match(/detail:1:inner is running the controller block/, log)
+  
+      truncate
+      remote_eval("Item.find(1).save!")
+      assert_match(/Outer: Inner<.*2 total items.*Artichoke/m, browse("items/detail/1"))
+      assert_match(/detail:1:outer is running the controller block/, log)
+      assert_match(/detail:1:inner is running the controller block/, log)    
+    end    
   end
   
   ### Support methods

data/test/setup.rb

@@ -6,9 +6,11 @@ Dir.chdir "#{File.dirname(__FILE__)}/integration/app/" do
   `ps awx`.split("\n").grep(/4304[1-3]/).map do |process| 
     system("kill -9 #{process.to_i}")
   end
+  
+  LOG = "/tmp/memcached.log"
 
-  system "memcached -p 43042 &"
-  system "memcached -p 43043 &"
+  system "memcached -vv -p 43042 >> #{LOG} 2>&1 &"
+  system "memcached -vv -p 43043 >> #{LOG} 2>&1 &"
   
   Dir.chdir "vendor/plugins" do
     system "rm interlock; ln -s ../../../../../ interlock"

data/test/unit/finder_test.rb

@@ -0,0 +1,105 @@
+
+require "#{File.dirname(__FILE__)}/../test_helper"
+require 'fileutils'
+
+class FinderTest < Test::Unit::TestCase
+
+  LOG = "#{HERE}/integration/app/log/development.log"     
+  
+  ### Finder caching tests
+  
+  def test_find_without_cache
+    Item.find(1, {})
+    assert_no_match(/model.*Item:find:1:default is loading from the db/, log)
+  end
+  
+  def test_find
+    assert_equal Item.find(1, {}),
+      Item.find(1)
+    assert_match(/model.*Item:find:1:default is loading from the db/, log)
+
+    assert_equal Item.find(1, {}),
+      Item.find(1)
+    assert_match(/model.*Item:find:1:default is loading from memcached/, log)
+  end
+  
+  def test_find_with_array
+    assert_equal Item.find([1, 2], {}),
+      Item.find([1, 2])
+    assert_match(/model.*Item:find:1:default is loading from the db/, log)
+    assert_match(/model.*Item:find:2:default is loading from the db/, log)
+
+    assert_equal Item.find([1, 2], {}),
+      Item.find([1, 2])
+    assert_match(/model.*Item:find:1:default is loading from memcached/, log)
+    assert_match(/model.*Item:find:2:default is loading from memcached/, log)    
+  end 
+  
+  def test_find_raise
+    assert_raises(ActiveRecord::RecordNotFound) do
+      Item.find(44)
+    end  
+  end
+    
+  def test_find_with_array_raise
+    assert_raises(ActiveRecord::RecordNotFound) do
+      # Once from the DB
+      Item.find([1, 2, 44])
+    end
+    assert_raises(ActiveRecord::RecordNotFound) do
+      # Once from Memcached
+      Item.find([1, 2, 44])
+    end  
+  end
+
+  def test_invalidate
+    Item.find(1).save!
+    truncate
+    Item.find(1)
+    assert_match(/model.*Item:find:1:default is loading from the db/, log)
+    Item.find(1)
+    assert_match(/model.*Item:find:1:default is loading from memcached/, log)  
+  end  
+
+  def test_find_all_by_id
+    assert_equal Item.find_all_by_id(44, {}), 
+      Item.find_all_by_id(44)
+    assert_equal Item.find_all_by_id([1,2], {}), 
+      Item.find_all_by_id([1,2])
+    assert_equal Item.find_all_by_id(1, 2, {}), 
+      Item.find_all_by_id(1, 2)
+  end
+
+  def test_find_by_id
+    assert_equal Item.find_by_id(44, {}), 
+      Item.find_by_id(44)
+    assert_equal Item.find_by_id([1,2], {}), 
+      Item.find_by_id([1,2])
+    assert_equal Item.find_by_id(1, 2, {}), 
+      Item.find_by_id(1, 2)
+  end
+    
+  ### Support methods
+  
+  def setup
+    # Change the asset ID; has a similar effect to flushing memcached
+    @old_asset_id = ENV['RAILS_ASSET_ID']
+    ENV['RAILS_ASSET_ID'] = rand.to_s
+    truncate    
+  end
+  
+  def teardown
+    # Restore the asset id
+    ENV['RAILS_ASSET_ID'] = @old_asset_id
+  end
+
+  def truncate
+    system("> #{LOG}")
+  end
+  
+  def log
+    File.open(LOG, 'r') do |f|
+      f.read
+    end
+  end  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: interlock
 version: !ruby/object:Gem::Version 
-  version: "1.2"
+  version: "1.3"
 platform: ruby
 authors: 
 - ""
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2008-02-04 00:00:00 -05:00
+date: 2008-03-02 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -51,8 +51,10 @@ files:
 - lib/interlock/active_record.rb
 - lib/interlock/config.rb
 - lib/interlock/core_extensions.rb
+- lib/interlock/finders.rb
 - lib/interlock/interlock.rb
 - lib/interlock/lock.rb
+- lib/interlock/pass_through_store.rb
 - lib/interlock.rb
 - LICENSE
 - Manifest
@@ -122,6 +124,7 @@ files:
 - test/setup.rb
 - test/teardown.rb
 - test/test_helper.rb
+- test/unit/finder_test.rb
 - test/unit/interlock_test.rb
 - test/unit/lock_test.rb
 - TODO
@@ -154,5 +157,6 @@ specification_version: 2
 summary: A Rails plugin for maintainable and high-efficiency caching.
 test_files: 
 - test/integration/server_test.rb
+- test/unit/finder_test.rb
 - test/unit/interlock_test.rb
 - test/unit/lock_test.rb