actionpack 7.1.3 → 7.2.3

data/lib/action_dispatch/http/response.rb

@@ -1,38 +1,40 @@
 # 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
+  # # 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).
   #
-  # 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
+  # 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.
   #
-  # 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.
+  # 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
     begin
       # For `Rack::Headers` (Rack 3+):
@@ -44,6 +46,20 @@ module ActionDispatch # :nodoc:
       Headers = ::Rack::Utils::HeaderHash
     end
 
+    class << self
+      if ActionDispatch::Constants::UNPROCESSABLE_CONTENT == :unprocessable_content
+        def rack_status_code(status) # :nodoc:
+          status = :unprocessable_content if status == :unprocessable_entity
+          Rack::Utils.status_code(status)
+        end
+      else
+        def rack_status_code(status) # :nodoc:
+          status = :unprocessable_entity if status == :unprocessable_content
+          Rack::Utils.status_code(status)
+        end
+      end
+    end
+
     # To be deprecated:
     Header = Headers
 
@@ -55,17 +71,17 @@ module ActionDispatch # :nodoc:
 
     # The headers for the response.
     #
-    #   header["Content-Type"] # => "text/plain"
-    #   header["Content-Type"] = "application/json"
-    #   header["Content-Type"] # => "application/json"
+    #     header["Content-Type"] # => "text/plain"
+    #     header["Content-Type"] = "application/json"
+    #     header["Content-Type"] # => "application/json"
     #
-    # Also aliased as +headers+.
+    # Also aliased as `headers`.
     #
-    #   headers["Content-Type"] # => "text/plain"
-    #   headers["Content-Type"] = "application/json"
-    #   headers["Content-Type"] # => "application/json"
+    #     headers["Content-Type"] # => "text/plain"
+    #     headers["Content-Type"] = "application/json"
+    #     headers["Content-Type"] # => "application/json"
     #
-    # Also aliased as +header+ for compatibility.
+    # Also aliased as `header` for compatibility.
     attr_reader :headers
 
     alias_method :header, :headers
@@ -229,18 +245,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)
+      @status = Response.rack_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
@@ -267,11 +295,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
@@ -281,8 +309,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
@@ -293,26 +321,26 @@ module ActionDispatch # :nodoc:
       @status
     end
 
-    # Returns a string to ensure compatibility with +Net::HTTPResponse+.
+    # 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
@@ -332,9 +360,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
 
@@ -356,7 +384,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)
@@ -383,17 +411,16 @@ 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, @headers.to_hash
@@ -402,7 +429,7 @@ module ActionDispatch # :nodoc:
 
     # 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)
@@ -456,11 +483,10 @@ 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?
 
       @request.commit_cookie_jar! unless committed?
@@ -488,8 +514,8 @@ module ActionDispatch # :nodoc:
       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
 

data/lib/action_dispatch/http/upload.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module Http
-    # = Action Dispatch HTTP \UploadedFile
+    # # 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
@@ -19,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.
@@ -57,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

data/lib/action_dispatch/http/url.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/module/attribute_accessors"
 
 module ActionDispatch
@@ -15,20 +17,20 @@ module ActionDispatch
       class << self
         # Returns the domain part of a host given the domain level.
         #
-        #    # Top-level domain example
-        #    extract_domain('www.example.com', 1) # => "example.com"
-        #    # Second-level domain example
-        #    extract_domain('dev.www.example.co.uk', 2) # => "example.co.uk"
+        #     # Top-level domain example
+        #     extract_domain('www.example.com', 1) # => "example.com"
+        #     # Second-level domain example
+        #     extract_domain('dev.www.example.co.uk', 2) # => "example.co.uk"
         def extract_domain(host, tld_length)
           extract_domain_from(host, tld_length) if named_host?(host)
         end
 
         # Returns the subdomains of a host as an Array given the domain level.
         #
