/
multiline_expression_indentation.rb
255 lines (216 loc) · 7.88 KB
/
multiline_expression_indentation.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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# frozen_string_literal: true
module RuboCop
module Cop
# Common functionality for checking multiline method calls and binary
# operations.
module MultilineExpressionIndentation # rubocop:disable Metrics/ModuleLength
KEYWORD_ANCESTOR_TYPES = %i[for if while until return].freeze
UNALIGNED_RHS_TYPES = %i[if while until for return
array kwbegin].freeze
DEFAULT_MESSAGE_TAIL = 'an expression'
ASSIGNMENT_MESSAGE_TAIL = 'an expression in an assignment'
KEYWORD_MESSAGE_TAIL = 'a %<kind>s in %<article>s `%<keyword>s` ' \
'statement'
def on_send(node)
return if !node.receiver || node.method?(:[])
return unless relevant_node?(node)
lhs = left_hand_side(node.receiver)
rhs = right_hand_side(node)
range = offending_range(node, lhs, rhs, style)
check(range, node, lhs, rhs)
end
private
# In a chain of method calls, we regard the top send node as the base
# for indentation of all lines following the first. For example:
# a.
# b c { block }. <-- b is indented relative to a
# d <-- d is indented relative to a
def left_hand_side(lhs)
lhs = lhs.parent while lhs.parent&.send_type?
lhs
end
def right_hand_side(send_node)
if send_node.operator_method? && send_node.arguments?
send_node.first_argument.source_range # not used for method calls
else
regular_method_right_hand_side(send_node)
end
end
def regular_method_right_hand_side(send_node)
dot = send_node.loc.dot
selector = send_node.loc.selector
if send_node.dot? && selector && dot.line == selector.line
dot.join(selector)
elsif selector
selector
elsif send_node.implicit_call?
dot.join(send_node.loc.begin)
end
end
# The correct indentation of `node` is usually `IndentationWidth`, with
# one exception: prefix keywords.
#
# ```
# while foo && # Here, `while` is called a "prefix keyword"
# bar # This is called "special indentation"
# baz
# end
# ```
#
# Note that *postfix conditionals* do *not* get "special indentation".
#
# ```
# next if foo &&
# bar # normal indentation, not special
# ```
def correct_indentation(node)
kw_node = kw_node_with_special_indentation(node)
if kw_node && !postfix_conditional?(kw_node)
# This cop could have its own IndentationWidth configuration
configured_indentation_width +
@config.for_cop('Layout/IndentationWidth')['Width']
else
configured_indentation_width
end
end
def check(range, node, lhs, rhs)
if range
incorrect_style_detected(range, node, lhs, rhs)
else
correct_style_detected
end
end
def incorrect_style_detected(range, node, lhs, rhs)
add_offense(range, location: range, message: message(node, lhs, rhs)) do
if supported_styles.size > 2 ||
offending_range(node, lhs, rhs, alternative_style)
unrecognized_style_detected
else
opposite_style_detected
end
end
end
def indentation(node)
node.source_range.source_line =~ /\S/
end
def operation_description(node, rhs)
kw_node_with_special_indentation(node) do |ancestor|
return keyword_message_tail(ancestor)
end
part_of_assignment_rhs(node, rhs) do |_node|
return ASSIGNMENT_MESSAGE_TAIL
end
DEFAULT_MESSAGE_TAIL
end
def keyword_message_tail(node)
keyword = node.loc.keyword.source
kind = keyword == 'for' ? 'collection' : 'condition'
article = keyword.start_with?('i', 'u') ? 'an' : 'a'
format(KEYWORD_MESSAGE_TAIL, kind: kind,
article: article,
keyword: keyword)
end
def kw_node_with_special_indentation(node)
keyword_node =
node.each_ancestor(*KEYWORD_ANCESTOR_TYPES).find do |ancestor|
next if ancestor.if_type? && ancestor.ternary?
within_node?(node, indented_keyword_expression(ancestor))
end
if keyword_node && block_given?
yield keyword_node
else
keyword_node
end
end
def indented_keyword_expression(node)
if node.for_type?
expression = node.collection
else
expression, = *node
end
expression
end
def argument_in_method_call(node, kind) # rubocop:todo Metrics/CyclomaticComplexity
node.each_ancestor(:send, :block).find do |a|
# If the node is inside a block, it makes no difference if that block
# is an argument in a method call. It doesn't count.
break false if a.block_type?
next if a.setter_method?
next unless kind == :with_or_without_parentheses ||
kind == :with_parentheses && parentheses?(a)
a.arguments.any? do |arg|
within_node?(node, arg)
end
end
end
def part_of_assignment_rhs(node, candidate)
rhs_node = node.each_ancestor.find do |ancestor|
break if disqualified_rhs?(candidate, ancestor)
valid_rhs?(candidate, ancestor)
end
if rhs_node && block_given?
yield rhs_node
else
rhs_node
end
end
def disqualified_rhs?(candidate, ancestor)
UNALIGNED_RHS_TYPES.include?(ancestor.type) ||
ancestor.block_type? && part_of_block_body?(candidate, ancestor)
end
def valid_rhs?(candidate, ancestor)
if ancestor.send_type?
valid_method_rhs_candidate?(candidate, ancestor)
elsif ancestor.assignment?
valid_rhs_candidate?(candidate, assignment_rhs(ancestor))
else
false
end
end
# The []= operator and setters (a.b = c) are parsed as :send nodes.
def valid_method_rhs_candidate?(candidate, node)
node.setter_method? &&
valid_rhs_candidate?(candidate, node.last_argument)
end
def valid_rhs_candidate?(candidate, node)
!candidate || within_node?(candidate, node)
end
def part_of_block_body?(candidate, block_node)
block_node.body && within_node?(candidate, block_node.body)
end
def assignment_rhs(node)
case node.type
when :casgn then _scope, _lhs, rhs = *node
when :op_asgn then _lhs, _op, rhs = *node
when :send then rhs = node.last_argument
else _lhs, rhs = *node
end
rhs
end
def not_for_this_cop?(node)
node.ancestors.any? do |ancestor|
grouped_expression?(ancestor) ||
inside_arg_list_parentheses?(node, ancestor)
end
end
def grouped_expression?(node)
node.begin_type? && node.loc.respond_to?(:begin) && node.loc.begin
end
def inside_arg_list_parentheses?(node, ancestor)
return false unless ancestor.send_type? && ancestor.parenthesized?
node.source_range.begin_pos > ancestor.loc.begin.begin_pos &&
node.source_range.end_pos < ancestor.loc.end.end_pos
end
# Returns true if `node` is a conditional whose `body` and `condition`
# begin on the same line.
def postfix_conditional?(node)
node.if_type? && node.modifier_form?
end
def within_node?(inner, outer)
o = outer.is_a?(AST::Node) ? outer.source_range : outer
i = inner.is_a?(AST::Node) ? inner.source_range : inner
i.begin_pos >= o.begin_pos && i.end_pos <= o.end_pos
end
end
end
end