actionpack 7.0.8.6 → 7.1.0.beta1

data/lib/action_dispatch/routing/route_set.rb

@@ -34,20 +34,20 @@ module ActionDispatch
           if @raise_on_name_error
             raise
           else
-            [404, { "X-Cascade" => "pass" }, []]
+            [404, { Constants::X_CASCADE => "pass" }, []]
           end
         end
 
-      private
-        def controller(req)
-          req.controller_class
-        rescue NameError => e
-          raise ActionController::RoutingError, e.message, e.backtrace
-        end
+        private
+          def controller(req)
+            req.controller_class
+          rescue NameError => e
+            raise ActionController::RoutingError, e.message, e.backtrace
+          end
 
-        def dispatch(controller, action, req, res)
-          controller.dispatch(action, req, res)
-        end
+          def dispatch(controller, action, req, res)
+            controller.dispatch(action, req, res)
+          end
       end
 
       class StaticDispatcher < Dispatcher
@@ -282,7 +282,7 @@ module ActionDispatch
 
               if args.size < path_params_size
                 path_params -= controller_options.keys
-                path_params -= result.keys
+                path_params -= (result[:path_params] || {}).merge(result).keys
               else
                 path_params = path_params.dup
               end
@@ -375,6 +375,7 @@ module ActionDispatch
         @disable_clear_and_finalize = false
         @finalized                  = false
         @env_key                    = "ROUTES_#{object_id}_SCRIPT_NAME"
+        @default_env                = nil
 
         @set    = Journey::Routes.new
         @router = Journey::Router.new @set
@@ -405,6 +406,25 @@ module ActionDispatch
       end
       private :make_request
 
+      def default_env
+        if default_url_options != @default_env&.[]("action_dispatch.routes.default_url_options")
+          url_options = default_url_options.dup.freeze
+          uri = URI(ActionDispatch::Http::URL.full_url_for(host: "example.org", **url_options))
+
+          @default_env = {
+            "action_dispatch.routes" => self,
+            "action_dispatch.routes.default_url_options" => url_options,
+            "HTTPS" => uri.scheme == "https" ? "on" : "off",
+            "rack.url_scheme" => uri.scheme,
+            "HTTP_HOST" => uri.port == uri.default_port ? uri.host : "#{uri.host}:#{uri.port}",
+            "SCRIPT_NAME" => uri.path.chomp("/"),
+            "rack.input" => "",
+          }.freeze
+        end
+
+        @default_env
+      end
+
       def draw(&block)
         clear! unless @disable_clear_and_finalize
         eval_block(block)
@@ -574,6 +594,20 @@ module ActionDispatch
           end
 
           private :_generate_paths_by_default
+
+          # If the module is included more than once (for example, in a subclass
+          # of an ancestor that includes the module), ensure that the `_routes`
+          # singleton and instance methods return the desired route set by
+          # including a new copy of the module (recursively if necessary). Note
+          # that this method is called for each inclusion, whereas the above
+          # `included` block is run only for the initial inclusion of each copy.
+          def self.included(base)
+            super
+            if !base._routes.equal?(@_proxy._routes)
+              @dup_for_reinclude ||= self.dup
+              base.include @dup_for_reinclude
+            end
+          end
         end
       end
 
@@ -596,16 +630,16 @@ module ActionDispatch
         named_routes[name] = route if name
 
         if route.segment_keys.include?(:controller)
-          ActiveSupport::Deprecation.warn(<<-MSG.squish)
+          ActionDispatch.deprecator.warn(<<-MSG.squish)
             Using a dynamic :controller segment in a route is deprecated and
-            will be removed in Rails 7.1.
+            will be removed in Rails 7.2.
           MSG
         end
 
         if route.segment_keys.include?(:action)
-          ActiveSupport::Deprecation.warn(<<-MSG.squish)
+          ActionDispatch.deprecator.warn(<<-MSG.squish)
             Using a dynamic :action segment in a route is deprecated and
-            will be removed in Rails 7.1.
+            will be removed in Rails 7.2.
           MSG
         end
 
@@ -779,18 +813,14 @@ module ActionDispatch
 
       RESERVED_OPTIONS = [:host, :protocol, :port, :subdomain, :domain, :tld_length,
                           :trailing_slash, :anchor, :params, :only_path, :script_name,
-                          :original_script_name, :relative_url_root]
+                          :original_script_name]
 
       def optimize_routes_generation?
         default_url_options.empty?
       end
 
       def find_script_name(options)
