actionpack 3.0.20 → 3.1.0.beta1

data/lib/action_controller/metal/implicit_render.rb

@@ -1,21 +1,21 @@
 module ActionController
   module ImplicitRender
-    def send_action(*)
-      ret = super
-      default_render unless response_body
-      ret
+    def send_action(method, *args)
+      if respond_to?(method, true)
+        ret = super
+        default_render unless response_body
+        ret
+      else
+        default_render
+      end
     end
 
-    def default_render
-      render
+    def default_render(*args)
+      render(*args)
     end
 
-    def method_for_action(action_name)
-      super || begin
-        if template_exists?(action_name.to_s, _prefix)
-          "default_render"
-        end
-      end
+    def action_method?(action_name)
+      super || template_exists?(action_name.to_s, _prefixes)
     end
   end
-end
+end

data/lib/action_controller/metal/instrumentation.rb

@@ -14,7 +14,7 @@ module ActionController
 
     attr_internal :view_runtime
 
-    def process_action(action, *args)
+    def process_action(*args)
       raw_payload = {
         :controller => self.class.name,
         :action     => self.action_name,
@@ -78,7 +78,7 @@ module ActionController
       yield
     end
 
-    # Everytime after an action is processed, this method is invoked
+    # Every time after an action is processed, this method is invoked
     # with the payload, so you can add more information.
     # :api: plugin
     def append_info_to_payload(payload) #:nodoc:

data/lib/action_controller/metal/mime_responds.rb

@@ -1,10 +1,13 @@
 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
 
+    include ActionController::ImplicitRender
+
     included do
       class_attribute :responder, :mimes_for_respond_to
       self.responder = ActionController::Responder
@@ -32,10 +35,10 @@ module ActionController #:nodoc:
       # and all actions except <tt>:edit</tt> respond to <tt>:xml</tt> and
       # <tt>:json</tt>.
       #
-      #   respond_to :rjs, :only => :create
+      #   respond_to :json, :only => :create
       #
       # This specifies that the <tt>:create</tt> action and no other responds
-      # to <tt>:rjs</tt>.
+      # to <tt>:json</tt>.
       def respond_to(*mimes)
         options = mimes.extract_options!
 
@@ -63,13 +66,13 @@ module ActionController #:nodoc:
     # might look something like this:
     #
     #   def index
-    #     @people = Person.find(:all)
+    #     @people = Person.all
     #   end
     #
     # Here's the same action, with web-service support baked in:
     #
     #   def index
-    #     @people = Person.find(:all)
+    #     @people = Person.all
     #
     #     respond_to do |format|
     #       format.html
@@ -105,8 +108,8 @@ module ActionController #:nodoc:
     #     end
     #   end
     #
-    # If the client wants HTML, we just redirect them back to the person list. If they want Javascript
-    # (format.js), then it is an RJS request and we render the RJS template associated with this action.
+    # If the client wants HTML, we just redirect them back to the person list. If they want JavaScript,
+    # then it is an Ajax request and we render the JavaScript template associated with this action.
     # Lastly, if the client wants XML, we render the created person as XML, but with a twist: we also
     # include the person's company in the rendered XML, so you get something like this:
     #
@@ -155,7 +158,7 @@ module ActionController #:nodoc:
     # Respond to also allows you to specify a common block for different formats by using any:
     #
     #   def index
-    #     @people = Person.find(:all)
+    #     @people = Person.all
     #
     #     respond_to do |format|
     #       format.html
@@ -178,7 +181,7 @@ module ActionController #:nodoc:
     #     respond_to :html, :xml, :json
     #
     #     def index
-    #       @people = Person.find(:all)
+    #       @people = Person.all
     #       respond_with(@person)
     #     end
     #   end
@@ -189,7 +192,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
 
@@ -208,8 +211,8 @@ module ActionController #:nodoc:
     # It also accepts a block to be given. It's used to overwrite a default
     # response:
     #
-    #   def destroy
-    #     @user = User.find(params[:id])
+    #   def create
+    #     @user = User.new(params[:user])
     #     flash[:notice] = "User was successfully created." if @user.save
     #
     #     respond_with(@user) do |format|
@@ -222,6 +225,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 +251,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,10 +263,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)
-      collector = Collector.new { default_render }
+    def retrieve_response_from_mimes(mimes=nil, &block) #:nodoc:
       mimes ||= collect_mimes_from_class_level
-      mimes.each { |mime| collector.send(mime) }
+      collector = Collector.new(mimes) { |options| default_render(options || {}) }
       block.call(collector) if block_given?
 
       if format = request.negotiate_mime(collector.order)
@@ -277,8 +282,9 @@ module ActionController #:nodoc:
       include AbstractController::Collector
       attr_accessor :order
 
-      def initialize(&block)
+      def initialize(mimes, &block)
         @order, @responses, @default_response = [], {}, block
+        mimes.each { |mime| send(mime) }
       end
 
       def any(*args, &block)
