blob: 0b3de9d78639fd8fc80bc922f68525a639539768 (
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# frozen_string_literal: true
module RuboCop
module Cop
module Gitlab
# Prefer using `.strong_memoize_attr()` over `#strong_memoize()`. See
# https://docs.gitlab.com/ee/development/utilities.html/#strongmemoize.
#
# Good:
#
# def memoized_method
# 'This is a memoized method'
# end
# strong_memoize_attr :memoized_method
#
# Bad, can be autocorrected:
#
# def memoized_method
# strong_memoize(:memoized_method) do
# 'This is a memoized method'
# end
# end
#
# Very bad, can't be autocorrected:
#
# def memoized_method
# return unless enabled?
#
# strong_memoize(:memoized_method) do
# 'This is a memoized method'
# end
# end
#
class StrongMemoizeAttr < RuboCop::Cop::Base
extend RuboCop::Cop::AutoCorrector
MSG = 'Use `strong_memoize_attr`, instead of using `strong_memoize` directly.'
def_node_matcher :strong_memoize?, <<~PATTERN
(block
$(send nil? :strong_memoize
(sym _)
)
(args)
$_
)
PATTERN
def on_block(node)
send_node, body = strong_memoize?(node)
return unless send_node
# Don't flag methods with parameters.
return if send_node.each_ancestor(:def).first&.arguments&.any?
# Don't flag singleton methods.
return if send_node.each_ancestor(:defs).any?
corrector = autocorrect_pure_definitions(node.parent, body) if node.parent.def_type?
add_offense(send_node, &corrector)
end
private
def autocorrect_pure_definitions(def_node, body)
proc do |corrector|
method_name = def_node.method_name
replacement = "\n#{indent(def_node)}strong_memoize_attr :#{method_name}"
corrector.insert_after(def_node, replacement)
corrector.replace(def_node.body, body.source)
end
end
end
end
end
end
|
