Add TestHelpers#vc_test_request (#1678)

In #1661, I renamed several private TestHelper methods to indicate that they should not be used by consumers.

However, we depended on the request method in the GitHub.com test suite. I've chosen to reintroduce this method with a new name, as we originally made it private due to it conflicting with folks setting a request method name in tests.

Author: joelhawksley

docs/CHANGELOG.md

@@ -10,6 +10,10 @@ nav_order: 5
 
 ## main
 
+* Add `TestHelpers#vc_test_request`.
+
+    *Joel Hawksley*
+
 ## v3.0.0.rc3
 
 Run into an issue with this release candidate? [Let us know](https://github.com/ViewComponent/view_component/issues/1629).

lib/view_component/test_helpers.rb

@@ -157,23 +157,23 @@ def with_controller_class(klass)
     #
     # @param path [String] The path to set for the current request.
     def with_request_url(path)
-      old_request_path_info = __vc_test_helpers_request.path_info
-      old_request_path_parameters = __vc_test_helpers_request.path_parameters
-      old_request_query_parameters = __vc_test_helpers_request.query_parameters
-      old_request_query_string = __vc_test_helpers_request.query_string
+      old_request_path_info = vc_test_request.path_info
+      old_request_path_parameters = vc_test_request.path_parameters
+      old_request_query_parameters = vc_test_request.query_parameters
+      old_request_query_string = vc_test_request.query_string
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
       path, query = path.split("?", 2)
-      __vc_test_helpers_request.path_info = path
-      __vc_test_helpers_request.path_parameters = Rails.application.routes.recognize_path_with_request(__vc_test_helpers_request, path, {})
-      __vc_test_helpers_request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
-      __vc_test_helpers_request.set_header(Rack::QUERY_STRING, query)
+      vc_test_request.path_info = path
+      vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
+      vc_test_request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
+      vc_test_request.set_header(Rack::QUERY_STRING, query)
       yield
     ensure
-      __vc_test_helpers_request.path_info = old_request_path_info
-      __vc_test_helpers_request.path_parameters = old_request_path_parameters
-      __vc_test_helpers_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
-      __vc_test_helpers_request.set_header(Rack::QUERY_STRING, old_request_query_string)
+      vc_test_request.path_info = old_request_path_info
+      vc_test_request.path_parameters = old_request_path_parameters
+      vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
+      vc_test_request.set_header(Rack::QUERY_STRING, old_request_query_string)
       @vc_test_controller = old_controller
     end
 
@@ -192,20 +192,31 @@ def vc_test_controller
       @vc_test_controller ||= __vc_test_helpers_build_controller(Base.test_controller.constantize)
     end
 
-    # Note: We prefix private methods here to prevent collisions in consumer's tests.
-    private
-
-    def __vc_test_helpers_request
-      @__vc_test_helpers_request ||=
+    # Access the request used by `render_inline`:
+    #
+    # ```ruby
+    # test "component does not render in Firefox" do
+    #   request.env["HTTP_USER_AGENT"] = "Mozilla/5.0"
+    #   render_inline(NoFirefoxComponent.new)
+    #   refute_component_rendered
+    # end
+    # ```
+    #
+    # @return [ActionDispatch::TestRequest]
+    def vc_test_request
+      @vc_test_request ||=
         begin
           out = ActionDispatch::TestRequest.create
           out.session = ActionController::TestSession.new
           out
         end
     end
 
+    # Note: We prefix private methods here to prevent collisions in consumer's tests.
+    private
+
     def __vc_test_helpers_build_controller(klass)
-      klass.new.tap { |c| c.request = __vc_test_helpers_request }.extend(Rails.application.routes.url_helpers)
+      klass.new.tap { |c| c.request = vc_test_request }.extend(Rails.application.routes.url_helpers)
     end
 
     def __vc_test_helpers_preview_class

test/sandbox/test/rendering_test.rb

@@ -841,7 +841,7 @@ def test_with_request_url
     end
 
     with_request_url "/products" do
-      assert_equal "/products", __vc_test_helpers_request.path
+      assert_equal "/products", vc_test_request.path
     end
   end
 
@@ -862,13 +862,13 @@ def test_with_request_url_with_query_parameters
     end
 
     with_request_url "/products?mykey=myvalue&otherkey=othervalue" do
-      assert_equal "/products", __vc_test_helpers_request.path
-      assert_equal "mykey=myvalue&otherkey=othervalue", __vc_test_helpers_request.query_string
-      assert_equal "/products?mykey=myvalue&otherkey=othervalue", __vc_test_helpers_request.fullpath
+      assert_equal "/products", vc_test_request.path
+      assert_equal "mykey=myvalue&otherkey=othervalue", vc_test_request.query_string
+      assert_equal "/products?mykey=myvalue&otherkey=othervalue", vc_test_request.fullpath
     end
 
     with_request_url "/products?mykey[mynestedkey]=myvalue" do
-      assert_equal({"mynestedkey" => "myvalue"}, __vc_test_helpers_request.parameters["mykey"])
+      assert_equal({"mynestedkey" => "myvalue"}, vc_test_request.parameters["mykey"])
     end
   end
 

test/sandbox/test/test_helper_test.rb

@@ -23,7 +23,7 @@ def test_with_request_url_under_constraint
     warden = Minitest::Mock.new
     warden.expect(:authenticate!, true)
 
-    __vc_test_helpers_request.env["warden"] = warden
+    vc_test_request.env["warden"] = warden
 
     with_request_url "/constraints_with_env" do
       render_inline(ControllerInlineComponent.new(message: "request.env is valid"))