actionpack 2.3.18 → 3.0.0.beta

data/lib/action_controller/caching.rb

@@ -3,69 +3,82 @@ 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.
+  # 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 Base.perform_caching = false.
+  # 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 is 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.
+  # 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):
   #
-  #   ActionController::Base.cache_store = :memory_store
-  #   ActionController::Base.cache_store = :file_store, "/path/to/cache/directory"
-  #   ActionController::Base.cache_store = :drb_store, "druby://localhost:9192"
-  #   ActionController::Base.cache_store = :mem_cache_store, "localhost"
-  #   ActionController::Base.cache_store = :mem_cache_store, Memcached::Rails.new("localhost:11211")
-  #   ActionController::Base.cache_store = MyOwnStore.new("parameter")
+  #   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 = :mem_cache_store, Memcached::Rails.new("localhost:11211")
+  #   config.action_controller.cache_store = MyOwnStore.new("parameter")
   module Caching
-    autoload :Actions, 'action_controller/caching/actions'
-    autoload :Fragments, 'action_controller/caching/fragments'
-    autoload :Pages, 'action_controller/caching/pages'
-    autoload :Sweeper, 'action_controller/caching/sweeper'
-    autoload :Sweeping, 'action_controller/caching/sweeping'
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
 
-    def self.included(base) #:nodoc:
-      base.class_eval do
-        @@cache_store = nil
-        cattr_reader :cache_store
+    eager_autoload do
+      autoload :Actions
+      autoload :Fragments
+      autoload :Pages
+      autoload :Sweeper, 'action_controller/caching/sweeping'
+      autoload :Sweeping, 'action_controller/caching/sweeping'
+    end
 
-        # Defines the storage option for cached fragments
-        def self.cache_store=(store_option)
-          @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
-        end
+    included do
+      @@cache_store = nil
+      cattr_reader :cache_store
 
-        include Pages, Actions, Fragments
-        include Sweeping if defined?(ActiveRecord)
+      # Defines the storage option for cached fragments
+      def self.cache_store=(store_option)
+        @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
+      end
 
-        @@perform_caching = true
-        cattr_accessor :perform_caching
+      include Pages, Actions, Fragments
+      include Sweeping if defined?(ActiveRecord)
 
-        def self.cache_configured?
-          perform_caching && cache_store
-        end
-      end
+      @@perform_caching = true
+      cattr_accessor :perform_caching
     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
+    module ClassMethods
+      def cache_configured?
+        perform_caching && cache_store
       end
+    end
 
-    private
-      def cache_configured?
-        self.class.cache_configured?
+    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

@@ -2,9 +2,12 @@ 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:
+    # 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
@@ -12,45 +15,64 @@ module ActionController #:nodoc:
     #     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.
+    # 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.
+    # 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>.
+    # 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.
+    # 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.
+    # 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.new { |c| !c.request.format.json? } # cache if is not a JSON request
-    #     caches_action :show, :cache_path => { :project => 1 }, :expires_in => 1.hour
-    #     caches_action :feed, :cache_path => Proc.new { |controller|
-    #       controller.params[:user_id] ?
-    #         controller.send(:user_list_url, controller.params[:user_id], controller.params[:id]) :
-    #         controller.send(:list_url, controller.params[:id]) }
+    #     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.
+    # If you pass :layout => false, it will only cache your action
+    # content. It is useful when your layout has dynamic information.
     #
     module Actions
-      def self.included(base) #:nodoc:
-        base.extend(ClassMethods)
-          base.class_eval do
-            attr_accessor :rendered_action_cache, :action_cache_path
-          end
-      end
+      extend ActiveSupport::Concern
 
       module ClassMethods
         # Declares that +actions+ should be cached.
@@ -58,119 +80,83 @@ module ActionController #:nodoc:
         def caches_action(*actions)
           return unless cache_configured?
           options = actions.extract_options!
-          filter_options = { :only => actions, :if => options.delete(:if), :unless => options.delete(:unless) }
+          filter_options = options.extract!(:if, :unless).merge(:only => actions)
+          cache_options  = options.extract!(:layout, :cache_path).merge(:store_options => options)
 
-          cache_filter = ActionCacheFilter.new(:layout => options.delete(:layout), :cache_path => options.delete(:cache_path), :store_options => options)
-          around_filter(filter_options) do |controller, action|
-            cache_filter.filter(controller, action)
-          end
+          around_filter ActionCacheFilter.new(cache_options), filter_options
         end
       end
 
-      protected
-        def expire_action(options = {})
-          return unless cache_configured?
+      def _render_cache_fragment(cache, extension, layout)
+        render :text => cache, :layout => layout, :content_type => Mime[extension || :html]
+      end
 
-          if options[:action].is_a?(Array)
-            options[:action].dup.each do |action|
-              expire_fragment(ActionCachePath.path_for(self, options.merge({ :action => action }), false))
-            end
-          else
-            expire_fragment(ActionCachePath.path_for(self, options, false))
-          end
-        end
+      def _save_fragment(name, layout, options)
+        return unless caching_allowed?
 
-      class ActionCacheFilter #:nodoc:
-        def initialize(options, &block)
-          @options = options
-        end
+        content = layout ? view_context.content_for(:layout) : response_body
+        write_fragment(name, content, options)
+      end
 
