actionpack 7.1.3.4 → 7.2.0.beta1

data/lib/action_dispatch/routing.rb

@@ -1,248 +1,250 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   # The routing module provides URL rewriting in native Ruby. It's a way to
   # redirect incoming requests to controllers and actions. This replaces
-  # mod_rewrite rules. Best of all, Rails' \Routing works with any web server.
-  # Routes are defined in <tt>config/routes.rb</tt>.
+  # mod_rewrite rules. Best of all, Rails' Routing works with any web server.
+  # Routes are defined in `config/routes.rb`.
   #
   # Think of creating routes as drawing a map for your requests. The map tells
   # them where to go based on some predefined pattern:
   #
-  #   Rails.application.routes.draw do
-  #     Pattern 1 tells some request to go to one place
-  #     Pattern 2 tell them to go to another
-  #     ...
-  #   end
+  #     Rails.application.routes.draw do
+  #       Pattern 1 tells some request to go to one place
+  #       Pattern 2 tell them to go to another
+  #       ...
+  #     end
   #
   # The following symbols are special:
   #
-  #   :controller maps to your controller name
-  #   :action     maps to an action with your controllers
+  #     :controller maps to your controller name
+  #     :action     maps to an action with your controllers
   #
-  # Other names simply map to a parameter as in the case of <tt>:id</tt>.
+  # Other names simply map to a parameter as in the case of `:id`.
   #
-  # == Resources
+  # ## Resources
   #
-  # Resource routing allows you to quickly declare all of the common routes
-  # for a given resourceful controller. Instead of declaring separate routes
-  # for your +index+, +show+, +new+, +edit+, +create+, +update+, and +destroy+
-  # actions, a resourceful route declares them in a single line of code:
+  # Resource routing allows you to quickly declare all of the common routes for a
+  # given resourceful controller. Instead of declaring separate routes for your
+  # `index`, `show`, `new`, `edit`, `create`, `update`, and `destroy` actions, a
+  # resourceful route declares them in a single line of code:
   #
-  #  resources :photos
+  #     resources :photos
   #
-  # Sometimes, you have a resource that clients always look up without
-  # referencing an ID. A common example, /profile always shows the profile of
-  # the currently logged in user. In this case, you can use a singular resource
-  # to map /profile (rather than /profile/:id) to the show action.
+  # Sometimes, you have a resource that clients always look up without referencing
+  # an ID. A common example, /profile always shows the profile of the currently
+  # logged in user. In this case, you can use a singular resource to map /profile
+  # (rather than /profile/:id) to the show action.
   #
-  #  resource :profile
+  #     resource :profile
   #
-  # It's common to have resources that are logically children of other
-  # resources:
+  # It's common to have resources that are logically children of other resources:
   #
-  #   resources :magazines do
-  #     resources :ads
-  #   end
+  #     resources :magazines do
+  #       resources :ads
+  #     end
   #
   # You may wish to organize groups of controllers under a namespace. Most
-  # commonly, you might group a number of administrative controllers under
-  # an +admin+ namespace. You would place these controllers under the
-  # <tt>app/controllers/admin</tt> directory, and you can group them together
-  # in your router:
+  # commonly, you might group a number of administrative controllers under an
+  # `admin` namespace. You would place these controllers under the
+  # `app/controllers/admin` directory, and you can group them together in your
+  # router:
   #
-  #   namespace "admin" do
-  #     resources :posts, :comments
-  #   end
+  #     namespace "admin" do
+  #       resources :posts, :comments
+  #     end
   #
   # Alternatively, you can add prefixes to your path without using a separate
-  # directory by using +scope+. +scope+ takes additional options which
-  # apply to all enclosed routes.
+  # directory by using `scope`. `scope` takes additional options which apply to
+  # all enclosed routes.
   #
-  #   scope path: "/cpanel", as: 'admin' do
-  #     resources :posts, :comments
-  #   end
+  #     scope path: "/cpanel", as: 'admin' do
+  #       resources :posts, :comments
+  #     end
   #
   # For more, see Routing::Mapper::Resources#resources,
   # Routing::Mapper::Scoping#namespace, and Routing::Mapper::Scoping#scope.
   #
