/
where_missing.rb
108 lines (89 loc) · 3.5 KB
/
where_missing.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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# Check for the use `left_joins` and `where` method for finding missing relationship records.
#
# This cop is enabled in Rails 6.1 or higher.
#
# @example
# # bad
# Foo.left_joins(:foo).where(foos: { id: nil })
#
# # good
# Foo.where.missing(:foo)
#
class WhereMissing < Base
include RangeHelp
extend AutoCorrector
extend TargetRailsVersion
MSG = 'Use `where.missing(:%<association>s)` instead of ' \
'`%<left_joins_method>s(:%<association>s).where(%<association>ss: { id: nil })`.'
RESTRICT_ON_SEND = %i[left_joins left_outer_joins].freeze
minimum_target_rails_version 6.1
# @!method where_node_and_argument(node)
def_node_search :where_node_and_argument, <<~PATTERN
$(send ... :where (hash <(pair $(sym _) (hash (pair (sym :id) (nil))))...> ))
PATTERN
# @!method missing_relationship?(node)
def_node_search :missing_relationship?, <<~PATTERN
(pair (sym _) (hash (pair (sym :id) (nil))))
PATTERN
def on_send(node)
return unless node.first_argument.sym_type?
where_node_and_argument(node.ancestors.last) do |where_node, where_argument|
next unless same_relationship?(where_argument, node.first_argument)
range = range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
register_offense(node, where_node, range)
break
end
end
private
def same_relationship?(where, left_joins)
"#{left_joins.value}s" == where.value.to_s
end
def register_offense(node, where_node, range)
add_offense(range, message: message(node)) do |corrector|
corrector.replace(node.loc.selector, 'where.missing')
if multi_condition?(where_node.first_argument)
replace_where_method(corrector, where_node)
else
remove_where_method(corrector, node, where_node)
end
end
end
def replace_where_method(corrector, where_node)
where_node.first_argument.children.each do |child|
next unless missing_relationship?(child)
corrector.remove(replace_range(child))
end
end
def replace_range(child)
if (right_sibling = child.right_sibling)
range_between(child.loc.expression.begin_pos, right_sibling.loc.expression.begin_pos)
else
range_between(child.left_sibling.loc.expression.end_pos, child.loc.expression.end_pos)
end
end
def remove_where_method(corrector, node, where_node)
range = range_between(where_node.loc.selector.begin_pos, where_node.loc.end.end_pos)
if node.multiline? && !same_line?(node, where_node)
range = range_by_whole_lines(range, include_final_newline: true)
else
corrector.remove(where_node.loc.dot)
end
corrector.remove(range)
end
def same_line?(left_joins_node, where_node)
left_joins_node.loc.selector.line == where_node.loc.selector.line
end
def multi_condition?(where_arg)
where_arg.children.count > 1
end
def message(node)
format(MSG, association: node.first_argument.value, left_joins_method: node.method_name)
end
end
end
end
end