interlock 1.0 → 1.1

data/lib/interlock/config.rb

@@ -19,7 +19,7 @@ module Interlock
       #
       # Load the configuration file, if available, and then set up the Memcached instance,
       # Rails settings, and CACHE constants. Should be more or less compatible with
-      # cache_fu.
+      # Cache_fu.
       #
       def run!
         if File.exist?(CONFIG_FILE)

data/lib/interlock/interlock.rb

@@ -7,9 +7,20 @@ module Interlock
   end  
   class UsageError < InterlockError #:nodoc:
   end
+  class FragmentConsistencyError < InterlockError #:nodoc:
+  end
   
   SCOPE_KEYS = [:controller, :action, :id]
   
+  # Buried value extracted from memcache.rb in the memcache-client gem.
+  # If one tries to request a key that is too long, the client throws an error.
+  # In practice, it seems better to simply avoid ever setting such long keys,
+  # so we use this value to achieve such for keys generated by Interlock.
+  KEY_LENGTH_LIMIT = 250
+  
+  # Similarly buried and useful: no whitespace allowed in keys.
+  ILLEGAL_KEY_CHARACTERS_PATTERN = /\s/
+  
   mattr_accessor :local_cache
     
   class << self
@@ -93,12 +104,20 @@ module Interlock
     # rolling your own.
     #
     def caching_key(controller, action, id, tag)
-      raise ArgumentError, "Both controller and action must be specified" unless controller and action
+      raise ArgumentError, 'Both controller and action must be specified' unless controller and action
       
       id = (id or 'all').to_interlock_tag
       tag = tag.to_interlock_tag
-
-      "interlock:#{ENV['RAILS_ASSET_ID']}:#{controller}:#{action}:#{id}:#{tag}"
+      
+      key = "interlock:#{ENV['RAILS_ASSET_ID']}:#{controller}:#{action}:#{id}:#{tag}"
+      
+      if key.length > KEY_LENGTH_LIMIT
+        old_key = key
+        key = key[0..KEY_LENGTH_LIMIT-1]
+        say old_key, "truncated to #{key}"
+      end
+      
+      key.gsub ILLEGAL_KEY_CHARACTERS_PATTERN, ''
     end
     
     #

data/tasks/interlock.rake

@@ -0,0 +1,10 @@
+
+namespace :interlock do
+  desc "Watch the Rails log for Interlock-specific messages"
+  task :tail do
+    Dir.chdir RAILS_ROOT do
+      exec("tail -f log/#{RAILS_ENV}.log | grep interlock")
+    end
+  end
+end
+  

data/test/integration/app/app/controllers/application.rb

@@ -2,9 +2,9 @@
 # Likewise, all the methods added will be available for all controllers.
 
 class ApplicationController < ActionController::Base
-  helper :all # include all helpers, all the time
+  # helper :all # include all helpers, all the time
 
   # See ActionController::RequestForgeryProtection for details
   # Uncomment the :secret if you're not using the cookie session store
-  protect_from_forgery # :secret => '491bb7f9ad07a91046fcc3756839524b'
+  # protect_from_forgery # :secret => '491bb7f9ad07a91046fcc3756839524b'
 end

data/test/integration/app/app/controllers/items_controller.rb

@@ -9,6 +9,16 @@ class ItemsController < ApplicationController
     render :action => 'list'
   end
   
+  def detail
+    # Nesting is theoretically useful when the outer view block invalidates faster than the inner one
+    behavior_cache :tag => :outer do
+      @items = Item.find(:all)
+    end
+    behavior_cache Item => :id, :tag => :inner do
+      @item = Item.find(params[:id])
+    end
+  end
+  
   def show
     behavior_cache Item => :id do
       @item = Item.find(params['id'])
@@ -21,6 +31,14 @@ class ItemsController < ApplicationController
     end
   end
   
+  def preview
+    @perform = false
+    behavior_cache Item => :id, :perform => @perform do
+      @item = Item.find(params['id'])
+    end
+    render :action => 'show'
+  end
+  
   private
   
   def related
@@ -28,5 +46,5 @@ class ItemsController < ApplicationController
       @related = "Delicious cake"
     end
   end