-  # == Non-resourceful routes
+  # ## Non-resourceful routes
   #
-  # For routes that don't fit the <tt>resources</tt> mold, you can use the HTTP helper
-  # methods <tt>get</tt>, <tt>post</tt>, <tt>patch</tt>, <tt>put</tt> and <tt>delete</tt>.
+  # For routes that don't fit the `resources` mold, you can use the HTTP helper
+  # methods `get`, `post`, `patch`, `put` and `delete`.
   #
-  #   get 'post/:id', to: 'posts#show'
-  #   post 'post/:id', to: 'posts#create_comment'
+  #     get 'post/:id', to: 'posts#show'
+  #     post 'post/:id', to: 'posts#create_comment'
   #
-  # Now, if you POST to <tt>/posts/:id</tt>, it will route to the <tt>create_comment</tt> action. A GET on the same
-  # URL will route to the <tt>show</tt> action.
+  # Now, if you POST to `/posts/:id`, it will route to the `create_comment`
+  # action. A GET on the same URL will route to the `show` action.
   #
-  # If your route needs to respond to more than one HTTP method (or all methods) then using the
-  # <tt>:via</tt> option on <tt>match</tt> is preferable.
+  # If your route needs to respond to more than one HTTP method (or all methods)
+  # then using the `:via` option on `match` is preferable.
   #
-  #   match 'post/:id', to: 'posts#show', via: [:get, :post]
+  #     match 'post/:id', to: 'posts#show', via: [:get, :post]
   #
-  # == Named routes
+  # ## Named routes
   #
-  # Routes can be named by passing an <tt>:as</tt> option,
-  # allowing for easy reference within your source as +name_of_route_url+
-  # for the full URL and +name_of_route_path+ for the URI path.
+  # Routes can be named by passing an `:as` option, allowing for easy reference
+  # within your source as `name_of_route_url` for the full URL and
+  # `name_of_route_path` for the URI path.
   #
   # Example:
   #
-  #   # In config/routes.rb
-  #   get '/login', to: 'accounts#login', as: 'login'
+  #     # In config/routes.rb
+  #     get '/login', to: 'accounts#login', as: 'login'
   #
-  #   # With render, redirect_to, tests, etc.
-  #   redirect_to login_url
+  #     # With render, redirect_to, tests, etc.
+  #     redirect_to login_url
   #
   # Arguments can be passed as well.
   #
-  #   redirect_to show_item_path(id: 25)
+  #     redirect_to show_item_path(id: 25)
   #
-  # Use <tt>root</tt> as a shorthand to name a route for the root path "/".
+  # Use `root` as a shorthand to name a route for the root path "/".
   #
-  #   # In config/routes.rb
-  #   root to: 'blogs#index'
+  #     # In config/routes.rb
+  #     root to: 'blogs#index'
   #
-  #   # would recognize http://www.example.com/ as
-  #   params = { controller: 'blogs', action: 'index' }
+  #     # would recognize http://www.example.com/ as
+  #     params = { controller: 'blogs', action: 'index' }
   #
-  #   # and provide these named routes
-  #   root_url   # => 'http://www.example.com/'
-  #   root_path  # => '/'
+  #     # and provide these named routes
+  #     root_url   # => 'http://www.example.com/'
+  #     root_path  # => '/'
   #
-  # Note: when using +controller+, the route is simply named after the
-  # method you call on the block parameter rather than map.
+  # Note: when using `controller`, the route is simply named after the method you
+  # call on the block parameter rather than map.
   #
-  #   # In config/routes.rb
-  #   controller :blog do
-  #     get 'blog/show'    => :list
-  #     get 'blog/delete'  => :delete
-  #     get 'blog/edit'    => :edit
-  #   end
+  #     # In config/routes.rb
+  #     controller :blog do
+  #       get 'blog/show'    => :list
+  #       get 'blog/delete'  => :delete
+  #       get 'blog/edit'    => :edit
+  #     end
   #
-  #   # provides named routes for show, delete, and edit
-  #   link_to @article.title, blog_show_path(id: @article.id)
+  #     # provides named routes for show, delete, and edit
+  #     link_to @article.title, blog_show_path(id: @article.id)
   #
