Merge remote branch 'mainstream/master'

7 files changed, 217 insertions, 90 deletions

diff --git a/actionpack/lib/abstract_controller/base.rb b/actionpack/lib/abstract_controller/base.rb
index f5b1c9e4d1..a6889d5d01 100644
--- a/actionpack/lib/abstract_controller/base.rb
+++ b/actionpack/lib/abstract_controller/base.rb
@@ -1,8 +1,11 @@
 module AbstractController
+  class Error < StandardError; end
+  class ActionNotFound < StandardError; end
 
   class Base
     attr_internal :response_body
     attr_internal :action_name
+    attr_internal :formats
 
     class << self
       attr_reader :abstract
@@ -69,26 +72,43 @@ module AbstractController
           # And always exclude explicitly hidden actions
           hidden_actions
       end
+
+      # Returns the full controller name, underscored, without the ending Controller.
+      # For instance, MyApp::MyPostsController would return "my_app/my_posts" for
+      # controller_name.
+      #
+      # ==== Returns
+      # String
+      def controller_path
+        @controller_path ||= name && name.sub(/Controller$/, '').underscore
+      end
     end
 
     abstract!
 
     # Calls the action going through the entire action dispatch stack.
-    # 
+    #
     # The actual method that is called is determined by calling
     # #method_for_action. If no method can handle the action, then an
     # ActionNotFound error is raised.
     #
     # ==== Returns
     # self
-    def process(action)
+    def process(action, *args)
       @_action_name = action_name = action.to_s
 
       unless action_name = method_for_action(action_name)
         raise ActionNotFound, "The action '#{action}' could not be found"
       end
 
-      process_action(action_name)
+      @_response_body = nil
+
+      process_action(action_name, *args)
+    end
+
+    # Delegates to the class' #controller_path
+    def controller_path
+      self.class.controller_path
     end
 
   private
@@ -108,8 +128,8 @@ module AbstractController
     # Call the action. Override this in a subclass to modify the
     # behavior around processing an action. This, and not #process,
     # is the intended way to override action dispatching.
-    def process_action(method_name)
-      send_action(method_name)
+    def process_action(method_name, *args)
+      send_action(method_name, *args)
     end
 
     # Actually call the method associated with the action. Override
diff --git a/actionpack/lib/abstract_controller/exceptions.rb b/actionpack/lib/abstract_controller/exceptions.rb
deleted file mode 100644
index b671516de1..0000000000
--- a/actionpack/lib/abstract_controller/exceptions.rb
+++ /dev/null
@@ -1,12 +0,0 @@
-module AbstractController
-  class Error < StandardError; end
-  class ActionNotFound < StandardError; end
-
-  class DoubleRenderError < Error
-    DEFAULT_MESSAGE = "Render and/or redirect were called multiple times in this action. Please note that you may only call render OR redirect, and at most once per action. Also note that neither redirect nor render terminate execution of the action, so if you want to exit an action after redirecting, you need to do something like \"redirect_to(...) and return\"."
-
-    def initialize(message = nil)
-      super(message || DEFAULT_MESSAGE)
-    end
-  end
-end
diff --git a/actionpack/lib/abstract_controller/helpers.rb b/actionpack/lib/abstract_controller/helpers.rb
index d3b492ad09..1d898d1a4c 100644
--- a/actionpack/lib/abstract_controller/helpers.rb
+++ b/actionpack/lib/abstract_controller/helpers.rb
@@ -4,7 +4,7 @@ module AbstractController
   module Helpers
     extend ActiveSupport::Concern
 
-    include RenderingController
+    include Rendering
 
     def self.next_serial
       @helper_serial ||= 0
diff --git a/actionpack/lib/abstract_controller/layouts.rb b/actionpack/lib/abstract_controller/layouts.rb
index c71cef42b2..6fbf6bc392 100644
--- a/actionpack/lib/abstract_controller/layouts.rb
+++ b/actionpack/lib/abstract_controller/layouts.rb
@@ -1,8 +1,164 @@
 module AbstractController