-        #    # Top-level domain example
-        #    extract_subdomains('www.example.com', 1) # => ["www"]
-        #    # Second-level domain example
-        #    extract_subdomains('dev.www.example.co.uk', 2) # => ["dev", "www"]
+        #     # Top-level domain example
+        #     extract_subdomains('www.example.com', 1) # => ["www"]
+        #     # Second-level domain example
+        #     extract_subdomains('dev.www.example.co.uk', 2) # => ["dev", "www"]
         def extract_subdomains(host, tld_length)
           if named_host?(host)
             extract_subdomains_from(host, tld_length)
@@ -39,10 +41,10 @@ module ActionDispatch
 
         # Returns the subdomains of a host as a String given the domain level.
         #
-        #    # Top-level domain example
-        #    extract_subdomain('www.example.com', 1) # => "www"
-        #    # Second-level domain example
-        #    extract_subdomain('dev.www.example.co.uk', 2) # => "dev.www"
+        #     # Top-level domain example
+        #     extract_subdomain('www.example.com', 1) # => "www"
+        #     # Second-level domain example
+        #     extract_subdomain('dev.www.example.co.uk', 2) # => "dev.www"
         def extract_subdomain(host, tld_length)
           extract_subdomains(host, tld_length).join(".")
         end
@@ -184,33 +186,33 @@ module ActionDispatch
 
       # Returns the complete URL used for this request.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
-      #   req.url # => "http://example.com"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
+      #     req.url # => "http://example.com"
       def url
         protocol + host_with_port + fullpath
       end
 
       # Returns 'https://' if this is an SSL request and 'http://' otherwise.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
-      #   req.protocol # => "http://"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
+      #     req.protocol # => "http://"
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com', 'HTTPS' => 'on'
-      #   req.protocol # => "https://"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com', 'HTTPS' => 'on'
+      #     req.protocol # => "https://"
       def protocol
         @protocol ||= ssl? ? "https://" : "http://"
       end
 
-      # Returns the \host and port for this request, such as "example.com:8080".
+      # Returns the host and port for this request, such as "example.com:8080".
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
-      #   req.raw_host_with_port # => "example.com"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
+      #     req.raw_host_with_port # => "example.com"
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
-      #   req.raw_host_with_port # => "example.com:80"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
+      #     req.raw_host_with_port # => "example.com:80"
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.raw_host_with_port # => "example.com:8080"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.raw_host_with_port # => "example.com:8080"
       def raw_host_with_port
         if forwarded = x_forwarded_host.presence
           forwarded.split(/,\s?/).last
@@ -221,35 +223,35 @@ module ActionDispatch
 
       # Returns the host for this request, such as "example.com".
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.host # => "example.com"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.host # => "example.com"
       def host
         raw_host_with_port.sub(/:\d+$/, "")
       end
 
-      # Returns a \host:\port string for this request, such as "example.com" or
-      # "example.com:8080". Port is only included if it is not a default port
-      # (80 or 443)
+      # Returns a host:port string for this request, such as "example.com" or
+      # "example.com:8080". Port is only included if it is not a default port (80 or
+      # 443)
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
-      #   req.host_with_port # => "example.com"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
+      #     req.host_with_port # => "example.com"
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
-      #   req.host_with_port # => "example.com"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
+      #     req.host_with_port # => "example.com"
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.host_with_port # => "example.com:8080"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.host_with_port # => "example.com:8080"
       def host_with_port
         "#{host}#{port_string}"
       end
 
       # Returns the port number of this request as an integer.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
-      #   req.port # => 80
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
+      #     req.port # => 80
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.port # => 8080
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.port # => 8080
       def port
         @port ||= if raw_host_with_port =~ /:(\d+)$/
           $1.to_i
@@ -258,10 +260,10 @@ module ActionDispatch
         end
       end
 
-      # Returns the standard \port number for this request's protocol.
+      # Returns the standard port number for this request's protocol.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.standard_port # => 80
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.standard_port # => 80
       def standard_port
         if "https://" == protocol
           443
@@ -270,70 +272,70 @@ module ActionDispatch
         end
       end
 