-  # == Pretty URLs
+  # ## Pretty URLs
   #
   # Routes can generate pretty URLs. For example:
   #
-  #   get '/articles/:year/:month/:day', to: 'articles#find_by_id', constraints: {
-  #     year:       /\d{4}/,
-  #     month:      /\d{1,2}/,
-  #     day:        /\d{1,2}/
-  #   }
+  #     get '/articles/:year/:month/:day', to: 'articles#find_by_id', constraints: {
+  #       year:       /\d{4}/,
+  #       month:      /\d{1,2}/,
+  #       day:        /\d{1,2}/
+  #     }
   #
   # Using the route above, the URL "http://localhost:3000/articles/2005/11/06"
   # maps to
   #
-  #   params = {year: '2005', month: '11', day: '06'}
+  #     params = {year: '2005', month: '11', day: '06'}
   #
-  # == Regular Expressions and parameters
+  # ## Regular Expressions and parameters
   # You can specify a regular expression to define a format for a parameter.
   #
-  #   controller 'geocode' do
-  #     get 'geocode/:postalcode', to: :show, constraints: {
-  #       postalcode: /\d{5}(-\d{4})?/
-  #     }
-  #   end
+  #     controller 'geocode' do
+  #       get 'geocode/:postalcode', to: :show, constraints: {
+  #         postalcode: /\d{5}(-\d{4})?/
+  #       }
+  #     end
   #
   # Constraints can include the 'ignorecase' and 'extended syntax' regular
   # expression modifiers:
   #
-  #   controller 'geocode' do
-  #     get 'geocode/:postalcode', to: :show, constraints: {
-  #       postalcode: /hx\d\d\s\d[a-z]{2}/i
-  #     }
-  #   end
-  #
-  #   controller 'geocode' do
-  #     get 'geocode/:postalcode', to: :show, constraints: {
-  #       postalcode: /# Postalcode format
-  #          \d{5} #Prefix
-  #          (-\d{4})? #Suffix
-  #          /x
-  #     }
-  #   end
+  #     controller 'geocode' do
+  #       get 'geocode/:postalcode', to: :show, constraints: {
+  #         postalcode: /hx\d\d\s\d[a-z]{2}/i
+  #       }
+  #     end
+  #
+  #     controller 'geocode' do
+  #       get 'geocode/:postalcode', to: :show, constraints: {
+  #         postalcode: /# Postalcode format
+  #            \d{5} #Prefix
+  #            (-\d{4})? #Suffix
+  #            /x
+  #       }
+  #     end
   #
-  # Using the multiline modifier will raise an +ArgumentError+.
-  # Encoding regular expression modifiers are silently ignored. The
-  # match will always use the default encoding or ASCII.
+  # Using the multiline modifier will raise an `ArgumentError`. Encoding regular
+  # expression modifiers are silently ignored. The match will always use the
+  # default encoding or ASCII.
   #
-  # == External redirects
+  # ## External redirects
   #
-  # You can redirect any path to another path using the redirect helper in your router:
+  # You can redirect any path to another path using the redirect helper in your
+  # router:
   #
-  #   get "/stories", to: redirect("/posts")
+  #     get "/stories", to: redirect("/posts")
   #
-  # == Unicode character routes
+  # ## Unicode character routes
   #
   # You can specify unicode character routes in your router:
   #
-  #   get "こんにちは", to: "welcome#index"
+  #     get "こんにちは", to: "welcome#index"
   #
-  # == Routing to Rack Applications
+  # ## Routing to Rack Applications
   #
-  # Instead of a String, like <tt>posts#index</tt>, which corresponds to the
-  # index action in the PostsController, you can specify any Rack application
-  # as the endpoint for a matcher:
+  # Instead of a String, like `posts#index`, which corresponds to the index action
+  # in the PostsController, you can specify any Rack application as the endpoint
+  # for a matcher:
   #
-  #   get "/application.js", to: Sprockets
+  #     get "/application.js", to: Sprockets
   #
-  # == Reloading routes
+  # ## Reloading routes
   #
   # You can reload routes if you feel you must:
   #