+  # Layouts reverse the common pattern of including shared headers and footers in many templates to isolate changes in
+  # repeated setups. The inclusion pattern has pages that look like this:
+  #
+  #   <%= render "shared/header" %>
+  #   Hello World
+  #   <%= render "shared/footer" %>
+  #
+  # This approach is a decent way of keeping common structures isolated from the changing content, but it's verbose
+  # and if you ever want to change the structure of these two includes, you'll have to change all the templates.
+  #
+  # With layouts, you can flip it around and have the common structure know where to insert changing content. This means
+  # that the header and footer are only mentioned in one place, like this:
+  #
+  #   // The header part of this layout
+  #   <%= yield %>
+  #   // The footer part of this layout
+  #
+  # And then you have content pages that look like this:
+  #
+  #    hello world
+  #
+  # At rendering time, the content page is computed and then inserted in the layout, like this:
+  #
+  #   // The header part of this layout
+  #   hello world
+  #   // The footer part of this layout
+  #
+  # == Accessing shared variables
+  #
+  # Layouts have access to variables specified in the content pages and vice versa. This allows you to have layouts with
+  # references that won't materialize before rendering time:
+  #
+  #   <h1><%= @page_title %></h1>
+  #   <%= yield %>
+  #
+  # ...and content pages that fulfill these references _at_ rendering time:
+  #
+  #    <% @page_title = "Welcome" %>
+  #    Off-world colonies offers you a chance to start a new life
+  #
+  # The result after rendering is:
+  #
+  #   <h1>Welcome</h1>
+  #   Off-world colonies offers you a chance to start a new life
+  #
+  # == Layout assignment
+  #
+  # You can either specify a layout declaratively (using the #layout class method) or give
+  # it the same name as your controller, and place it in <tt>app/views/layouts</tt>.
+  # If a subclass does not have a layout specified, it inherits its layout using normal Ruby inheritance.
+  #
+  # For instance, if you have PostsController and a template named <tt>app/views/layouts/posts.html.erb</tt>,
+  # that template will be used for all actions in PostsController and controllers inheriting
+  # from PostsController.
+  #
+  # If you use a module, for instance Weblog::PostsController, you will need a template named
+  # <tt>app/views/layouts/weblog/posts.html.erb</tt>.
+  #
+  # Since all your controllers inherit from ApplicationController, they will use
+  # <tt>app/views/layouts/application.html.erb</tt> if no other layout is specified
+  # or provided.
+  #
+  # == Inheritance Examples
+  #
+  #   class BankController < ActionController::Base
+  #     layout "bank_standard"
+  #
+  #   class InformationController < BankController
+  #
+  #   class TellerController < BankController
+  #     # teller.html.erb exists
+  #
+  #   class TillController < TellerController
+  #
+  #   class VaultController < BankController
+  #     layout :access_level_layout
+  #
+  #   class EmployeeController < BankController
+  #     layout nil
+  #
+  # The InformationController uses "bank_standard" inherited from the BankController, the VaultController overwrites
+  # and picks the layout dynamically, and the EmployeeController doesn't want to use a layout at all.
+  #
+  # The TellerController uses +teller.html.erb+, and TillController inherits that layout and
+  # uses it as well.
+  #
+  # == Types of layouts
+  #
+  # Layouts are basically just regular templates, but the name of this template needs not be specified statically. Sometimes
+  # you want to alternate layouts depending on runtime information, such as whether someone is logged in or not. This can
+  # be done either by specifying a method reference as a symbol or using an inline method (as a proc).
+  #
+  # The method reference is the preferred approach to variable layouts and is used like this:
+  #
+  #   class WeblogController < ActionController::Base
+  #     layout :writers_and_readers
+  #
+  #     def index
+  #       # fetching posts
+  #     end
+  #
+  #     private
+  #       def writers_and_readers
+  #         logged_in? ? "writer_layout" : "reader_layout"
+  #       end
+  #
+  # Now when a new request for the index action is processed, the layout will vary depending on whether the person accessing
+  # is logged in or not.
+  #
+  # If you want to use an inline method, such as a proc, do something like this:
+  #
+  #   class WeblogController < ActionController::Base
+  #     layout proc{ |controller| controller.logged_in? ? "writer_layout" : "reader_layout" }
+  #
+  # Of course, the most common way of specifying a layout is still just as a plain template name:
+  #
+  #   class WeblogController < ActionController::Base
+  #     layout "weblog_standard"
+  #
+  # If no directory is specified for the template name, the template will by default be looked for in <tt>app/views/layouts/</tt>.
+  # Otherwise, it will be looked up relative to the template root.
+  #
+  # == Conditional layouts
+  #
+  # If you have a layout that by default is applied to all the actions of a controller, you still have the option of rendering
+  # a given action or set of actions without a layout, or restricting a layout to only a single action or a set of actions. The
+  # <tt>:only</tt> and <tt>:except</tt> options can be passed to the layout call. For example:
+  #
+  #   class WeblogController < ActionController::Base
+  #     layout "weblog_standard", :except => :rss
+  #
+  #     # ...
+  #
+  #   end
+  #
+  # This will assign "weblog_standard" as the WeblogController's layout  except for the +rss+ action, which will not wrap a layout
+  # around the rendered view.
+  #
+  # Both the <tt>:only</tt> and <tt>:except</tt> condition can accept an arbitrary number of method references, so
+  # #<tt>:except => [ :rss, :text_only ]</tt> is valid, as is <tt>:except => :rss</tt>.
+  #
+  # == Using a different layout in the action render call
+  #
+  # If most of your actions use the same layout, it makes perfect sense to define a controller-wide layout as described above.
+  # Sometimes you'll have exceptions where one action wants to use a different layout than the rest of the controller.
+  # You can do this by passing a <tt>:layout</tt> option to the <tt>render</tt> call. For example:
+  #
+  #   class WeblogController < ActionController::Base
+  #     layout "weblog_standard"
+  #
+  #     def help
+  #       render :action => "help", :layout => "help"
+  #     end
+  #   end
+  #
+  # This will render the help action with the "help" layout instead of the controller-wide "weblog_standard" layout.
   module Layouts
     extend ActiveSupport::Concern
 
