rubocop/cop/put_group_routes_under_scope.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

# frozen_string_literal: true

module RuboCop
  module Cop
    # Checks for a group routes outside '/-/' scope.
    # For more information see: https://gitlab.com/gitlab-org/gitlab/issues/29572
    class PutGroupRoutesUnderScope < RuboCop::Cop::Cop
      MSG = 'Put new group routes under /-/ scope'

      def_node_matcher :dash_scope?, <<~PATTERN
        (:send nil? :scope (hash <(pair (sym :path)(str "groups/*group_id/-")) ...>))
      PATTERN

      def on_send(node)
        return unless in_group_routes?(node)
        return unless resource?(node)
        return unless outside_scope?(node)

        add_offense(node)
      end

      def outside_scope?(node)
        node.each_ancestor(:block).none? do |parent|
          dash_scope?(parent.to_a.first)
        end
      end

      def in_group_routes?(node)
        path = node.location.expression.source_buffer.name
        dirname = File.dirname(path)
        filename = File.basename(path)

        dirname.end_with?('config/routes') &&
          filename.end_with?('group.rb')
      end

      def resource?(node)
        node.method_name == :resource ||
          node.method_name == :resources
      end
    end
  end
end