blob: 2ff2ed47a2314da5a616e66af9990e3bed3e876e (
plain)
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# frozen_string_literal: true
module RuboCop
module Cop
module UsageData
# This cop checks that metric instrumentation classes subclass one of the allowed base classes.
#
# @example
#
# # good
# class CountIssues < DatabaseMetric
# # ...
# end
#
# # bad
# class CountIssues < BaseMetric
# # ...
# end
class InstrumentationSuperclass < RuboCop::Cop::Cop
MSG = "Instrumentation classes should subclass one of the following: %{allowed_classes}."
BASE_PATTERN = "(const nil? !#allowed_class?)"
def_node_matcher :class_definition, <<~PATTERN
(class (const _ !#allowed_class?) #{BASE_PATTERN} ...)
PATTERN
def_node_matcher :class_new_definition, <<~PATTERN
[!^(casgn {nil? cbase} #allowed_class? ...)
!^^(casgn {nil? cbase} #allowed_class? (block ...))
(send (const {nil? cbase} :Class) :new #{BASE_PATTERN})]
PATTERN
def on_class(node)
class_definition(node) do
register_offense(node.children[1])
end
end
def on_send(node)
class_new_definition(node) do
register_offense(node.children.last)
end
end
private
def allowed_class?(class_name)
allowed_classes.include?(class_name)
end
def allowed_classes
cop_config['AllowedClasses'] || []
end
def register_offense(offense_node)
message = format(MSG, allowed_classes: allowed_classes.join(', '))
add_offense(offense_node, message: message)
end
end
end
end
end
|