-    include RenderingController
+    include Rendering
 
     included do
       extlib_inheritable_accessor(:_layout_conditions) { Hash.new }
@@ -20,7 +176,7 @@ module AbstractController
       end
 
       def clear_template_caches!
-        @found_layouts.clear if @found_layouts
+        @found_layouts.clear if defined? @found_layouts
         super
       end
 
@@ -89,7 +245,7 @@ module AbstractController
       # ==== Returns
       # String:: A template name
       def _implied_layout_name
-        name && name.underscore
+        controller_path
       end
 
       # Takes the specified layout and creates a _layout method to be called
diff --git a/actionpack/lib/abstract_controller/localized_cache.rb b/actionpack/lib/abstract_controller/localized_cache.rb
index ee7b43cb9f..bf648af60a 100644
--- a/actionpack/lib/abstract_controller/localized_cache.rb
+++ b/actionpack/lib/abstract_controller/localized_cache.rb
@@ -1,6 +1,6 @@
 module AbstractController
   class HashKey
-    @hash_keys = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = {} } }
+    @hash_keys = Hash.new {|h,k| h[k] = Hash.new {|sh,sk| sh[sk] = {} } }
 
     def self.get(klass, formats, locale)
       @hash_keys[klass][formats][locale] ||= new(klass, formats, locale)
diff --git a/actionpack/lib/abstract_controller/logger.rb b/actionpack/lib/abstract_controller/logger.rb
index 27ba5be45f..a23a13e1d6 100644
--- a/actionpack/lib/abstract_controller/logger.rb
+++ b/actionpack/lib/abstract_controller/logger.rb
@@ -9,53 +9,5 @@ module AbstractController
       cattr_accessor :logger
       extend ActiveSupport::Benchmarkable
     end
-
-    # A class that allows you to defer expensive processing
-    # until the logger actually tries to log. Otherwise, you are
-    # forced to do the processing in advance, and send the
-    # entire processed String to the logger, which might
-    # just discard the String if the log level is too low.
-    #
-    # TODO: Require that Rails loggers accept a block.
-    class DelayedLog < ActiveSupport::BasicObject
-      def initialize(&block)
-        @str, @block = nil, block
-      end
-
-      def method_missing(*args, &block)
-        unless @str
-          @str, @block = @block.call, nil
-        end
-        @str.send(*args, &block)
-      end
-    end
-
-    # Override process_action in the AbstractController::Base
-    # to log details about the method.
-    def process_action(action)
-      result = ActiveSupport::Notifications.instrument(:process_action,
-                :controller => self, :action => action) do
-        super
-      end
-
-      if logger
-        log = DelayedLog.new do
-          "\n\nProcessing #{self.class.name}\##{action_name} " \
-          "to #{request.formats} (for #{request_origin}) " \
-          "[#{request.method.to_s.upcase}]"
-        end
-
-        logger.info(log)
-      end
-
-      result
-    end
-
-  private
-    # Returns the request origin with the IP and time. This needs to be cached,
-    # otherwise we would get different results for each time it calls.
-    def request_origin
-      @request_origin ||= "#{request.remote_ip} at #{Time.now.to_s(:db)}"
-    end
   end
 end
diff --git a/actionpack/lib/abstract_controller/rendering_controller.rb b/actionpack/lib/abstract_controller/rendering.rb
index 7054b9cf26..332d86b089 100644
--- a/actionpack/lib/abstract_controller/rendering_controller.rb
+++ b/actionpack/lib/abstract_controller/rendering.rb
@@ -1,13 +1,18 @@
-require "abstract_controller/logger"
+require "abstract_controller/base"
 
 module AbstractController
