interlock 1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+
+v1.0. First release.

data/LICENSE

@@ -0,0 +1,184 @@
+Academic Free License (AFL) v. 3.0
+
+This Academic Free License (the "License") applies to any original work
+of authorship (the "Original Work") whose owner (the "Licensor") has
+placed the following licensing notice adjacent to the copyright notice
+for the Original Work:
+
+Licensed under the Academic Free License version 3.0
+
+1) Grant of Copyright License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, for the duration of
+the copyright, to do the following:
+
+a) to reproduce the Original Work in copies, either alone or as part of
+a collective work;
+
+b) to translate, adapt, alter, transform, modify, or arrange the
+Original Work, thereby creating derivative works ("Derivative Works")
+based upon the Original Work;
+
+c) to distribute or communicate copies of the Original Work and
+Derivative Works to the public, under any license of your choice that
+does not contradict the terms and conditions, including Licensor's
+reserved rights and remedies, in this Academic Free License;
+
+d) to perform the Original Work publicly; and
+
+e) to display the Original Work publicly.
+
+2) Grant of Patent License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, under patent claims
+owned or controlled by the Licensor that are embodied in the Original
+Work as furnished by the Licensor, for the duration of the patents, to
+make, use, sell, offer for sale, have made, and import the Original Work
+and Derivative Works.
+
+3) Grant of Source Code License. The term "Source Code" means the
+preferred form of the Original Work for making modifications to it and
+all available documentation describing how to modify the Original Work.
+Licensor agrees to provide a machine-readable copy of the Source Code of
+the Original Work along with each copy of the Original Work that
+Licensor distributes. Licensor reserves the right to satisfy this
+obligation by placing a machine-readable copy of the Source Code in an
+information repository reasonably calculated to permit inexpensive and
+convenient access by You for as long as Licensor continues to distribute
+the Original Work.
+
+4) Exclusions From License Grant. Neither the names of Licensor, nor the
+names of any contributors to the Original Work, nor any of their
+trademarks or service marks, may be used to endorse or promote products
+derived from this Original Work without express prior permission of the
+Licensor. Except as expressly stated herein, nothing in this License
+grants any license to Licensor's trademarks, copyrights, patents, trade
+secrets or any other intellectual property. No patent license is granted
+to make, use, sell, offer for sale, have made, or import embodiments of
+any patent claims other than the licensed claims defined in Section 2.
+No license is granted to the trademarks of Licensor even if such marks
+are included in the Original Work. Nothing in this License shall be
+interpreted to prohibit Licensor from licensing under terms different
+from this License any Original Work that Licensor otherwise would have a
+right to license.
+
+5) External Deployment. The term "External Deployment" means the use,
+distribution, or communication of the Original Work or Derivative Works
+in any way such that the Original Work or Derivative Works may be used
+by anyone other than You, whether those works are distributed or
+communicated to those persons or made available as an application
+intended for use over a network. As an express condition for the grants
+of license hereunder, You must treat any External Deployment by You of
+the Original Work or a Derivative Work as a distribution under section
+1(c).
+
+6) Attribution Rights. You must retain, in the Source Code of any
+Derivative Works that You create, all copyright, patent, or trademark
+notices from the Source Code of the Original Work, as well as any
+notices of licensing and any descriptive text identified therein as an
+"Attribution Notice." You must cause the Source Code for any Derivative
+Works that You create to carry a prominent Attribution Notice reasonably
+calculated to inform recipients that You have modified the Original
+Work.
+
+7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants
+that the copyright in and to the Original Work and the patent rights
+granted herein by Licensor are owned by the Licensor or are sublicensed
+to You under the terms of this License with the permission of the
+contributor(s) of those copyrights and patent rights. Except as
+expressly stated in the immediately preceding sentence, the Original
+Work is provided under this License on an "AS IS" BASIS and WITHOUT
+WARRANTY, either express or implied, including, without limitation, the
+warranties of non-infringement, merchantability or fitness for a
+particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL
+WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential
+part of this License. No license to the Original Work is granted by this
+License except under this disclaimer.
+
+8) Limitation of Liability. Under no circumstances and under no legal
+theory, whether in tort (including negligence), contract, or otherwise,
+shall the Licensor be liable to anyone for any indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or the use of the Original Work including,
+without limitation, damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages
+or losses. This limitation of liability shall not apply to the extent
+applicable law prohibits such limitation.
+
+9) Acceptance and Termination. If, at any time, You expressly assented
+to this License, that assent indicates your clear and irrevocable
+acceptance of this License and all of its terms and conditions. If You
+distribute or communicate copies of the Original Work or a Derivative
+Work, You must make a reasonable effort under the circumstances to
+obtain the express assent of recipients to the terms of this License.
+This License conditions your rights to undertake the activities listed
+in Section 1, including your right to create Derivative Works based upon
+the Original Work, and doing so without honoring these terms and
+conditions is prohibited by copyright law and international treaty.
+Nothing in this License is intended to affect copyright exceptions and
+limitations (including "fair use" or "fair dealing"). This License shall
+terminate immediately and You may no longer exercise any of the rights
+granted to You by this License upon your failure to honor the conditions
+in Section 1(c).
+
+10) Termination for Patent Action. This License shall terminate
+automatically and You may no longer exercise any of the rights granted
+to You by this License as of the date You commence an action, including
+a cross-claim or counterclaim, against Licensor or any licensee alleging
+that the Original Work infringes a patent. This termination provision
+shall not apply for an action alleging patent infringement by
+combinations of the Original Work with other software or hardware.
+
+11) Jurisdiction, Venue and Governing Law. Any action or suit relating
+to this License may be brought only in the courts of a jurisdiction
+wherein the Licensor resides or in which Licensor conducts its primary
+business, and under the laws of that jurisdiction excluding its
+conflict-of-law provisions. The application of the United Nations
+Convention on Contracts for the International Sale of Goods is expressly
+excluded. Any use of the Original Work outside the scope of this License
+or after its termination shall be subject to the requirements and
+penalties of copyright or patent law in the appropriate jurisdiction.
+This section shall survive the termination of this License.
+
+12) Attorneys' Fees. In any action to enforce the terms of this License
+or seeking damages relating thereto, the prevailing party shall be
+entitled to recover its costs and expenses, including, without
+limitation, reasonable attorneys' fees and costs incurred in connection
+with such action, including any appeal of such action. This section
+shall survive the termination of this License.
+
+13) Miscellaneous. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable.
+
+14) Definition of "You" in This License. "You" throughout this License,
+whether in upper or lower case, means an individual or a legal entity
+exercising rights under, and complying with all of the terms of, this
+License. For legal entities, "You" includes any entity that controls, is
+controlled by, or is under common control with you. For purposes of this
+definition, "control" means (i) the power, direct or indirect, to cause
+the direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+15) Right to Use. You may use the Original Work in all ways not
+otherwise restricted or conditioned by this License or by law, and
+Licensor promises not to interfere with or be responsible for such uses
+by You.
+
+16) Modification of This License. This License is Copyright (c) 2005
+Lawrence Rosen. Permission is granted to copy, distribute, or
+communicate this License without modification. Nothing in this License
+permits You to modify this License as applied to the Original Work or to
+Derivative Works. However, You may modify the text of this License and
+copy, distribute or communicate your modified version (the "Modified
+License") and apply it to other original works of authorship subject to
+the following conditions: (i) You may not indicate in any way that your
+Modified License is the "Academic Free License" or "AFL" and you may not
+use those names in the name of your Modified License; (ii) You must
+replace the notice specified in the first paragraph above with the
+notice "Licensed under <insert your license name here>" or with a notice
+of your own that is not confusingly similar to the notice in this
+License; and (iii) You may not claim that your original works are open
+source software unless your Modified License has been approved by Open
+Source Initiative (OSI) and You comply with its license review and
+certification process.
+

data/Manifest

@@ -0,0 +1,89 @@
+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/memcached.rb
+lib/interlock.rb
+LICENSE
+Manifest
+README
+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/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/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/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
+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/memcached_test.rb
+TODO

data/README

@@ -0,0 +1,168 @@
+
+Interlock
+
+An optimal-efficiency caching plugin for Rails.
+
+== License
+
+Copyright 2007 Cloudburst, LLC. Licensed under the AFL 3; see the included LICENSE file. Portions copyright 2006 Chris Wanstrath and used with permission.
+
+The public certificate for the gem is at http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem.
+
+== Requirements
+
+* Memcached (http://www.danga.com/memcached)
+* memcache-client gem
+
+== What it does
+
+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 automatically tracks invalidation dependencies based on the model lifecyle, and supports arbitrary levels of  scoping per-block.
+
+== Installation
+  
+First, compile and install memcached itself. Get a memcached server running.
+
+You also need the <tt>memcache-client</tt> gem:
+  sudo gem install memcache-client
+
+Then, install the plugin:
+  script/plugin install -x svn://rubyforge.org/var/svn/fauna/interlock/trunk
+  
+Lastly, configure your Rails app for memcached by creating a <tt>config/memcached.yml</tt> file. The format is compatible with Cache_fu:
+
+  defaults:
+    namespace: myapp
+    sessions: false
+  development:
+    servers: 
+      - localhost:11211 # Default port
+  production:
+    servers
+      - 10.12.128.1
+      - 10.12.128.2     
+      
+Now you're ready to go.
+ 
+== Usage
+
+Interlock provides two similar caching methods: <tt>behavior_cache</tt> for controllers and <tt>view_cache</tt> for views. The both accept an optional list or hash of model dependencies, and an optional <tt>:tag</tt> keypair. <tt>view_cache</tt> also accepts a <tt>ttl</tt>.
+
+The simplest usage doesn't require any parameters. In the controller:
+
+  class ItemsController < ActionController::Base
+  
+    def slow_action
+      behavior_cache do
+        @items = Item.find(:all, :conditions => "be slow")
+      end
+    end
+    
+  end
+  
+Now, in the view, wrap the largest section of ERB you can find that uses data from <tt>@items</tt> (but not from any other instance variables) in a <tt>view_cache</tt> block. 
+
+  <% @title = "My Sweet Items" %>
+
+  <% view_cache do %>
+    <% @items.each do |item| %>
+      <h1><%= item.name %></h1>
+    <% end %>
+  <% end %>
+  
+You have to do them both.
+
+This automatically registers a caching dependency on Item for <tt>slow_action</tt>. The controller block won't run if the <tt>slow_action</tt> view fragment is fresh, and the view fragment will only get invalidated when an Item is changed. 
+
+You can use multiple instance variables in one block, of course. Just make sure the <tt>behavior_cache</tt> provides whatever the <tt>view_cache</tt> uses.
+
+== Declaring dependencies
+
+You can declare non-default invalidation dependencies by passing models to <tt>behavior_cache</tt> (you can also pass them to <tt>view_cache</tt>, but you should only do that if you are caching a fragment without an associated behavior block in the controller).
+
+<b>No dependencies (cache never invalidates):</b>
+  behavior_cache nil do
+  end
+  
+<b>Invalidate on any Media change:</b>
+  behavior_cache Media do
+  end
+  
+<b>Invalidate on any Media or Item change:</b>
+  behavior_cache Media, Item do
+  end
+  
+<b>Invalidate on Item changes if the Item <tt>id</tt> matches the current <tt>params[:id]</tt> value:</b>
+  behavior_cache Item => :id do
+  end
+
+You do not have to pass the same dependencies to <tt>behavior_cache</tt> and <tt>view_cache</tt> even for the same action. The set union of both dependency lists will be used.
+
+== Narrowing scope and caching multiple blocks
+
+Sometimes you need to cache multiple blocks in a controller, or otherwise get a more fine-grained scope. Interlock provides the <tt>:tag</tt> key for this purpose. <tt>:tag</tt> accepts either an array of symbols, which are mapped to <tt>params</tt> values, or an arbitrary object, which is converted to a string identifier. <b>Your corresponding behavior caches and view caches must have identical <tt>:tag</tt> values for the interlocking to take effect.</b>
+
+Note that <tt>:tag</tt> can be used to scope caches. You can simultaneously cache different versions of the same block, differentiating based on params or other logic. This is great for caching per-user, for example:
+
+  def profile
+    @user = current_user
+    behavior_cache :tag => @user do
+      @items = Item.find(:all, :conditions => "be slow")
+    end
+  end
+
+In the view, use the same <tt>:tag</tt> value (<tt>@user</tt>). Note that <tt>@user</tt> must be set outside of the behavior block in the controller, because its contents are used to decide whether to run the block in the first place.
+
+This way each user will see only their own cache. Pretty neat.
+
+== Broadening scope
+
+Sometimes the default scope (<tt>controller</tt>, <tt>action</tt>, <tt>params[:id]</tt>) is too narrow. For example, you might share a partial across actions, and set up its data via a filter. By default, Interlock will cache a separate version of it for each action. To avoid this, you can use the <tt>:ignore</tt> key, which lets you list parts of the default scope to ignore:
+
+  before_filter :recent
+  
+  private
+  
+  def recent
+    behavior_cache :ignore => :action do
+      @recent = Item.find(:all, :limit => 5, :order => 'updated_at DESC')
+    end
+  end
+
+Valid values for <tt>:ignore</tt> are <tt>:controller</tt>, <tt>:action</tt>, <tt>:id</tt>, and <tt>:all</tt>. You can pass an array of multiple values. <b>Just like with <tt>:tag</tt>, your corresponding behavior caches and view caches must have identical <tt>:ignore</tt> values.</b> Note that cache blocks with <tt>:ignore</tt> values still obey the regular invalidation rules.
+
+A good way to get started is to just use the default scope. Then <tt>grep</tt> in the production log for <tt>interlock</tt> and see what keys are being set and read. If you see lots of different keys go by for data that you know is the same, then set some <tt>:ignore</tt> values. 
+
+== View-only caching
+
+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 nil, :ignore => :all, :tag => 'sidebar', :ttl => 5.minutes %>
+    <h1>On the side</h1>
+  <% end %> 
+  
+Remember that <tt>nil</tt> disables invalidation rules. This is a nice trick for keeping your caching strategy unified.
+
+== Gotchas
+
+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>.
+
+<b>If you have custom <tt>render</tt> calls in the controller, they must be outside the <tt>behavior_cache</tt> blocks.</b> No exceptions. For example:
+
+  def profile
+    behavior_cache do
+      @items = Item.find(:all, :conditions => "be slow")
+    end
+    render :action => 'home'
+  end
+
+You can write custom invalidation rules if you really want to, but try hard to avoid it; it has a significant cost in long-term maintainability.
+
+Also, Interlock obeys the <tt>ENV['RAILS_ASSET_ID']</tt> setting, so if you need to blanket-invalidate all your caches, just change <tt>RAILS_ASSET_ID</tt> (for example, you could have it increment on every deploy).
+
+== Reporting problems
+
+* http://rubyforge.org/forum/forum.php?forum_id=18926
+
+Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC. 

data/TODO

@@ -0,0 +1,3 @@
+
+* Figure out how to cache Builder blocks
+* Figure out how to cache RJS

data/examples/memcached.yml

@@ -0,0 +1,10 @@
+defaults:
+  namespace: myapp
+  sessions: false
+development:
+  servers:
+    - localhost:11211
+production:
+  servers
+    - 10.12.128.1
+    - 10.12.128.2

data/init.rb

@@ -0,0 +1,2 @@
+
+require 'interlock'

data/interlock.gemspec

@@ -0,0 +1,52 @@
+
+# Gem::Specification for Interlock-1.0
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{interlock}
+  s.version = "1.0"
+
+  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{2007-12-13}
+  s.description = %q{An optimal-efficiency caching plugin for Rails.}
+  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/memcached.rb", "lib/interlock.rb", "LICENSE", "Manifest", "README", "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/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/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/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", "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/memcached_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{0.9.5}
+  s.summary = %q{An optimal-efficiency caching plugin for Rails.}
+  s.test_files = ["test/integration/server_test.rb", "test/unit/memcached_test.rb"]
+
+  s.add_dependency(%q<memcache_client>, [">= 1.5.0"])
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# 
+# require 'echoe'
+# 
+# Echoe.new("interlock") do |p|
+#   p.project = "fauna"
+#   p.summary = "An optimal-efficiency caching plugin for Rails."
+#   p.url = "http://blog.evanweaver.com/files/doc/fauna/interlock/"  
+#   p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"  
+#   p.dependencies = "memcache_client >=1.5.0"
+#   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"]
+# end
+# 
+# desc "Run all the tests in production and development mode both"
+# task "test_all" do
+#   STDERR.puts "#{'='*80}\nDevelopment mode\n#{'='*80}"
+#   system("rake test:multi_rails:all")
+# 
+#   ENV['PRODUCTION'] = '1'
+#   STDERR.puts "#{'='*80}\nProduction mode\n#{'='*80}"
+#   system("rake test:multi_rails:all")
+# end

data/lib/interlock/action_controller.rb

@@ -0,0 +1,123 @@
+
+module ActionController #:nodoc:
+  class Base
+  
+    #
+    # Build the fragment key from a particular context. This must be deterministic 
+    # and stateful except for the tag. We can't scope the key to arbitrary params 
+    # because the view doesn't have access to which are relevant and which are 
+    # not.
+    #
+    # Note that the tag can be pretty much any object. Define #to_interlock_tag
+    # if you need custom tagging for some class. ActiveRecord::Base already
+    # has it defined appropriately.
+    #
+    # If you pass an Array of symbols as the tag, it will get value-mapped onto
+    # params and sorted. This makes granular scoping easier, although it doesn't
+    # sidestep the normal blanket invalidations.
+    #
+    def caching_key(ignore = nil, tag = nil)
+      ignore = Array(ignore)
+      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."
+      end
+        
+      if tag.is_a? Array and tag.all? {|x| x.is_a? Symbol}
+        tag = tag.sort_by do |key|
+          key.to_s
+        end.map do |key| 
+          params[key].to_interlock_tag
+        end.join(";")
+      end
+      
+      Interlock.caching_key(      
+        ignore.include?(:controller) ? 'any' : controller_name,
+        ignore.include?(:action) ? 'any' : action_name,
+        ignore.include?(:id) ? 'all' : params[:id],
+        tag
+      )
+    end
+    
+    #
+    # Mark a controller block for caching. Accepts a list of class dependencies for
+    # invalidation, as well as a :tag key for explicit fragment scoping.
+    #
+    def behavior_cache(*args)  
+      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]
+      
+      key = caching_key(options.value_for_indifferent_key(:ignore), options.value_for_indifferent_key(:tag))      
+      Interlock.register_dependencies(dependencies, key)
+          
+      # See if the fragment exists, and run the block if it doesn't.
+      unless read_fragment(key)    
+        Interlock.say key, "is running the controller block"
+        yield
+      end
+    end
+    
+    #:stopdoc:
+    alias :caching :behavior_cache # Deprecated
+    #:startdoc:
+
+    private
+
+    # 
+    # 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"
+    end    
+    
+    # Should be registered first in the chain
+    prepend_before_filter :clear_interlock_local_cache 
+  
+  end
+  
+  module Caching #:nodoc:
+    module Fragments
+       
+      #
+      # Replaces Rail's write_fragment method. Avoids extra checks for regex keys, 
+      # which are unsupported, adds more detailed logging information, and stores 
+      # writes in the local process cache too to avoid duplicate memcached requests.
+      #
+      def write_fragment(key, content, options = nil)
+        return unless perform_caching
+
+        fragment_cache_store.write(key, content, options)
+        Interlock.local_cache.write(key, content, options)
+
+        Interlock.say key, "wrote"
+
+        content
+      end
+
+      #
+      # Replaces Rail's read_fragment method. Avoids checks for regex keys, 
+      # which are unsupported, adds more detailed logging information, and
+      # checks the local process cache before hitting memcached. Hits on 
+      # memcached are then stored back locally to avoid duplicate requests.
+      #
+      def read_fragment(key, options = nil)
+        return unless perform_caching
+
+        if content = Interlock.local_cache.read(key, options)
+          # Interlock.say key, "read from local cache"
+        elsif content = fragment_cache_store.read(key, options)            
+          Interlock.say key, "read from memcached"
+          Interlock.local_cache.write(key, content, options)
+        else
+          # Interlock.say key, "not found"
+        end
+        content
+      end      
+      
+    end
+  end    
+end