actionpack 7.0.8.1 → 7.2.2.1

data/lib/action_dispatch/http/response.rb

@@ -1,74 +1,78 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/module/attribute_accessors"
 require "action_dispatch/http/filter_redirect"
 require "action_dispatch/http/cache"
 require "monitor"
 
 module ActionDispatch # :nodoc:
+  # # Action Dispatch Response
+  #
   # Represents an HTTP response generated by a controller action. Use it to
   # retrieve the current state of the response, or customize the response. It can
-  # either represent a real HTTP response (i.e. one that is meant to be sent
-  # back to the web browser) or a TestResponse (i.e. one that is generated
-  # from integration tests).
+  # either represent a real HTTP response (i.e. one that is meant to be sent back
+  # to the web browser) or a TestResponse (i.e. one that is generated from
+  # integration tests).
   #
-  # \Response is mostly a Ruby on \Rails framework implementation 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.
+  # The Response object for the current request is exposed on controllers as
+  # ActionController::Metal#response. ActionController::Metal also provides a few
+  # additional methods that delegate to attributes of the Response such as
+  # ActionController::Metal#headers.
   #
-  # 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
-  # Integration::RequestHelpers#get and Integration::RequestHelpers#post return
-  # objects of type TestResponse (which are of course also of type \Response).
+  # Integration tests will likely also want to inspect responses in more detail.
+  # Methods such as Integration::RequestHelpers#get and
+  # Integration::RequestHelpers#post return instances of TestResponse (which
+  # inherits from Response) for this purpose.
   #
   # For example, the following demo integration test prints the body of the
   # controller response to the console:
   #
-  #  class DemoControllerTest < ActionDispatch::IntegrationTest
-  #    def test_print_root_path_to_console
-  #      get('/')
-  #      puts response.body
-  #    end
-  #  end
+  #     class DemoControllerTest < ActionDispatch::IntegrationTest
+  #       def test_print_root_path_to_console
+  #         get('/')
+  #         puts response.body
+  #       end
+  #     end
   class Response
-    class Header < DelegateClass(Hash) # :nodoc:
-      def initialize(response, header)
-        @response = response
-        super(header)
-      end
-
-      def []=(k, v)
-        if @response.sending? || @response.sent?
-          raise ActionDispatch::IllegalStateError, "header already sent"
-        end
-
-        super
-      end
-
-      def merge(other)
-        self.class.new @response, __getobj__.merge(other)
-      end
-
-      def to_hash
-        __getobj__.dup
-      end
+    begin
+      # For `Rack::Headers` (Rack 3+):
+      require "rack/headers"
+      Headers = ::Rack::Headers
+    rescue LoadError
+      # For `Rack::Utils::HeaderHash`:
+      require "rack/utils"
+      Headers = ::Rack::Utils::HeaderHash
     end
 
+    # To be deprecated:
+    Header = Headers
+
     # The request that the response is responding to.
     attr_accessor :request
 
     # The HTTP status code.
     attr_reader :status
 
-    # Get headers for this response.
-    attr_reader :header
+    # The headers for the response.
+    #
+    #     header["Content-Type"] # => "text/plain"
+    #     header["Content-Type"] = "application/json"
+    #     header["Content-Type"] # => "application/json"
+    #
+    # Also aliased as `headers`.
+    #
+    #     headers["Content-Type"] # => "text/plain"
+    #     headers["Content-Type"] = "application/json"
+    #     headers["Content-Type"] # => "application/json"
+    #
+    # Also aliased as `header` for compatibility.
+    attr_reader :headers
 
-    alias_method :headers,  :header
+    alias_method :header, :headers
 
-    delegate :[], :[]=, to: :@header
+    delegate :[], :[]=, to: :@headers
 
     def each(&block)
       sending!
@@ -79,7 +83,6 @@ module ActionDispatch # :nodoc:
 
     CONTENT_TYPE = "Content-Type"
     SET_COOKIE   = "Set-Cookie"
-    LOCATION     = "Location"
     NO_CONTENT_CODES = [100, 101, 102, 103, 204, 205, 304]
 
     cattr_accessor :default_charset, default: "utf-8"
