Merge branch 'dz-improve-route-cop' into 'master'

Improve routing cop

See merge request gitlab-org/gitlab!40976

config/routes/group.rb

@@ -23,9 +23,7 @@ constraints(::Constraints::GroupUrlConstrainer.new) do
       get 'archived', action: :show, as: :group_archived # rubocop:disable Cop/PutGroupRoutesUnderScope
     end
 
-    # These routes are legit and the cop rule will be improved in
-    # https://gitlab.com/gitlab-org/gitlab/-/issues/230703
-    get '/', action: :show, as: :group_canonical # rubocop:disable Cop/PutGroupRoutesUnderScope
+    get '/', action: :show, as: :group_canonical
   end
 
   scope(path: 'groups/*group_id/-',
@@ -112,11 +110,9 @@ constraints(::Constraints::GroupUrlConstrainer.new) do
         as: :group,
         constraints: { id: Gitlab::PathRegex.full_namespace_route_regex, format: /(html|json|atom)/ },
         controller: :groups) do
-    # These routes are legit and the cop rule will be improved in
-    # https://gitlab.com/gitlab-org/gitlab/-/issues/230703
-    get '/', action: :show # rubocop:disable Cop/PutGroupRoutesUnderScope
-    patch '/', action: :update # rubocop:disable Cop/PutGroupRoutesUnderScope
-    put '/', action: :update # rubocop:disable Cop/PutGroupRoutesUnderScope
-    delete '/', action: :destroy # rubocop:disable Cop/PutGroupRoutesUnderScope
+    get '/', action: :show
+    patch '/', action: :update
+    put '/', action: :update
+    delete '/', action: :destroy
   end
 end

rubocop/routes_under_scope.rb

@@ -12,6 +12,7 @@ module RuboCop
     def on_send(node)
       return unless route_method?(node)
       return unless outside_scope?(node)
+      return if root_route?(node)
 
       add_offense(node)
     end
@@ -25,5 +26,13 @@ module RuboCop
     def route_method?(node)
       ROUTE_METHODS.include?(node.method_name)
     end
+
+    def root_route?(node)
+      first_argument = node.arguments.first
+
+      if first_argument.respond_to?(:value)
+        first_argument.value == '/'
+      end
+    end
   end
 end

spec/rubocop/cop/put_group_routes_under_scope_spec.rb

@@ -46,4 +46,18 @@ RSpec.describe RuboCop::Cop::PutGroupRoutesUnderScope, type: :rubocop do
       end
     PATTERN
   end
+
+  it 'does not register an offense for the root route' do
+    expect_no_offenses(<<~PATTERN)
+      get '/'
+    PATTERN
+  end
+
+  it 'does not register an offense for the root route within scope' do
+    expect_no_offenses(<<~PATTERN)
+      scope(path: 'groups/*group_id/-', module: :groups) do
+        get '/'
+      end
+    PATTERN
+  end
 end

spec/rubocop/cop/put_project_routes_under_scope_spec.rb

@@ -46,4 +46,18 @@ RSpec.describe RuboCop::Cop::PutProjectRoutesUnderScope, type: :rubocop do
       end
     PATTERN
   end
+
+  it 'does not register an offense for the root route' do
+    expect_no_offenses(<<~PATTERN)
+      get '/'
+    PATTERN
+  end
+
+  it 'does not register an offense for the root route within scope' do
+    expect_no_offenses(<<~PATTERN)
+      scope '-' do
+        get '/'
+      end
+    PATTERN
+  end
 end