Vendoring Rails 2.3.5

vendor/rails/actionpack/lib/action_controller/response.rb

@@ -1,24 +1,25 @@
 require 'digest/md5'
 
 module ActionController # :nodoc:
-  # Represents an HTTP response generated by a controller action. One can use an
-  # ActionController::AbstractResponse object to retrieve the current state of the
-  # response, or customize the response. An AbstractResponse object can either
-  # represent a "real" HTTP response (i.e. one that is meant to be sent back to the
-  # web browser) or a test response (i.e. one that is generated from integration
-  # tests). See CgiResponse and TestResponse, respectively.
+  # Represents an HTTP response generated by a controller action. One can use
+  # an ActionController::Response object to retrieve the current state
+  # of the response, or customize the response. An Response object can
+  # either represent a "real" HTTP response (i.e. one that is meant to be sent
+  # back to the web browser) or a test response (i.e. one that is generated
+  # from integration tests). See CgiResponse and TestResponse, respectively.
   #
-  # AbstractResponse is mostly a Ruby on Rails framework implement detail, and should
-  # never be used directly in controllers. Controllers should use the methods defined
-  # in ActionController::Base instead. For example, if you want to set the HTTP
-  # response's content MIME type, then use ActionControllerBase#headers instead of
-  # AbstractResponse#headers.
+  # Response is mostly a Ruby on Rails framework implement detail, and
+  # should never be used directly in controllers. Controllers should use the
+  # methods defined in ActionController::Base instead. For example, if you want
+  # to set the HTTP response's content MIME type, then use
+  # ActionControllerBase#headers instead of Response#headers.
   #
-  # Nevertheless, integration tests may want to inspect controller responses in more
-  # detail, and that's when AbstractResponse can be useful for application developers.
-  # Integration test methods such as ActionController::Integration::Session#get and
-  # ActionController::Integration::Session#post return objects of type TestResponse
-  # (which are of course also of type AbstractResponse).
+  # Nevertheless, integration tests may want to inspect controller responses in
+  # more detail, and that's when Response can be useful for application
+  # developers. Integration test methods such as
+  # ActionController::Integration::Session#get and
+  # ActionController::Integration::Session#post return objects of type
+  # TestResponse (which are of course also of type Response).
   #
   # For example, the following demo integration "test" prints the body of the
   # controller response to the console:
@@ -29,25 +30,26 @@ module ActionController # :nodoc:
   #      puts @response.body
   #    end
   #  end
-  class AbstractResponse
+  class Response < Rack::Response
     DEFAULT_HEADERS = { "Cache-Control" => "no-cache" }
     attr_accessor :request
 
-    # The body content (e.g. HTML) of the response, as a String.
-    attr_accessor :body
-    # The headers of the response, as a Hash. It maps header names to header values.
-    attr_accessor :headers
-    attr_accessor :session, :cookies, :assigns, :template, :layout
+    attr_accessor :session, :assigns, :template, :layout
     attr_accessor :redirected_to, :redirected_to_method_params
 
     delegate :default_charset, :to => 'ActionController::Base'
 
     def initialize
-      @body, @headers, @session, @assigns = "", DEFAULT_HEADERS.merge("cookie" => []), [], []
-    end
+      @status = 200
+      @header = Rack::Utils::HeaderHash.new(DEFAULT_HEADERS)
 
-    def status; headers['Status'] end
-    def status=(status) headers['Status'] = status end
+      @writer = lambda { |x| @body << x }
+      @block = nil
+
+      @body = "",
+      @session = []
+      @assigns = []
+    end
 
     def location; headers['Location'] end
     def location=(url) headers['Location'] = url end
@@ -109,13 +111,17 @@ module ActionController # :nodoc:
     def etag
       headers['ETag']
     end
-    
+
     def etag?
       headers.include?('ETag')
     end
-    
+
     def etag=(etag)
-      headers['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
+      if etag.blank?
+        headers.delete('ETag')
+      else
+        headers['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
+      end
     end
 
     def redirect(url, status)
@@ -138,26 +144,64 @@ module ActionController # :nodoc:
       handle_conditional_get!
       set_content_length!
       convert_content_type!
+      convert_language!
+      convert_cookies!
+    end
+
+    def each(&callback)
+      if @body.respond_to?(:call)
+        @writer = lambda { |x| callback.call(x) }
+        @body.call(self, self)
+      elsif @body.respond_to?(:to_str)
+        yield @body
+      else
+        @body.each(&callback)
+      end
+
+      @writer = callback
+      @block.call(self) if @block
+    end
+
+    def write(str)
+      @writer.call str.to_s
+      str
+    end
+
+    def flush #:nodoc:
+      ActiveSupport::Deprecation.warn(
+        'Calling output.flush is no longer needed for streaming output ' +
+        'because ActionController::Response automatically handles it', caller)
+    end
+
+    def set_cookie(key, value)
+      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
-      def handle_conditional_get! 
-        if etag? || last_modified? 
-          set_conditional_cache_control! 
-        elsif nonempty_ok_response? 
-          self.etag = body 
+      def handle_conditional_get!
+        if etag? || last_modified?
+          set_conditional_cache_control!
+        elsif nonempty_ok_response?
+          self.etag = body
 
-          if request && request.etag_matches?(etag) 
-            self.status = '304 Not Modified' 
-            self.body = '' 
-          end 
+          if request && request.etag_matches?(etag)
+            self.status = '304 Not Modified'
+            self.body = ''
+          end
 
-          set_conditional_cache_control! 
-        end 
+          set_conditional_cache_control!
+        end
       end
 
       def nonempty_ok_response?
-        ok = !status || status[0..2] == '200'
+        ok = !status || status.to_s[0..2] == '200'
         ok && body.is_a?(String) && !body.empty?
       end
 
@@ -168,23 +212,28 @@ module ActionController # :nodoc:
       end
 
       def convert_content_type!
-        if content_type = headers.delete("Content-Type")
-          self.headers["type"] = content_type
-        end
-        if content_type = headers.delete("Content-type")
-          self.headers["type"] = content_type
-        end
-        if content_type = headers.delete("content-type")
-          self.headers["type"] = content_type
+        headers['Content-Type'] ||= "text/html"
+        headers['Content-Type'] += "; charset=" + headers.delete('charset') if headers['charset']
+      end
+
+      # Don't set the Content-Length for block-based bodies as that would mean
+      # reading it all into memory. Not nice for, say, a 2GB streaming file.
+      def set_content_length!
+        if status && status.to_s[0..2] == '204'
+          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.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
         end
       end
-    
-      # Don't set the Content-Length for block-based bodies as that would mean reading it all into memory. Not nice
-      # for, say, a 2GB streaming file.
-      def set_content_length!
-        unless body.respond_to?(:call) || (status && status[0..2] == '304')
-          self.headers["Content-Length"] ||= body.size
-        end
+
+      def convert_language!
+        headers["Content-Language"] = headers.delete("language") if headers["language"]
+      end
+
+      def convert_cookies!
+        headers['Set-Cookie'] = Array(headers['Set-Cookie']).compact
       end
   end
 end