-  
+    
 end

data/test/integration/app/app/views/items/detail.rhtml

@@ -0,0 +1,20 @@
+
+<% view_cache :tag => :outer do %>  
+  <div style="border: 1px solid black; padding: 5px;">
+    <p>I invalidate quickly.</p>
+    <h1><%= @items.size %> total items</h1>
+
+    <% content_for :title do %>Outer: <% end %>
+    
+    <% view_cache :tag => :inner do %>
+      <div style="margin: 20px; padding: 5px; border: 1px solid black;">
+        <p>I invalidate slowly.</p>
+        <h2>Item <%= @item.id %> is <%= @item.name %>.</h2>
+
+         <% content_for :title do %>Inner<% end %>
+
+      </div>
+    <% end %>
+    
+  </div>  
+<% end %>

data/test/integration/app/app/views/items/{list.html.erb → list.rhtml}

@@ -1,10 +1,16 @@
 
 <h1>List</h1>
 <% view_cache do %>
+
+  <% content_for :title do %>
+    <%= @items.size %> Items
+  <% end %>
+
   <% @items.each do |item| %>
     <h3><%= item.name %></h3>
     <p><%= item.description %></p>
   <% end %>
+
 <% end %>
 
 <%= render :partial => 'shared/related' %>

data/test/integration/app/app/views/items/{show.html.erb → show.rhtml}

@@ -1,6 +1,6 @@
 
 <h1>Show</h1>
-<% view_cache Item => :id do %>
+<% view_cache :perform => @perform do %>
     <h3><%= @item.name %></h3>
     <p><%= @item.description %></p>
 <% end %>

data/test/integration/app/app/views/layouts/application.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>Interlock Test: <%= yield :title %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+  

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

@@ -55,8 +55,10 @@ module Rails
 
     def load_rails_gem
       if version = self.class.gem_version
+        STDERR.puts "Boot.rb loading version #{version}"
         gem 'rails', version
       else
+        STDERR.puts "Boot.rb loading latest available version"
         gem 'rails'
       end
     rescue Gem::LoadError => load_error

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

@@ -1,13 +1,11 @@
 
-RAILS_GEM_VERSION = ENV['MULTIRAILS_RAILS_VERSION'] if ENV['MULTIRAILS_RAILS_VERSION']
-
 require File.join(File.dirname(__FILE__), 'boot')
 require 'action_controller'
 
 Rails::Initializer.run do |config|
   
   if ActionController::Base.respond_to? 'session='
-    config.action_controller.session = {:session_key => '_app_session', :secret => '22cde4d5c1a61ba69a817953'}
+    config.action_controller.session = {:session_key => '_app_session', :secret => '22cde4d5c1a61ba69a81795322cde4d5c1a61ba69a817953'}
   end
     
   #  config.to_prepare do     

data/test/integration/server_test.rb

@@ -70,7 +70,8 @@ class ServerTest < Test::Unit::TestCase
   end
   
   def test_caching_with_tag
-    sleep(3)
+    # This test is a little over-complicated
+    sleep(4)
     assert_no_match(/Artichoke/, browse("items/recent?seconds=3"))
     assert_match(/recent:all:3 is running the controller block/, log)
 
@@ -79,15 +80,26 @@ class ServerTest < Test::Unit::TestCase
     assert_match(/recent:all:2 is running the controller block/, log)
     assert_no_match(/recent:all:3 is running the controller block/, log)
     
+    truncate
+    remote_eval("Item.find(1).save!")
+    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    
+    browse("items/preview/1")
+    assert_no_match(/preview:1:untagged registered a dependency/, log)
+    assert_match(/preview:1:untagged is not cached/, log)
     
     truncate
-    remote_eval("Item.find(1).save!")
-    assert_match(/Artichoke/, browse("items/recent?seconds=3"))
-    assert_match(/recent:all:3 is running the controller block/, log)
-  end  
+    browse("items/preview/1")
+    assert_no_match(/preview:1:untagged registered a dependency/, log)
+    assert_match(/preview:1:untagged is not cached/, log)        
+  end
   
   def test_caching_with_ignore
     assert_match(/Delicious cake/, browse('items'))