-      # Returns whether this request is using the standard port
+      # Returns whether this request is using the standard port.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
-      #   req.standard_port? # => true
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
+      #     req.standard_port? # => true
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.standard_port? # => false
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.standard_port? # => false
       def standard_port?
         port == standard_port
       end
 
-      # Returns a number \port suffix like 8080 if the \port number of this request
-      # is not the default HTTP \port 80 or HTTPS \port 443.
+      # Returns a number port suffix like 8080 if the port number of this request is
+      # not the default HTTP port 80 or HTTPS port 443.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
-      #   req.optional_port # => nil
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
+      #     req.optional_port # => nil
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.optional_port # => 8080
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.optional_port # => 8080
       def optional_port
         standard_port? ? nil : port
       end
 
-      # Returns a string \port suffix, including colon, like ":8080" if the \port
-      # number of this request is not the default HTTP \port 80 or HTTPS \port 443.
+      # Returns a string port suffix, including colon, like ":8080" if the port number
+      # of this request is not the default HTTP port 80 or HTTPS port 443.
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
-      #   req.port_string # => ""
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
+      #     req.port_string # => ""
       #
-      #   req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
-      #   req.port_string # => ":8080"
+      #     req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
+      #     req.port_string # => ":8080"
       def port_string
         standard_port? ? "" : ":#{port}"
       end
 
-      # Returns the requested port, such as 8080, based on SERVER_PORT
+      # Returns the requested port, such as 8080, based on SERVER_PORT.
       #
-      #   req = ActionDispatch::Request.new 'SERVER_PORT' => '80'
-      #   req.server_port # => 80
+      #     req = ActionDispatch::Request.new 'SERVER_PORT' => '80'
+      #     req.server_port # => 80
       #
-      #   req = ActionDispatch::Request.new 'SERVER_PORT' => '8080'
-      #   req.server_port # => 8080
+      #     req = ActionDispatch::Request.new 'SERVER_PORT' => '8080'
+      #     req.server_port # => 8080
       def server_port
         get_header("SERVER_PORT").to_i
       end
 
-      # Returns the \domain part of a \host, such as "rubyonrails.org" in "www.rubyonrails.org". You can specify
-      # a different <tt>tld_length</tt>, such as 2 to catch rubyonrails.co.uk in "www.rubyonrails.co.uk".
+      # Returns the domain part of a host, such as "rubyonrails.org" in
+      # "www.rubyonrails.org". You can specify a different `tld_length`, such as 2 to
+      # catch rubyonrails.co.uk in "www.rubyonrails.co.uk".
       def domain(tld_length = @@tld_length)
         ActionDispatch::Http::URL.extract_domain(host, tld_length)
       end
 
-      # Returns all the \subdomains as an array, so <tt>["dev", "www"]</tt> would be
-      # returned for "dev.www.rubyonrails.org". You can specify a different <tt>tld_length</tt>,
-      # such as 2 to catch <tt>["www"]</tt> instead of <tt>["www", "rubyonrails"]</tt>
-      # in "www.rubyonrails.co.uk".
+      # Returns all the subdomains as an array, so `["dev", "www"]` would be returned
+      # for "dev.www.rubyonrails.org". You can specify a different `tld_length`, such
+      # as 2 to catch `["www"]` instead of `["www", "rubyonrails"]` in
+      # "www.rubyonrails.co.uk".
       def subdomains(tld_length = @@tld_length)
         ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
       end
 
-      # Returns all the \subdomains as a string, so <tt>"dev.www"</tt> would be
-      # returned for "dev.www.rubyonrails.org". You can specify a different <tt>tld_length</tt>,
-      # such as 2 to catch <tt>"www"</tt> instead of <tt>"www.rubyonrails"</tt>
-      # in "www.rubyonrails.co.uk".
+      # Returns all the subdomains as a string, so `"dev.www"` would be returned for
+      # "dev.www.rubyonrails.org". You can specify a different `tld_length`, such as 2
+      # to catch `"www"` instead of `"www.rubyonrails"` in "www.rubyonrails.co.uk".
       def subdomain(tld_length = @@tld_length)
         ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
       end