-  #   Rails.application.reload_routes!
+  #     Rails.application.reload_routes!
   #
-  # This will clear all named routes and reload config/routes.rb if the file has been modified from
-  # last load. To absolutely force reloading, use <tt>reload!</tt>.
+  # This will clear all named routes and reload config/routes.rb if the file has
+  # been modified from last load. To absolutely force reloading, use `reload!`.
   #
-  # == Testing Routes
+  # ## Testing Routes
   #
   # The two main methods for testing your routes:
   #
-  # === +assert_routing+
+  # ### `assert_routing`
   #
-  #   def test_movie_route_properly_splits
-  #     opts = {controller: "plugin", action: "checkout", id: "2"}
-  #     assert_routing "plugin/checkout/2", opts
-  #   end
+  #     def test_movie_route_properly_splits
+  #       opts = {controller: "plugin", action: "checkout", id: "2"}
+  #       assert_routing "plugin/checkout/2", opts
+  #     end
   #
-  # +assert_routing+ lets you test whether or not the route properly resolves into options.
+  # `assert_routing` lets you test whether or not the route properly resolves into
+  # options.
   #
-  # === +assert_recognizes+
+  # ### `assert_recognizes`
   #
-  #   def test_route_has_options
-  #     opts = {controller: "plugin", action: "show", id: "12"}
-  #     assert_recognizes opts, "/plugins/show/12"
-  #   end
+  #     def test_route_has_options
+  #       opts = {controller: "plugin", action: "show", id: "12"}
+  #       assert_recognizes opts, "/plugins/show/12"
+  #     end
   #
-  # Note the subtle difference between the two: +assert_routing+ tests that
-  # a URL fits options while +assert_recognizes+ tests that a URL
-  # breaks into parameters properly.
+  # Note the subtle difference between the two: `assert_routing` tests that a URL
+  # fits options while `assert_recognizes` tests that a URL breaks into parameters
+  # properly.
   #
-  # In tests you can simply pass the URL or named route to +get+ or +post+.
+  # In tests you can simply pass the URL or named route to `get` or `post`.
   #
-  #   def send_to_jail
-  #     get '/jail'
-  #     assert_response :success
-  #   end
+  #     def send_to_jail
+  #       get '/jail'
+  #       assert_response :success
+  #     end
   #
-  #   def goes_to_login
-  #     get login_url
-  #     #...
-  #   end
+  #     def goes_to_login
+  #       get login_url
+  #       #...
+  #     end
   #
-  # == View a list of all your routes
+  # ## View a list of all your routes
   #
-  #   $ bin/rails routes
+  #     $ bin/rails routes
   #
-  # Target a specific controller with <tt>-c</tt>, or grep routes
-  # using <tt>-g</tt>. Useful in conjunction with <tt>--expanded</tt>
-  # which displays routes vertically.
+  # Target a specific controller with `-c`, or grep routes using `-g`. Useful in
+  # conjunction with `--expanded` which displays routes vertically.
   module Routing
     extend ActiveSupport::Autoload
 

data/lib/action_dispatch/system_test_case.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 gem "capybara", ">= 3.26"
 
 require "capybara/dsl"
@@ -12,103 +14,103 @@ require "action_dispatch/system_testing/test_helpers/screenshot_helper"
 require "action_dispatch/system_testing/test_helpers/setup_and_teardown"
 
 module ActionDispatch
-  # = System Testing
+  # # System Testing
   #
-  # System tests let you test applications in the browser. Because system
-  # tests use a real browser experience, you can test all of your JavaScript
-  # easily from your test suite.
+  # System tests let you test applications in the browser. Because system tests
+  # use a real browser experience, you can test all of your JavaScript easily from
+  # your test suite.
   #
-  # To create a system test in your application, extend your test class
-  # from <tt>ApplicationSystemTestCase</tt>. System tests use Capybara as a
-  # base and allow you to configure the settings through your
-  # <tt>application_system_test_case.rb</tt> file that is generated with a new
-  # application or scaffold.
+  # To create a system test in your application, extend your test class from
+  # `ApplicationSystemTestCase`. System tests use Capybara as a base and allow you
+  # to configure the settings through your `application_system_test_case.rb` file
+  # that is generated with a new application or scaffold.
   #
   # Here is an example system test:
   #