@@ -104,6 +116,41 @@ class ServerTest < Test::Unit::TestCase
     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)
+    
+    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
   
   ### Support methods
 

data/test/setup.rb

@@ -2,6 +2,11 @@
 # Setup integration system for the integration suite
 
 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
+
   system "memcached -p 43042 &"
   system "memcached -p 43043 &"
   

data/test/teardown.rb

@@ -1,4 +0,0 @@
-
-`ps awx`.split("\n").grep(/4304[1-3]/).map do |process| 
-  system("kill -9 #{process.to_i}")
-end

data/test/test_helper.rb

@@ -2,12 +2,19 @@
 $VERBOSE = nil
 require 'rubygems'
 require 'test/unit'
+require 'echoe'
 require 'multi_rails_init'
 
+if defined? ENV['MULTIRAILS_RAILS_VERSION']
+  ENV['RAILS_GEM_VERSION'] = ENV['MULTIRAILS_RAILS_VERSION']
+end
+
 $rcov = ENV['RCOV']
 require 'ruby-debug' unless $rcov
 
-HERE = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH << HERE
+Echoe.silence do
+  HERE = File.expand_path(File.dirname(__FILE__))
+  $LOAD_PATH << HERE
+end
 
 require 'integration/app/config/environment'

data/test/unit/interlock_test.rb

@@ -0,0 +1,21 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class InterlockTest < Test::Unit::TestCase
+  def test_caching_key_requires_controller_and_action
+    assert_raises ArgumentError do
+      Interlock.caching_key nil, nil, nil, nil
+    end
+  end
+  
+  def test_caching_key_prevents_too_long_keys
+    assert_equal Interlock::KEY_LENGTH_LIMIT,
+      Interlock.caching_key('controller', 'action', 'id', 'x'*Interlock::KEY_LENGTH_LIMIT).size,
+      "keys longer than #{Interlock::KEY_LENGTH_LIMIT} will result in errors from memcache-client"
+  end
+  
+  def test_caching_key_strips_whitespace
+    assert_no_match Interlock::ILLEGAL_KEY_CHARACTERS_PATTERN,
+      Interlock.caching_key('controller', 'action', 'id', 'tag with illegal characters')
+      'generated keys should not contain illegal characters'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: interlock
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: "1.1"
 platform: ruby
 authors: 
 - ""
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2007-12-13 00:00:00 -05:00
+date: 2008-01-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.0
     version: 
-description: An optimal-efficiency caching plugin for Rails.
+description: A Rails plugin for maintainable and high-efficiency caching.
 email: ""
 executables: []
 
@@ -65,6 +65,7 @@ files:
 - 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
@@ -72,10 +73,12 @@ files:
 - 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/list.html.erb
-- test/integration/app/app/views/items/recent.html.erb
-- test/integration/app/app/views/items/show.html.erb
-- test/integration/app/app/views/shared/_related.html.erb
+- 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
@@ -86,18 +89,7 @@ files:
 - test/integration/app/config/initializers/mime_types.rb
 - test/integration/app/config/memcached.yml
 - test/integration/app/config/routes.rb
-- test/integration/app/coverage/cache-43041
-- test/integration/app/coverage/index.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-action_controller_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-action_view_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-active_record_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-config_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-core_extensions_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-interlock_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock-memcached_rb.html
-- test/integration/app/coverage/vendor-plugins-interlock-lib-interlock_rb.html
 - test/integration/app/db/migrate/001_create_items.rb
-- test/integration/app/db/schema.rb
 - test/integration/app/doc/README_FOR_APP
 - test/integration/app/public/404.html
 - test/integration/app/public/422.html
@@ -138,6 +130,7 @@ files:
 - test/setup.rb
 - test/teardown.rb
 - test/test_helper.rb
+- test/unit/interlock_test.rb
 - test/unit/memcached_test.rb
 - TODO
 - interlock.gemspec
@@ -163,10 +156,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 0.9.5
+rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
-summary: An optimal-efficiency caching plugin for Rails.
+summary: A Rails plugin for maintainable and high-efficiency caching.
 test_files: 
 - test/integration/server_test.rb
+- test/unit/interlock_test.rb
 - test/unit/memcached_test.rb