actionpack 7.1.3.2 → 7.2.0.beta1

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
@@ -272,68 +274,68 @@ module ActionDispatch
 
       # 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
       #
-      #   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

data/lib/action_dispatch/journey/formatter.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "action_controller/metal/exceptions"
 
 module ActionDispatch
   # :stopdoc:
   module Journey
     # The Formatter class is used for formatting URLs. For example, parameters
-    # passed to +url_for+ in Rails will eventually call Formatter#generate.
+    # passed to `url_for` in Rails will eventually call Formatter#generate.
     class Formatter
       attr_reader :routes
 
@@ -66,16 +68,16 @@ module ActionDispatch
         match_route(name, constraints) do |route|
           parameterized_parts = extract_parameterized_parts(route, options, path_parameters)
 
-          # Skip this route unless a name has been provided or it is a
-          # standard Rails route since we can't determine whether an options
-          # hash passed to url_for matches a Rack application or a redirect.
+          # Skip this route unless a name has been provided or it is a standard Rails
+          # route since we can't determine whether an options hash passed to url_for
+          # matches a Rack application or a redirect.
           next unless name || route.dispatcher?
 
           missing_keys = missing_keys(route, parameterized_parts)
           next if missing_keys && !missing_keys.empty?
           params = options.delete_if do |key, _|
-            # top-level params' normal behavior of generating query_params
-            # should be preserved even if the same key is also a bind_param
+            # top-level params' normal behavior of generating query_params should be
+            # preserved even if the same key is also a bind_param
             parameterized_parts.key?(key) || route.defaults.key?(key) ||
               (path_params.key?(key) && !original_options.key?(key))
           end
@@ -104,6 +106,11 @@ module ActionDispatch
         @cache = nil
       end
 
+      def eager_load!
+        cache
+        nil
+      end
+
       private
         def extract_parameterized_parts(route, options, recall)
           parameterized_parts = recall.merge(options)

data/lib/action_dispatch/journey/gtg/builder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "action_dispatch/journey/gtg/transition_table"
 
 module ActionDispatch
@@ -66,9 +68,8 @@ module ActionDispatch
           when Nodes::Group
             true
           when Nodes::Star
-            # the default star regex is /(.+)/ which is NOT nullable
-            # but since different constraints can be provided we must
-            # actually check if this is the case or not.
+            # the default star regex is /(.+)/ which is NOT nullable but since different
+            # constraints can be provided we must actually check if this is the case or not.
             node.regexp.match?("")
           when Nodes::Or
             node.children.any? { |c| nullable?(c) }

data/lib/action_dispatch/journey/gtg/simulator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "strscan"
 
 module ActionDispatch

data/lib/action_dispatch/journey/gtg/transition_table.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "action_dispatch/journey/nfa/dot"
 
 module ActionDispatch
@@ -55,8 +57,8 @@ module ActionDispatch
 
           t.each { |s, previous_start|
             if previous_start.nil?
-              # In the simple case of a "default" param regex do this fast-path
-              # and add all next states.
+              # In the simple case of a "default" param regex do this fast-path and add all
+              # next states.
               if token_matches_default_component && states = @stdparam_states[s]
                 states.each { |re, v| next_states << [v, nil].freeze if !v.nil? }
               end
@@ -67,10 +69,10 @@ module ActionDispatch
               end
             end
 
-            # For regexes that aren't the "default" style, they may potentially
-            # not be terminated by the first "token" [./?], so we need to continue
-            # to attempt to match this regexp as well as any successful paths that
-            # continue out of it. both paths could be valid.
+            # For regexes that aren't the "default" style, they may potentially not be
+            # terminated by the first "token" [./?], so we need to continue to attempt to
+            # match this regexp as well as any successful paths that continue out of it.
+            # both paths could be valid.
             if states = @regexp_states[s]
               slice_start = if previous_start.nil?
                 start_index
@@ -86,8 +88,8 @@ module ActionDispatch
                 next_states << [v, nil].freeze if !v.nil? && re.match?(curr_slice)
               }
 
