Merge branch 'master' into sprockets

6 files changed, 61 insertions, 16 deletions

diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb
index e6523e56d2..5f9e082cd3 100644
--- a/actionpack/lib/action_controller/base.rb
+++ b/actionpack/lib/action_controller/base.rb
@@ -105,7 +105,7 @@ module ActionController
   # == Renders
   #
   # Action Controller sends content to the user by using one of five rendering methods. The most versatile and common is the rendering
-  # of a template. Included in the Action Pack is the Action View, which enables rendering of ERb templates. It's automatically configured.
+  # of a template. Included in the Action Pack is the Action View, which enables rendering of ERB templates. It's automatically configured.
   # The controller passes objects to the view by assigning instance variables:
   #
   #   def show
@@ -128,7 +128,7 @@ module ActionController
   #     end
   #   end
   #
-  # Read more about writing ERb and Builder templates in ActionView::Base.
+  # Read more about writing ERB and Builder templates in ActionView::Base.
   #
   # == Redirects
   #
diff --git a/actionpack/lib/action_controller/metal.rb b/actionpack/lib/action_controller/metal.rb
index e5db31061b..585bd5e5ab 100644
--- a/actionpack/lib/action_controller/metal.rb
+++ b/actionpack/lib/action_controller/metal.rb
@@ -201,19 +201,23 @@ module ActionController
     class_attribute :middleware_stack
     self.middleware_stack = ActionController::MiddlewareStack.new
 
-    def self.inherited(base)
+    def self.inherited(base) #nodoc:
       base.middleware_stack = self.middleware_stack.dup
       super
     end
 
+    # Adds given middleware class and its args to bottom of middleware_stack
     def self.use(*args, &block)
       middleware_stack.use(*args, &block)
     end
 
+    # Alias for middleware_stack
     def self.middleware
       middleware_stack
     end
 
+    # Makes the controller a rack endpoint that points to the action in
+    # the given env's action_dispatch.request.path_parameters key.
     def self.call(env)
       action(env['action_dispatch.request.path_parameters'][:action]).call(env)
     end
diff --git a/actionpack/lib/action_controller/metal/http_authentication.rb b/actionpack/lib/action_controller/metal/http_authentication.rb
index b98429792d..1d6df89007 100644
--- a/actionpack/lib/action_controller/metal/http_authentication.rb
+++ b/actionpack/lib/action_controller/metal/http_authentication.rb
@@ -67,7 +67,7 @@ module ActionController
     #   class PostsController < ApplicationController
     #     REALM = "SuperSecret"
     #     USERS = {"dhh" => "secret", #plain text password
-    #              "dap" => Digest:MD5::hexdigest(["dap",REALM,"secret"].join(":"))  #ha1 digest password
+    #              "dap" => Digest::MD5.hexdigest(["dap",REALM,"secret"].join(":"))  #ha1 digest password
     #
     #     before_filter :authenticate, :except => [:index]
     #
diff --git a/actionpack/lib/action_controller/metal/implicit_render.rb b/actionpack/lib/action_controller/metal/implicit_render.rb
index 678f4ca763..3ec0c4c6a4 100644
--- a/actionpack/lib/action_controller/metal/implicit_render.rb
+++ b/actionpack/lib/action_controller/metal/implicit_render.rb
@@ -10,8 +10,8 @@ module ActionController
       end
     end
 
-    def default_render
-      render
+    def default_render(*args)
+      render(*args)
     end
 
     def action_method?(action_name)
diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb
index a2e06fe0a6..618a6cdb7d 100644
--- a/actionpack/lib/action_controller/metal/mime_responds.rb
+++ b/actionpack/lib/action_controller/metal/mime_responds.rb
@@ -1,8 +1,9 @@
 require 'abstract_controller/collector'
 require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/object/inclusion'
 
 module ActionController #:nodoc:
-  module MimeResponds #:nodoc:
+  module MimeResponds
     extend ActiveSupport::Concern
 
     included do
@@ -189,7 +190,7 @@ module ActionController #:nodoc:
       raise ArgumentError, "respond_to takes either types or a block, never both" if mimes.any? && block_given?
 
       if response = retrieve_response_from_mimes(mimes, &block)
-        response.call
+        response.call(nil)
       end
     end
 
