-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
heredoc_indentation_spec.rb
302 lines (274 loc) · 8.19 KB
/
heredoc_indentation_spec.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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Layout::HeredocIndentation, :config do
let(:allow_heredoc) { true }
let(:other_cops) do
{
'Layout/LineLength' => { 'Max' => 5, 'AllowHeredoc' => allow_heredoc }
}
end
shared_examples 'offense' do |name, code, correction = nil|
it "registers an offense for #{name}" do
inspect_source(code)
expect(cop.offenses.size).to eq(1)
end
it "autocorrects for #{name}" do
corrected = autocorrect_source_with_loop(code)
expect(corrected).to eq(correction)
end
end
shared_examples 'accept' do |name, code|
it "accepts for #{name}" do
expect_no_offenses(code)
end
end
shared_examples 'warning' do |message|
it 'warns' do
correct = lambda do
autocorrect_source(<<~RUBY)
<<-RUBY2
foo
RUBY2
RUBY
end
expect(&correct).to raise_error(RuboCop::Warning, message)
end
end
shared_examples 'all heredoc type' do |quote|
context "quoted by #{quote}" do
let(:cop_config) do
{ 'EnforcedStyle' => :powerpack }
end
include_examples 'offense', 'not indented', <<~RUBY, <<~CORRECTION
<<#{quote}RUBY2#{quote}
\#{foo}
bar
RUBY2
RUBY
<<#{quote}RUBY2#{quote}.strip_indent
\#{foo}
bar
RUBY2
CORRECTION
include_examples 'offense', 'minus level indented', <<~RUBY, <<~CORRECTION
def foo
<<#{quote}RUBY2#{quote}
\#{foo}
bar
RUBY2
end
RUBY
def foo
<<#{quote}RUBY2#{quote}.strip_indent
\#{foo}
bar
RUBY2
end
CORRECTION
include_examples 'offense', 'not indented, with `-`',
<<~RUBY, <<~CORRECTION
<<-#{quote}RUBY2#{quote}
\#{foo}
bar
RUBY2
RUBY
<<-#{quote}RUBY2#{quote}.strip_indent
\#{foo}
bar
RUBY2
CORRECTION
include_examples 'offense', 'minus level indented, with `-`',
<<~RUBY, <<~CORRECTION
def foo
<<-#{quote}RUBY2#{quote}
\#{foo}
bar
RUBY2
end
RUBY
def foo
<<-#{quote}RUBY2#{quote}.strip_indent
\#{foo}
bar
RUBY2
end
CORRECTION
it 'does not register an offense when not indented but with ' \
'whitespace, with `-`' do
expect_no_offenses(<<-RUBY)
def foo
<<-#{quote}RUBY2#{quote}
something
RUBY2
end
RUBY
end
include_examples 'accept', 'indented, but with `-`', <<~RUBY
def foo
<<-#{quote}RUBY2#{quote}
something
RUBY2
end
RUBY
include_examples 'accept', 'not indented but with whitespace', <<~RUBY
def foo
<<#{quote}RUBY2#{quote}
something
RUBY2
end
RUBY
include_examples 'accept', 'indented, but without `~`', <<~RUBY
def foo
<<#{quote}RUBY2#{quote}
something
RUBY2
end
RUBY
include_examples 'accept', 'an empty line', <<~RUBY
<<-#{quote}RUBY2#{quote}
RUBY2
RUBY
context 'when Layout/LineLength is configured' do
let(:allow_heredoc) { false }
include_examples 'offense', 'short heredoc', <<~RUBY, <<~CORRECTION
<<#{quote}RUBY2#{quote}
12
RUBY2
RUBY
<<#{quote}RUBY2#{quote}.strip_indent
12
RUBY2
CORRECTION
include_examples 'accept', 'long heredoc', <<~RUBY
<<#{quote}RUBY2#{quote}
12345678
RUBY2
RUBY
end
it 'displays a message with suggestion powerpack' do
expect_offense(<<~RUBY)
<<-RUBY2
foo
^^^ Use 2 spaces for indentation in a heredoc by using `String#strip_indent`.
RUBY2
RUBY
end
context 'EnforcedStyle is `squiggly`' do
let(:cop_config) do
{ 'EnforcedStyle' => :squiggly }
end
include_examples 'offense', 'not indented', <<~RUBY, <<~CORRECTION
<<~#{quote}RUBY2#{quote}
something
RUBY2
RUBY
<<~#{quote}RUBY2#{quote}
something
RUBY2
CORRECTION
include_examples 'offense', 'minus level indented',
<<~RUBY, <<~CORRECTION
def foo
<<~#{quote}RUBY2#{quote}
something
RUBY2
end
RUBY
def foo
<<~#{quote}RUBY2#{quote}
something
RUBY2
end
CORRECTION
include_examples 'offense', 'too deep indented', <<~RUBY, <<~CORRECTION
<<~#{quote}RUBY2#{quote}
something
RUBY2
RUBY
<<~#{quote}RUBY2#{quote}
something
RUBY2
CORRECTION
include_examples 'offense', 'not indented, without `~`',
<<~RUBY, <<~CORRECTION
<<#{quote}RUBY2#{quote}
foo
RUBY2
RUBY
<<~#{quote}RUBY2#{quote}
foo
RUBY2
CORRECTION
include_examples 'offense', 'not indented, with `~`',
<<~RUBY, <<~CORRECTION
<<~#{quote}RUBY2#{quote}
foo
RUBY2
RUBY
<<~#{quote}RUBY2#{quote}
foo
RUBY2
CORRECTION
include_examples 'offense', 'first line minus-level indented, with `-`',
<<~RUBY, <<-CORRECTION
puts <<-#{quote}RUBY2#{quote}
def foo
bar
end
RUBY2
RUBY
puts <<~#{quote}RUBY2#{quote}
def foo
bar
end
RUBY2
CORRECTION
include_examples 'accept', 'indented, with `~`', <<~RUBY
<<~#{quote}RUBY2#{quote}
something
RUBY2
RUBY
include_examples 'accept', 'include empty lines', <<~RUBY
<<~#{quote}MSG#{quote}
foo
bar
MSG
RUBY
include_examples 'offense', 'not indented enough with empty lines',
<<-RUBY, <<-CORRECTION
def baz
<<~#{quote}MSG#{quote}
foo
bar
MSG
end
RUBY
def baz
<<~#{quote}MSG#{quote}
foo
bar
MSG
end
CORRECTION
it 'displays message to use `<<~` instead of `<<`' do
expect_offense(<<~RUBY)
<<RUBY2
foo
^^^ Use 2 spaces for indentation in a heredoc by using `<<~` instead of `<<`.
RUBY2
RUBY
end
it 'displays message to use `<<~` instead of `<<-`' do
expect_offense(<<~RUBY)
<<-RUBY2
foo
^^^ Use 2 spaces for indentation in a heredoc by using `<<~` instead of `<<-`.
RUBY2
RUBY
end
end
end
end
[nil, "'", '"', '`'].each do |quote|
include_examples 'all heredoc type', quote
end
end