forked from rubocop/rubocop
-
Notifications
You must be signed in to change notification settings - Fork 2
/
end_alignment.rb
190 lines (169 loc) · 5.23 KB
/
end_alignment.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
# frozen_string_literal: true
module RuboCop
module Cop
module Layout
# Checks whether the end keywords are aligned properly.
#
# Three modes are supported through the `EnforcedStyleAlignWith`
# configuration parameter:
#
# If it's set to `keyword` (which is the default), the `end`
# shall be aligned with the start of the keyword (if, class, etc.).
#
# If it's set to `variable` the `end` shall be aligned with the
# left-hand-side of the variable assignment, if there is one.
#
# If it's set to `start_of_line`, the `end` shall be aligned with the
# start of the line where the matching keyword appears.
#
# This `Layout/EndAlignment` cop aligns with keywords (e.g. `if`, `while`, `case`)
# by default. On the other hand, `Layout/BeginEndAlignment` cop aligns with
# `EnforcedStyleAlignWith: start_of_line` by default due to `||= begin` tends
# to align with the start of the line. These style can be configured by each cop.
#
# @example EnforcedStyleAlignWith: keyword (default)
# # bad
#
# variable = if true
# end
#
# # good
#
# variable = if true
# end
#
# variable =
# if true
# end
#
# @example EnforcedStyleAlignWith: variable
# # bad
#
# variable = if true
# end
#
# # good
#
# variable = if true
# end
#
# variable =
# if true
# end
#
# @example EnforcedStyleAlignWith: start_of_line
# # bad
#
# variable = if true
# end
#
# puts(if true
# end)
#
# # good
#
# variable = if true
# end
#
# puts(if true
# end)
#
# variable =
# if true
# end
class EndAlignment < Base
include CheckAssignment
include EndKeywordAlignment
include RangeHelp
extend AutoCorrector
def on_class(node)
check_other_alignment(node)
end
def on_module(node)
check_other_alignment(node)
end
def on_if(node)
check_other_alignment(node) unless node.ternary?
end
def on_while(node)
check_other_alignment(node)
end
def on_until(node)
check_other_alignment(node)
end
def on_case(node)
if node.argument?
check_asgn_alignment(node.parent, node)
else
check_other_alignment(node)
end
end
private
def autocorrect(corrector, node)
AlignmentCorrector.align_end(corrector, processed_source, node, alignment_node(node))
end
def check_assignment(node, rhs)
# If there are method calls chained to the right hand side of the
# assignment, we let rhs be the receiver of those method calls before
# we check if it's an if/unless/while/until.
return unless (rhs = first_part_of_call_chain(rhs))
return unless rhs.conditional?
return if rhs.if_type? && rhs.ternary?
check_asgn_alignment(node, rhs)
end
def check_asgn_alignment(outer_node, inner_node)
align_with = {
keyword: inner_node.loc.keyword,
start_of_line: start_line_range(inner_node),
variable: asgn_variable_align_with(outer_node, inner_node)
}
check_end_kw_alignment(inner_node, align_with)
ignore_node(inner_node)
end
def asgn_variable_align_with(outer_node, inner_node)
expr = outer_node.source_range
if line_break_before_keyword?(expr, inner_node)
inner_node.loc.keyword
else
range_between(expr.begin_pos, inner_node.loc.keyword.end_pos)
end
end
def check_other_alignment(node)
align_with = {
keyword: node.loc.keyword,
variable: node.loc.keyword,
start_of_line: start_line_range(node)
}
check_end_kw_alignment(node, align_with)
end
def alignment_node(node)
case style
when :keyword
node
when :variable
alignment_node_for_variable_style(node)
else
start_line_range(node)
end
end
def alignment_node_for_variable_style(node)
return node.parent if node.case_type? && node.argument? && same_line?(node, node.parent)
assignment = assignment_or_operator_method(node)
if assignment && !line_break_before_keyword?(assignment.source_range, node)
assignment
else
# Fall back to 'keyword' style if this node is not on the RHS of an
# assignment, or if it is but there's a line break between LHS and
# RHS.
node
end
end
def assignment_or_operator_method(node)
node.ancestors.find do |ancestor|
ancestor.assignment_or_similar? || (ancestor.send_type? && ancestor.operator_method?)
end
end
end
end
end
end