@@ -291,7 +297,7 @@ module ActionController #:nodoc:
       alias :all :any
 
       def custom(mime_type, &block)
-        mime_type = mime_type.is_a?(Mime::Type) ? mime_type : Mime::Type.lookup(mime_type.to_s)
+        mime_type = Mime::Type.lookup(mime_type.to_s) unless mime_type.is_a?(Mime::Type)
         @order << mime_type
         @responses[mime_type] ||= block
       end

data/lib/action_controller/metal/params_wrapper.rb

@@ -0,0 +1,224 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/array/wrap'
+require 'action_dispatch/http/mime_types'
+
+module ActionController
+  # Wraps parameters hash into nested hash. This will allow client to submit
+  # POST request without having to specify a root element in it.
+  #
+  # By default this functionality won't be enabled. You can enable
+  # it globally by setting +ActionController::Base.wrap_parameters+:
+  #
+  #     ActionController::Base.wrap_parameters = [:json]
+  #
+  # You could also turn it on per controller by setting the format array to
+  # non-empty array:
+  #
+  #     class UsersController < ApplicationController
+  #       wrap_parameters :format => [:json, :xml]
+  #     end
+  #
+  # If you enable +ParamsWrapper+ for +:json+ format. Instead of having to
+  # send JSON parameters like this:
+  #
+  #     {"user": {"name": "Konata"}}
+  #
+  # You can now just send a parameters like this:
+  #
+  #     {"name": "Konata"}
+  #
+  # And it will be wrapped into a nested hash with the key name matching
+  # controller's name. For example, if you're posting to +UsersController+,
+  # your new +params+ hash will look like this:
+  #
+  #     {"name" => "Konata", "user" => {"name" => "Konata"}}
+  #
+  # You can also specify the key in which the parameters should be wrapped to,
+  # and also the list of attributes it should wrap by using either +:only+ or
+  # +:except+ options like this:
+  #
+  #     class UsersController < ApplicationController
+  #       wrap_parameters :person, :only => [:username, :password]
+  #     end
+  #
+  # If you're going to pass the parameters to an +ActiveModel+ object (such as
+  # +User.new(params[:user])+), you might consider passing the model class to
+  # the method instead. The +ParamsWrapper+ will actually try to determine the
+  # list of attribute names from the model and only wrap those attributes:
+  #
+  #     class UsersController < ApplicationController
+  #       wrap_parameters Person
+  #     end
+  #
+  # You still could pass +:only+ and +:except+ to set the list of attributes
+  # you want to wrap.
+  #
+  # By default, if you don't specify the key in which the parameters would be
+  # wrapped to, +ParamsWrapper+ will actually try to determine if there's
+  # a model related to it or not. This controller, for example:
+  #
+  #     class Admin::UsersController < ApplicationController
+  #     end
+  #
+  # will try to check if +Admin::User+ or +User+ model exists, and use it to
+  # determine the wrapper key respectively. If both of the model doesn't exists,
+  # it will then fallback to use +user+ as the key.
+  module ParamsWrapper
+    extend ActiveSupport::Concern
+
+    EXCLUDE_PARAMETERS = %w(authenticity_token _method utf8)
+
+    included do
+      class_attribute :_wrapper_options
+      self._wrapper_options = {:format => []}
+    end
+
+    module ClassMethods
+      # Sets the name of the wrapper key, or the model which +ParamsWrapper+
+      # would use to determine the attribute names from.
+      #
+      # ==== Examples
+      #   wrap_parameters :format => :xml
+      #     # enables the parmeter wrapper for XML format
+      #
+      #   wrap_parameters :person
+      #     # wraps parameters into +params[:person]+ hash
+      #
+      #   wrap_parameters Person
+      #     # wraps parameters by determine the wrapper key from Person class
+      #     (+person+, in this case) and the list of attribute names
+      #
+      #   wrap_parameters :only => [:username, :title]
+      #     # wraps only +:username+ and +:title+ attributes from parameters.
+      #
+      #   wrap_parameters false
+      #     # disable parameters wrapping for this controller altogether.
+      #
+      # ==== Options
+      # * <tt>:format</tt> - The list of formats in which the parameters wrapper
+      #   will be enabled.
+      # * <tt>:only</tt> - The list of attribute names which parameters wrapper
+      #   will wrap into a nested hash.
+      # * <tt>:except</tt> - The list of attribute names which parameters wrapper
+      #   will exclude from a nested hash.
+      def wrap_parameters(name_or_model_or_options, options = {})
+        model = nil
+
+        case name_or_model_or_options
+        when Hash
+          options = name_or_model_or_options
+        when false
+          options = options.merge(:format => [])
+        when Symbol, String
+          options = options.merge(:name => name_or_model_or_options)
+        else
+          model = name_or_model_or_options
+        end
+
+        _set_wrapper_defaults(_wrapper_options.slice(:format).merge(options), model)
+      end
+
+      # Sets the default wrapper key or model which will be used to determine
+      # wrapper key and attribute names. Will be called automatically when the
+      # module is inherited.
+      def inherited(klass)
+        if klass._wrapper_options[:format].present?
+          klass._set_wrapper_defaults(klass._wrapper_options)
+        end
+        super
+      end
+
+      protected
+
+      # Determine the wrapper model from the controller's name. By convention,
+      # this could be done by trying to find the defined model that has the
+      # same singularize name as the controller. For example, +UsersController+
+      # will try to find if the +User+ model exists.
+      def _default_wrap_model
+        model_name = self.name.sub(/Controller$/, '').singularize
+
+        begin
+          model_klass = model_name.constantize
+        rescue NameError => e
+          unscoped_model_name = model_name.split("::", 2).last
+          break if unscoped_model_name == model_name
+          model_name = unscoped_model_name
+        end until model_klass
+
+        model_klass
+      end
+
+      def _set_wrapper_defaults(options, model=nil)
+        options = options.dup
+
+        unless options[:only] || options[:except]
+          model ||= _default_wrap_model
+          if model.respond_to?(:column_names)
+            options[:only] = model.column_names
+          end
+        end
+
+        unless options[:name]
+          model ||= _default_wrap_model
+          options[:name] = model ? model.to_s.demodulize.underscore :
+            controller_name.singularize
+        end
+
+        options[:only]   = Array.wrap(options[:only]).collect(&:to_s)   if options[:only]
+        options[:except] = Array.wrap(options[:except]).collect(&:to_s) if options[:except]
+        options[:format] = Array.wrap(options[:format])
+
+        self._wrapper_options = options
+      end
+    end
+
+    # Performs parameters wrapping upon the request. Will be called automatically
+    # by the metal call stack.
+    def process_action(*args)
+      if _wrapper_enabled?
+        wrapped_hash = _wrap_parameters request.request_parameters
+        wrapped_filtered_hash = _wrap_parameters request.filtered_parameters
+
+        # This will make the wrapped hash accessible from controller and view
+        request.parameters.merge! wrapped_hash
+        request.request_parameters.merge! wrapped_hash
+
+        # This will make the wrapped hash displayed in the log file
+        request.filtered_parameters.merge! wrapped_filtered_hash
+      end
+      super
+    end
+
+    private
+
+      # Returns the wrapper key which will use to stored wrapped parameters.
+      def _wrapper_key
+        _wrapper_options[:name]
+      end
+
+      # Returns the list of enabled formats.
+      def _wrapper_formats
+        _wrapper_options[:format]
+      end
+
+      # Returns the list of parameters which will be selected for wrapped.
+      def _wrap_parameters(parameters)
+        value = if only = _wrapper_options[:only]
+          parameters.slice(*only)
+        else
+          except = _wrapper_options[:except] || []
+          parameters.except(*(except + EXCLUDE_PARAMETERS))
+        end
+
+        { _wrapper_key => value }
+      end
+
+      # Checks if we should perform parameters wrapping.
+      def _wrapper_enabled?
+        ref = request.content_mime_type.try(:ref)
+        _wrapper_formats.include?(ref) && !request.request_parameters[_wrapper_key]
+      end
+  end
+end

