interlock 1.3 → 1.4

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v1.4. Rails 2.1 compatibility. Store dependency trees per object, when possible. Use shorter namespaces for Memcached.
+
 v1.3. Add basic finder memoization.
 
 v1.2. Add compatibility with Memcached client.

data/README

@@ -15,9 +15,7 @@ If you use this software, please {make a donation}[http://blog.evanweaver.com/do
 
 * memcached (http://www.danga.com/memcached)
 * memcache-client gem
-* Rails 1.2.6
-
-Note that Rails 2.0.2 is required for caching <tt>content_for</tt> or nesting <tt>view_cache</tt> blocks.
+* Rails 2.1
 
 == Features
 
@@ -37,7 +35,7 @@ You also need either <tt>memcache-client</tt> or {memcached}[http://blog.evanwea
   sudo gem install memcache-client
 
 Then, install the plugin:
-  script/plugin install -x svn://rubyforge.org/var/svn/fauna/interlock/trunk
+  script/plugin install git://github.com/fauna/interlock.git
   
 Lastly, configure your Rails app for memcached by creating a <tt>config/memcached.yml</tt> file. The format is compatible with Cache_fu:
 
@@ -49,13 +47,13 @@ Lastly, configure your Rails app for memcached by creating a <tt>config/memcache
     servers: 
       - 127.0.0.1:11211 # Default host and port
   production:
-    servers
-      - 10.12.128.1
-      - 10.12.128.2     
+    servers:
+      - 10.12.128.1:11211
+      - 10.12.128.2:11211
       
 Now you're ready to go.
 
-Note that if you have {memcached 0.7}[http://blog.evanweaver.com/files/doc/fauna/memcached], you can use <tt>client: memcached</tt> for better performance.
+Note that if you have the {memcached}[http://blog.evanweaver.com/files/doc/fauna/memcached] client, you can use <tt>client: memcached</tt> for better performance.
  
 == Usage
 

data/Rakefile

@@ -0,0 +1,34 @@
+
+require 'echoe'
+
+Echoe.new("interlock") do |p|
+  p.project = "fauna"
+  p.summary = "A Rails plugin for maintainable and high-efficiency caching."
+  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/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
+
+desc "Run all the tests in production and development mode both"
+task "test_all" do  
+  ['memcache-client', 'memcached'].each do |client|
+    ENV['CLIENT'] = client
+    ['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
+
+task "tail" do
+  log = "test/integration/app/log/development.log"
+  system("touch #{log} && tail -f #{log} | grep interlock")
+end

data/interlock.gemspec

@@ -1,62 +1,33 @@
-
-# Gem::Specification for Interlock-1.3
-# Originally generated by Echoe
+# -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{interlock}
-  s.version = "1.3"
-
-  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.version = "1.4"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [""]
-  s.date = %q{2008-03-02}
+  s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
+  s.date = %q{2009-11-18}
   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/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.extra_rdoc_files = ["CHANGELOG", "lib/interlock/action_controller.rb", "lib/interlock/action_view.rb", "lib/interlock/active_record.rb", "lib/interlock/config.rb", "lib/interlock/finders.rb", "lib/interlock/interlock.rb", "lib/interlock/lock.rb", "LICENSE", "README", "TODO"]
+  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", "Rakefile", "test/unit/active_record_test.rb"]
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/interlock/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Interlock", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.0.1}
+  s.rubygems_version = %q{1.3.5}
+  s.signing_key = %q{/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem}
   s.summary = %q{A Rails plugin for maintainable and high-efficiency caching.}
-  s.test_files = ["test/integration/server_test.rb", "test/unit/finder_test.rb", "test/unit/interlock_test.rb", "test/unit/lock_test.rb"]
-end
+  s.test_files = ["test/integration/server_test.rb", "test/unit/active_record_test.rb", "test/unit/finder_test.rb", "test/unit/interlock_test.rb", "test/unit/lock_test.rb"]
 
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
 
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# 
-# require 'echoe'
-# 
-# Echoe.new("interlock") do |p|
-#   p.project = "fauna"
-#   p.summary = "A Rails plugin for maintainable and high-efficiency caching."
-#   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/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
-# 
-# desc "Run all the tests in production and development mode both"
-# task "test_all" do  
-#   ['memcache-client', 'memcached'].each do |client|
-#     ENV['CLIENT'] = client
-#     ['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
-# 
-# task "tail" do
-#   log = "test/integration/app/log/development.log"
-#   system("touch #{log} && tail -f #{log} | grep interlock")
-# end
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/interlock.rb

@@ -13,7 +13,11 @@ require 'interlock/finders'
 require 'interlock/active_record'
 
 begin
-  require 'memcached'
+  if defined?(JRUBY_VERSION)
+    require 'memcache-client'
+  else
+    require 'memcached'
+  end
 rescue LoadError
 end
 

data/lib/interlock/action_controller.rb

@@ -16,7 +16,7 @@ If you pass an Array of symbols as the tag, it will get value-mapped onto params
       ignore = Interlock::SCOPE_KEYS if ignore.include? :all    
       
       if (Interlock::SCOPE_KEYS - ignore).empty? and !tag
-        raise UsageError, "You must specify a :tag if you are ignoring the entire default scope."
+        raise Interlock::UsageError, "You must specify a :tag if you are ignoring the entire default scope."
       end
         
       if tag.is_a? Array and tag.all? {|x| x.is_a? Symbol}
@@ -121,11 +121,13 @@ And in the <tt>show.html.erb</tt> view:
       conventional_class = begin; controller_name.classify.constantize; rescue NameError; end
       options, dependencies = Interlock.extract_options_and_dependencies(args, conventional_class)
       
-      raise UsageError, ":ttl has no effect in a behavior_cache block" if options[:ttl]
+      raise Interlock::UsageError, ":ttl has no effect in a behavior_cache block" if options[:ttl]
+
+      Interlock.say "key", "yo: #{options.inspect} -- #{dependencies.inspect}"
 
       key = caching_key(options.value_for_indifferent_key(:ignore), options.value_for_indifferent_key(:tag))      
 
-      if options[:perform] == false
+      if options[:perform] == false || Interlock.config[:disabled]
         Interlock.say key, "is not cached"
         yield
       else
@@ -149,8 +151,8 @@ And in the <tt>show.html.erb</tt> view:
     # Callback to reset the local cache.
     #
     def clear_interlock_local_cache
-      Interlock.local_cache = ::ActionController::Base::MemoryStore.new
-      RAILS_DEFAULT_LOGGER.warn "** cleared interlock local cache"
+      Interlock.local_cache = ::ActiveSupport::Cache::MemoryStore.new
+      Interlock.log "** cleared interlock local cache"
     end    
     
     # Should be registered first in the chain
@@ -172,7 +174,7 @@ And in the <tt>show.html.erb</tt> view:
         
         content = [block_content, @template.cached_content_for]
 
-        fragment_cache_store.write(key, content, options)
+        cache_store.write(key, content, options)
         Interlock.local_cache.write(key, content, options)
 
         Interlock.say key, "wrote"
@@ -193,7 +195,7 @@ And in the <tt>show.html.erb</tt> view:
         begin
           if content = Interlock.local_cache.read(key, options)
             # Interlock.say key, "read from local cache"
-          elsif content = fragment_cache_store.read(key, options)                    
+          elsif content = cache_store.read(key, options)                    
             raise Interlock::FragmentConsistencyError, "#{key} expected Array but got #{content.class}" unless content.is_a? Array
             Interlock.say key, "read from memcached"
             Interlock.local_cache.write(key, content, options)
@@ -225,5 +227,27 @@ And in the <tt>show.html.erb</tt> view:
       end
       
     end
-  end    
+    
+    # With Rails 2.1 action caching, we need to slip in our :expire param into the ActionCacheFilter options, so that when we 
+    # write_fragment we can pass that in and allow shane's #{key}_expiry to take effect 
+    # (see def write in interlock/config.rb) 
+    module Actions 
+
+      module ClassMethods 
+        def caches_action(*actions) 
+          return unless cache_configured? 
+          options = actions.extract_options! 
+          around_filter(ActionCacheFilter.new(:cache_path => options.delete(:cache_path), :expire => options.delete(:expire)), {:only => actions}.merge(options)) 
+        end 
+      end 
+   
+      class ActionCacheFilter #:nodoc: 
+        def after(controller) 
+          return if controller.rendered_action_cache || !caching_allowed(controller) 
+          controller.write_fragment(controller.action_cache_path.path, controller.response.body, :expire => @options[:expire]) # pass in our :expire 
+        end 
+      end
+    end    
+
+  end
 end

data/lib/interlock/action_view.rb

@@ -30,7 +30,7 @@ Note that the cached item is not guaranteed to live this long. An invalidation r
 
 It's fine to use a <tt>view_cache</tt> block without a <tt>behavior_cache</tt> block. For example, to mimic regular fragment cache behavior, but take advantage of memcached's <tt>:ttl</tt> support, call:
 
-  <% view_cache :ignore => :all, :tag => 'sidebar', :ttl => 5.minutes %>
+  <% view_cache :ignore => :all, :tag => 'sidebar', :ttl => 5.minutes do %>
   <% end %>  
   
 == Dependencies, scoping, and other options
@@ -44,7 +44,7 @@ See ActionController::Base for explanations of the rest of the options. The <tt>
 
        key = controller.caching_key(options.value_for_indifferent_key(:ignore), options.value_for_indifferent_key(:tag))      
        
-       if options[:perform] == false
+       if options[:perform] == false || Interlock.config[:disabled]
          # Interlock.say key, "is not cached"
          block.call
        else       
@@ -53,11 +53,8 @@ See ActionController::Base for explanations of the rest of the options. The <tt>
          # Interlock.say key, "is rendering"
 
          @cached_content_for, previous_cached_content_for = {}, @cached_content_for
-         @controller.cache_erb_fragment(
-           block, 
-           key, 
-           :ttl => (options.value_for_indifferent_key(:ttl) or Interlock.config[:ttl])
-         )
+
+         cache key, :ttl => (options.value_for_indifferent_key(:ttl) or Interlock.config[:ttl]), &block
          
          # This is tricky. If we were already caching content_fors in a parent block, we need to 
          # append the content_fors set in the inner block to those already set in the outer block. 

data/lib/interlock/active_record.rb

@@ -1,6 +1,16 @@
 
 module ActiveRecord #:nodoc:
   class Base
+
+    @@nil_sentinel = :_nil
+
+    class << self # Class methods    
+      def update_counters_with_expiry(id, counters)
+        update_counters_without_expiry(id, counters)
+        find(id).expire_interlock_keys
+      end
+      alias_method_chain :update_counters, :expiry      
+    end
     
     #
     # Convert this record to a tag string.
@@ -12,25 +22,40 @@ module ActiveRecord #:nodoc:
     #
     # The expiry callback.
     #
-    
     def expire_interlock_keys
+      return if Interlock.config[:disabled] or (defined? CGI::Session::ActiveRecordStore and is_a? CGI::Session::ActiveRecordStore::Session)
       
       # 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
+      self.expire_interlock_keys_for_dependency(Interlock.dependency_key(self.class.base_class, :all, nil))
+      self.expire_interlock_keys_for_dependency(Interlock.dependency_key(self.class.base_class, :id, "::::#{to_param}:"))
       
       # Models
       if Interlock.config[:with_finders]
-        Interlock.invalidate(self.class.caching_key(self.id))
+        key = self.class.base_class.caching_key(self.id)
+        Interlock.say key, 'invalidated with finders', 'model'
+        Interlock.invalidate key
       end
     end
     
     before_save :expire_interlock_keys
+    after_save :expire_interlock_keys
     after_destroy :expire_interlock_keys
-            
+
+    #
+    # Reload. Expires the cache and force reload from db.
+    #
+    def reload_with_expiry(*args)
+      expire_interlock_keys
+      reload_without_expiry(*args)
+    end
+    alias_method_chain :reload, :expiry
+  
+    def expire_interlock_keys_for_dependency(dependency_key)
+      (CACHE.get(dependency_key) || {}).each do |key, scope|
+        Interlock.say key, "invalidated by rule #{self.class} -> #{scope.inspect}."
+        Interlock.invalidate key
+      end      
+    end
+    
   end
-end
+end

data/lib/interlock/config.rb

@@ -1,4 +1,4 @@
-
+#require 'ehcache'
 module Interlock
 
   DEFAULTS = {
@@ -9,13 +9,26 @@ module Interlock
     :with_finders => false
   }    
   
-  CLIENT_KEYS = [ 
+  CLIENT_KEYS =[
+    :prefix_key,
+    :distribution,
+    :verify_key,
+    :tcp_nodelay,
     :hash,
-    :no_block,
+    :hash_with_prefix_key,
+    :show_backtraces,
+    :default_ttl,
+    :ketama_weighted,
+    :retry_timeout,
+    :default_weight,
     :buffer_requests,
+    :timeout,
+    :sort_hosts,
+    :cache_lookups,
+    :connect_timeout,
+    :no_block,
+    :failover,
     :support_cas,
-    :tcp_nodelay,
-    :distribution,
     :namespace
   ] 
 
@@ -42,9 +55,11 @@ module Interlock
           Interlock.config.merge!(config[:defaults] || {})
           Interlock.config.merge!(config[RAILS_ENV.to_sym] || {})
         end
-        
+
         install_memcached
         install_fragments        
+
+        # Always install the finders.
         install_finders if Interlock.config[:with_finders]
       end
   
@@ -55,16 +70,25 @@ module Interlock
         Interlock.config[:namespace] << "-#{RAILS_ENV}"
   
         unless defined? Object::CACHE
-        
+
           # Give people a choice of client, even though I don't like conditional dependencies.
           klass = case Interlock.config[:client]
             when 'memcached'
-              Memcached::Rails
+              begin
+                Memcached::Rails
+              rescue ArgumentError
+                raise ConfigurationError, "'memcached' client requested but not installed. Try 'sudo gem install memcached'."
+              end
+              
             when 'memcache-client'              
-              raise ConfigurationError, "You have the Ruby-MemCache gem installed. Please uninstall Ruby-MemCache, or otherwise guarantee that memcache-client will load instead." if MemCache.constants.include?('SVNURL')
-              MemCache              
-            else
-              raise ConfigurationError, "Invalid client name '#{Interlock.config[:client]}'"
+              begin
+                if MemCache.constants.include?('SVNURL')
+                  raise ConfigurationError, "You have the Ruby-MemCache gem installed. Please uninstall Ruby-MemCache, or otherwise guarantee that memcache-client will load instead." 
+                end
+                MemCache              
+              rescue ArgumentError
+                raise ConfigurationError, "'memcache-client' client requested but not installed. Try 'sudo gem install memcache-client'."
+              end
           end
           
           Object.const_set('CACHE', 
@@ -73,7 +97,7 @@ module Interlock
               Interlock.config.slice(*CLIENT_KEYS)
             )
           )
-          
+
           # Mark that we're the ones who did it.
           class << CACHE
             def installed_by_interlock; true; end
@@ -104,9 +128,8 @@ module Interlock
             set(name.to_s, 
               content, 
               options.is_a?(Hash) ? options[:ttl] : Interlock.config[:ttl] )
-          end          
-        end  
-              
+          end
+        end
       end
       
       #
@@ -115,16 +138,18 @@ module Interlock
       def install_fragments
         # Memcached fragment caching is mandatory        
         ActionView::Helpers::CacheHelper.class_eval do
-          def cache(name, options = nil, &block)
+          def cache(name = {}, options = nil, &block)
             # Things explode if options does not default to nil
             RAILS_DEFAULT_LOGGER.debug "** fragment #{name} stored via obsolete cache() call"
-            @controller.cache_erb_fragment(block, name, options)
+            @controller.fragment_for(output_buffer, name, options, &block)
           end
         end                
-        ActionController::Base.fragment_cache_store = CACHE
+        ActionController::Base.cache_store = CACHE
   
         # Sessions are optional
         if Interlock.config[:sessions]
+          # XXX Right now this requires memcache-client to be installed, due to a Rails problem.
+          # http://dev.rubyonrails.org/ticket/11290
           ActionController::Base.session_store = :mem_cache_store
           ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS.update 'cache' => CACHE      
         end      
@@ -134,17 +159,10 @@ module Interlock
       # 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        
+        RAILS_DEFAULT_LOGGER.warn "** using interlock finder caches"
+        ActiveRecord::Base.send(:include, Interlock::Finders)
       end
 
-    end      
+    end
   end
-end
+end

data/lib/interlock/finders.rb

@@ -1,131 +1,155 @@
 
 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      
+    def self.included(klass)
+      class << klass
+        alias_method :find_via_db, :find
+        remove_method :find
+      end
       
+      klass.extend ClassMethods
     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
+    module ClassMethods
+
+      #
+      # Cached find. 
+      # 
+      # Any other options besides ids short-circuit the cache.
+      #    
+      def find(*args)
+        return find_via_db(*args) if args.last.is_a? Hash or args.first.is_a? Symbol
+        ids = args.flatten.compact.uniq
+        return find_via_db(ids) if ids.blank? 
+      
+        records = find_via_cache(ids, true)
+
+        if ids.length > 1 or args.first.is_a?(Array)
+          records
+        else
+          records.first
+        end      
+      
+      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
+      #
+      # 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
     
-    #
-    # Build the model cache key for a particular id.
-    #
-    def caching_key(id)
-      Interlock.caching_key(
-        self.name,
-        "find",
-        id,
-        "default"
-      )
-    end    
-        
-    private
+      #
+      # 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
     
-    def find_via_cache(ids, should_raise) #:doc:
-      results = []
+      #
+      # Build the model cache key for a particular id.
+      #
+      def caching_key(id)
+        Interlock.caching_key(
+          self.base_class.name,
+          "find",
+          id,
+          "default"
+        )
+      end
+
+      def finder_ttl
+        0
+      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]
+        ordered_keys_to_ids = ids.flatten.map { |id| [caching_key(id), id.to_i] }
+        keys_to_ids = Hash[*ordered_keys_to_ids.flatten]
 
-      records = {}
+        records = {}
       
-      if ActionController::Base.perform_caching
-        load_from_local_cache(records, keys_to_ids)
-        load_from_memcached(records, keys_to_ids)
-      end
+        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)
+        load_from_db(records, keys_to_ids)
       
-      # Put them in order
+        # 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
+        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
+     
+        # Don't return Nil objects, only the found records
+        results.compact
       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
+      def load_from_local_cache(current, keys_to_ids) #:doc:            
+        # Load from the local cache      
         records = {}
-        missed = keys_to_ids.reject { |key, | current[key] }      
+        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)
+          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
+          # 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
+          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
+      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)]
+          # Load from the db
+          ids_to_find = missed.values
+          if ids_to_find.length > 1
+            records = send("find_all_by_#{primary_key}".to_sym, ids_to_find, {})
+          else
+            records = [send("find_by_#{primary_key}".to_sym, ids_to_find.first, {})].compact # explicitly just look for one if that's all that's needed
+          end
+
+          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
+          # 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, value.class.finder_ttl unless Interlock.config[:disabled]
+          end
         
-        current.merge!(records)
-      end    
+          current.merge!(records)
+        end    
+      end
     end
-    
-  end
-end
-  
+  end # Finders
+end # Interlock
+  

data/lib/interlock/interlock.rb

@@ -76,9 +76,11 @@ module Interlock
     # Add each key with scope to the appropriate dependencies array.
     #
     def register_dependencies(dependencies, key)
+      return if Interlock.config[:disabled]
+ 
       Array(dependencies).each do |klass, scope|
-        dep_key = dependency_key(klass)
-        
+        dep_key = dependency_key(klass, scope, key)
+      
         # Get the value for this class/key out of the global store.
         this = (CACHE.get(dep_key) || {})[key]
 
@@ -89,21 +91,32 @@ module Interlock
             Interlock.say key, "registered a dependency on #{klass} -> #{scope.inspect}."
             (hash || {}).merge({key => scope})
           end
-        end
-        
+        end        
       end
     end
 
     def say(key, msg, type = "fragment") #:nodoc:
-      RAILS_DEFAULT_LOGGER.warn "** #{type} #{key.inspect[1..-2]} #{msg}"
+      log "** #{type} #{key.inspect[1..-2]} #{msg}"
     end
-     
+    
+    def log(msg)
+      case Interlock.config[:log_level]
+      when 'debug', 'info', 'warn', 'error'
+        log_method = Interlock.config[:log_level]
+      else
+        log_method = :debug
+      end
+      
+      RAILS_DEFAULT_LOGGER.send( log_method, msg )
+    end
+
     #   
     # Get the Memcached key for a class's dependency list. We store per-class 
     # to reduce lock contention.
     #
-    def dependency_key(klass) 
-      "interlock:#{ENV['RAILS_ASSET_ID']}:dependency:#{klass.name}"
+    def dependency_key(klass, scope, key) 
+      id = (scope == :id ? ":#{key.field(4)}" : nil)
+      "interlock:#{ENV['RAILS_ASSET_ID']}:dependency:#{klass.name}#{id}"
     end
     
     # 
@@ -135,9 +148,8 @@ module Interlock
     def invalidate(key)
       # Console and tests do not install the local cache
       Interlock.local_cache.delete(key) if Interlock.local_cache
+      ActionController::Base.cache_store.delete key
+    end
 
-      ActionController::Base.fragment_cache_store.delete key
-    end    
-    
   end    
 end

data/lib/interlock/lock.rb

@@ -17,14 +17,13 @@ module Interlock
         # for this.        
         begin
           response = CACHE.add("lock:#{key}", "Locked by #{Process.pid}", lock_expiry)
-          # Nil is a successful response for Memcached, so we'll simulate the MemCache
-          # API.
-          response ||= "STORED\r\n"
-        rescue Object => e
-          # Catch exceptions from Memcached without setting response.
+          # Nil is a successful response for Memcached 0.11, and "STORED\r\n" for MemCache.
+          response = [true, nil, "STORED\r\n"].include?(response)
+        rescue Memcached::NotStored 
+          # Do nothing
         end
         
-        if response == "STORED\r\n"
+        if response
           begin
             value = yield(CACHE.get(key))
             CACHE.set(key, value)
@@ -33,9 +32,11 @@ module Interlock
             CACHE.delete("lock:#{key}")
           end
         else
+          # Wait
           sleep((2**count) / 2.0)
         end
       end
+      
       raise ::Interlock::LockAcquisitionError, "Couldn't acquire lock for #{key}"
     end
     

data/test/integration/app/config/environment.rb

@@ -5,7 +5,7 @@ require 'action_controller'
 Rails::Initializer.run do |config|
   
   if ActionController::Base.respond_to? 'session='
-    config.action_controller.session = {:session_key => '_app_session', :secret => '22cde4d5c1a61ba69a81795322cde4d5c1a61ba69a817953'}
+    config.action_controller.session = {:session_key => rand.to_s, :secret => '22cde4d5c1a61ba69a81795322cde4d5c1a61ba69a817953'}
   end
     
   #  config.to_prepare do     

data/test/integration/app/config/environments/development.rb

@@ -5,6 +5,5 @@ config.cache_classes = production
 config.whiny_nils = true
 config.action_controller.consider_all_requests_local = !production
 config.action_controller.perform_caching = true
-config.action_view.cache_template_extensions = production
 config.action_view.debug_rjs = !production
 config.action_mailer.raise_delivery_errors = false

data/test/integration/server_test.rb

@@ -39,6 +39,23 @@ class ServerTest < Test::Unit::TestCase
     assert_match(/all:untagged read from memcached/, log)
   end
   
+  def test_controller_respects_log_level
+    remote = <<-CODE
+    RAILS_DEFAULT_LOGGER.level = Logger::INFO;
+    Interlock.config[:log_level] = 'info'
+    CODE
+    remote_eval(remote)
+    
+    truncate
+    browse("items")
+    assert_match(/cleared interlock local cache/, log)
+    
+    remote_eval("Interlock.config[:log_level] = 'debug'")
+    truncate
+    browse("items")
+    assert_no_match(/cleared interlock local cache/, log)
+  end
+  
   def test_broad_invalidation
     browse("items")
     assert_match(/all:untagged is running the controller block/, log)
@@ -71,7 +88,8 @@ class ServerTest < Test::Unit::TestCase
   
   def test_caching_with_tag
     # This test is a little over-complicated
-    sleep(4)
+    remote_eval("Item.update_all('updated_at = NULL')")
+    
     assert_no_match(/Artichoke/, browse("items/recent?seconds=3"))
     assert_match(/recent:all:3 is running the controller block/, log)
 
@@ -81,13 +99,13 @@ class ServerTest < Test::Unit::TestCase
     assert_no_match(/recent:all:3 is running the controller block/, log)
     
     truncate
-    remote_eval("Item.find(1).save!")
+    remote_eval("Item.find(1).update_attributes!(:description => 'Changed!')")
     assert_match(/Artichoke/, browse("items/recent?seconds=4"))
     assert_match(/recent:all:4 is running the controller block/, log)
 
     truncate
     assert_no_match(/Artichoke/, browse("items/recent?seconds=3"))
-    assert_no_match(/recent:all:3 is running the controller block/, log)    
+    assert_no_match(/recent:all:3 is running the controller block/, log)
   end
   
   def test_caching_with_perform_false    

data/test/unit/active_record_test.rb

@@ -0,0 +1,8 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class FinderTest < Test::Unit::TestCase
+  def test_reload_should_work
+    item = Item.find(1)
+    assert_equal Item.find(1, {}), item.reload
+  end
+end

data/test/unit/finder_test.rb

@@ -9,7 +9,8 @@ class FinderTest < Test::Unit::TestCase
   ### Finder caching tests
   
   def test_find_without_cache
-    Item.find(1, {})
+    # Non-empty options hash bypasses the cache entirely, including the logging
+    Item.find(1, {:conditions => "1 = 1"})
     assert_no_match(/model.*Item:find:1:default is loading from the db/, log)
   end
   
@@ -33,14 +34,19 @@ class FinderTest < Test::Unit::TestCase
       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 
+  end
+  
+  def test_single_element_array_returns_array
+    assert_equal Item.find([1], {}),
+      Item.find([1])
+  end
   
   def test_find_raise
     assert_raises(ActiveRecord::RecordNotFound) do
       Item.find(44)
-    end  
+    end
   end
-    
+
   def test_find_with_array_raise
     assert_raises(ActiveRecord::RecordNotFound) do
       # Once from the DB
@@ -49,7 +55,12 @@ class FinderTest < Test::Unit::TestCase
     assert_raises(ActiveRecord::RecordNotFound) do
       # Once from Memcached
       Item.find([1, 2, 44])
-    end  
+    end
+  end
+
+  def test_find_with_array_ignores_nil
+    assert_equal Item.find(1, nil, {}), Item.find(1, nil)
+    assert_equal Item.find([1, nil], {}), Item.find([1, nil])
   end
 
   def test_invalidate
@@ -59,7 +70,39 @@ class FinderTest < Test::Unit::TestCase
     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  
+  end
+  
+  def test_reload_should_invalidate
+    item = Item.find(1)
+    item.reload
+    assert_match(/model.*Item:find:1:default invalidated with finders/, log)
+    truncate
+    Item.find(1)
+    assert_match(/model.*Item:find:1:default is loading from memcached/, log)  
+  end
+  
+  def test_update_attributes_should_invalidate
+    item = Item.find(1)
+    name = item.name
+
+    item.update_attributes!(:name => 'Updated')
+    updated_item = Item.find(1)
+    assert_equal 'Updated', item.name
+
+    # Restore name for further tests
+    item.update_attributes!(:name => name)
+  end
+  
+  def test_update_all_should_invalidate
+    # TODO
+  end
+  
+  def test_update_counters_should_invalidate
+    item = Item.find(1)
+    Item.update_counters(1, :counting_something => 1)
+    updated_item = Item.find(1)
+    assert_equal updated_item.counting_something, item.counting_something + 1
+  end
 
   def test_find_all_by_id
     assert_equal Item.find_all_by_id(44, {}), 
@@ -69,6 +112,10 @@ class FinderTest < Test::Unit::TestCase
     assert_equal Item.find_all_by_id(1, 2, {}), 
       Item.find_all_by_id(1, 2)
   end
+  
+  def test_invalidate_sti
+    # XXX Need a regression test
+  end
 
   def test_find_by_id
     assert_equal Item.find_by_id(44, {}), 
@@ -78,7 +125,31 @@ class FinderTest < Test::Unit::TestCase
     assert_equal Item.find_by_id(1, 2, {}), 
       Item.find_by_id(1, 2)
   end
-    
+  
+  def test_custom_log_level
+    old_level = RAILS_DEFAULT_LOGGER.level
+    RAILS_DEFAULT_LOGGER.level = Logger::INFO
+
+    Interlock.config[:log_level] = 'info'
+    truncate
+    Item.find(1)
+    assert_match(/model.*Item:find:1:default is loading/, log)
+
+    Interlock.config[:log_level] = 'debug'
+    truncate
+    Item.find(1)
+    assert_no_match(/model.*Item:find:1:default is loading/, log)
+  ensure
+    RAILS_DEFAULT_LOGGER.level = old_level
+  end
+  
+  def test_find_with_nonstandard_primary_key
+    db = Book.find_via_db(1137)
+    cache = Book.find(1137)
+    assert_equal db, cache
+    assert_equal Book.find_via_db(1137, 2001, :order => "guid ASC"), Book.find(1137, 2001)
+  end
+  
   ### Support methods
   
   def setup

data/test/unit/interlock_test.rb

@@ -18,4 +18,13 @@ class InterlockTest < Test::Unit::TestCase
       Interlock.caching_key('controller', 'action', 'id', 'tag with illegal characters')
       'generated keys should not contain illegal characters'
   end
+  
+  def disabled_test_register_dependencies_with_many_keys_one_dependency    
+    assert_nothing_raised do
+      (1..5000).each do |i|
+        Interlock.register_dependencies({Item=>:id}, Interlock.caching_key("a"*200, "show", i, nil))
+      end
+    end    
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: interlock
 version: !ruby/object:Gem::Version 
-  version: "1.3"
+  version: "1.4"
 platform: ruby
 authors: 
 - ""
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2008-03-02 00:00:00 -05:00
+date: 2009-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -40,8 +40,18 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- CHANGELOG
+- lib/interlock/action_controller.rb
+- lib/interlock/action_view.rb
+- lib/interlock/active_record.rb
+- lib/interlock/config.rb
+- lib/interlock/finders.rb
+- lib/interlock/interlock.rb
+- lib/interlock/lock.rb
+- LICENSE
+- README
+- TODO
 files: 
 - CHANGELOG
 - examples/memcached.yml
@@ -129,11 +139,19 @@ files:
 - test/unit/lock_test.rb
 - TODO
 - interlock.gemspec
+- Rakefile
 has_rdoc: true
 homepage: http://blog.evanweaver.com/files/doc/fauna/interlock/
-post_install_message: 
-rdoc_options: []
+licenses: []
 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Interlock
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -146,17 +164,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 1.0.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A Rails plugin for maintainable and high-efficiency caching.
 test_files: 
 - test/integration/server_test.rb
+- test/unit/active_record_test.rb
 - test/unit/finder_test.rb
 - test/unit/interlock_test.rb
 - test/unit/lock_test.rb