Bring abstract_controller up to date with rails/master

Resolved all the conflicts since 2.3.0 -> HEAD. Following is a list
of commits that could not be applied cleanly or are obviated with the
abstract_controller refactor. They all need to be revisited to ensure
that fixes made in 2.3 do not reappear in 3.0:

2259ecf368e6a6715966f69216e3ee86bf1a82a7
AR not available
  * This will be reimplemented with ActionORM or equivalent

06182ea02e92afad579998aa80144588e8865ac3
implicitly rendering a js response should not use the default layout
[#1844 state:resolved]
  * This will be handled generically

893e9eb99504705419ad6edac14d00e71cef5f12
Improve view rendering performance in development mode and reinstate
template recompiling in production [#1909 state:resolved]
  * We will need to reimplement rails-dev-boost on top of the refactor;
    the changes here are very implementation specific and cannot be
    cleanly applied. The following commits are implicated:

      199e750d46c04970b5e7684998d09405648ecbd4
      3942cb406e1d5db0ac00e03153809cc8dc4cc4db
      f8ea9f85d4f1e3e6f3b5d895bef6b013aa4b0690
      e3b166aab37ddc2fbab030b146eb61713b91bf55
      ae9f258e03c9fd5088da12c1c6cd216cc89a01f7
      44423126c6f6133a1d9cf1d0832b527e8711d40f

0cb020b4d6d838025859bd60fb8151c8e21b8e84
workaround for picking layouts based on wrong view_paths
[#1974 state:resolved]
  * The specifics of this commit no longer apply. Since it is a two-line
    commit, we will reimplement this change.

8c5cc66a831aadb159f3daaffa4208064c30af0e
make action_controller/layouts pick templates from the current instance's
view_paths instead of the class view_paths [#1974 state:resolved]
  * This does not apply at all. It should be trivial to apply the feature
    to the reimplemented ActionController::Base.

87e8b162463f13bd50d27398f020769460a770e3
fix HTML fallback for explicit templates [#2052 state:resolved]
  * There were a number of patches related to this that simply compounded
    each other. Basically none of them apply cleanly, and the underlying
    issue needs to be revisited. After discussing the underlying problem
    with Koz, we will defer these fixes for further discussion.

10 files changed, 125 insertions, 301 deletions

diff --git a/actionpack/lib/action_dispatch/http/request.rb b/actionpack/lib/action_dispatch/http/request.rb
index a2c14f7ea2..7d47a1566e 100755
--- a/actionpack/lib/action_dispatch/http/request.rb
+++ b/actionpack/lib/action_dispatch/http/request.rb
@@ -31,7 +31,7 @@ module ActionDispatch
     # <tt>:get</tt>. If the request \method is not listed in the HTTP_METHODS
     # constant above, an UnknownHttpMethod exception is raised.
     def request_method
-      HTTP_METHOD_LOOKUP[super] || raise(ActionController::UnknownHttpMethod, "#{super}, accepted HTTP methods are #{HTTP_METHODS.to_sentence}")
+      @request_method ||= HTTP_METHOD_LOOKUP[super] || raise(ActionController::UnknownHttpMethod, "#{super}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(:locale => :en)}")
     end
 
     # Returns the HTTP request \method used for action processing as a
@@ -431,15 +431,15 @@ EOM
       FORM_DATA_MEDIA_TYPES.include?(content_type.to_s)
     end
 
-    # Override Rack's GET method to support nested query strings
+    # Override Rack's GET method to support indifferent access
     def GET
-      @env["action_controller.request.query_parameters"] ||= UrlEncodedPairParser.parse_query_parameters(query_string)
+      @env["action_controller.request.query_parameters"] ||= normalize_parameters(super)
     end
     alias_method :query_parameters, :GET
 
-    # Override Rack's POST method to support nested query strings
+    # Override Rack's POST method to support indifferent access
     def POST
-      @env["action_controller.request.request_parameters"] ||= UrlEncodedPairParser.parse_hash_parameters(super)
+      @env["action_controller.request.request_parameters"] ||= normalize_parameters(super)
     end
     alias_method :request_parameters, :POST
 
@@ -456,6 +456,7 @@ EOM
     end
 
     def reset_session
+      @env['rack.session.options'].delete(:id)
       @env['rack.session'] = {}
     end
 
@@ -475,5 +476,28 @@ EOM
       def named_host?(host)
         !(host.nil? || /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.match(host))
       end
+
+      # Convert nested Hashs to HashWithIndifferentAccess and replace
+      # file upload hashs with UploadedFile objects
+      def normalize_parameters(value)
+        case value
+        when Hash
+          if value.has_key?(:tempfile)
+            upload = value[:tempfile]
+            upload.extend(UploadedFile)
+            upload.original_path = value[:filename]
+            upload.content_type = value[:type]
+            upload
+          else
+            h = {}
+            value.each { |k, v| h[k] = normalize_parameters(v) }
+            h.with_indifferent_access
+          end
+        when Array
+          value.map { |e| normalize_parameters(e) }
+        else
+          value
+        end
+      end
   end
 end
diff --git a/actionpack/lib/action_dispatch/http/response.rb b/actionpack/lib/action_dispatch/http/response.rb
index e1d8ee3527..ecf40b8103 100644
--- a/actionpack/lib/action_dispatch/http/response.rb
+++ b/actionpack/lib/action_dispatch/http/response.rb
@@ -40,14 +40,28 @@ module ActionDispatch # :nodoc:
     delegate :default_charset, :to => 'ActionController::Base'
 
     def initialize
-      @status = 200
-      @header = DEFAULT_HEADERS.dup
+      super
+      @header = Rack::Utils::HeaderHash.new(DEFAULT_HEADERS)
+      @session, @assigns = [], []
+    end
 
-      @writer = lambda { |x| @body << x }
-      @block = nil
+    def body
+      str = ''
+      each { |part| str << part.to_s }
+      str
+    end
 
-      @body = "",
-      @session, @assigns = [], []
+    def body=(body)
+      @body =
+        if body.is_a?(String)
+          [body]
+        else
+          body
+        end
+    end
+
+    def body_parts
+      @body
     end
 
     def location; headers['Location'] end
@@ -144,7 +158,6 @@ module ActionDispatch # :nodoc:
       set_content_length!
       convert_content_type!
       convert_language!
-      convert_expires!
       convert_cookies!
     end
 
@@ -153,7 +166,7 @@ module ActionDispatch # :nodoc:
         @writer = lambda { |x| callback.call(x) }
         @body.call(self, self)
       elsif @body.is_a?(String)
-        @body.each_line(&callback)
+        callback.call(@body)
       else
         @body.each(&callback)
       end
@@ -163,37 +176,20 @@ module ActionDispatch # :nodoc:
     end
 
     def write(str)
-      @writer.call str.to_s
+      str = str.to_s
+      @writer.call str
       str
     end
 
-    # Over Rack::Response#set_cookie to add HttpOnly option
     def set_cookie(key, value)
-      case value
-      when Hash
-        domain  = "; domain="  + value[:domain]    if value[:domain]
-        path    = "; path="    + value[:path]      if value[:path]
-        # According to RFC 2109, we need dashes here.
-        # N.B.: cgi.rb uses spaces...
-        expires = "; expires=" + value[:expires].clone.gmtime.
-          strftime("%a, %d-%b-%Y %H:%M:%S GMT")    if value[:expires]
-        secure = "; secure"  if value[:secure]
-        httponly = "; HttpOnly" if value[:http_only]
-        value = value[:value]
-      end
-      value = [value]  unless Array === value
-      cookie = ::Rack::Utils.escape(key) + "=" +
-        value.map { |v| ::Rack::Utils.escape v }.join("&") +
-        "#{domain}#{path}#{expires}#{secure}#{httponly}"
-
-      case self["Set-Cookie"]
-      when Array
-        self["Set-Cookie"] << cookie
-      when String
-        self["Set-Cookie"] = [self["Set-Cookie"], cookie]
-      when nil
-        self["Set-Cookie"] = cookie
+      if value.has_key?(:http_only)
+        ActiveSupport::Deprecation.warn(
+          "The :http_only option in ActionController::Response#set_cookie " +
+          "has been renamed. Please use :httponly instead.", caller)
+        value[:httponly] ||= value.delete(:http_only)
       end
+
+      super(key, value)
     end
 
     private
@@ -205,7 +201,7 @@ module ActionDispatch # :nodoc:
 
           if request && request.etag_matches?(etag)
             self.status = '304 Not Modified'
-            self.body = ''
+            self.body = []
           end
 
           set_conditional_cache_control!
@@ -214,7 +210,11 @@ module ActionDispatch # :nodoc:
 
       def nonempty_ok_response?
         ok = !status || status.to_s[0..2] == '200'
-        ok && body.is_a?(String) && !body.empty?
+        ok && string_body?
+      end
+
+      def string_body?
+        !body_parts.respond_to?(:call) && body_parts.any? && body_parts.all? { |part| part.is_a?(String) }
       end
 
       def set_conditional_cache_control!
@@ -235,8 +235,8 @@ module ActionDispatch # :nodoc:
           headers.delete('Content-Length')
         elsif length = headers['Content-Length']
           headers['Content-Length'] = length.to_s
-        elsif !body.respond_to?(:call) && (!status || status.to_s[0..2] != '304')
-          headers["Content-Length"] = body.size.to_s
+        elsif string_body? && (!status || status.to_s[0..2] != '304')
+          headers["Content-Length"] = Rack::Utils.bytesize(body).to_s
         end
       end
 
@@ -244,10 +244,6 @@ module ActionDispatch # :nodoc:
         headers["Content-Language"] = headers.delete("language") if headers["language"]
       end
 
-      def convert_expires!
-        headers["Expires"] = headers.delete("") if headers["expires"]
-      end
-
       def convert_cookies!
         headers['Set-Cookie'] = Array(headers['Set-Cookie']).compact
       end
diff --git a/actionpack/lib/action_dispatch/middleware/session/abstract_store.rb b/actionpack/lib/action_dispatch/middleware/session/abstract_store.rb
index 879d98fbdb..6c039cf62d 100644
--- a/actionpack/lib/action_dispatch/middleware/session/abstract_store.rb
+++ b/actionpack/lib/action_dispatch/middleware/session/abstract_store.rb
@@ -17,16 +17,11 @@ module ActionDispatch
           @loaded = false
         end
 
-        def id
-          load! unless @loaded
-          @id
-        end
-
         def session_id
           ActiveSupport::Deprecation.warn(
-            "ActionController::Session::AbstractStore::SessionHash#session_id" +
-            "has been deprecated.Please use #id instead.", caller)
-          id
+            "ActionController::Session::AbstractStore::SessionHash#session_id " +
+            "has been deprecated. Please use request.session_options[:id] instead.", caller)
+          @env[ENV_SESSION_OPTIONS_KEY][:id]
         end
 
         def [](key)
@@ -47,20 +42,45 @@ module ActionDispatch
 
         def data
          ActiveSupport::Deprecation.warn(
-           "ActionController::Session::AbstractStore::SessionHash#data" +
-           "has been deprecated.Please use #to_hash instead.", caller)
+           "ActionController::Session::AbstractStore::SessionHash#data " +
+           "has been deprecated. Please use #to_hash instead.", caller)
           to_hash
         end
 
+        def inspect
+          load! unless @loaded
+          super
+        end
+
         private
           def loaded?
             @loaded
           end
 
           def load!
-            @id, session = @by.send(:load_session, @env)
-            replace(session)
-            @loaded = true
+            stale_session_check! do
+              id, session = @by.send(:load_session, @env)
+              (@env[ENV_SESSION_OPTIONS_KEY] ||= {})[:id] = id
+              replace(session)
+              @loaded = true
+            end
+          end
+
+          def stale_session_check!
+            yield
+          rescue ArgumentError => argument_error
+            if argument_error.message =~ %r{undefined class/module ([\w:]*\w)}
+              begin
+                # Note that the regexp does not allow $1 to end with a ':'
+                $1.constantize
+              rescue LoadError, NameError => const_error
+                raise ActionController::SessionRestoreError, "Session contains objects whose class definition isn\\'t available.\nRemember to require the classes for all objects kept in the session.\n(Original exception: \#{const_error.message} [\#{const_error.class}])\n"
+              end
+
+              retry
+            else
+              raise
+            end
           end
       end
 
@@ -107,11 +127,7 @@ module ActionDispatch
         if !session_data.is_a?(AbstractStore::SessionHash) || session_data.send(:loaded?) || options[:expire_after]
           session_data.send(:load!) if session_data.is_a?(AbstractStore::SessionHash) && !session_data.send(:loaded?)
 
-          if session_data.is_a?(AbstractStore::SessionHash)
-            sid = session_data.id
-          else
-            sid = generate_sid
-          end
+          sid = options[:id] || generate_sid
 
           unless set_session(env, sid, session_data.to_hash)
             return response
@@ -128,12 +144,9 @@ module ActionDispatch
           cookie << "; HttpOnly" if options[:httponly]
 
           headers = response[1]
-          case a = headers[SET_COOKIE]
-          when Array
-            a << cookie
-          when String
-            headers[SET_COOKIE] = [a, cookie]
-          when nil
+          unless headers[SET_COOKIE].blank?
+            headers[SET_COOKIE] << "\n#{cookie}"
+          else
             headers[SET_COOKIE] = cookie
           end
         end
diff --git a/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb b/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb
index ec93f66a88..433c4cc070 100644
--- a/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb
+++ b/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb
@@ -88,7 +88,7 @@ module ActionDispatch
 
       def call(env)
         env[ENV_SESSION_KEY] = AbstractStore::SessionHash.new(self, env)
-        env[ENV_SESSION_OPTIONS_KEY] = @default_options
+        env[ENV_SESSION_OPTIONS_KEY] = @default_options.dup
 
         status, headers, body = @app.call(env)
 
@@ -108,12 +108,9 @@ module ActionDispatch
           end
 
           cookie = build_cookie(@key, cookie.merge(options))
-          case headers[HTTP_SET_COOKIE]
-          when Array
-            headers[HTTP_SET_COOKIE] << cookie
-          when String
-            headers[HTTP_SET_COOKIE] = [headers[HTTP_SET_COOKIE], cookie]
-          when nil
+          unless headers[HTTP_SET_COOKIE].blank?
+            headers[HTTP_SET_COOKIE] << "\n#{cookie}"
+          else
             headers[HTTP_SET_COOKIE] = cookie
           end
         end
@@ -133,7 +130,7 @@ module ActionDispatch
             expires = "; expires=" + value[:expires].clone.gmtime.
               strftime("%a, %d-%b-%Y %H:%M:%S GMT") if value[:expires]
             secure = "; secure" if value[:secure]
-            httponly = "; httponly" if value[:httponly]
+            httponly = "; HttpOnly" if value[:httponly]
             value = value[:value]
           end
           value = [value] unless Array === value
diff --git a/actionpack/lib/action_dispatch/rack.rb b/actionpack/lib/action_dispatch/rack.rb
index 69df9dac06..89087c124f 100644
--- a/actionpack/lib/action_dispatch/rack.rb
+++ b/actionpack/lib/action_dispatch/rack.rb
@@ -1,3 +1,3 @@
-require 'action_dispatch/rack/lock'
-require 'action_dispatch/rack/multipart'
-require 'action_dispatch/rack/parse_query'
+# require 'action_dispatch/rack/lock'
+# require 'action_dispatch/rack/multipart'
+# require 'action_dispatch/rack/parse_query'
diff --git a/actionpack/lib/action_dispatch/rack/lock.rb b/actionpack/lib/action_dispatch/rack/lock.rb
deleted file mode 100644
index 9bf1889065..0000000000
--- a/actionpack/lib/action_dispatch/rack/lock.rb
+++ /dev/null
@@ -1,21 +0,0 @@
-module Rack
-  # Rack::Lock was commited to Rack core
-  # http://github.com/rack/rack/commit/7409b0c
-  # Remove this when Rack 1.0 is released
-  unless defined? Lock
-    class Lock
-      FLAG = 'rack.multithread'.freeze
-
-      def initialize(app, lock = Mutex.new)
-        @app, @lock = app, lock
-      end
-
-      def call(env)
-        old, env[FLAG] = env[FLAG], false
-        @lock.synchronize { @app.call(env) }
-      ensure
-        env[FLAG] = old
-      end
-    end
-  end
-end
diff --git a/actionpack/lib/action_dispatch/rack/multipart.rb b/actionpack/lib/action_dispatch/rack/multipart.rb
deleted file mode 100644
index 3b142307e9..0000000000
--- a/actionpack/lib/action_dispatch/rack/multipart.rb
+++ /dev/null
@@ -1,22 +0,0 @@
-module Rack
-  module Utils
-    module Multipart
-      class << self
-        def parse_multipart_with_rewind(env)
-          result = parse_multipart_without_rewind(env)
-
-          begin
-            env['rack.input'].rewind if env['rack.input'].respond_to?(:rewind)
-          rescue Errno::ESPIPE
-            # Handles exceptions raised by input streams that cannot be rewound
-            # such as when using plain CGI under Apache
-          end
-
-          result
-        end
-
-        alias_method_chain :parse_multipart, :rewind
-      end
-    end
-  end
-end
diff --git a/actionpack/lib/action_dispatch/rack/parse_query.rb b/actionpack/lib/action_dispatch/rack/parse_query.rb
deleted file mode 100644
index 15de720f14..0000000000
--- a/actionpack/lib/action_dispatch/rack/parse_query.rb
+++ /dev/null
@@ -1,18 +0,0 @@
-# Rack does not automatically cleanup Safari 2 AJAX POST body
-# This has not yet been commited to Rack, please +1 this ticket:
-# http://rack.lighthouseapp.com/projects/22435/tickets/19
-
-module Rack
-  module Utils
-    alias_method :parse_query_without_ajax_body_cleanup, :parse_query
-    module_function :parse_query_without_ajax_body_cleanup
-
-    def parse_query(qs, d = '&;')
-      qs = qs.to_s.dup
-      qs.chop! if qs[-1] == 0
-      qs.gsub!(/&_=$/, '')
-      parse_query_without_ajax_body_cleanup(qs, d)
-    end
-    module_function :parse_query
-  end
-end
diff --git a/actionpack/lib/action_dispatch/utils/middleware_stack.rb b/actionpack/lib/action_dispatch/utils/middleware_stack.rb
index 924e3dbbc2..ee5f28d5cb 100644
--- a/actionpack/lib/action_dispatch/utils/middleware_stack.rb
+++ b/actionpack/lib/action_dispatch/utils/middleware_stack.rb
@@ -27,7 +27,9 @@ module ActionDispatch
       end
 
       def klass
-        if @klass.is_a?(Class)
+        if @klass.respond_to?(:call)
+          @klass.call
+        elsif @klass.is_a?(Class)
           @klass
         else
           @klass.to_s.constantize
@@ -37,6 +39,8 @@ module ActionDispatch
       end
 
       def active?
+        return false unless klass
+
         if @conditional.respond_to?(:call)
           @conditional.call
         else
@@ -63,11 +67,17 @@ module ActionDispatch
 
       def build(app)
         if block
-          klass.new(app, *args, &block)
+          klass.new(app, *build_args, &block)
         else
-          klass.new(app, *args)
+          klass.new(app, *build_args)
         end
       end
+
+      private
+
+        def build_args
+          Array(args).map { |arg| arg.respond_to?(:call) ? arg.call : arg }
+        end
     end
 
     def initialize(*args, &block)
diff --git a/actionpack/lib/action_dispatch/utils/url_encoded_pair_parser.rb b/actionpack/lib/action_dispatch/utils/url_encoded_pair_parser.rb
deleted file mode 100644
index f2e832a977..0000000000
--- a/actionpack/lib/action_dispatch/utils/url_encoded_pair_parser.rb
+++ /dev/null
@@ -1,155 +0,0 @@
-module ActionDispatch
-  class UrlEncodedPairParser < StringScanner #:nodoc:
-    class << self
-      def parse_query_parameters(query_string)
-        return {} if query_string.blank?
-
-        pairs = query_string.split('&').collect do |chunk|
-          next if chunk.empty?
-          key, value = chunk.split('=', 2)
-          next if key.empty?
-          value = value.nil? ? nil : CGI.unescape(value)
-          [ CGI.unescape(key), value ]
-        end.compact
-
-        new(pairs).result
-      end
-
-      def parse_hash_parameters(params)
-        parser = new
-
-        params = params.dup
-        until params.empty?
-          for key, value in params
-            if key.blank?
-              params.delete(key)
-            elsif value.is_a?(Array)
-              parser.parse(key, get_typed_value(value.shift))
-              params.delete(key) if value.empty?
-            else
-              parser.parse(key, get_typed_value(value))
-              params.delete(key)
-            end
-          end
-        end
-
-        parser.result
-      end
-
-      private
-        def get_typed_value(value)
-          case value
-          when String
-            value
-          when NilClass
-            ''
-          when Array
-            value.map { |v| get_typed_value(v) }
-          when Hash
-            if value.has_key?(:tempfile) && value[:filename].any?
-              upload = value[:tempfile]
-              upload.extend(UploadedFile)
-              upload.original_path = value[:filename]
-              upload.content_type = value[:type]
-              upload
-            else
-              nil
-            end
-          else
-            raise "Unknown form value: #{value.inspect}"
-          end
-        end
-    end
-
-    attr_reader :top, :parent, :result
-
-    def initialize(pairs = [])
-      super('')
-      @result = {}
-      pairs.each { |key, value| parse(key, value) }
-    end
-
-    KEY_REGEXP = %r{([^\[\]=&]+)}
-    BRACKETED_KEY_REGEXP = %r{\[([^\[\]=&]+)\]}
-
-    # Parse the query string
-    def parse(key, value)
-      self.string = key
-      @top, @parent = result, nil
-
-      # First scan the bare key
-      key = scan(KEY_REGEXP) or return
-      key = post_key_check(key)
-
-      # Then scan as many nestings as present
-      until eos?
-        r = scan(BRACKETED_KEY_REGEXP) or return
-        key = self[1]
-        key = post_key_check(key)
-      end
-
-      bind(key, value)
-    end
-
-    private
-      # After we see a key, we must look ahead to determine our next action. Cases:
-      #
-      #   [] follows the key. Then the value must be an array.
-      #   = follows the key. (A value comes next)
-      #   & or the end of string follows the key. Then the key is a flag.
-      #   otherwise, a hash follows the key.
-      def post_key_check(key)
-        if scan(/\[\]/) # a[b][] indicates that b is an array
-          container(key, Array)
-          nil
-        elsif check(/\[[^\]]/) # a[b] indicates that a is a hash
-          container(key, Hash)
-          nil
-        else # End of key? We do nothing.
-          key
-        end
-      end
-
-      # Add a container to the stack.
-      def container(key, klass)
-        type_conflict! klass, top[key] if top.is_a?(Hash) && top.key?(key) && ! top[key].is_a?(klass)
-        value = bind(key, klass.new)
-        type_conflict! klass, value unless value.is_a?(klass)
-        push(value)
-      end
-
-      # Push a value onto the 'stack', which is actually only the top 2 items.
-      def push(value)
-        @parent, @top = @top, value
-      end
-
-      # Bind a key (which may be nil for items in an array) to the provided value.
-      def bind(key, value)
-        if top.is_a? Array
-          if key
-            if top[-1].is_a?(Hash) && ! top[-1].key?(key)
-              top[-1][key] = value
-            else
-              top << {key => value}.with_indifferent_access
-            end
-            push top.last
-            return top[key]
-          else
-            top << value
-            return value
-          end
-        elsif top.is_a? Hash
-          key = CGI.unescape(key)
-          parent << (@top = {}) if top.key?(key) && parent.is_a?(Array)
-          top[key] ||= value
-          return top[key]
-        else
-          raise ArgumentError, "Don't know what to do: top is #{top.inspect}"
-        end
-      end
-
-      def type_conflict!(klass, value)
-        raise TypeError, "Conflicting types for parameter containers. Expected an instance of #{klass} but found an instance of #{value.class}. This can be caused by colliding Array and Hash parameters like qs[]=value&qs[key]=value. (The parameters received were #{value.inspect}.)"
-      end
-  end
-end