actionpack 2.3.18 → 3.0.0.beta

data/lib/action_controller/caching/pages.rb

@@ -62,9 +62,10 @@ module ActionController #:nodoc:
         #   expire_page "/lists/show"
         def expire_page(path)
           return unless perform_caching
+          path = page_cache_path(path)
 
-          benchmark "Expired page: #{page_cache_file(path)}" do
-            File.delete(page_cache_path(path)) if File.exist?(page_cache_path(path))
+          instrument_page_cache :expire_page, path do
+            File.delete(path) if File.exist?(path)
           end
         end
 
@@ -72,10 +73,11 @@ module ActionController #:nodoc:
         #   cache_page "I'm the cached content", "/lists/show"
         def cache_page(content, path)
           return unless perform_caching
+          path = page_cache_path(path)
 
-          benchmark "Cached page: #{page_cache_file(path)}" do
-            FileUtils.makedirs(File.dirname(page_cache_path(path)))
-            File.open(page_cache_path(path), "wb+") { |f| f.write(content) }
+          instrument_page_cache :write_page, path do
+            FileUtils.makedirs(File.dirname(path))
+            File.open(path, "wb+") { |f| f.write(content) }
           end
         end
 
@@ -105,6 +107,10 @@ module ActionController #:nodoc:
           def page_cache_path(path)
             page_cache_directory + page_cache_file(path)
           end
+
+          def instrument_page_cache(name, path)
+            ActiveSupport::Notifications.instrument("action_controller.#{name}", :path => path){ yield }
+          end
       end
 
       # Expires the page that was cached with the +options+ as a key. Example:
@@ -149,4 +155,4 @@ module ActionController #:nodoc:
         end
     end
   end
-end
+end

data/lib/action_controller/caching/sweeping.rb

@@ -51,5 +51,47 @@ module ActionController #:nodoc:
         end
       end
     end
