Merge pull request rails#48407 from andrewn617/create_class_level_with_routing_helper

Create a class level #with_routing helper

Author: rafaelfranca

actionpack/CHANGELOG.md

@@ -1,3 +1,27 @@
+*   The `with_routing` helper can now be called at the class level. When called at the class level, the routes will
+    be setup before each test, and reset after every test. For example:
+
+    ```ruby
+    class RoutingTest < ActionController::TestCase
+      with_routing do |routes|
+        routes.draw do
+          resources :articles
+          resources :authors
+        end
+      end
+
+      def test_articles_route
+        assert_routing("/articles", controller: "articles", action: "index")
+      end
+
+       def test_authors_route
+        assert_routing("/authors", controller: "authors", action: "index")
+      end
+    end
+    ```
+
+    *Andrew Novoselac*
+
 *   The `Mime::Type` now supports handling types with parameters and correctly handles quotes.
     When parsing the accept header, the parameters before the q-parameter are kept and if a matching mime-type exists it is used.
     To keep the current functionality, a fallback is created to look for the media-type without the parameters.

actionpack/lib/action_dispatch/testing/assertions.rb

@@ -6,6 +6,8 @@
 
 module ActionDispatch
   module Assertions
+    extend ActiveSupport::Concern
+
     include ResponseAssertions
     include RoutingAssertions
     include Rails::Dom::Testing::Assertions

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

@@ -9,6 +9,37 @@ 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
+
+      class_methods do
+        # 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
+        #     assert_equal "/users", users_path
+        #   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
@@ -150,33 +181,11 @@ def assert_routing(path, options, defaults = {}, extras = {}, message = nil)
       #     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 +199,37 @@ def method_missing(selector, *args, &block)
       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)

actionpack/test/dispatch/routing_assertions_test.rb

@@ -223,4 +223,46 @@ def test_with_routing
       end
     end
   end
+
+  class WithRoutingTest < ActionController::TestCase
+    def before_setup
+      @routes = ActionDispatch::Routing::RouteSet.new
+      @routes.draw do
+        resources :articles
+      end
+
+      super
+    end
+
+    with_routing do |routes|
+      routes.draw do
+        resources :articles, path: "artikel"
+      end
+    end
+
+    def test_with_routing_for_the_entire_test_file
+      assert_routing("/artikel", controller: "articles", action: "index")
+      assert_raise(Assertion) do
+        assert_routing("/articles", controller: "articles", action: "index")
+      end
+    end
+
+    def test_with_routing_for_entire_test_file_can_be_overwritten_for_individual_test
+      with_routing do |routes|
+        routes.draw do
+          resources :articles, path: "articolo"
+        end
+
+        assert_routing("/articolo", controller: "articles", action: "index")
+        assert_raise(Assertion) do
+          assert_routing("/artikel", controller: "articles", action: "index")
+        end
+      end
+
+      assert_routing("/artikel", controller: "articles", action: "index")
+      assert_raise(Assertion) do
+        assert_routing("/articolo", controller: "articles", action: "index")
+      end
+    end
+  end
 end