@@ -102,6 +105,12 @@ module ActionDispatch # :nodoc:
         @str_body = nil
       end
 
+      def to_ary
+        @buf.respond_to?(:to_ary) ?
+          @buf.to_ary :
+          @buf.each
+      end
+
       def body
         @str_body ||= begin
           buf = +""
@@ -117,6 +126,7 @@ module ActionDispatch # :nodoc:
         @response.commit!
         @buf.push string
       end
+      alias_method :<<, :write
 
       def each(&block)
         if @str_body
@@ -146,9 +156,9 @@ module ActionDispatch # :nodoc:
         end
     end
 
-    def self.create(status = 200, header = {}, body = [], default_headers: self.default_headers)
-      header = merge_default_headers(header, default_headers)
-      new status, header, body
+    def self.create(status = 200, headers = {}, body = [], default_headers: self.default_headers)
+      headers = merge_default_headers(headers, default_headers)
+      new status, headers, body
     end
 
     def self.merge_default_headers(original, default)
@@ -158,10 +168,14 @@ module ActionDispatch # :nodoc:
     # The underlying body, as a streamable object.
     attr_reader :stream
 
-    def initialize(status = 200, header = {}, body = [])
+    def initialize(status = 200, headers = nil, body = [])
       super()
 
-      @header = Header.new(self, header)
+      @headers = Headers.new
+
+      headers&.each do |key, value|
+        @headers[key] = value
+      end
 
       self.body, self.status = body, status
 
@@ -175,10 +189,10 @@ module ActionDispatch # :nodoc:
       yield self if block_given?
     end
 
-    def has_header?(key);   headers.key? key;   end
-    def get_header(key);    headers[key];       end
-    def set_header(key, v); headers[key] = v;   end
-    def delete_header(key); headers.delete key; end
+    def has_header?(key);   @headers.key? key;   end
+    def get_header(key);    @headers[key];       end
+    def set_header(key, v); @headers[key] = v;   end
+    def delete_header(key); @headers.delete key; end
 
     def await_commit
       synchronize do
@@ -217,18 +231,30 @@ module ActionDispatch # :nodoc:
     def committed?; synchronize { @committed }; end
     def sent?;      synchronize { @sent };      end
 
+    ##
+    # :method: location
+    #
+    # Location of the response.
+
+    ##
+    # :method: location=
+    #
+    # :call-seq: location=(location)
+    #
+    # Sets the location of the response
+
     # Sets the HTTP status code.
     def status=(status)
       @status = Rack::Utils.status_code(status)
     end
 
-    # Sets the HTTP response's content MIME type. For example, in the controller
-    # you could write this:
+    # Sets the HTTP response's content MIME type. For example, in the controller you
+    # could write this:
     #
-    #  response.content_type = "text/plain"
+    #     response.content_type = "text/plain"
     #
-    # If a character set has been defined for this response (see charset=) then
-    # the character set information will also be included in the content type
+    # If a character set has been defined for this response (see #charset=) then the
+    # character set information will also be included in the content type
     # information.
     def content_type=(content_type)
       return unless content_type
@@ -255,11 +281,11 @@ module ActionDispatch # :nodoc:
       end
     end
 
-    # Sets the HTTP character set. In case of +nil+ parameter
-    # it sets the charset to +default_charset+.
+    # Sets the HTTP character set. In case of `nil` parameter it sets the charset to
+    # `default_charset`.
     #
-    #   response.charset = 'utf-16' # => 'utf-16'
-    #   response.charset = nil      # => 'utf-8'
+    #     response.charset = 'utf-16' # => 'utf-16'
+    #     response.charset = nil      # => 'utf-8'
     def charset=(charset)
       content_type = parsed_content_type_header.mime_type
       if false == charset
@@ -269,8 +295,8 @@ module ActionDispatch # :nodoc:
       end
     end
 
-    # The charset of the response. HTML wants to know the encoding of the
-    # content you're giving them, so we need to send that along.
+    # The charset of the response. HTML wants to know the encoding of the content
+    # you're giving them, so we need to send that along.
     def charset
       header_info = parsed_content_type_header
       header_info.charset || self.class.default_charset