+
+    if defined?(ActiveRecord) and defined?(ActiveRecord::Observer)
+      class Sweeper < ActiveRecord::Observer #:nodoc:
+        attr_accessor :controller
+
+        def before(controller)
+          self.controller = controller
+          callback(:before) if controller.perform_caching
+        end
+
+        def after(controller)
+          callback(:after) if controller.perform_caching
+          # Clean up, so that the controller can be collected after this request
+          self.controller = nil
+        end
+
+        protected
+          # gets the action cache path for the given options.
+          def action_path_for(options)
+            Actions::ActionCachePath.new(controller, options).path
+          end
+
+          # Retrieve instance variables set in the controller.
+          def assigns(key)
+            controller.instance_variable_get("@#{key}")
+          end
+
+        private
+          def callback(timing)
+            controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
+            action_callback_method_name     = "#{controller_callback_method_name}_#{controller.action_name}"
+
+            __send__(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
+            __send__(action_callback_method_name)     if respond_to?(action_callback_method_name, true)
+          end
+
+          def method_missing(method, *arguments, &block)
+            return if @controller.nil?
+            @controller.__send__(method, *arguments, &block)
+          end
+      end
+    end
   end
 end

data/lib/action_controller/deprecated.rb

@@ -0,0 +1,5 @@
+ActionController::AbstractRequest = ActionController::Request = ActionDispatch::Request
+ActionController::AbstractResponse = ActionController::Response = ActionDispatch::Response
+ActionController::Routing = ActionDispatch::Routing
+ActionController::Routing::Routes = ActionDispatch::Routing::RouteSet.new
+ActionController::UrlWriter = ActionController::UrlFor

data/lib/action_controller/deprecated/dispatcher.rb

@@ -0,0 +1,28 @@
+module ActionController
+  class Dispatcher
+    class << self
+      def before_dispatch(*args, &block)
+        ActiveSupport::Deprecation.warn "ActionController::Dispatcher.before_dispatch is deprecated. " <<
+          "Please use ActionDispatch::Callbacks.before instead.", caller
+        ActionDispatch::Callbacks.before(*args, &block)
+      end
+
+      def after_dispatch(*args, &block)
+        ActiveSupport::Deprecation.warn "ActionController::Dispatcher.after_dispatch is deprecated. " <<
+          "Please use ActionDispatch::Callbacks.after instead.", caller
+        ActionDispatch::Callbacks.after(*args, &block)
+      end
+
+      def to_prepare(*args, &block)
+        ActiveSupport::Deprecation.warn "ActionController::Dispatcher.to_prepare is deprecated. " <<
+          "Please use config.to_prepare instead", caller
+        ActionDispatch::Callbacks.after(*args, &block)
+      end
+
+      def new
+        ActiveSupport::Deprecation.warn "ActionController::Dispatcher.new is deprecated, use Rails.application instead."
+        Rails.application
+      end
+    end
+  end
+end

data/lib/action_controller/deprecated/integration_test.rb

@@ -0,0 +1,2 @@
+ActionController::Integration = ActionDispatch::Integration
+ActionController::IntegrationTest = ActionDispatch::IntegrationTest

data/lib/action_controller/deprecated/performance_test.rb

@@ -0,0 +1 @@
+ActionController::PerformanceTest = ActionDispatch::PerformanceTest

data/lib/action_controller/metal.rb

@@ -0,0 +1,125 @@
+require 'active_support/core_ext/class/attribute'
+
+module ActionController
+  # ActionController::Metal provides a way to get a valid Rack application from a controller.
+  #
+  # In AbstractController, dispatching is triggered directly by calling #process on a new controller.
+  # ActionController::Metal provides an #action method that returns a valid Rack application for a
+  # given action. Other rack builders, such as Rack::Builder, Rack::URLMap, and the Rails router,
+  # can dispatch directly to the action returned by FooController.action(:index).
+  class Metal < AbstractController::Base
+    abstract!
+
+    # :api: public
+    attr_internal :params, :env
+
+    # Returns the last part of the controller's name, underscored, without the ending
+    # "Controller". For instance, MyApp::MyPostsController would return "my_posts" for
+    # controller_name
+    #
+    # ==== Returns
+    # String
+    def self.controller_name
+      @controller_name ||= controller_path.split("/").last
+    end
+
+    # Delegates to the class' #controller_name
+    def controller_name
+      self.class.controller_name
+    end
+
+    # The details below can be overridden to support a specific
+    # Request and Response object. The default ActionController::Base
+    # implementation includes RackDelegation, which makes a request
+    # and response object available. You might wish to control the
+    # environment and response manually for performance reasons.
+
+    attr_internal :status, :headers, :content_type, :response
+
+    def initialize(*)
+      @_headers = {}
+      super
+    end
+
+    # Basic implementations for content_type=, location=, and headers are
+    # provided to reduce the dependency on the RackDelegation module
+    # in Renderer and Redirector.
+
+    def content_type=(type)
+      headers["Content-Type"] = type.to_s
+    end
+
+    def location=(url)
+      headers["Location"] = url
+    end
+
+    def status=(status)
+      @_status = Rack::Utils.status_code(status)
+    end
+
+    # :api: private
+    def dispatch(name, env)
+      @_env = env
+      @_env['action_controller.instance'] = self
+      process(name)
+      to_a
+    end
+
+    # :api: private
+    def to_a
+      response ? response.to_a : [status, headers, response_body]
+    end
+
+    class ActionEndpoint
+      @@endpoints = Hash.new {|h,k| h[k] = Hash.new {|sh,sk| sh[sk] = {} } }
+
+      def self.for(controller, action, stack)
+        @@endpoints[controller][action][stack] ||= begin
+          endpoint = new(controller, action)
+          stack.build(endpoint)
+        end
+      end
+
+      def initialize(controller, action)
+        @controller, @action = controller, action
+        @_formats = [Mime::HTML]
+      end
+
+      def call(env)
+        @controller.new.dispatch(@action, env)
+      end
+    end
+
+    class_attribute :middleware_stack
+    self.middleware_stack = ActionDispatch::MiddlewareStack.new
+
+    def self.inherited(base)
+      self.middleware_stack = base.middleware_stack.dup
+    end
+
+    def self.use(*args)
+      middleware_stack.use(*args)
+    end
+
+    def self.middleware
+      middleware_stack
+    end
+
+    def self.call(env)
+      action(env['action_dispatch.request.path_parameters'][:action]).call(env)
+    end
+
+    # Return a rack endpoint for the given action. Memoize the endpoint, so
+    # multiple calls into MyController.action will return the same object
+    # for the same action.
+    #
+    # ==== Parameters
+    # action<#to_s>:: An action name
+    #
+    # ==== Returns
+    # Proc:: A rack application
+    def self.action(name)
+      ActionEndpoint.for(self, name, middleware_stack)
+    end
+  end
+end

data/lib/action_controller/metal/compatibility.rb

@@ -0,0 +1,141 @@
+module ActionController
+  module Compatibility
+    extend ActiveSupport::Concern
+
+    include AbstractController::Compatibility
+
+    class ::ActionController::ActionControllerError < StandardError #:nodoc:
+    end
+
+    # Temporary hax
+    included do
+      ::ActionController::UnknownAction = ::AbstractController::ActionNotFound
+      ::ActionController::DoubleRenderError = ::AbstractController::DoubleRenderError
+
+      cattr_accessor :session_options
+      self.session_options = {}
+
+      cattr_accessor :relative_url_root
+      self.relative_url_root = ENV['RAILS_RELATIVE_URL_ROOT']
+
+      class << self
+        delegate :default_charset=, :to => "ActionDispatch::Response"
+        delegate :resources_path_names, :to => "ActionController::Routing::Routes"
+        delegate :resources_path_names=, :to => "ActionController::Routing::Routes"
+      end
+
+      # cattr_reader :protected_instance_variables
+      cattr_accessor :protected_instance_variables
+      self.protected_instance_variables = %w(@assigns @performed_redirect @performed_render
+                                             @variables_added @request_origin @url
+                                             @parent_controller @action_name
+                                             @before_filter_chain_aborted @_headers @_params
+                                             @_response)
+
+      # Controls the resource action separator
+      cattr_accessor :resource_action_separator
+      self.resource_action_separator = "/"
+
+      cattr_accessor :use_accept_header
+      self.use_accept_header = true
+
+      self.page_cache_directory = defined?(Rails.public_path) ? Rails.public_path : ""
+
+      # Prepends all the URL-generating helpers from AssetHelper. This makes it possible to easily move javascripts, stylesheets,
+      # and images to a dedicated asset server away from the main web server. Example:
+      #   ActionController::Base.asset_host = "http://assets.example.com"
+      cattr_accessor :asset_host
+
+      cattr_accessor :ip_spoofing_check
+      self.ip_spoofing_check = true
+
+      cattr_accessor :trusted_proxies
+    end
+
+    # For old tests
+    def initialize_template_class(*) end
+    def assign_shortcuts(*) end
+
+    # TODO: Remove this after we flip
+    def template
+      @template ||= view_context
+    end
+
+    def process_action(*)
+      template
+      super
+    end
+
+    module ClassMethods
+      def consider_all_requests_local
+        ActiveSupport::Deprecation.warn "ActionController::Base.consider_all_requests_local is deprecated, " <<
+          "use Rails.application.config.consider_all_requests_local instead"
+        Rails.application.config.consider_all_requests_local
+      end
+
+      def consider_all_requests_local=(value)
+        ActiveSupport::Deprecation.warn "ActionController::Base.consider_all_requests_local= is no longer effective. " <<
+          "Please configure it on your application with config.consider_all_requests_local="
+      end
+
+      def allow_concurrency
+        ActiveSupport::Deprecation.warn "ActionController::Base.allow_concurrency is deprecated, " <<
+          "use Rails.application.config.allow_concurrency instead"
+        Rails.application.config.allow_concurrency
+      end
+
+      def allow_concurrency=(value)
+        ActiveSupport::Deprecation.warn "ActionController::Base.allow_concurrency= is no longer effective. " <<
+          "Please configure it on your application with config.allow_concurrency="
+      end
+
+      def rescue_action(env)
+        raise env["action_dispatch.rescue.exception"]
+      end
+
+      # Defines the storage option for cached fragments
+      def cache_store=(store_option)
+        @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
+      end
+    end
+
+    delegate :consider_all_requests_local, :consider_all_requests_local=,
+             :allow_concurrency, :allow_concurrency=, :to => :"self.class"
+
+    def render_to_body(options)
+      if options.is_a?(Hash) && options.key?(:template)
+        options[:template].sub!(/^\//, '')
+      end
+
+      options[:text] = nil if options.delete(:nothing) == true
+      options[:text] = " " if options.key?(:text) && options[:text].nil?
+
+      super || " "
+    end
+
+    def _handle_method_missing
+      method_missing(@_action_name.to_sym)
+    end
+
+    def method_for_action(action_name)
+      super || (respond_to?(:method_missing) && "_handle_method_missing")
+    end
+
+    def performed?
+      response_body
+    end
+
+    # ==== Request only view path switching ====
+    def append_view_path(path)
+      view_paths.push(*path)
+    end
+
+    def prepend_view_path(path)
+      view_paths.unshift(*path)
+    end
+
+    def view_paths
+      view_context.view_paths
+    end
+  end
+end

data/lib/action_controller/metal/conditional_get.rb

@@ -0,0 +1,86 @@
+module ActionController
+  module ConditionalGet
+    extend ActiveSupport::Concern
+
+    include RackDelegation
+    include Head
+
+    # Sets the etag, last_modified, or both on the response and renders a
+    # "304 Not Modified" response if the request is already fresh.
+    #
+    # Parameters:
+    # * <tt>:etag</tt>
+    # * <tt>:last_modified</tt>
+    # * <tt>:public</tt> By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
+    #
+    # Example:
+    #
+    #   def show
+    #     @article = Article.find(params[:id])
+    #     fresh_when(:etag => @article, :last_modified => @article.created_at.utc, :public => true)
+    #   end
+    #
+    # This will render the show template if the request isn't sending a matching etag or
+    # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
+    #
+    def fresh_when(options)
+      options.assert_valid_keys(:etag, :last_modified, :public)
+
+      response.etag          = options[:etag]          if options[:etag]
+      response.last_modified = options[:last_modified] if options[:last_modified]
+      response.cache_control[:public] = true if options[:public]
+
+      head :not_modified if request.fresh?(response)
+    end
+
+    # Sets the etag and/or last_modified on the response and checks it against
+    # the client request. If the request doesn't match the options provided, the
+    # request is considered stale and should be generated from scratch. Otherwise,
+    # it's fresh and we don't need to generate anything and a reply of "304 Not Modified" is sent.
+    #
+    # Parameters:
+    # * <tt>:etag</tt>
+    # * <tt>:last_modified</tt>
+    # * <tt>:public</tt> By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
+    #
+    # Example:
+    #
+    #   def show
+    #     @article = Article.find(params[:id])
+    #
+    #     if stale?(:etag => @article, :last_modified => @article.created_at.utc)
+    #       @statistics = @article.really_expensive_call
+    #       respond_to do |format|
+    #         # all the supported formats
+    #       end
+    #     end
+    #   end
+    def stale?(options)
+      fresh_when(options)
+      !request.fresh?(response)
+    end
+
+    # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
+    # intermediate caches shouldn't cache the response.
+    #
+    # Examples:
+    #   expires_in 20.minutes
+    #   expires_in 3.hours, :public => true
+    #   expires in 3.hours, 'max-stale' => 5.hours, :public => true
+    #
+    # This method will overwrite an existing Cache-Control header.
+    # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
+    def expires_in(seconds, options = {}) #:doc:
+      response.cache_control.merge!(:max_age => seconds, :public => options.delete(:public))
+      options.delete(:private)
+
+      response.cache_control[:extras] = options.map {|k,v| "#{k}=#{v}"}
+    end
+
+    # Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
+    # intermediate caches (like caching proxy servers).
+    def expires_now #:doc:
+      response.cache_control.replace(:no_cache => true)
+    end
+  end
+end