-        options.delete(:script_name) || find_relative_url_root(options) || ""
-      end
-
-      def find_relative_url_root(options)
-        options.delete(:relative_url_root) || relative_url_root
+        options.delete(:script_name) || relative_url_root || ""
       end
 
       def path_for(options, route_name = nil, reserved = RESERVED_OPTIONS)
@@ -854,7 +884,7 @@ module ActionDispatch
 
       def recognize_path(path, environment = {})
         method = (environment[:method] || "GET").to_s.upcase
-        path = Journey::Router::Utils.normalize_path(path) unless %r{://}.match?(path)
+        path = Journey::Router::Utils.normalize_path(path) unless path&.include?("://")
         extras = environment[:extras] || {}
 
         begin

data/lib/action_dispatch/routing/routes_proxy.rb

@@ -29,7 +29,7 @@ module ActionDispatch
 
       def method_missing(method, *args)
         if @helpers.respond_to?(method)
-          self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          instance_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{method}(*args)
               options = args.extract_options!
               options = url_options.merge((options || {}).symbolize_keys)

data/lib/action_dispatch/routing/url_for.rb

@@ -2,6 +2,8 @@
 
 module ActionDispatch
   module Routing
+    # = Action Dispatch Routing \UrlFor
+    #
     # In <tt>config/routes.rb</tt> you define URL-to-controller mappings, but the reverse
     # is also possible: a URL can be generated from one of your routing definitions.
     # URL generation functionality is centralized in this module.
@@ -37,7 +39,7 @@ module ActionDispatch
     #   # => "/users/new?message=Welcome%21"
     #
     # Notice the <tt>only_path: true</tt> part. This is because UrlFor has no
-    # information about the website hostname that your Rails app is serving. So if you
+    # information about the website hostname that your \Rails app is serving. So if you
     # want to include the hostname as well, then you must also pass the <tt>:host</tt>
     # argument:
     #
@@ -134,6 +136,8 @@ module ActionDispatch
       # * <tt>:port</tt> - Optionally specify the port to connect to.
       # * <tt>:anchor</tt> - An anchor name to be appended to the path.
       # * <tt>:params</tt> - The query parameters to be appended to the path.
+      # * <tt>:path_params</tt> - The query parameters that will only be used
+      #   for the named dynamic segments of path. If unused, they will be discarded.
       # * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in <tt>"/archive/2009/"</tt>.
       # * <tt>:script_name</tt> - Specifies application path relative to domain root. If provided, prepends application path.
       #

data/lib/action_dispatch/routing.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/string/filters"
-
 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
@@ -240,7 +238,7 @@ module ActionDispatch
   #
   # == View a list of all your routes
   #
-  #   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>
@@ -250,7 +248,9 @@ module ActionDispatch
 
     autoload :Mapper
     autoload :RouteSet
-    autoload :RoutesProxy
+    eager_autoload do
+      autoload :RoutesProxy
+    end
     autoload :UrlFor
     autoload :PolymorphicRoutes
 

data/lib/action_dispatch/system_test_case.rb

@@ -51,7 +51,7 @@ module ActionDispatch
   #     driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
   #   end
   #
-  # By default, <tt>ActionDispatch::SystemTestCase</tt> is driven by the
+  # 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
@@ -106,8 +106,8 @@ module ActionDispatch
   #     end
   #   end
   #
-  # Because <tt>ActionDispatch::SystemTestCase</tt> is a shim between Capybara
-  # and Rails, any driver that is supported by Capybara is supported by system
+  # 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

data/lib/action_dispatch/system_testing/browser.rb

@@ -26,16 +26,15 @@ module ActionDispatch
         yield options if block_given? && options
       end
 
-      # driver_path can be configured as a proc.
-      # proc to update web drivers. Running this proc early allows us to only
-      # update the webdriver once and avoid race conditions when using
-      # parallel tests.
+      # driver_path can be configured as a proc. Running this proc early allows
+      # us to only update the webdriver once and avoid race conditions when
+      # using parallel tests.
       def preload
         case type
         when :chrome
-          ::Selenium::WebDriver::Chrome::Service.driver_path&.call
+          ::Selenium::WebDriver::Chrome::Service.driver_path.try(:call)
         when :firefox
-          ::Selenium::WebDriver::Firefox::Service.driver_path&.call
+          ::Selenium::WebDriver::Firefox::Service.driver_path.try(:call)
         end
       end
 

data/lib/action_dispatch/system_testing/driver.rb

@@ -12,14 +12,6 @@ module ActionDispatch
         @name = @options.delete(:name) || driver_type
         @capabilities = capabilities
 
-        if [:poltergeist, :webkit].include?(driver_type)
-          ActiveSupport::Deprecation.warn <<~MSG.squish
-            Poltergeist and capybara-webkit are not maintained already.
-            Driver registration of :poltergeist or :webkit is deprecated and will be removed in Rails 7.1.
-            You can still use :selenium, and also :cuprite is available for alternative to Poltergeist.
-          MSG
-        end
-
         if driver_type == :selenium
           gem "selenium-webdriver", ">= 4.0.0"
           require "selenium/webdriver"
@@ -38,7 +30,7 @@ module ActionDispatch
 
       private
         def registerable?
-          [:selenium, :poltergeist, :webkit, :cuprite, :rack_test].include?(@driver_type)
+          [:selenium, :cuprite, :rack_test, :playwright].include?(@driver_type)
         end
 
         def register
@@ -47,10 +39,9 @@ module ActionDispatch
           Capybara.register_driver name do |app|
             case @driver_type
             when :selenium then register_selenium(app)
-            when :poltergeist then register_poltergeist(app)
-            when :webkit then register_webkit(app)
             when :cuprite then register_cuprite(app)
             when :rack_test then register_rack_test(app)
+            when :playwright then register_playwright(app)
             end
           end
         end
@@ -65,16 +56,6 @@ module ActionDispatch
           end
         end
 
-        def register_poltergeist(app)
-          Capybara::Poltergeist::Driver.new(app, @options.merge(window_size: @screen_size))
-        end
-
-        def register_webkit(app)
-          Capybara::Webkit::Driver.new(app, Capybara::Webkit::Configuration.to_hash.merge(@options)).tap do |driver|
-            driver.resize_window_to(driver.current_window_handle, *@screen_size)
-          end
-        end
-
         def register_cuprite(app)
           Capybara::Cuprite::Driver.new(app, @options.merge(window_size: @screen_size))
         end
@@ -83,6 +64,17 @@ module ActionDispatch
           Capybara::RackTest::Driver.new(app, respect_data_method: true, **@options)
         end
 
+        def register_playwright(app)
+          screen = { width: @screen_size[0], height: @screen_size[1] } if @screen_size
+          options = {
+            screen: screen,
+            viewport: screen,
+            **@options
+          }.compact
+
+          Capybara::Playwright::Driver.new(app, **options)
+        end
+
         def setup
           Capybara.current_driver = name
         end

data/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb

@@ -13,28 +13,28 @@ module ActionDispatch
         # to investigate changes at different points during your test. These will be
         # named with a sequential prefix (or 'failed' for failing tests)
         #
-        # The screenshot will be displayed in your console, if supported.
-        #
         # The default screenshots directory is +tmp/screenshots+ but you can set a different
         # one with +Capybara.save_path+
         #
-        # You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT_HTML+ environment variable to
-        # save the HTML from the page that is being screenshotted so you can investigate the
-        # elements on the page at the time of the screenshot
+        # You can use the +html+ argument or set the +RAILS_SYSTEM_TESTING_SCREENSHOT_HTML+
+        # environment variable to save the HTML from the page that is being screenshotted
+        # so you can investigate the elements on the page at the time of the screenshot
         #
-        # You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT+ environment variable to
-        # control the output. Possible values are:
+        # You can use the +screenshot+ argument or set the +RAILS_SYSTEM_TESTING_SCREENSHOT+
+        # environment variable to control the output. Possible values are:
         # * [+simple+ (default)]    Only displays the screenshot path.
         #                           This is the default value.
         # * [+inline+]              Display the screenshot in the terminal using the
         #                           iTerm image protocol (https://iterm2.com/documentation-images.html).
         # * [+artifact+]            Display the screenshot in the terminal, using the terminal
         #                           artifact format (https://buildkite.github.io/terminal-to-html/inline-images/).
-        def take_screenshot
+        def take_screenshot(html: false, screenshot: nil)
+          showing_html = html || html_from_env?
+
           increment_unique
-          save_html if save_html?
+          save_html if showing_html
           save_image
-          puts display_image
+          show display_image(html: showing_html, screenshot_output: screenshot)
         end
 
         # Takes a screenshot of the current page in the browser if the test
@@ -42,13 +42,16 @@ module ActionDispatch
         #
         # +take_failed_screenshot+ is called during system test teardown.
         def take_failed_screenshot
-          take_screenshot if failed? && supports_screenshot? && Capybara::Session.instance_created?
+          return unless failed? && supports_screenshot? && Capybara::Session.instance_created?
+
+          take_screenshot
+          metadata[:failure_screenshot_path] = relative_image_path if Minitest::Runnable.method_defined?(:metadata)
         end
 
         private
           attr_accessor :_screenshot_counter
 
-          def save_html?
+          def html_from_env?
             ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] == "1"
           end
 
