/
empty_line_after_guard_clause_spec.rb
480 lines (415 loc) · 10.4 KB
/
empty_line_after_guard_clause_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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Layout::EmptyLineAfterGuardClause do
subject(:cop) { described_class.new }
it 'registers an offense and corrects a guard clause ' \
'not followed by empty line' do
expect_offense(<<~RUBY)
def foo
return if need_return?
^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
foobar
end
RUBY
expect_correction(<<~RUBY)
def foo
return if need_return?
foobar
end
RUBY
end
it 'registers an offense and corrects `next` guard clause not followed by ' \
'empty line' do
expect_offense(<<~RUBY)
def foo
next unless need_next? # comment
^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
foobar
end
RUBY
expect_correction(<<~RUBY)
def foo
next unless need_next? # comment
foobar
end
RUBY
end
it 'registers an offense and corrects a guard clause is before `begin`' do
expect_offense(<<~RUBY)
def foo
return another_object if something_different?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
begin
bar
rescue SomeException
baz
end
end
RUBY
expect_correction(<<~RUBY)
def foo
return another_object if something_different?
begin
bar
rescue SomeException
baz
end
end
RUBY
end
it 'registers an offense and corrects a `raise` guard clause not followed ' \
'by empty line when `unless` condition is after heredoc' do
expect_offense(<<~RUBY)
def foo
raise ArgumentError, <<-MSG unless path
Must be called with mount point
MSG
^^^^^ Add empty line after guard clause.
bar
end
RUBY
expect_correction(<<~RUBY)
def foo
raise ArgumentError, <<-MSG unless path
Must be called with mount point
MSG
bar
end
RUBY
end
it 'registers an offense and corrects a `raise` guard clause not followed ' \
'by empty line when `if` condition is after heredoc' do
expect_offense(<<~RUBY)
def foo
raise ArgumentError, <<-MSG if path
Must be called with mount point
MSG
^^^^^ Add empty line after guard clause.
bar
end
RUBY
expect_correction(<<~RUBY)
def foo
raise ArgumentError, <<-MSG if path
Must be called with mount point
MSG
bar
end
RUBY
end
it 'registers an offense and corrects a next guard clause not followed by ' \
'empty line when guard clause is after heredoc ' \
'including string interpolation' do
expect_offense(<<~'RUBY')
raise(<<-FAIL) unless true
#{1 + 1}
FAIL
^^^^ Add empty line after guard clause.
1
RUBY
expect_correction(<<~'RUBY')
raise(<<-FAIL) unless true
#{1 + 1}
FAIL
1
RUBY
end
it 'accepts a `raise` guard clause not followed by empty line when guard ' \
'clause is after condition without method invocation' do
expect_no_offenses(<<~'RUBY')
def foo
raise unless $1 == o
bar
end
RUBY
end
it 'registers an offense and corrects a `raise` guard clause not followed ' \
'by empty line when guard clause is after method call with argument' do
expect_offense(<<~'RUBY')
def foo
raise SerializationError.new("Unsupported argument type: #{argument.class.name}") unless serializer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
serializer.serialize(argument)
end
RUBY
expect_correction(<<~'RUBY')
def foo
raise SerializationError.new("Unsupported argument type: #{argument.class.name}") unless serializer
serializer.serialize(argument)
end
RUBY
end
it 'registers an offense and corrects when using `and return` ' \
'before guard condition' do
expect_offense(<<~RUBY)
def foo
render :foo and return if condition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
do_something
end
RUBY
expect_correction(<<~RUBY)
def foo
render :foo and return if condition
do_something
end
RUBY
end
it 'registers an offense and corrects when using `or return` ' \
'before guard condition' do
expect_offense(<<~RUBY)
def foo
render :foo or return if condition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
do_something
end
RUBY
expect_correction(<<~RUBY)
def foo
render :foo or return if condition
do_something
end
RUBY
end
it 'accepts modifier if' do
expect_no_offenses(<<~RUBY)
def foo
foo += 1 if need_add?
foobar
end
RUBY
end
it 'accepts a guard clause followed by empty line when guard clause ' \
'including heredoc' do
expect_no_offenses(<<~RUBY)
def method
if truthy
raise <<-MSG
This is an error.
MSG
end
value
end
RUBY
end
it 'registers an offense and corrects a guard clause not followed by ' \
'empty line when guard clause including heredoc' do
expect_offense(<<~RUBY)
def method
if truthy
raise <<-MSG
This is an error.
MSG
end
^^^ Add empty line after guard clause.
value
end
RUBY
expect_correction(<<~RUBY)
def method
if truthy
raise <<-MSG
This is an error.
MSG
end
value
end
RUBY
end
it 'accepts a guard clause followed by end' do
expect_no_offenses(<<~RUBY)
def foo
if something?
return
end
end
RUBY
end
it 'accepts using guard clause is after `raise`' do
expect_no_offenses(<<~RUBY)
def foo
raise ArgumentError, 'HTTP redirect too deep' if limit.zero?
foobar
end
RUBY
end
it 'accepts a guard clause inside oneliner block' do
expect_no_offenses(<<~RUBY)
def foo
object.tap { |obj| return another_object if something? }
foobar
end
RUBY
end
it 'accepts multiple guard clauses' do
expect_no_offenses(<<~RUBY)
def foo
return another_object if something?
return another_object if something_else?
return another_object if something_different?
foobar
end
RUBY
end
it 'accepts a modifier if when the next line is `end`' do
expect_no_offenses(<<~RUBY)
def foo
return another_object if something_different?
end
RUBY
end
it 'accepts a guard clause when the next line is `rescue`' do
expect_no_offenses(<<~RUBY)
def foo
begin
return another_object if something_different?
rescue SomeException
bar
end
end
RUBY
end
it 'accpets a guard clause when the next line is `ensure`' do
expect_no_offenses(<<~RUBY)
def foo
begin
return another_object if something_different?
ensure
bar
end
end
RUBY
end
it 'accpets a guard clause when the next line is `rescue`-`else`' do
expect_no_offenses(<<~RUBY)
def foo
begin
bar
rescue SomeException
return another_object if something_different?
else
bar
end
end
RUBY
end
it 'accepts a guard clause when the next line is `else`' do
expect_no_offenses(<<~RUBY)
def foo
if cond
return another_object if something_different?
else
bar
end
end
RUBY
end
it 'accpets a guard clause when the next line is `elsif`' do
expect_no_offenses(<<~RUBY)
def foo
if cond
return another_object if something_different?
elsif
bar
end
end
RUBY
end
it 'accepta a guard clause after a single line heredoc' do
expect_no_offenses(<<~RUBY)
def foo
raise ArgumentError, <<-MSG unless path
Must be called with mount point
MSG
bar
end
RUBY
end
it 'accepta a guard clause that is after multiline heredoc' do
expect_no_offenses(<<~RUBY)
def foo
raise ArgumentError, <<-MSG unless path
foo
bar
baz
MSG
bar
end
RUBY
end
it 'accpets a guard clause that is after a multiline heredoc ' \
'with chained calls' do
expect_no_offenses(<<~RUBY)
def foo
raise ArgumentError, <<~END.squish.it.good unless guard
A multiline message
that will be squished.
END
return_value
end
RUBY
end
it 'accpets a guard clause that is after a multiline heredoc ' \
'nested argument call' do
expect_no_offenses(<<~RUBY)
def foo
raise ArgumentError, call(<<~END.squish) unless guard
A multiline message
that will be squished.
END
return_value
end
RUBY
end
it 'registers an offense and corrects a guard clause that is ' \
'a ternary operator' do
expect_offense(<<~RUBY)
def foo
puts 'some action happens here'
rescue => e
a_check ? raise(e) : other_thing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
true
end
RUBY
expect_correction(<<~RUBY)
def foo
puts 'some action happens here'
rescue => e
a_check ? raise(e) : other_thing
true
end
RUBY
end
it 'registers an offense and corrects a method starting with end_' do
expect_offense(<<~RUBY)
def foo
next unless need_next?
^^^^^^^^^^^^^^^^^^^^^^ Add empty line after guard clause.
end_this!
end
RUBY
expect_correction(<<~RUBY)
def foo
next unless need_next?
end_this!
end
RUBY
end
it 'registers an offense and corrects only the last guard clause' do
expect_offense(<<~RUBY)
def foo
next if foo?
next if bar?
^^^^^^^^^^^^ Add empty line after guard clause.
foobar
end
RUBY
expect_correction(<<~RUBY)
def foo
next if foo?
next if bar?
foobar
end
RUBY
end
end