@@ -281,26 +307,26 @@ module ActionDispatch # :nodoc:
       @status
     end
 
-    # Returns a string to ensure compatibility with <tt>Net::HTTPResponse</tt>.
+    # Returns a string to ensure compatibility with `Net::HTTPResponse`.
     def code
       @status.to_s
     end
 
     # Returns the corresponding message for the current HTTP status code:
     #
-    #   response.status = 200
-    #   response.message # => "OK"
+    #     response.status = 200
+    #     response.message # => "OK"
     #
-    #   response.status = 404
-    #   response.message # => "Not Found"
+    #     response.status = 404
+    #     response.message # => "Not Found"
     #
     def message
       Rack::Utils::HTTP_STATUS_CODES[@status]
     end
     alias_method :status_message, :message
 
-    # Returns the content of the response as a string. This contains the contents
-    # of any calls to <tt>render</tt>.
+    # Returns the content of the response as a string. This contains the contents of
+    # any calls to `render`.
     def body
       @stream.body
     end
@@ -320,9 +346,9 @@ module ActionDispatch # :nodoc:
       end
     end
 
-    # Avoid having to pass an open file handle as the response body.
-    # Rack::Sendfile will usually intercept the response and uses
-    # the path directly, so there is no reason to open the file.
+    # Avoid having to pass an open file handle as the response body. Rack::Sendfile
+    # will usually intercept the response and uses the path directly, so there is no
+    # reason to open the file.
     class FileBody # :nodoc:
       attr_reader :to_path
 
@@ -344,7 +370,7 @@ module ActionDispatch # :nodoc:
       end
     end
 
-    # Send the file stored at +path+ as the response body.
+    # Send the file stored at `path` as the response body.
     def send_file(path)
       commit!
       @stream = FileBody.new(path)
@@ -371,26 +397,25 @@ module ActionDispatch # :nodoc:
       if stream.respond_to?(:abort)
         stream.abort
       elsif stream.respond_to?(:close)
-        # `stream.close` should really be reserved for a close from the
-        # other direction, but we must fall back to it for
-        # compatibility.
+        # `stream.close` should really be reserved for a close from the other direction,
+        # but we must fall back to it for compatibility.
         stream.close
       end
     end
 
-    # Turns the Response into a Rack-compatible array of the status, headers,
-    # and body. Allows explicit splatting:
+    # Turns the Response into a Rack-compatible array of the status, headers, and
+    # body. Allows explicit splatting:
     #
-    #   status, headers, body = *response
+    #     status, headers, body = *response
     def to_a
       commit!
-      rack_response @status, @header.to_hash
+      rack_response @status, @headers.to_hash
     end
     alias prepare! to_a
 
     # Returns the response cookies, converted to a Hash of (name => value) pairs
     #
-    #   assert_equal 'AuthorOfNewPage', r.cookies['author']
+    #     assert_equal 'AuthorOfNewPage', r.cookies['author']
     def cookies
       cookies = {}
       if header = get_header(SET_COOKIE)
@@ -444,15 +469,13 @@ module ActionDispatch # :nodoc:
     end
 
     def before_sending
-      # Normally we've already committed by now, but it's possible
-      # (e.g., if the controller action tries to read back its own
-      # response) to get here before that. In that case, we must force
-      # an "early" commit: we're about to freeze the headers, so this is
-      # our last chance.
+      # Normally we've already committed by now, but it's possible (e.g., if the
+      # controller action tries to read back its own response) to get here before
+      # that. In that case, we must force an "early" commit: we're about to freeze the
+      # headers, so this is our last chance.
       commit! unless committed?
 
-      headers.freeze
-      request.commit_cookie_jar! unless committed?
+      @request.commit_cookie_jar! unless committed?
     end
 
     def build_buffer(response, body)
@@ -476,13 +499,9 @@ module ActionDispatch # :nodoc:
         @response = response
       end
 
-      def each(*args, &block)
-        @response.each(*args, &block)
-      end
-
       def close
