Install

script/plugin install git://github.com/blythedunham/static_record_cache.git

Documentation

class SomeStaticClass < ActiveRecord::Base
  acts_as_static_record
end

#cache hits
SomeStaticClass.find_by_name('blah')
SomeStaticClass.find_by_id(5)
SomeStaticClass.find :all
assoc_class.some_static_class

One can specify the cache key for faster lookups and also customize the finder SQL for the class. More documentation can be found in the rdocs.

Another, simpler method of caching can be used by folks using the active record context plugin by technoweenie. Extending StaticRecordCache will permanently cache data for the class regardless of context. This however, only caches by id.

class TelephoneCarriers < ActiveRecord::Base
  extend StaticActiveRecordContext
end

Be sure to install active_record_cache plugin:

script/plugin install http://svn.techno-weenie.net/projects/plugins/active_record_context/

script/plugin install http://arperftoolkit.rubyforge.org/svn/trunk/conditional_page_cache

At the top of the controller, indicate which actions you wish to cache with conditionally_cache.

class MyController < Application

  conditionally_cache :action_one, :action_two

  def cache_page?(current_action_name)
    @user.demo?
  end

  def cache_action?(action_name)
    !@user.admin?
  end

end

To use page caching, add a method cache_page?(current_action_name) on the controller. The page will be cached if this method returns true.

Similarly, return true from method cache_action?(current_action_name) when you want to action cache the page. This method is the same as the one used by the action caching plugin which works great along with this one.

playing pinball in Vegas reminded me of mongrel multi caching funtime

We really like cache with our rails at Spongecell and have been really successful with Tom Fake’s Action Cache plugin when we are unable to page cache highly demanded content.

One little concurrency issue that I encountered running with the Action cache plugin on multiple mongrels was one mongrel would delete (expire) a meta data file while another was simultaneously writing the meta or data file. Anyhoo, the result was an angry corrupt file that was served to other web clients. This made some of customers angry. Then I was angry. To avoid all the hatred, I patched the method cached_entry in action_cache.rb with this little change to remove the cache on exceptions. action_cache.diff

        rescue
          remove_cache_item(controller)
          return nil
        end

With that said, here are my favorite features which you will love too!

• The timer expiry. So… you can be super lazy and just expire your cache say every 10 minutes without having to write complex sweeping code that may or may not slow down some other actions.
  @response.time_to_live = 10.minutes

• Easy integration with  Nginx X-Accel-Redirect (and Apache’s X-SendFile) to tell your web server to send the cached file downstream. This allows you to still use before and after filters, but  offloads the work the Nginx and free up your mongrels a bit to bark at someone else.

For more information on rails caching, check out Gregg from Rail Envy’s sweet post.