-  module RenderingController
-    extend ActiveSupport::Concern
+  class DoubleRenderError < Error
+    DEFAULT_MESSAGE = "Render and/or redirect were called multiple times in this action. Please note that you may only call render OR redirect, and at most once per action. Also note that neither redirect nor render terminate execution of the action, so if you want to exit an action after redirecting, you need to do something like \"redirect_to(...) and return\"."
 
-    include AbstractController::Logger
+    def initialize(message = nil)
+      super(message || DEFAULT_MESSAGE)
+    end
+  end
+
+  module Rendering
+    extend ActiveSupport::Concern
 
     included do
-      attr_internal :formats
       extlib_inheritable_accessor :_view_paths
       self._view_paths ||= ActionView::PathSet.new
     end
@@ -21,7 +26,7 @@ module AbstractController
     # An instance of a view class. The default view class is ActionView::Base
     #
     # The view class must have the following methods:
-    # View.for_controller[controller] Create a new ActionView instance for a 
+    # View.for_controller[controller] Create a new ActionView instance for a
     #   controller
     # View#render_partial[options]
     #   - responsible for setting options[:_template]
@@ -59,7 +64,7 @@ module AbstractController
     def render_to_body(options = {})
       # TODO: Refactor so we can just use the normal template logic for this
       if options.key?(:partial)
-        view_context.render_partial(options)
+        _render_partial(options)
       else
         _determine_template(options)
         _render_template(options)
@@ -71,7 +76,7 @@ module AbstractController
     #
     # :api: plugin
     def render_to_string(options = {})
-      AbstractController::RenderingController.body_to_s(render_to_body(options))
+      AbstractController::Rendering.body_to_s(render_to_body(options))
     end
 
     # Renders the template from an object.
@@ -79,11 +84,18 @@ module AbstractController
     # ==== Options
     # _template<ActionView::Template>:: The template to render
     # _layout<ActionView::Template>:: The layout to wrap the template in (optional)
-    # _partial<TrueClass, FalseClass>:: Whether or not the template to be rendered is a partial
     def _render_template(options)
       view_context.render_template(options)
     end
 
+    # Renders the given partial.
+    #
+    # ==== Options
+    # partial<String|Object>:: The partial name or the object to be rendered
+    def _render_partial(options)
+      view_context.render_partial(options)
+    end
+
     # The list of view paths for this controller. See ActionView::ViewPathSet for
     # more details about writing custom view paths.
     def view_paths
@@ -115,10 +127,10 @@ module AbstractController
     # _partial<TrueClass, FalseClass>:: Whether or not the file to look up is a partial
     def _determine_template(options)
       if options.key?(:text)
-        options[:_template] = ActionView::TextTemplate.new(options[:text], format_for_text)
+        options[:_template] = ActionView::Template::Text.new(options[:text], format_for_text)
       elsif options.key?(:inline)
-        handler = ActionView::Template.handler_class_for_extension(options[:type] || "erb")
-        template = ActionView::Template.new(options[:inline], "inline #{options[:inline].inspect}", handler, {})
+        handler  = ActionView::Template.handler_class_for_extension(options[:type] || "erb")
+        template = ActionView::Template.new(options[:inline], "inline template", handler, {})
         options[:_template] = template
       elsif options.key?(:template)
         options[:_template_name] = options[:template]
@@ -152,12 +164,12 @@ module AbstractController
     module ClassMethods
       def clear_template_caches!
       end
-      
+
       # Append a path to the list of view paths for this controller.
       #
       # ==== Parameters
-      # path<String, ViewPath>:: If a String is provided, it gets converted into 
-      # the default view path. You may also provide a custom view path 
+      # path<String, ViewPath>:: If a String is provided, it gets converted into
+      # the default view path. You may also provide a custom view path
       # (see ActionView::ViewPathSet for more information)
       def append_view_path(path)
         self.view_paths << path
@@ -166,8 +178,8 @@ module AbstractController
       # Prepend a path to the list of view paths for this controller.
       #
       # ==== Parameters
-      # path<String, ViewPath>:: If a String is provided, it gets converted into 
-      # the default view path. You may also provide a custom view path 
+      # path<String, ViewPath>:: If a String is provided, it gets converted into
+      # the default view path. You may also provide a custom view path
       # (see ActionView::ViewPathSet for more information)
       def prepend_view_path(path)
         clear_template_caches!
@@ -186,9 +198,8 @@ module AbstractController
       #   otherwise, process the parameter into a ViewPathSet.
       def view_paths=(paths)
         clear_template_caches!
-        self._view_paths = paths.is_a?(ActionView::PathSet) ?
-                            paths : ActionView::Base.process_view_paths(paths)
+        self._view_paths = paths.is_a?(ActionView::PathSet) ? paths : ActionView::Base.process_view_paths(paths)
       end
     end
   end
-end
+end
\ No newline at end of file