-        # Rack "close" maps to Response#abort, and *not* Response#close
-        # (which is used when the controller's finished writing)
+        # Rack "close" maps to Response#abort, and **not** Response#close (which is used
+        # when the controller's finished writing)
         @response.abort
       end
 
@@ -490,14 +509,28 @@ module ActionDispatch # :nodoc:
         @response.body
       end
 
+      BODY_METHODS = { to_ary: true, each: true, call: true, to_path: true }
+
       def respond_to?(method, include_private = false)
-        if method.to_sym == :to_path
+        if BODY_METHODS.key?(method)
           @response.stream.respond_to?(method)
         else
           super
         end
       end
 
+      def to_ary
+        @response.stream.to_ary
+      end
+
+      def each(*args, &block)
+        @response.each(*args, &block)
+      end
+
+      def call(*arguments, &block)
+        @response.stream.call(*arguments, &block)
+      end
+
       def to_path
         @response.stream.to_path
       end
@@ -505,16 +538,16 @@ module ActionDispatch # :nodoc:
 
     def handle_no_content!
       if NO_CONTENT_CODES.include?(@status)
-        @header.delete CONTENT_TYPE
-        @header.delete "Content-Length"
+        @headers.delete CONTENT_TYPE
+        @headers.delete "Content-Length"
       end
     end
 
-    def rack_response(status, header)
+    def rack_response(status, headers)
       if NO_CONTENT_CODES.include?(status)
-        [status, header, []]
+        [status, headers, []]
       else
-        [status, header, RackBody.new(self)]
+        [status, headers, RackBody.new(self)]
       end
     end
   end

data/lib/action_dispatch/http/upload.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module Http
+    # # Action Dispatch HTTP UploadedFile
+    #
     # Models uploaded files.
     #
-    # The actual file is accessible via the +tempfile+ accessor, though some
-    # of its interface is available directly for convenience.
+    # The actual file is accessible via the `tempfile` accessor, though some of its
+    # interface is available directly for convenience.
     #
-    # Uploaded files are temporary files whose lifespan is one request. When
-    # the object is finalized Ruby unlinks the file, so there is no need to
-    # clean them with a separate maintenance task.
+    # Uploaded files are temporary files whose lifespan is one request. When the
+    # object is finalized Ruby unlinks the file, so there is no need to clean them
+    # with a separate maintenance task.
     class UploadedFile
       # The basename of the file in the client.
       attr_accessor :original_filename
@@ -17,8 +21,8 @@ module ActionDispatch
       # A string with the MIME type of the file.
       attr_accessor :content_type
 
-      # A +Tempfile+ object with the actual uploaded file. Note that some of
-      # its interface is available directly.
+      # A `Tempfile` object with the actual uploaded file. Note that some of its
+      # interface is available directly.
       attr_accessor :tempfile
 
       # A string with the headers of the multipart request.
@@ -55,42 +59,42 @@ module ActionDispatch
         end
       end
 
-      # Shortcut for +tempfile.read+.
+      # Shortcut for `tempfile.read`.
       def read(length = nil, buffer = nil)
         @tempfile.read(length, buffer)
       end
 
-      # Shortcut for +tempfile.open+.
+      # Shortcut for `tempfile.open`.
       def open
         @tempfile.open
       end
 
-      # Shortcut for +tempfile.close+.
+      # Shortcut for `tempfile.close`.
       def close(unlink_now = false)
         @tempfile.close(unlink_now)
       end
 
-      # Shortcut for +tempfile.path+.
+      # Shortcut for `tempfile.path`.
       def path
         @tempfile.path
       end
 
-      # Shortcut for +tempfile.to_path+.
+      # Shortcut for `tempfile.to_path`.
       def to_path
         @tempfile.to_path
       end
 
-      # Shortcut for +tempfile.rewind+.
+      # Shortcut for `tempfile.rewind`.
       def rewind
         @tempfile.rewind
       end
 
-      # Shortcut for +tempfile.size+.
+      # Shortcut for `tempfile.size`.
       def size
         @tempfile.size
       end
 
-      # Shortcut for +tempfile.eof?+.
+      # Shortcut for `tempfile.eof?`.
       def eof?
         @tempfile.eof?
       end