/
redundant_sort.rb
165 lines (146 loc) · 4.59 KB
/
redundant_sort.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop is used to identify instances of sorting and then
# taking only the first or last element. The same behavior can
# be accomplished without a relatively expensive sort by using
# `Enumerable#min` instead of sorting and taking the first
# element and `Enumerable#max` instead of sorting and taking the
# last element. Similarly, `Enumerable#min_by` and
# `Enumerable#max_by` can replace `Enumerable#sort_by` calls
# after which only the first or last element is used.
#
# @example
# # bad
# [2, 1, 3].sort.first
# [2, 1, 3].sort[0]
# [2, 1, 3].sort.at(0)
# [2, 1, 3].sort.slice(0)
#
# # good
# [2, 1, 3].min
#
# # bad
# [2, 1, 3].sort.last
# [2, 1, 3].sort[-1]
# [2, 1, 3].sort.at(-1)
# [2, 1, 3].sort.slice(-1)
#
# # good
# [2, 1, 3].max
#
# # bad
# arr.sort_by(&:foo).first
# arr.sort_by(&:foo)[0]
# arr.sort_by(&:foo).at(0)
# arr.sort_by(&:foo).slice(0)
#
# # good
# arr.min_by(&:foo)
#
# # bad
# arr.sort_by(&:foo).last
# arr.sort_by(&:foo)[-1]
# arr.sort_by(&:foo).at(-1)
# arr.sort_by(&:foo).slice(-1)
#
# # good
# arr.max_by(&:foo)
#
class RedundantSort < Cop
include RangeHelp
MSG = 'Use `%<suggestion>s` instead of '\
'`%<sorter>s...%<accessor_source>s`.'
def_node_matcher :redundant_sort?, <<~MATCHER
{
(send $(send _ $:sort ...) ${:last :first})
(send $(send _ $:sort ...) ${:[] :at :slice} {(int 0) (int -1)})
(send $(send _ $:sort_by _) ${:last :first})
(send $(send _ $:sort_by _) ${:[] :at :slice} {(int 0) (int -1)})
(send (block $(send _ ${:sort_by :sort}) ...) ${:last :first})
(send
(block $(send _ ${:sort_by :sort}) ...)
${:[] :at :slice} {(int 0) (int -1)}
)
}
MATCHER
def on_send(node)
redundant_sort?(node) do |sort_node, sorter, accessor|
range = range_between(
sort_node.loc.selector.begin_pos,
node.loc.expression.end_pos
)
add_offense(node,
location: range,
message: message(node,
sorter,
accessor))
end
end
def autocorrect(node)
sort_node, sorter, accessor = redundant_sort?(node)
lambda do |corrector|
# Remove accessor, e.g. `first` or `[-1]`.
corrector.remove(
range_between(
accessor_start(node),
node.loc.expression.end_pos
)
)
# Replace "sort" or "sort_by" with the appropriate min/max method.
corrector.replace(
sort_node.loc.selector,
suggestion(sorter, accessor, arg_value(node))
)
end
end
private
def message(node, sorter, accessor)
accessor_source = range_between(
node.loc.selector.begin_pos,
node.loc.expression.end_pos
).source
format(MSG,
suggestion: suggestion(sorter,
accessor,
arg_value(node)),
sorter: sorter,
accessor_source: accessor_source)
end
def suggestion(sorter, accessor, arg)
base(accessor, arg) + suffix(sorter)
end
def base(accessor, arg)
if accessor == :first || arg&.zero?
'min'
elsif accessor == :last || arg == -1
'max'
end
end
def suffix(sorter)
if sorter == :sort
''
elsif sorter == :sort_by
'_by'
end
end
def arg_node(node)
node.arguments.first
end
def arg_value(node)
arg_node(node).nil? ? nil : arg_node(node).node_parts.first
end
# This gets the start of the accessor whether it has a dot
# (e.g. `.first`) or doesn't (e.g. `[0]`)
def accessor_start(node)
if node.loc.dot
node.loc.dot.begin_pos
else
node.loc.selector.begin_pos
end
end
end
end
end
end