halorgium-actionpack 3.0.pre

data/lib/action_controller/caching.rb

@@ -0,0 +1,80 @@
+require 'fileutils'
+require 'uri'
+require 'set'
+
+module ActionController #:nodoc:
+  # Caching is a cheap way of speeding up slow applications by keeping the result of
+  # calculations, renderings, and database calls around for subsequent requests.
+  # Action Controller affords you three approaches in varying levels of granularity:
+  # Page, Action, Fragment.
+  #
+  # You can read more about each approach and the sweeping assistance by clicking the
+  # modules below.
+  #
+  # Note: To turn off all caching and sweeping, set
+  #   config.action_controller.perform_caching = false.
+  #
+  # == Caching stores
+  #
+  # All the caching stores from ActiveSupport::Cache are available to be used as backends
+  # for Action Controller caching. This setting only affects action and fragment caching
+  # as page caching is always written to disk.
+  #
+  # Configuration examples (MemoryStore is the default):
+  #
+  #   config.action_controller.cache_store = :memory_store
+  #   config.action_controller.cache_store = :file_store, "/path/to/cache/directory"
+  #   config.action_controller.cache_store = :drb_store, "druby://localhost:9192"
+  #   config.action_controller.cache_store = :mem_cache_store, "localhost"
+  #   config.action_controller.cache_store = MyOwnStore.new("parameter")
+  module Caching
+    extend ActiveSupport::Concern
+
+    autoload :Actions, 'action_controller/caching/actions'
+    autoload :Fragments, 'action_controller/caching/fragments'
+    autoload :Pages, 'action_controller/caching/pages'
+    autoload :Sweeper, 'action_controller/caching/sweeping'
+    autoload :Sweeping, 'action_controller/caching/sweeping'
+
+    included do
+      @@cache_store = nil
+      cattr_reader :cache_store
+
+      # Defines the storage option for cached fragments
+      def self.cache_store=(store_option)
+        @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
+      end
+
+      include Pages, Actions, Fragments
+      include Sweeping if defined?(ActiveRecord)
+
+      @@perform_caching = true
+      cattr_accessor :perform_caching
+    end
+
+    module ClassMethods
+      def cache_configured?
+        perform_caching && cache_store
+      end
+    end
+
+    def caching_allowed?
+      request.get? && response.status == 200
+    end
+
+  protected
+    # Convenience accessor
+    def cache(key, options = {}, &block)
+      if cache_configured?
+        cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
+      else
+        yield
+      end
+    end
+
+  private
+    def cache_configured?
+      self.class.cache_configured?
+    end
+  end
+end

data/lib/action_controller/caching/actions.rb