data/lib/action_controller/metal/redirecting.rb

@@ -20,6 +20,7 @@ module ActionController
     # * <tt>Record</tt> - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record.
     # * <tt>String</tt> starting with <tt>protocol://</tt> (like <tt>http://</tt>) - Is passed straight through as the target for redirection.
     # * <tt>String</tt> not containing a protocol - The current protocol and host is prepended to the string.
+    # * <tt>Proc</tt> - A block that will be executed in the controller's context. Should return any option accepted by +redirect_to+.
     # * <tt>:back</tt> - Back to the page that issued the request. Useful for forms that are triggered from multiple places.
     #   Short-hand for <tt>redirect_to(request.env["HTTP_REFERER"])</tt>
     #
@@ -30,6 +31,7 @@ module ActionController
     #   redirect_to "/images/screenshot.jpg"
     #   redirect_to articles_url
     #   redirect_to :back
+    #   redirect_to proc { edit_post_url(@post) }
     #
     # The redirection happens as a "302 Moved" header unless otherwise specified.
     #
@@ -38,7 +40,7 @@ module ActionController
     #   redirect_to :action=>'atom', :status => :moved_permanently
     #   redirect_to post_url(@post), :status => 301
     #   redirect_to :action=>'atom', :status => 302
-    # 
+    #
     # The status code can either be a standard {HTTP Status code}[http://www.iana.org/assignments/http-status-codes] as an
     # integer, or a symbol representing the downcased, underscored and symbolized description.
     #
@@ -85,9 +87,11 @@ module ActionController
         when :back
           raise RedirectBackError unless refer = request.headers["Referer"]
           refer
+        when Proc
+          _compute_redirect_to_location options.call
         else
           url_for(options)
-        end.gsub(/[\0\r\n]/, '')
+        end.gsub(/[\r\n]/, '')
       end
   end
 end