-        def filter(controller, action)
-          should_continue = before(controller)
-          action.call if should_continue
-          after(controller)
-        end
+    protected
+      def expire_action(options = {})
+        return unless cache_configured?
 
-        def before(controller)
-          cache_path = ActionCachePath.new(controller, path_options_for(controller, @options.slice(:cache_path)))
-          if cache = controller.read_fragment(cache_path.path, @options[:store_options])
-            controller.rendered_action_cache = true
-            set_content_type!(controller, cache_path.extension)
-            options = { :text => cache }
-            options.merge!(:layout => true) if cache_layout?
-            controller.__send__(:render, options)
-            false
-          else
-            controller.action_cache_path = cache_path
-          end
+        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
 
-        def after(controller)
-          return if controller.rendered_action_cache || !caching_allowed(controller)
-          action_content = cache_layout? ? content_for_layout(controller) : controller.response.body
-          controller.write_fragment(controller.action_cache_path.path, action_content, @options[:store_options])
+      class ActionCacheFilter #:nodoc:
+        def initialize(options, &block)
+          @cache_path, @store_options, @layout =
+            options.values_at(:cache_path, :store_options, :layout)
         end
 
-        private
-          def set_content_type!(controller, extension)
-            controller.response.content_type = Mime::Type.lookup_by_extension(extension).to_s if extension
-          end
-
-          def path_options_for(controller, options)
-            ((path_options = options[:cache_path]).respond_to?(:call) ? path_options.call(controller) : path_options) || {}
-          end
-
-          def caching_allowed(controller)
-            controller.request.get? && controller.response.status.to_i == 200
+        def filter(controller)
+          path_options = if @cache_path.respond_to?(:call)
+            controller.instance_exec(controller, &@cache_path)
+          else
+            @cache_path
           end
 
-          def cache_layout?
-            @options[:layout] == false
-          end
+          cache_path = ActionCachePath.new(controller, path_options || {})
 
-          def content_for_layout(controller)
-            controller.response.layout && controller.response.template.instance_variable_get('@cached_content_for_layout')
+          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
 
-        class << self
-          def path_for(controller, options, infer_extension = true)
-            new(controller, options, infer_extension).path
-          end
-        end
-        
-        # When true, infer_extension will look up the cache path extension 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.
+        # 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
-            extract_extension(controller.request)
-            options = options.reverse_merge(:format => @extension) if options.is_a?(Hash)
+            @extension = controller.params[:format]
+            options.reverse_merge!(:format => @extension) if options.is_a?(Hash)
           end
 
-          path = controller.url_for(options).split('://').last
-          normalize!(path)
-          add_extension!(path, @extension)
-          @path = URI.unescape(path)
+          path = controller.url_for(options).split(%r{://}).last
+          @path = normalize!(path)
         end
 
-        private
-          def normalize!(path)
-            path << 'index' if path[-1] == ?/
-          end
-
-          def add_extension!(path, extension)
-            path << ".#{extension}" if extension and !path.ends_with?(extension)
-          end
-          
-          def extract_extension(request)
-            # Don't want just what comes after the last '.' to accommodate multi part extensions
-            # such as tar.gz.
-            @extension = request.path[/^[^.]+\.(.+)$/, 1] || request.cache_format
-          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

data/lib/action_controller/caching/fragments.rb

@@ -36,8 +36,8 @@ module ActionController #:nodoc:
 
       def fragment_for(buffer, name = {}, options = nil, &block) #:nodoc:
         if perform_caching
-          if cache = read_fragment(name, options)
-            buffer.safe_concat(cache.html_safe)
+          if fragment_exist?(name, options)
+            buffer.safe_concat(read_fragment(name, options))
           else
             pos = buffer.length
             block.call
@@ -51,34 +51,30 @@ module ActionController #:nodoc:
       # 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)
 
-        self.class.benchmark "Cached fragment miss: #{key}" do
-          key = fragment_cache_key(key)
-          content = content.html_safe.to_str if content.respond_to?(:html_safe)
+        instrument_fragment_cache :write_fragment, 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)
-        self.class.benchmark "Cached fragment hit: #{key}" do
-          result = cache_store.read(key, options)
-          result.respond_to?(:html_safe) ? result.html_safe : result
+
+        instrument_fragment_cache :read_fragment, 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)
 
-        self.class.benchmark "Cached fragment exists?: #{key}" do
+        instrument_fragment_cache :exist_fragment?, key do
           cache_store.exist?(key, options)
         end
       end
@@ -102,19 +98,21 @@ module ActionController #:nodoc:
       # 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
 
-        key = key.is_a?(Regexp) ? key : fragment_cache_key(key)
-
-        if key.is_a?(Regexp)
-          self.class.benchmark "Expired fragments matching: #{key.source}" do
+        instrument_fragment_cache :expire_fragment, key do
+          if key.is_a?(Regexp)
             cache_store.delete_matched(key, options)
-          end
-        else
-          self.class.benchmark "Expired fragment: #{key}" do
+          else
             cache_store.delete(key, options)
           end
         end
       end
+
+      def instrument_fragment_cache(name, key)
+        ActiveSupport::Notifications.instrument("action_controller.#{name}", :key => key){ yield }
+      end
     end
   end
 end