-  #   require "application_system_test_case"
+  #     require "application_system_test_case"
   #
-  #   class Users::CreateTest < ApplicationSystemTestCase
-  #     test "adding a new user" do
-  #       visit users_path
-  #       click_on 'New User'
+  #     class Users::CreateTest < ApplicationSystemTestCase
+  #       test "adding a new user" do
+  #         visit users_path
+  #         click_on 'New User'
   #
-  #       fill_in 'Name', with: 'Arya'
-  #       click_on 'Create User'
+  #         fill_in 'Name', with: 'Arya'
+  #         click_on 'Create User'
   #
-  #       assert_text 'Arya'
+  #         assert_text 'Arya'
+  #       end
   #     end
-  #   end
   #
-  # When generating an application or scaffold, an +application_system_test_case.rb+
-  # file will also be generated containing the base class for system testing.
-  # This is where you can change the driver, add Capybara settings, and other
-  # configuration for your system tests.
+  # When generating an application or scaffold, an
+  # `application_system_test_case.rb` file will also be generated containing the
+  # base class for system testing. This is where you can change the driver, add
+  # Capybara settings, and other configuration for your system tests.
   #
-  #   require "test_helper"
+  #     require "test_helper"
   #
-  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  #     driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
-  #   end
+  #     class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #       driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+  #     end
   #
-  # By default, +ActionDispatch::SystemTestCase+ is driven by the
-  # Selenium driver, with the Chrome browser, and a browser size of 1400x1400.
+  # By default, `ActionDispatch::SystemTestCase` is driven by the Selenium driver,
+  # with the Chrome browser, and a browser size of 1400x1400.
   #
   # Changing the driver configuration options is easy. Let's say you want to use
-  # the Firefox browser instead of Chrome. In your +application_system_test_case.rb+
-  # file add the following:
-  #
-  #   require "test_helper"
+  # the Firefox browser instead of Chrome. In your
+  # `application_system_test_case.rb` file add the following:
   #
-  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  #     driven_by :selenium, using: :firefox
-  #   end
+  #     require "test_helper"
   #
-  # +driven_by+ has a required argument for the driver name. The keyword
-  # arguments are +:using+ for the browser and +:screen_size+ to change the
-  # size of the browser screen. These two options are not applicable for
-  # headless drivers and will be silently ignored if passed.
-  #
-  # Headless browsers such as headless Chrome and headless Firefox are also supported.
-  # You can use these browsers by setting the +:using+ argument to +:headless_chrome+ or +:headless_firefox+.
+  #     class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #       driven_by :selenium, using: :firefox
+  #     end
   #
-  # To use a headless driver, like Cuprite, update your Gemfile to use
-  # Cuprite instead of Selenium and then declare the driver name in the
-  # +application_system_test_case.rb+ file. In this case, you would leave out
-  # the +:using+ option because the driver is headless, but you can still use
-  # +:screen_size+ to change the size of the browser screen, also you can use
-  # +:options+ to pass options supported by the driver. Please refer to your
+  # `driven_by` has a required argument for the driver name. The keyword arguments
+  # are `:using` for the browser and `:screen_size` to change the size of the
+  # browser screen. These two options are not applicable for headless drivers and
+  # will be silently ignored if passed.
+  #
+  # Headless browsers such as headless Chrome and headless Firefox are also
+  # supported. You can use these browsers by setting the `:using` argument to
+  # `:headless_chrome` or `:headless_firefox`.
+  #
+  # To use a headless driver, like Cuprite, update your Gemfile to use Cuprite
+  # instead of Selenium and then declare the driver name in the
+  # `application_system_test_case.rb` file. In this case, you would leave out the
+  # `:using` option because the driver is headless, but you can still use
+  # `:screen_size` to change the size of the browser screen, also you can use
+  # `:options` to pass options supported by the driver. Please refer to your
   # driver documentation to learn about supported options.
   #
-  #   require "test_helper"
-  #   require "capybara/cuprite"
+  #     require "test_helper"
+  #     require "capybara/cuprite"
   #