@@ -62,7 +65,7 @@ module ActionDispatch
           end
 
           def image_name
-            sanitized_method_name = method_name.tr("/\\", "--")
+            sanitized_method_name = method_name.gsub(/[^\w]+/, "-")
             name = "#{unique}_#{sanitized_method_name}"
             name[0...225]
           end
@@ -87,6 +90,10 @@ module ActionDispatch
             "#{absolute_path}.png"
           end
 
+          def relative_image_path
+            "#{absolute_path.relative_path_from(Rails.root)}.png"
+          end
+
           def absolute_html_path
             "#{absolute_path}.html"
           end
@@ -109,11 +116,15 @@ module ActionDispatch
             output_type
           end
 
-          def display_image
+          def show(img)
+            puts img
+          end
+
+          def display_image(html:, screenshot_output:)
             message = +"[Screenshot Image]: #{image_path}\n"
-            message << +"[Screenshot HTML]: #{html_path}\n" if save_html?
+            message << +"[Screenshot HTML]: #{html_path}\n" if html
 
-            case output_type
+            case screenshot_output || output_type
             when "artifact"
               message << "\e]1338;url=artifact://#{absolute_image_path}\a\n"
             when "inline"

data/lib/action_dispatch/testing/assertions/response.rb

@@ -30,7 +30,7 @@ module ActionDispatch
       def assert_response(type, message = nil)
         message ||= generate_response_message(type)
 
