File: default_scope.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (24 lines) | stat: -rw-r--r-- 621 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# frozen_string_literal: true

module RuboCop
  module Cop
    # Cop that denylists the use of `default_scope`.
    class DefaultScope < RuboCop::Cop::Base
      MSG = <<~EOF
        Do not use `default_scope`, as it does not follow the principle of
        least surprise. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33847
        for more details.
      EOF

      def_node_matcher :default_scope?, <<~PATTERN
        (send {nil? (const nil? ...)} :default_scope ...)
      PATTERN

      def on_send(node)
        return unless default_scope?(node)

        add_offense(node)
      end
    end
  end
end