/
redundant_splat_expansion.rb
172 lines (151 loc) · 4.5 KB
/
redundant_splat_expansion.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
166
167
168
169
170
171
172
# frozen_string_literal: true
module RuboCop
module Cop
module Lint
# This cop checks for unneeded usages of splat expansion
#
# @example
#
# # bad
#
# a = *[1, 2, 3]
# a = *'a'
# a = *1
#
# begin
# foo
# rescue *[StandardError, ApplicationError]
# bar
# end
#
# case foo
# when *[1, 2, 3]
# bar
# else
# baz
# end
#
# @example
#
# # good
#
# c = [1, 2, 3]
# a = *c
# a, b = *c
# a, *b = *c
# a = *1..10
# a = ['a']
#
# begin
# foo
# rescue StandardError, ApplicationError
# bar
# end
#
# case foo
# when 1, 2, 3
# bar
# else
# baz
# end
class RedundantSplatExpansion < Cop
MSG = 'Replace splat expansion with comma separated values.'
ARRAY_PARAM_MSG = 'Pass array contents as separate arguments.'
PERCENT_W = '%w'
PERCENT_CAPITAL_W = '%W'
PERCENT_I = '%i'
PERCENT_CAPITAL_I = '%I'
ASSIGNMENT_TYPES = %i[lvasgn ivasgn cvasgn gvasgn].freeze
def_node_matcher :array_new?, <<~PATTERN
{
$(send (const nil? :Array) :new ...)
$(block (send (const nil? :Array) :new ...) ...)
}
PATTERN
def_node_matcher :literal_expansion, <<~PATTERN
(splat {$({str dstr int float array} ...) (block $#array_new? ...) $#array_new?} ...)
PATTERN
def on_splat(node)
redundant_splat_expansion(node) do
if array_splat?(node) &&
(method_argument?(node) || part_of_an_array?(node))
add_offense(node, message: ARRAY_PARAM_MSG)
else
add_offense(node)
end
end
end
def autocorrect(node)
range, content = replacement_range_and_content(node)
lambda do |corrector|
corrector.replace(range, content)
end
end
private
def redundant_splat_expansion(node)
literal_expansion(node) do |expanded_item|
if expanded_item.send_type?
return if array_new_inside_array_literal?(expanded_item)
grandparent = node.parent.parent
return if grandparent &&
!ASSIGNMENT_TYPES.include?(grandparent.type)
end
yield
end
end
def array_new_inside_array_literal?(array_new_node)
return false unless array_new?(array_new_node)
grandparent = array_new_node.parent.parent
grandparent.array_type? && grandparent.children.size > 1
end
def replacement_range_and_content(node)
variable, = *node
loc = node.loc
if array_new?(variable)
[node.parent.loc.expression, variable.source]
elsif !variable.array_type?
[loc.expression, "[#{variable.source}]"]
elsif redundant_brackets?(node)
[loc.expression, remove_brackets(variable)]
else
[loc.operator, '']
end
end
def array_splat?(node)
node.children.first.array_type?
end
def method_argument?(node)
node.parent.send_type?
end
def part_of_an_array?(node)
# The parent of a splat expansion is an array that does not have
# `begin` or `end`
parent = node.parent
parent.array_type? && parent.loc.begin && parent.loc.end
end
def redundant_brackets?(node)
parent = node.parent
grandparent = node.parent.parent
parent.when_type? || parent.send_type? || part_of_an_array?(node) ||
grandparent&.resbody_type?
end
def remove_brackets(array)
array_start = array.loc.begin.source
elements = *array
elements = elements.map(&:source)
if array_start.start_with?(PERCENT_W)
"'#{elements.join("', '")}'"
elsif array_start.start_with?(PERCENT_CAPITAL_W)
%("#{elements.join('", "')}")
elsif array_start.start_with?(PERCENT_I)
":#{elements.join(', :')}"
elsif array_start.start_with?(PERCENT_CAPITAL_I)
%(:"#{elements.join('", :"')}")
else
elements.join(', ')
end
end
end
end
end
end