/
order_field.rb
62 lines (55 loc) · 1.41 KB
/
order_field.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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# frozen_string_literal: true
module RuboCop
module Cop
module Sevencop
# Identifies a String including "field" is passed to `order` or `reorder`.
#
# @safety
# This cop is unsafe because it can register a false positive.
#
# @example
#
# # bad
# articles.order('field(id, ?)', a)
#
# # good
# articles.order(Arel.sql('field(id, ?)'), a)
#
# # bad
# reorder('field(id, ?)', a)
#
# # good
# reorder(Arel.sql('field(id, ?)'), a)
#
class OrderField < Base
extend AutoCorrector
MSG = 'Wrap safe SQL String by `Arel.sql`.'
RESTRICT_ON_SEND = %i[
order
reorder
].freeze
ORDER_METHOD_NAMES = ::Set[
*RESTRICT_ON_SEND
]
def_node_matcher :order_with_field?, <<~PATTERN
(send
_ ORDER_METHOD_NAMES
(str /field\(.+\)/)
...
)
PATTERN
# @param [RuboCop::AST::SendNode] node
def on_send(node)
return unless order_with_field?(node)
first_argument_node = node.arguments.first
add_offense(first_argument_node) do |corrector|
corrector.replace(
node.arguments.first,
"Arel.sql(#{first_argument_node.source})"
)
end
end
end
end
end
end