Add new cop Grape/RouteParamGrouping

Author: kakubin

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+### New Features
+
+* New cop `Grape/RouteParamGrouping` detects route parameter defined on endpoint ([@kakubin][])
+
 ## [0.4.2] - 2024-04-05
 
 ### Changes

config/default.yml

@@ -19,6 +19,9 @@ Grape/FieldName:
     - snake_case
     - camelCase
 
+Grape/RouteParamGrouping:
+  Enabled: true
+
 Grape/RouteParamType:
   Enabled: true
   Safe: false

lib/rubocop/cop/grape/route_param_grouping.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      #
+      # @example
+      #
+      #   # bad
+      #   get ':id' do
+      #   end
+      #
+      #   # good
+      #   route_param :id, type: Integer do
+      #     get do
+      #     end
+      #   end
+      #
+      class RouteParamGrouping < Base
+        include EndpointHelper
+
+        MSG = 'Use route_param for route parameter'
+
+        def on_block(node)
+          return unless (method_send_node = http_method_node?(node))
+          return unless (first_argument_node = method_send_node.arguments.first)
+          return unless first_argument_node.value.match?(/:\w/)
+
+          add_offense(first_argument_node)
+        end
+      end
+    end
+  end
+end

lib/rubocop/cop/grape_cops.rb

@@ -7,4 +7,5 @@
 require_relative 'grape/ivar'
 require_relative 'grape/params_position'
 require_relative 'grape/present_with'
+require_relative 'grape/route_param_grouping'
 require_relative 'grape/route_param_type'

lib/rubocop/cop/mixin/endpoint_helper.rb

@@ -7,7 +7,7 @@ module EndpointHelper
       extend NodePattern::Macros
 
       def_node_matcher :http_method_node?, <<~PATTERN
-        (block (send _ {:get :post :put :patch :delete} ...) ...)
+        (block $(send _ {:get :post :put :patch :delete} ...) ...)
       PATTERN
 
       def_node_matcher :params_node?, <<~PATTERN

spec/rubocop/cop/grape/route_param_grouping.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Grape::RouteParamGrouping, :config do
+  it 'no offense reported' do
+    expect_no_offenses(<<~RUBY)
+      route_param :id, type: Integer do
+        get do
+        end
+      end
+    RUBY
+  end
+
+  context 'without other options' do
+    it 'offense detected' do
+      expect_offense(<<~RUBY)
+        get ':id' do
+            ^^^^^ Use route_param for route parameters
+        end
+      RUBY
+    end
+  end
+
+  context 'with other options' do
+    it 'offense detected' do
+      expect_offense(<<~RUBY)
+        get ':id', requirements: { id: /[0-9]*/ }  do
+            ^^^^^ Use route_param for route parameters
+        end
+      RUBY
+    end
+  end
+
+  context 'ss' do
+    it 'offense detected' do
+      expect_offense(<<~RUBY)
+        get 'books/:id' do
+            ^^^^^^^^^^^ Use route_param for route parameters
+        end
+      RUBY
+    end
+  end
+end