-              # and regardless, we must continue accepting tokens and retrying this regexp.
-              # we need to remember where we started as well so we can take bigger slices.
+              # and regardless, we must continue accepting tokens and retrying this regexp. we
+              # need to remember where we started as well so we can take bigger slices.
               next_states << [s, slice_start].freeze
             end
           }

data/lib/action_dispatch/journey/nfa/dot.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module Journey # :nodoc:
     module NFA # :nodoc:

data/lib/action_dispatch/journey/nodes/node.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "action_dispatch/journey/visitors"
 
 module ActionDispatch
@@ -21,9 +23,8 @@ module ActionDispatch
       end
 
       def requirements=(requirements)
-        # inject any regexp requirements for `star` nodes so they can be
-        # determined nullable, which requires knowing if the regex accepts an
-        # empty string.
+        # inject any regexp requirements for `star` nodes so they can be determined
+        # nullable, which requires knowing if the regex accepts an empty string.
         (symbols + stars).each do |node|
           re = requirements[node.to_sym]
           node.regexp = re if re
@@ -51,8 +52,8 @@ module ActionDispatch
               stars << node
 
               if formatted != false
-                # Add a constraint for wildcard route to make it non-greedy and
-                # match the optional format part of the route by default.
+                # Add a constraint for wildcard route to make it non-greedy and match the
+                # optional format part of the route by default.
                 wildcard_options[node.name.to_sym] ||= /.+?/m
               end
             end

data/lib/action_dispatch/journey/parser.rb

@@ -1,8 +1,9 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.16
-# from Racc grammar file "".
-#
+# This file is automatically generated by Racc 1.4.16 from
+# Racc grammar file "".
+
+# :markup: markdown
 
 require 'racc/parser.rb'
 

data/lib/action_dispatch/journey/parser_extras.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "action_dispatch/journey/scanner"
 require "action_dispatch/journey/nodes/node"
 

data/lib/action_dispatch/journey/path/pattern.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module Journey # :nodoc:
     module Path # :nodoc:
@@ -32,7 +34,8 @@ module ActionDispatch
         end
 
         def requirements_anchored?
-          # each required param must not be surrounded by a literal, otherwise it isn't simple to chunk-match the url piecemeal
+          # each required param must not be surrounded by a literal, otherwise it isn't
+          # simple to chunk-match the url piecemeal
           terminals = ast.terminals
 
           terminals.each_with_index { |s, index|

data/lib/action_dispatch/journey/route.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   # :stopdoc:
   module Journey
@@ -52,7 +54,7 @@ module ActionDispatch
 
       ##
       # +path+ is a path constraint.
-      # +constraints+ is a hash of constraints to be applied to this route.
+      # `constraints` is a hash of constraints to be applied to this route.
       def initialize(name:, app: nil, path:, constraints: {}, required_defaults: [], defaults: {}, request_method_match: nil, precedence: 0, scope_options: {}, internal: false, source_location: nil)
         @name        = name
         @app         = app
@@ -82,14 +84,14 @@ module ActionDispatch
         nil
       end
 
-      # Needed for `bin/rails routes`. Picks up succinctly defined requirements
-      # for a route, for example route
+      # Needed for `bin/rails routes`. Picks up succinctly defined requirements for a
+      # route, for example route
       #
-      #   get 'photo/:id', :controller => 'photos', :action => 'show',
-      #     :id => /[A-Z]\d{5}/
+      #     get 'photo/:id', :controller => 'photos', :action => 'show',
+      #       :id => /[A-Z]\d{5}/
       #
-      # will have {:controller=>"photos", :action=>"show", :id=>/[A-Z]\d{5}/}
-      # as requirements.
+      # will have {:controller=>"photos", :action=>"show", :[id=>/](A-Z){5}/} as
+      # requirements.
       def requirements
         @defaults.merge(path.requirements).delete_if { |_, v|
           /.+?/m == v