-  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  #     driven_by :cuprite, screen_size: [1400, 1400], options:
-  #       { js_errors: true }
-  #   end
+  #     class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #       driven_by :cuprite, screen_size: [1400, 1400], options:
+  #         { js_errors: true }
+  #     end
   #
-  # Some drivers require browser capabilities to be passed as a block instead
-  # of through the +options+ hash.
+  # Some drivers require browser capabilities to be passed as a block instead of
+  # through the `options` hash.
   #
   # As an example, if you want to add mobile emulation on chrome, you'll have to
-  # create an instance of selenium's +Chrome::Options+ object and add
-  # capabilities with a block.
-  #
-  # The block will be passed an instance of <tt><Driver>::Options</tt> where you can
-  # define the capabilities you want. Please refer to your driver documentation
-  # to learn about supported options.
-  #
-  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  #     driven_by :selenium, using: :chrome, screen_size: [1024, 768] do |driver_option|
-  #       driver_option.add_emulation(device_name: 'iPhone 6')
-  #       driver_option.add_extension('path/to/chrome_extension.crx')
+  # create an instance of selenium's `Chrome::Options` object and add capabilities
+  # with a block.
+  #
+  # The block will be passed an instance of `<Driver>::Options` where you can
+  # define the capabilities you want. Please refer to your driver documentation to
+  # learn about supported options.
+  #
+  #     class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #       driven_by :selenium, using: :chrome, screen_size: [1024, 768] do |driver_option|
+  #         driver_option.add_emulation(device_name: 'iPhone 6')
+  #         driver_option.add_extension('path/to/chrome_extension.crx')
+  #       end
   #     end
-  #   end
   #
-  # Because +ActionDispatch::SystemTestCase+ is a shim between Capybara
-  # and \Rails, any driver that is supported by Capybara is supported by system
-  # tests as long as you include the required gems and files.
+  # Because `ActionDispatch::SystemTestCase` is a shim between Capybara and Rails,
+  # any driver that is supported by Capybara is supported by system tests as long
+  # as you include the required gems and files.
   class SystemTestCase < ActiveSupport::TestCase
     include Capybara::DSL
     include Capybara::Minitest::Assertions
@@ -137,28 +139,36 @@ module ActionDispatch
 
     # System Test configuration options
     #
-    # The default settings are Selenium, using Chrome, with a screen size
-    # of 1400x1400.
+    # The default settings are Selenium, using Chrome, with a screen size of
+    # 1400x1400.
     #
     # Examples:
     #
-    #   driven_by :cuprite
+    #     driven_by :cuprite
     #
-    #   driven_by :selenium, screen_size: [800, 800]
+    #     driven_by :selenium, screen_size: [800, 800]
     #
-    #   driven_by :selenium, using: :chrome
+    #     driven_by :selenium, using: :chrome
     #
-    #   driven_by :selenium, using: :headless_chrome
+    #     driven_by :selenium, using: :headless_chrome
     #
-    #   driven_by :selenium, using: :firefox
+    #     driven_by :selenium, using: :firefox
     #
-    #   driven_by :selenium, using: :headless_firefox
+    #     driven_by :selenium, using: :headless_firefox
     def self.driven_by(driver, using: :chrome, screen_size: [1400, 1400], options: {}, &capabilities)
       driver_options = { using: using, screen_size: screen_size, options: options }
 
       self.driver = SystemTesting::Driver.new(driver, **driver_options, &capabilities)
     end
 
+    # Configuration for the System Test application server.
+    #
+    # By default this is localhost. This method allows the host and port to be specified manually.
+    def self.served_by(host:, port:)
+      Capybara.server_host = host
+      Capybara.server_port = port
+    end
+
     private
       def url_helpers
         @url_helpers ||=
@@ -178,9 +188,9 @@ module ActionDispatch
           end
       end
 
-      def method_missing(name, *args, &block)
+      def method_missing(name, ...)
         if url_helpers.respond_to?(name)
-          url_helpers.public_send(name, *args, &block)
+          url_helpers.public_send(name, ...)
         else
           super
         end