-        if RESPONSE_PREDICATES.keys.include?(type)
+        if RESPONSE_PREDICATES.key?(type)
           assert @response.public_send(RESPONSE_PREDICATES[type]), message
         else
           assert_equal AssertionResponse.new(type).code, @response.response_code, message
@@ -50,12 +50,19 @@ module ActionDispatch
       #
       #   # Asserts that the redirection matches the regular expression
       #   assert_redirected_to %r(\Ahttp://example.org)
-      def assert_redirected_to(options = {}, message = nil)
-        assert_response(:redirect, message)
-        return true if options === @response.location
+      #
+      #   # Asserts that the redirection has the HTTP status code 301 (Moved
+      #   # Permanently).
+      #   assert_redirected_to "/some/path", status: :moved_permanently
+      def assert_redirected_to(url_options = {}, options = {}, message = nil)
+        options, message = {}, options unless options.is_a?(Hash)
+
+        status = options[:status] || :redirect
+        assert_response(status, message)
+        return true if url_options === @response.location
 
         redirect_is       = normalize_argument_to_redirection(@response.location)
-        redirect_expected = normalize_argument_to_redirection(options)
+        redirect_expected = normalize_argument_to_redirection(url_options)
 
         message ||= "Expected response to be a redirect to <#{redirect_expected}> but was a redirect to <#{redirect_is}>"
         assert_operator redirect_expected, :===, redirect_is, message
@@ -93,7 +100,7 @@ module ActionDispatch
         end
 
         def code_with_name(code_or_name)
-          if RESPONSE_PREDICATES.values.include?("#{code_or_name}?".to_sym)
+          if RESPONSE_PREDICATES.value?("#{code_or_name}?".to_sym)
             code_or_name = RESPONSE_PREDICATES.invert["#{code_or_name}?".to_sym]
           end
 

data/lib/action_dispatch/testing/assertions/routing.rb

