Merge pull request rails#54163 from jagthedrummer/jeremy/resource-route-verbosity-fix

[Fix rails#54134] Add resource name to the `ArgumentError` that's raised when invalid `:only` or `:except` options are given to `#resource` or `#resources`

Author: rafaelfranca

actionpack/CHANGELOG.md

@@ -1,3 +1,19 @@
+*   Add resource name to the `ArgumentError` that's raised when invalid `:only` or `:except` options are given to `#resource` or `#resources`
+
+    This makes it easier to locate the source of the problem, especially for routes drawn by gems.
+
+    Before:
+    ```
+    :only and :except must include only [:index, :create, :new, :show, :update, :destroy, :edit], but also included [:foo, :bar]
+    ```
+
+    After:
+    ```
+    Route `resources :products` - :only and :except must include only [:index, :create, :new, :show, :update, :destroy, :edit], but also included [:foo, :bar]
+    ```
+
+    *Jeremy Green*
+
 *   Add `check_collisions` option to `ActionDispatch::Session::CacheStore`.
 
     Newly generated session ids use 128 bits of randomness, which is more than

actionpack/lib/action_dispatch/routing/mapper.rb

@@ -1328,7 +1328,8 @@ def initialize(entities, api_only, shallow, only: nil, except: nil, **options)
 
             valid_actions = self.class.default_actions(false) # ignore api_only for this validation
             if (invalid_actions = invalid_only_except_options(valid_actions, only:, except:).presence)
-              raise ArgumentError, ":only and :except must include only #{valid_actions}, but also included #{invalid_actions}"
+              error_prefix = "Route `resource#{"s" unless singleton?} :#{entities}`"
+              raise ArgumentError, "#{error_prefix} - :only and :except must include only #{valid_actions}, but also included #{invalid_actions}"
             end
 
             @name       = entities.to_s

actionpack/test/controller/resources_test.rb

@@ -1131,7 +1131,7 @@ def test_singleton_resource_name_is_not_singularized
   end
 
   def test_invalid_only_option_for_resources
-    expected_message = ":only and :except must include only [:index, :create, :new, :show, :update, :destroy, :edit], but also included [:foo, :bar]"
+    expected_message = "Route `resources :products` - :only and :except must include only [:index, :create, :new, :show, :update, :destroy, :edit], but also included [:foo, :bar]"
     assert_raise(ArgumentError, match: expected_message) do
       with_routing do |set|
         set.draw do
@@ -1142,7 +1142,7 @@ def test_invalid_only_option_for_resources
   end
 
   def test_invalid_only_option_for_singleton_resource
-    expected_message = ":only and :except must include only [:show, :create, :update, :destroy, :new, :edit], but also included [:foo, :bar]"
+    expected_message = "Route `resource :products` - :only and :except must include only [:show, :create, :update, :destroy, :new, :edit], but also included [:foo, :bar]"
     assert_raise(ArgumentError, match: expected_message) do
       with_routing do |set|
         set.draw do
@@ -1153,7 +1153,7 @@ def test_invalid_only_option_for_singleton_resource
   end
 
   def test_invalid_except_option_for_resources
-    expected_message = ":only and :except must include only [:index, :create, :new, :show, :update, :destroy, :edit], but also included [:foo]"
+    expected_message = "Route `resources :products` - :only and :except must include only [:index, :create, :new, :show, :update, :destroy, :edit], but also included [:foo]"
 
     assert_raise(ArgumentError, match: expected_message) do
       with_routing do |set|
@@ -1165,7 +1165,7 @@ def test_invalid_except_option_for_resources
   end
 
   def test_invalid_except_option_for_singleton_resource
-    expected_message = ":only and :except must include only [:show, :create, :update, :destroy, :new, :edit], but also included [:foo]"
+    expected_message = "Route `resource :products` - :only and :except must include only [:show, :create, :update, :destroy, :new, :edit], but also included [:foo]"
     assert_raise(ArgumentError, match: expected_message) do
       with_routing do |set|
         set.draw do