/
block_delimiters_spec.rb
814 lines (697 loc) · 20.4 KB
/
block_delimiters_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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Style::BlockDelimiters, :config do
shared_examples 'syntactic styles' do
it 'registers an offense for a single line block with do-end' do
expect_offense(<<~RUBY)
each do |x| end
^^ Prefer `{...}` over `do...end` for single-line blocks.
RUBY
end
it 'accepts a single line block with braces' do
expect_no_offenses('each { |x| }')
end
it 'accepts a multi-line block with do-end' do
expect_no_offenses(<<~RUBY)
each do |x|
end
RUBY
end
it 'accepts a multi-line block that needs braces to be valid ruby' do
expect_no_offenses(<<~RUBY)
puts [1, 2, 3].map { |n|
n * n
}, 1
RUBY
end
end
context 'Semantic style' do
cop_config = {
'EnforcedStyle' => 'semantic',
'ProceduralMethods' => %w[tap],
'FunctionalMethods' => %w[let],
'IgnoredMethods' => ['lambda', /test/]
}
let(:cop_config) { cop_config }
it 'accepts a multi-line block with braces if the return value is assigned' do
expect_no_offenses(<<~RUBY)
foo = map { |x|
x
}
RUBY
end
it 'accepts a multi-line block with braces if it is the return value of its scope' do
expect_no_offenses(<<~RUBY)
block do
map { |x|
x
}
end
RUBY
end
it 'accepts a multi-line block with braces when passed to a method' do
expect_no_offenses(<<~RUBY)
puts map { |x|
x
}
RUBY
end
it 'accepts a multi-line block with braces when chained' do
expect_no_offenses(<<~RUBY)
map { |x|
x
}.inspect
RUBY
end
it 'accepts a multi-line block with braces when passed to a known functional method' do
expect_no_offenses(<<~RUBY)
let(:foo) {
x
}
RUBY
end
it 'registers an offense for a multi-line block with braces if the return value is not used' do
expect_offense(<<~RUBY)
each { |x|
^ Prefer `do...end` over `{...}` for procedural blocks.
x
}
RUBY
end
it 'registers an offense for a multi-line block with do-end if the return value is assigned' do
expect_offense(<<~RUBY)
foo = map do |x|
^^ Prefer `{...}` over `do...end` for functional blocks.
x
end
RUBY
end
it 'registers an offense for a multi-line block with do-end if the ' \
'return value is passed to a method' do
expect_offense(<<~RUBY)
puts (map do |x|
^^ Prefer `{...}` over `do...end` for functional blocks.
x
end)
RUBY
end
it 'registers an offense for a multi-line block with do-end if the ' \
'return value is attribute-assigned' do
expect_offense(<<~RUBY)
foo.bar = map do |x|
^^ Prefer `{...}` over `do...end` for functional blocks.
x
end
RUBY
end
it 'accepts a multi-line block with do-end if it is the return value of its scope' do
expect_no_offenses(<<~RUBY)
block do
map do |x|
x
end
end
RUBY
end
it 'accepts a single line block with {} if used in an if statement' do
expect_no_offenses('return if any? { |x| x }')
end
it 'accepts a single line block with {} if used in a logical or' do
expect_no_offenses('any? { |c| c } || foo')
end
it 'accepts a single line block with {} if used in a logical and' do
expect_no_offenses('any? { |c| c } && foo')
end
it 'accepts a single line block with {} if used in an array' do
expect_no_offenses('[detect { true }, other]')
end
it 'accepts a single line block with {} if used in an irange' do
expect_no_offenses('detect { true }..other')
end
it 'accepts a single line block with {} if used in an erange' do
expect_no_offenses('detect { true }...other')
end
it 'accepts a multi-line functional block with do-end if it is a known procedural method' do
expect_no_offenses(<<~RUBY)
foo = bar.tap do |x|
x.age = 3
end
RUBY
end
it 'accepts a multi-line functional block with do-end if it is an ignored method' do
expect_no_offenses(<<~RUBY)
foo = lambda do
puts 42
end
RUBY
end
it 'accepts a multi-line functional block with do-end if it is an ignored method by regex' do
expect_no_offenses(<<~RUBY)
foo = test_method do
puts 42
end
RUBY
end
context 'with a procedural one-line block' do
context 'with AllowBracesOnProceduralOneLiners false or unset' do
it 'registers an offense for a single line procedural block' do
expect_offense(<<~RUBY)
each { |x| puts x }
^ Prefer `do...end` over `{...}` for procedural blocks.
RUBY
expect_correction(<<~RUBY)
each do |x| puts x end
RUBY
end
it 'accepts a single line block with do-end if it is procedural' do
expect_no_offenses('each do |x| puts x; end')
end
end
context 'with AllowBracesOnProceduralOneLiners true' do
let(:cop_config) { cop_config.merge('AllowBracesOnProceduralOneLiners' => true) }
it 'accepts a single line procedural block with braces' do
expect_no_offenses('each { |x| puts x }')
end
it 'accepts a single line procedural do-end block' do
expect_no_offenses('each do |x| puts x; end')
end
end
end
context 'with a procedural multi-line block' do
it 'auto-corrects { and } to do and end' do
expect_offense(<<~RUBY)
each { |x|
^ Prefer `do...end` over `{...}` for procedural blocks.
x
}
RUBY
expect_correction(<<~RUBY)
each do |x|
x
end
RUBY
end
it 'auto-corrects { and } to do and end with appropriate spacing' do
expect_offense(<<~RUBY)
each {|x|
^ Prefer `do...end` over `{...}` for procedural blocks.
x
}
RUBY
expect_correction(<<~RUBY)
each do |x|
x
end
RUBY
end
end
it 'allows {} if it is a known functional method' do
expect_no_offenses(<<~RUBY)
let(:foo) { |x|
x
}
RUBY
end
it 'allows {} if it is a known procedural method' do
expect_no_offenses(<<~RUBY)
foo = bar.tap do |x|
x.age = 1
end
RUBY
end
it 'auto-corrects do-end to {} if it is a functional block' do
expect_offense(<<~RUBY)
foo = map do |x|
^^ Prefer `{...}` over `do...end` for functional blocks.
x
end
RUBY
expect_correction(<<~RUBY)
foo = map { |x|
x
}
RUBY
end
it 'auto-corrects do-end to {} with appropriate spacing' do
expect_offense(<<~RUBY)
foo = map do|x|
^^ Prefer `{...}` over `do...end` for functional blocks.
x
end
RUBY
expect_correction(<<~RUBY)
foo = map { |x|
x
}
RUBY
end
it 'auto-corrects do-end to {} if it is a functional block and does not change the meaning' do
expect_offense(<<~RUBY)
puts (map do |x|
^^ Prefer `{...}` over `do...end` for functional blocks.
x
end)
RUBY
expect_correction(<<~RUBY)
puts (map { |x|
x
})
RUBY
end
end
context 'line count-based style' do
cop_config = { 'EnforcedStyle' => 'line_count_based', 'IgnoredMethods' => ['proc', /test/] }
let(:cop_config) { cop_config }
include_examples 'syntactic styles'
it 'auto-corrects do and end for single line blocks to { and }' do
expect_offense(<<~RUBY)
block do |x| end
^^ Prefer `{...}` over `do...end` for single-line blocks.
RUBY
expect_correction(<<~RUBY)
block { |x| }
RUBY
end
it 'does not auto-correct do-end if {} would change the meaning' do
expect_offense(<<~RUBY)
s.subspec 'Subspec' do |sp| end
^^ Prefer `{...}` over `do...end` for single-line blocks.
RUBY
expect_no_corrections
end
it 'does not auto-correct {} if do-end would change the meaning' do
expect_no_offenses(<<~RUBY)
foo :bar, :baz, qux: lambda { |a|
bar a
}
RUBY
end
context 'when there are braces around a multi-line block' do
it 'registers an offense in the simple case' do
expect_offense(<<~RUBY)
each { |x|
^ Avoid using `{...}` for multi-line blocks.
}
RUBY
end
it 'registers an offense when combined with attribute assignment' do
expect_offense(<<~RUBY)
foo.bar = baz.map { |x|
^ Avoid using `{...}` for multi-line blocks.
}
RUBY
end
it 'registers an offense when there is a comment after the closing brace and block body is not empty' do
expect_offense(<<~RUBY)
baz.map { |x|
^ Avoid using `{...}` for multi-line blocks.
foo(x) } # comment
RUBY
expect_correction(<<~RUBY)
# comment
baz.map do |x|
foo(x) end
RUBY
end
it 'registers an offense when there is a comment after the closing brace and using method chain' do
expect_offense(<<~RUBY)
baz.map { |x|
^ Avoid using `{...}` for multi-line blocks.
foo(x) }.qux.quux # comment
RUBY
expect_correction(<<~RUBY)
# comment
baz.map do |x|
foo(x) end.qux.quux
RUBY
end
it 'registers an offense when there is a comment after the closing brace and block body is empty' do
expect_offense(<<~RUBY)
baz.map { |x|
^ Avoid using `{...}` for multi-line blocks.
} # comment
RUBY
expect_correction(<<~RUBY)
# comment
baz.map do |x|
end
RUBY
end
it 'accepts braces if do-end would change the meaning' do
expect_no_offenses(<<~RUBY)
scope :foo, lambda { |f|
where(condition: "value")
}
expect { something }.to raise_error(ErrorClass) { |error|
# ...
}
expect { x }.to change {
Counter.count
}.from(0).to(1)
cr.stubs client: mock {
expects(:email_disabled=).with(true)
expects :save
}
RUBY
end
it 'accepts a multi-line functional block with {} if it is an ignored method' do
expect_no_offenses(<<~RUBY)
foo = proc {
puts 42
}
RUBY
end
it 'accepts a multi-line functional block with {} if it is an ignored method by regex' do
expect_no_offenses(<<~RUBY)
foo = test_method {
puts 42
}
RUBY
end
it 'registers an offense for braces if do-end would not change the meaning' do
expect_offense(<<~RUBY)
scope :foo, (lambda { |f|
^ Avoid using `{...}` for multi-line blocks.
where(condition: "value")
})
expect { something }.to(raise_error(ErrorClass) { |error|
^ Avoid using `{...}` for multi-line blocks.
# ...
})
RUBY
end
it 'can handle special method names such as []= and done?' do
expect_offense(<<~RUBY)
h2[k2] = Hash.new { |h3,k3|
^ Avoid using `{...}` for multi-line blocks.
h3[k3] = 0
}
x = done? list.reject { |e|
e.nil?
}
RUBY
end
it 'auto-corrects { and } to do and end' do
expect_offense(<<~RUBY)
each{ |x|
^ Avoid using `{...}` for multi-line blocks.
some_method
other_method
}
RUBY
expect_correction(<<~RUBY)
each do |x|
some_method
other_method
end
RUBY
end
it 'auto-corrects adjacent curly braces correctly' do
expect_offense(<<~RUBY)
(0..3).each { |a| a.times {
^ Avoid using `{...}` for multi-line blocks.
^ Avoid using `{...}` for multi-line blocks.
puts a
}}
RUBY
expect_correction(<<~RUBY)
(0..3).each do |a| a.times do
puts a
end end
RUBY
end
it 'does not auto-correct {} if do-end would introduce a syntax error' do
expect_no_offenses(<<~RUBY)
my_method :arg1, arg2: proc {
something
}, arg3: :another_value
RUBY
end
end
end
context 'braces for chaining style' do
cop_config = { 'EnforcedStyle' => 'braces_for_chaining', 'IgnoredMethods' => ['proc', /test/] }
let(:cop_config) { cop_config }
include_examples 'syntactic styles'
it 'registers an offense for multi-line chained do-end blocks' do
expect_offense(<<~RUBY)
each do |x|
^^ Prefer `{...}` over `do...end` for multi-line chained blocks.
end.map(&:to_s)
RUBY
expect_correction(<<~RUBY)
each { |x|
}.map(&:to_s)
RUBY
end
it 'accepts a multi-line functional block with {} if it is an ignored method' do
expect_no_offenses(<<~RUBY)
foo = proc {
puts 42
}
RUBY
end
it 'accepts a multi-line functional block with {} if it is an ignored method by regex' do
expect_no_offenses(<<~RUBY)
foo = test_method {
puts 42
}
RUBY
end
it 'allows when :[] is chained' do
expect_no_offenses(<<~RUBY)
foo = [{foo: :bar}].find { |h|
h.key?(:foo)
}[:foo]
RUBY
end
it 'allows do/end inside Hash[]' do
expect_no_offenses(<<~RUBY)
Hash[
{foo: :bar}.map do |k, v|
[k, v]
end
]
RUBY
end
it 'allows chaining to } inside of Hash[]' do
expect_no_offenses(<<~RUBY)
Hash[
{foo: :bar}.map { |k, v|
[k, v]
}.uniq
]
RUBY
end
it 'disallows {} with no chain inside of Hash[]' do
expect_offense(<<~RUBY)
Hash[
{foo: :bar}.map { |k, v|
^ Prefer `do...end` for multi-line blocks without chaining.
[k, v]
}
]
RUBY
end
context 'when there are braces around a multi-line block' do
it 'registers an offense in the simple case' do
expect_offense(<<~RUBY)
each { |x|
^ Prefer `do...end` for multi-line blocks without chaining.
}
RUBY
end
it 'registers an offense when combined with attribute assignment' do
expect_offense(<<~RUBY)
foo.bar = baz.map { |x|
^ Prefer `do...end` for multi-line blocks without chaining.
}
RUBY
end
it 'allows when the block is being chained' do
expect_no_offenses(<<~RUBY)
each { |x|
}.map(&:to_sym)
RUBY
end
it 'allows when the block is being chained with attribute assignment' do
expect_no_offenses(<<~RUBY)
foo.bar = baz.map { |x|
}.map(&:to_sym)
RUBY
end
end
context 'with safe navigation' do
it 'registers an offense for multi-line chained do-end blocks' do
expect_offense(<<~RUBY)
arr&.each do |x|
^^ Prefer `{...}` over `do...end` for multi-line chained blocks.
end&.map(&:to_s)
RUBY
expect_correction(<<~RUBY)
arr&.each { |x|
}&.map(&:to_s)
RUBY
end
end
end
context 'always braces' do
cop_config = { 'EnforcedStyle' => 'always_braces', 'IgnoredMethods' => ['proc', /test/] }
let(:cop_config) { cop_config }
it 'registers an offense for a single line block with do-end' do
expect_offense(<<~RUBY)
each do |x| end
^^ Prefer `{...}` over `do...end` for blocks.
RUBY
expect_correction(<<~RUBY)
each { |x| }
RUBY
end
it 'accepts a single line block with braces' do
expect_no_offenses('each { |x| }')
end
it 'registers an offense for a multi-line block with do-end' do
expect_offense(<<~RUBY)
each do |x|
^^ Prefer `{...}` over `do...end` for blocks.
end
RUBY
end
it 'does not auto-correct do-end if {} would change the meaning' do
expect_offense(<<~RUBY)
s.subspec 'Subspec' do |sp| end
^^ Prefer `{...}` over `do...end` for blocks.
RUBY
expect_no_corrections
end
it 'accepts a multi-line block that needs braces to be valid ruby' do
expect_no_offenses(<<~RUBY)
puts [1, 2, 3].map { |n|
n * n
}, 1
RUBY
end
it 'registers an offense for multi-line chained do-end blocks' do
expect_offense(<<~RUBY)
each do |x|
^^ Prefer `{...}` over `do...end` for blocks.
end.map(&:to_s)
RUBY
expect_correction(<<~RUBY)
each { |x|
}.map(&:to_s)
RUBY
end
it 'registers an offense for multi-lined do-end blocks when combined ' \
'with attribute assignment' do
expect_offense(<<~RUBY)
foo.bar = baz.map do |x|
^^ Prefer `{...}` over `do...end` for blocks.
end
RUBY
end
it 'accepts a multi-line functional block with do-end if it is an ignored method' do
expect_no_offenses(<<~RUBY)
foo = proc do
puts 42
end
RUBY
end
it 'accepts a multi-line functional block with do-end if it is an ignored method by regex' do
expect_no_offenses(<<~RUBY)
foo = test_method do
puts 42
end
RUBY
end
context 'when there are braces around a multi-line block' do
it 'allows in the simple case' do
expect_no_offenses(<<~RUBY)
each { |x|
}
RUBY
end
it 'allows when combined with attribute assignment' do
expect_no_offenses(<<~RUBY)
foo.bar = baz.map { |x|
}
RUBY
end
it 'allows when the block is being chained' do
expect_no_offenses(<<~RUBY)
each { |x|
}.map(&:to_sym)
RUBY
end
end
end
context 'BracesRequiredMethods' do
cop_config = { 'EnforcedStyle' => 'line_count_based', 'BracesRequiredMethods' => %w[sig] }
let(:cop_config) { cop_config }
describe 'BracesRequiredMethods methods' do
it 'allows braces' do
expect_no_offenses(<<~RUBY)
sig {
params(
foo: string,
).void
}
def consume(foo)
foo
end
RUBY
end
it 'registers an offense with do' do
expect_offense(<<~RUBY)
sig do
^^ Brace delimiters `{...}` required for 'sig' method.
params(
foo: string,
).void
end
def consume(foo)
foo
end
RUBY
expect_correction(<<~RUBY)
sig {
params(
foo: string,
).void
}
def consume(foo)
foo
end
RUBY
end
end
describe 'other methods' do
it 'allows braces' do
expect_no_offenses(<<~RUBY)
other_method do
params(
foo: string,
).void
end
def consume(foo)
foo
end
RUBY
end
it 'auto-corrects { and } to do and end' do
expect_offense(<<~RUBY)
each{ |x|
^ Avoid using `{...}` for multi-line blocks.
some_method
other_method
}
RUBY
expect_correction(<<~RUBY)
each do |x|
some_method
other_method
end
RUBY
end
end
end
end