@@ -0,0 +1,163 @@
+require 'set'
+
+module ActionController #:nodoc:
+  module Caching
+    # Action caching is similar to page caching by the fact that the entire
+    # output of the response is cached, but unlike page caching, every
+    # request still goes through the Action Pack. The key benefit
+    # of this is that filters are run before the cache is served, which
+    # allows for authentication and other restrictions on whether someone
+    # is allowed to see the cache. Example:
+    #
+    #   class ListsController < ApplicationController
+    #     before_filter :authenticate, :except => :public
+    #     caches_page   :public
+    #     caches_action :index, :show, :feed
+    #   end
+    #
+    # In this example, the public action doesn't require authentication,
+    # so it's possible to use the faster page caching method. But both
+    # the show and feed action are to be shielded behind the authenticate
+    # filter, so we need to implement those as action caches.
+    #
+    # Action caching internally uses the fragment caching and an around
+    # filter to do the job. The fragment cache is named according to both
+    # the current host and the path. So a page that is accessed at
+    # http://david.somewhere.com/lists/show/1 will result in a fragment named
+    # "david.somewhere.com/lists/show/1". This allows the cacher to
+    # differentiate between "david.somewhere.com/lists/" and
+    # "jamis.somewhere.com/lists/" -- which is a helpful way of assisting
+    # the subdomain-as-account-key pattern.
+    #
+    # Different representations of the same resource, e.g.
+    # <tt>http://david.somewhere.com/lists</tt> and
+    # <tt>http://david.somewhere.com/lists.xml</tt>
+    # are treated like separate requests and so are cached separately.
+    # Keep in mind when expiring an action cache that
+    # <tt>:action => 'lists'</tt> is not the same as
+    # <tt>:action => 'list', :format => :xml</tt>.
+    #
+    # You can set modify the default action cache path by passing a
+    # :cache_path option.  This will be passed directly to
+    # ActionCachePath.path_for.  This is handy for actions with multiple
+    # possible routes that should be cached differently.  If a block is
+    # given, it is called with the current controller instance.
+    #
+    # And you can also use :if (or :unless) to pass a Proc that
+    # specifies when the action should be cached.
+    #
+    # Finally, if you are using memcached, you can also pass :expires_in.
+    #
+    #   class ListsController < ApplicationController
+    #     before_filter :authenticate, :except => :public
+    #     caches_page   :public
+    #     caches_action :index, :if => proc do |c|
+    #       !c.request.format.json?  # cache if is not a JSON request
+    #     end
+    #
+    #     caches_action :show, :cache_path => { :project => 1 },
+    #       :expires_in => 1.hour
+    #
+    #     caches_action :feed, :cache_path => proc do |controller|
+    #       if controller.params[:user_id]
+    #         controller.send(:user_list_url,
+    #           controller.params[:user_id], controller.params[:id])
+    #       else
+    #         controller.send(:list_url, controller.params[:id])
+    #       end
+    #     end
+    #   end
+    #
+    # If you pass :layout => false, it will only cache your action
+    # content. It is useful when your layout has dynamic information.
+    #
+    module Actions
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Declares that +actions+ should be cached.
+        # See ActionController::Caching::Actions for details.
+        def caches_action(*actions)
+          return unless cache_configured?
+          options = actions.extract_options!
+          filter_options = options.extract!(:if, :unless).merge(:only => actions)
+          cache_options  = options.extract!(:layout, :cache_path).merge(:store_options => options)
+
+          around_filter ActionCacheFilter.new(cache_options), filter_options
+        end
+      end
+
+      def _render_cache_fragment(cache, extension, layout)
+        render :text => cache, :layout => layout, :content_type => Mime[extension || :html]
+      end
+
+      def _save_fragment(name, layout, options)
+        return unless caching_allowed?
+
+        content = layout ? view_context.content_for(:layout) : response_body
+        write_fragment(name, content, options)
+      end
+
+    protected
+      def expire_action(options = {})
+        return unless cache_configured?
+
+        actions = options[:action]
+        if actions.is_a?(Array)
+          actions.each {|action| expire_action(options.merge(:action => action)) }
+        else
+          expire_fragment(ActionCachePath.new(self, options, false).path)
+        end
+      end
+
+      class ActionCacheFilter #:nodoc:
+        def initialize(options, &block)
+          @cache_path, @store_options, @layout =
+            options.values_at(:cache_path, :store_options, :layout)
+        end
+
+        def filter(controller)
+          path_options = if @cache_path.respond_to?(:call)
+            controller.instance_exec(controller, &@cache_path)
+          else
+            @cache_path
+          end
+
+          cache_path = ActionCachePath.new(controller, path_options || {})
+
+          if cache = controller.read_fragment(cache_path.path, @store_options)
+            controller._render_cache_fragment(cache, cache_path.extension, @layout == false)
+          else
+            yield
+            controller._save_fragment(cache_path.path, @layout == false, @store_options)
+          end
+        end
+      end
+
+      class ActionCachePath
+        attr_reader :path, :extension
+
+        # If +infer_extension+ is true, the cache path extension is looked up from the request's
+        # path & format. This is desirable when reading and writing the cache, but not when
+        # expiring the cache - expire_action should expire the same files regardless of the
+        # request format.
+        def initialize(controller, options = {}, infer_extension = true)
+          if infer_extension
+            @extension = controller.params[:format]
+            options.reverse_merge!(:format => @extension) if options.is_a?(Hash)
+          end
+
+          path = controller.url_for(options).split(%r{://}).last
+          @path = normalize!(path)
+        end
+
+      private
+        def normalize!(path)
+          path << 'index' if path[-1] == ?/
+          path << ".#{extension}" if extension and !path.ends_with?(extension)
+          URI.unescape(path)
+        end
+      end
+    end
+  end
+end

data/lib/action_controller/caching/fragments.rb

@@ -0,0 +1,116 @@
+module ActionController #:nodoc:
+  module Caching
+    # Fragment caching is used for caching various blocks within templates without caching the entire action as a whole. This is useful when
+    # certain elements of an action change frequently or depend on complicated state while other parts rarely change or can be shared amongst multiple
+    # parties. The caching is done using the cache helper available in the Action View. A template with caching might look something like:
+    #
+    #   <b>Hello <%= @name %></b>
+    #   <% cache do %>
+    #     All the topics in the system:
+    #     <%= render :partial => "topic", :collection => Topic.find(:all) %>
+    #   <% end %>
+    #
+    # This cache will bind to the name of the action that called it, so if this code was part of the view for the topics/list action, you would
+    # be able to invalidate it using <tt>expire_fragment(:controller => "topics", :action => "list")</tt>.
+    #
+    # This default behavior is of limited use if you need to cache multiple fragments per action or if the action itself is cached using
+    # <tt>caches_action</tt>, so we also have the option to qualify the name of the cached fragment with something like:
+    #
+    #   <% cache(:action => "list", :action_suffix => "all_topics") do %>
+    #
+    # That would result in a name such as "/topics/list/all_topics", avoiding conflicts with the action cache and with any fragments that use a
+    # different suffix. Note that the URL doesn't have to really exist or be callable - the url_for system is just used to generate unique
+    # cache names that we can refer to when we need to expire the cache.
+    #
+    # The expiration call for this example is:
+    #
+    #   expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")
+    module Fragments
+      # Given a key (as described in <tt>expire_fragment</tt>), returns a key suitable for use in reading,
+      # writing, or expiring a cached fragment. If the key is a hash, the generated key is the return
+      # value of url_for on that hash (without the protocol). All keys are prefixed with "views/" and uses
+      # ActiveSupport::Cache.expand_cache_key for the expansion.
+      def fragment_cache_key(key)
+        ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
+      end
+
+      def fragment_for(buffer, name = {}, options = nil, &block) #:nodoc:
+        if perform_caching
+          if fragment_exist?(name,options)
+            buffer.concat(read_fragment(name, options))
+          else
+            pos = buffer.length
+            block.call
+            write_fragment(name, buffer[pos..-1], options)
+          end
+        else
+          block.call
+        end
+      end
+
+      # Writes <tt>content</tt> to the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
+      def write_fragment(key, content, options = nil)
+        return content unless cache_configured?
+        key = fragment_cache_key(key)
+
+        ActiveSupport::Notifications.instrument(:write_fragment, :key => key) do
+          cache_store.write(key, content, options)
+        end
+        content
+      end
+
+      # Reads a cached fragment from the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
+      def read_fragment(key, options = nil)
+        return unless cache_configured?
+        key = fragment_cache_key(key)
+
+        ActiveSupport::Notifications.instrument(:read_fragment, :key => key) do
+          cache_store.read(key, options)
+        end
+      end
+
+      # Check if a cached fragment from the location signified by <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
+      def fragment_exist?(key, options = nil)
+        return unless cache_configured?
+        key = fragment_cache_key(key)
+
+        ActiveSupport::Notifications.instrument(:fragment_exist?, :key => key) do
+          cache_store.exist?(key, options)
+        end
+      end
+
+      # Removes fragments from the cache.
+      #
+      # +key+ can take one of three forms:
+      # * String - This would normally take the form of a path, like
+      #   <tt>"pages/45/notes"</tt>.
+      # * Hash - Treated as an implicit call to +url_for+, like
+      #   <tt>{:controller => "pages", :action => "notes", :id => 45}</tt>
+      # * Regexp - Will remove any fragment that matches, so
+      #   <tt>%r{pages/\d*/notes}</tt> might remove all notes. Make sure you
+      #   don't use anchors in the regex (<tt>^</tt> or <tt>$</tt>) because
+      #   the actual filename matched looks like
+      #   <tt>./cache/filename/path.cache</tt>. Note: Regexp expiration is
+      #   only supported on caches that can iterate over all keys (unlike
+      #   memcached).
+      #
+      # +options+ is passed through to the cache store's <tt>delete</tt>
+      # method (or <tt>delete_matched</tt>, for Regexp keys.)
+      def expire_fragment(key, options = nil)
+        return unless cache_configured?
+        key = fragment_cache_key(key) unless key.is_a?(Regexp)
+        message = nil
+
+        ActiveSupport::Notifications.instrument(:expire_fragment, :key => key) do
+          if key.is_a?(Regexp)
+            message = "Expired fragments matching: #{key.source}"
+            cache_store.delete_matched(key, options)
+          else
+            message = "Expired fragment: #{key}"
+            cache_store.delete(key, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_controller/caching/pages.rb

@@ -0,0 +1,154 @@
+require 'fileutils'
+require 'uri'
+
+module ActionController #:nodoc:
+  module Caching
+    # Page caching is an approach to caching where the entire action output of is stored as a HTML file that the web server
+    # can serve without going through Action Pack. This is the fastest way to cache your content as opposed to going dynamically
+    # through the process of generating the content. Unfortunately, this incredible speed-up is only available to stateless pages
+    # where all visitors are treated the same. Content management systems -- including weblogs and wikis -- have many pages that are
+    # a great fit for this approach, but account-based systems where people log in and manipulate their own data are often less
+    # likely candidates.
+    #
+    # Specifying which actions to cache is done through the <tt>caches_page</tt> class method:
+    #
+    #   class WeblogController < ActionController::Base
+    #     caches_page :show, :new
+    #   end
+    #
+    # This will generate cache files such as <tt>weblog/show/5.html</tt> and <tt>weblog/new.html</tt>,
+    # which match the URLs used to trigger the dynamic generation. This is how the web server is able
+    # pick up a cache file when it exists and otherwise let the request pass on to Action Pack to generate it.
+    #
+    # Expiration of the cache is handled by deleting the cached file, which results in a lazy regeneration approach where the cache
+    # is not restored before another hit is made against it. The API for doing so mimics the options from +url_for+ and friends:
+    #
+    #   class WeblogController < ActionController::Base
+    #     def update
+    #       List.update(params[:list][:id], params[:list])
+    #       expire_page :action => "show", :id => params[:list][:id]
+    #       redirect_to :action => "show", :id => params[:list][:id]
+    #     end
+    #   end
+    #
+    # Additionally, you can expire caches using Sweepers that act on changes in the model to determine when a cache is supposed to be
+    # expired.
+    module Pages
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+        base.class_eval do
+          @@page_cache_directory = defined?(Rails.public_path) ? Rails.public_path : ""
+          ##
+          # :singleton-method:
+          # The cache directory should be the document root for the web server and is set using <tt>Base.page_cache_directory = "/document/root"</tt>.
+          # For Rails, this directory has already been set to Rails.public_path (which is usually set to <tt>RAILS_ROOT + "/public"</tt>). Changing
+          # this setting can be useful to avoid naming conflicts with files in <tt>public/</tt>, but doing so will likely require configuring your
+          # web server to look in the new location for cached files.
+          cattr_accessor :page_cache_directory
+
+          @@page_cache_extension = '.html'
+          ##
+          # :singleton-method:
+          # Most Rails requests do not have an extension, such as <tt>/weblog/new</tt>. In these cases, the page caching mechanism will add one in
+          # order to make it easy for the cached files to be picked up properly by the web server. By default, this cache extension is <tt>.html</tt>.
+          # If you want something else, like <tt>.php</tt> or <tt>.shtml</tt>, just set Base.page_cache_extension. In cases where a request already has an
+          # extension, such as <tt>.xml</tt> or <tt>.rss</tt>, page caching will not add an extension. This allows it to work well with RESTful apps.
+          cattr_accessor :page_cache_extension
+        end
+      end
+
+      module ClassMethods
+        # Expires the page that was cached with the +path+ as a key. Example:
+        #   expire_page "/lists/show"
+        def expire_page(path)
+          return unless perform_caching
+          path = page_cache_path(path)
+
+          ActiveSupport::Notifications.instrument(:expire_page, :path => path) do
+            File.delete(path) if File.exist?(path)
+          end
+        end
+
+        # Manually cache the +content+ in the key determined by +path+. Example:
+        #   cache_page "I'm the cached content", "/lists/show"
+        def cache_page(content, path)
+          return unless perform_caching
+          path = page_cache_path(path)
+
+          ActiveSupport::Notifications.instrument(:cache_page, :path => path) do
+            FileUtils.makedirs(File.dirname(path))
+            File.open(path, "wb+") { |f| f.write(content) }
+          end
+        end
+
+        # Caches the +actions+ using the page-caching approach that'll store the cache in a path within the page_cache_directory that
+        # matches the triggering url.
+        #
+        # Usage:
+        #
+        #   # cache the index action
+        #   caches_page :index
+        #
+        #   # cache the index action except for JSON requests
+        #   caches_page :index, :if => Proc.new { |c| !c.request.format.json? }
+        def caches_page(*actions)
+          return unless perform_caching
+          options = actions.extract_options!
+          after_filter({:only => actions}.merge(options)) { |c| c.cache_page }
+        end
+
+        private
+          def page_cache_file(path)
+            name = (path.empty? || path == "/") ? "/index" : URI.unescape(path.chomp('/'))
+            name << page_cache_extension unless (name.split('/').last || name).include? '.'
+            return name
+          end
+
+          def page_cache_path(path)
+            page_cache_directory + page_cache_file(path)
+          end
+      end
+
+      # Expires the page that was cached with the +options+ as a key. Example:
+      #   expire_page :controller => "lists", :action => "show"
+      def expire_page(options = {})
+        return unless perform_caching
+
+        if options.is_a?(Hash)
+          if options[:action].is_a?(Array)
+            options[:action].dup.each do |action|
+              self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :action => action)))
+            end
+          else
+            self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true)))
+          end
+        else
+          self.class.expire_page(options)
+        end
+      end
+
+      # Manually cache the +content+ in the key determined by +options+. If no content is provided, the contents of response.body is used
+      # If no options are provided, the requested url is used. Example:
+      #   cache_page "I'm the cached content", :controller => "lists", :action => "show"
+      def cache_page(content = nil, options = nil)
+        return unless perform_caching && caching_allowed
+
+        path = case options
+          when Hash
+            url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :format => params[:format]))
+          when String
+            options
+          else
+            request.path
+        end
+
+        self.class.cache_page(content || response.body, path)
+      end
+
+      private
+        def caching_allowed
+          request.get? && response.status.to_i == 200
+        end
+    end
+  end
+end