@@ -222,6 +223,9 @@ module ActionController #:nodoc:
     # is quite simple (it just needs to respond to call), you can even give
     # a proc to it.
     #
+    # In order to use respond_with, first you need to declare the formats your
+    # controller responds to in the class level with a call to <tt>respond_to</tt>.
+    #
     def respond_with(*resources, &block)
       raise "In order to use respond_with, first you need to declare the formats your " <<
             "controller responds to in the class level" if self.class.mimes_for_respond_to.empty?
@@ -245,9 +249,9 @@ module ActionController #:nodoc:
         config = self.class.mimes_for_respond_to[mime]
 
         if config[:except]
-          !config[:except].include?(action)
+          !action.in?(config[:except])
         elsif config[:only]
-          config[:only].include?(action)
+          action.in?(config[:only])
         else
           true
         end
@@ -257,9 +261,9 @@ module ActionController #:nodoc:
     # Collects mimes and return the response for the negotiated format. Returns
     # nil if :not_acceptable was sent to the client.
     #
-    def retrieve_response_from_mimes(mimes=nil, &block)
+    def retrieve_response_from_mimes(mimes=nil, &block) #:nodoc:
       mimes ||= collect_mimes_from_class_level
-      collector = Collector.new(mimes) { default_render }
+      collector = Collector.new(mimes) { |options| default_render(options || {}) }
       block.call(collector) if block_given?
 
       if format = request.negotiate_mime(collector.order)
diff --git a/actionpack/lib/action_controller/metal/responder.rb b/actionpack/lib/action_controller/metal/responder.rb
index 4b45413cf8..59a3621f72 100644
--- a/actionpack/lib/action_controller/metal/responder.rb
+++ b/actionpack/lib/action_controller/metal/responder.rb
@@ -77,6 +77,37 @@ module ActionController #:nodoc:
   #
   #   respond_with(@project, :manager, @task)
   #
+  # === Custom options
+  #
+  # <code>respond_with</code> also allow you to pass options that are forwarded
+  # to the underlying render call. Those options are only applied success
+  # scenarios. For instance, you can do the following in the create method above:
+  #
+  #   def create
+  #     @project = Project.find(params[:project_id])
+  #     @task = @project.comments.build(params[:task])
+  #     flash[:notice] = 'Task was successfully created.' if @task.save
+  #     respond_with(@project, @task, :status => 201)
+  #   end
+  #
+  # This will return status 201 if the task was saved with success. If not,
+  # it will simply ignore the given options and return status 422 and the
+  # resource errors. To customize the failure scenario, you can pass a
+  # a block to <code>respond_with</code>:
+  #
+  #   def create
+  #     @project = Project.find(params[:project_id])
+  #     @task = @project.comments.build(params[:task])
+  #     respond_with(@project, @task, :status => 201) do |format|
+  #       if @task.save
+  #         flash[:notice] = 'Task was successfully created.'
+  #       else
+  #         format.html { render "some_special_template" }
+  #       end
+  #     end
+  #   end
+  #
+  # Using <code>respond_with</code> with a block follows the same syntax as <code>respond_to</code>.
   class Responder
     attr_reader :controller, :request, :format, :resource, :resources, :options
 
@@ -131,7 +162,11 @@ module ActionController #:nodoc:
     # responds to :to_format and display it.
     #
     def to_format
-      default_render
+      if get? || !has_errors?
+        default_render
+      else
+        display_errors
+      end
     rescue ActionView::MissingTemplate => e
       api_behavior(e)
     end
@@ -155,8 +190,6 @@ module ActionController #:nodoc:
 
       if get?
         display resource
-      elsif has_errors?
-        display resource.errors, :status => :unprocessable_entity
       elsif post?
         display resource, :status => :created, :location => api_location
       elsif has_empty_resource_definition?
@@ -185,7 +218,7 @@ module ActionController #:nodoc:
     # controller.
     #
     def default_render
-      @default_response.call
+      @default_response.call(options)
     end
 
     # Display is just a shortcut to render a resource with the current format.
@@ -209,6 +242,10 @@ module ActionController #:nodoc:
       controller.render given_options.merge!(options).merge!(format => resource)
     end
 
+    def display_errors
+      controller.render format => resource.errors, :status => :unprocessable_entity
+    end
+
     # Check whether the resource has errors.
     #
     def has_errors?