@@ -9,6 +9,36 @@ module ActionDispatch
   module Assertions
     # Suite of assertions to test routes generated by \Rails and the handling of requests made to them.
     module RoutingAssertions
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # A helper to make it easier to test different route configurations.
+        # This method temporarily replaces @routes with a new RouteSet instance
+        # before each test.
+        #
+        # The new instance is yielded to the passed block. Typically the block
+        # will create some routes using <tt>set.draw { match ... }</tt>:
+        #
+        #   with_routing do |set|
+        #     set.draw do
+        #       resources :users
+        #     end
+        #   end
+        #
+        def with_routing(&block)
+          old_routes, old_controller = nil
+
+          setup do
+            old_routes, old_controller = @routes, @controller
+            create_routes(&block)
+          end
+
+          teardown do
+            reset_routes(old_routes, old_controller)
+          end
+        end
+      end
+
       def setup # :nodoc:
         @routes ||= nil
         super
@@ -83,7 +113,7 @@ module ActionDispatch
       #   # Asserts that the generated route gives us our custom route
       #   assert_generates "changesets/12", { controller: 'scm', action: 'show_diff', revision: "12" }
       def assert_generates(expected_path, options, defaults = {}, extras = {}, message = nil)
-        if %r{://}.match?(expected_path)
+        if expected_path.include?("://")
           fail_on(URI::InvalidURIError, message) do
             uri = URI.parse(expected_path)
             expected_path = uri.path.to_s.empty? ? "/" : uri.path
@@ -150,33 +180,11 @@ module ActionDispatch
       #     assert_equal "/users", users_path
       #   end
       #
-      def with_routing
-        old_routes, @routes = @routes, ActionDispatch::Routing::RouteSet.new
-        if defined?(@controller) && @controller
-          old_controller, @controller = @controller, @controller.clone
-          _routes = @routes
-
-          @controller.singleton_class.include(_routes.url_helpers)
-
-          if @controller.respond_to? :view_context_class
-            view_context_class = Class.new(@controller.view_context_class) do
-              include _routes.url_helpers
-            end
-
-            custom_view_context = Module.new {
-              define_method(:view_context_class) do
-                view_context_class
-              end
-            }
-            @controller.extend(custom_view_context)
-          end
-        end
-        yield @routes
+      def with_routing(&block)
+        old_routes, old_controller = @routes, @controller
+        create_routes(&block)
       ensure
-        @routes = old_routes
-        if defined?(@controller) && @controller
-          @controller = old_controller
-        end
+        reset_routes(old_routes, old_controller)
       end
 
       # ROUTES TODO: These assertions should really work in an integration context
@@ -190,6 +198,37 @@ module ActionDispatch
       ruby2_keywords(:method_missing)
 
       private
+        def create_routes
+          @routes = ActionDispatch::Routing::RouteSet.new
+          if defined?(@controller) && @controller
+            @controller = @controller.clone
+            _routes = @routes
+
+            @controller.singleton_class.include(_routes.url_helpers)
+
+            if @controller.respond_to? :view_context_class
+              view_context_class = Class.new(@controller.view_context_class) do
+                include _routes.url_helpers
+              end
+
+              custom_view_context = Module.new {
+                define_method(:view_context_class) do
+                  view_context_class
+                end
+              }
+              @controller.extend(custom_view_context)
+            end
+          end
+          yield @routes
+        end
+
+        def reset_routes(old_routes, old_controller)
+          @routes = old_routes
+          if defined?(@controller) && @controller
+            @controller = old_controller
+          end
+        end
+
         # Recognizes the route for a given path.
         def recognized_request_for(path, extras = {}, msg)
           if path.is_a?(Hash)
@@ -202,7 +241,7 @@ module ActionDispatch
           controller = @controller if defined?(@controller)
           request = ActionController::TestRequest.create controller&.class
 
-          if %r{://}.match?(path)
+          if path.include?("://")
             fail_on(URI::InvalidURIError, msg) do
               uri = URI.parse(path)
               request.env["rack.url_scheme"] = uri.scheme || "http"

data/lib/action_dispatch/testing/assertions.rb

@@ -6,6 +6,8 @@ require "action_dispatch/testing/assertions/routing"
 
 module ActionDispatch
   module Assertions
+    extend ActiveSupport::Concern
+
     include ResponseAssertions
     include RoutingAssertions
     include Rails::Dom::Testing::Assertions
@@ -14,7 +16,7 @@ module ActionDispatch
       @html_document ||= if @response.media_type&.end_with?("xml")
         Nokogiri::XML::Document.parse(@response.body)
       else
-        Nokogiri::HTML::Document.parse(@response.body)
+        Rails::Dom::Testing.html_document.parse(@response.body)
       end
     end
   end