/
mutable_constant_spec.rb
618 lines (527 loc) · 19.2 KB
/
mutable_constant_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Style::MutableConstant, :config do
let(:prefix) { nil }
shared_examples 'mutable objects' do |o|
context 'when assigning with =' do
it "registers an offense for #{o} assigned to a constant " \
'and corrects by adding .freeze' do
expect_offense([prefix, <<~RUBY].compact.join("\n"), o: o)
CONST = %{o}
^{o} Freeze mutable objects assigned to constants.
RUBY
expect_correction([prefix, <<~RUBY].compact.join("\n"))
CONST = #{o}.freeze
RUBY
end
end
context 'when assigning with ||=' do
it "registers an offense for #{o} assigned to a constant " \
'and corrects by adding .freeze' do
expect_offense([prefix, <<~RUBY].compact.join("\n"), o: o)
CONST ||= %{o}
^{o} Freeze mutable objects assigned to constants.
RUBY
expect_correction([prefix, <<~RUBY].compact.join("\n"))
CONST ||= #{o}.freeze
RUBY
end
end
end
shared_examples 'immutable objects' do |o|
it "allows #{o} to be assigned to a constant" do
source = [prefix, "CONST = #{o}"].compact.join("\n")
expect_no_offenses(source)
end
it "allows #{o} to be ||= to a constant" do
source = [prefix, "CONST ||= #{o}"].compact.join("\n")
expect_no_offenses(source)
end
end
shared_examples 'literals that are frozen' do |o|
let(:prefix) { o }
it_behaves_like 'immutable objects', '[1, 2, 3]'
it_behaves_like 'immutable objects', '%w(a b c)'
it_behaves_like 'immutable objects', '{ a: 1, b: 2 }'
it_behaves_like 'immutable objects', "'str'"
it_behaves_like 'immutable objects', '"top#{1 + 2}"'
it_behaves_like 'immutable objects', '1'
it_behaves_like 'immutable objects', '1.5'
it_behaves_like 'immutable objects', ':sym'
it_behaves_like 'immutable objects', 'FOO + BAR'
it_behaves_like 'immutable objects', 'FOO - BAR'
it_behaves_like 'immutable objects', "'foo' + 'bar'"
it_behaves_like 'immutable objects', "ENV['foo']"
it_behaves_like 'immutable objects', "::ENV['foo']"
end
shared_examples 'literals that are not frozen' do |o|
let(:prefix) { o }
it_behaves_like 'mutable objects', '[1, 2, 3]'
it_behaves_like 'mutable objects', '%w(a b c)'
it_behaves_like 'mutable objects', '{ a: 1, b: 2 }'
it_behaves_like 'mutable objects', "'str'"
it_behaves_like 'mutable objects', '"top#{1 + 2}"'
it_behaves_like 'immutable objects', '1'
it_behaves_like 'immutable objects', '1.5'
it_behaves_like 'immutable objects', ':sym'
it_behaves_like 'immutable objects', 'FOO + BAR'
it_behaves_like 'immutable objects', 'FOO - BAR'
it_behaves_like 'immutable objects', "'foo' + 'bar'"
it_behaves_like 'immutable objects', "ENV['foo']"
it_behaves_like 'immutable objects', "::ENV['foo']"
end
shared_examples 'string literal' do
# TODO : It is not yet decided when frozen string will be the default.
# It has been abandoned in the Ruby 3.0 period, but may default in
# the long run. So these tests are left with a provisional value of 4.0.
if RuboCop::TargetRuby.supported_versions.include?(4.0)
context 'when the target ruby version >= 4.0' do
let(:ruby_version) { 4.0 }
context 'when the frozen string literal comment is missing' do
it_behaves_like 'immutable objects', '"#{a}"'
end
context 'when the frozen string literal comment is true' do
let(:prefix) { '# frozen_string_literal: true' }
it_behaves_like 'immutable objects', '"#{a}"'
end
context 'when the frozen string literal comment is false' do
let(:prefix) { '# frozen_string_literal: false' }
it_behaves_like 'immutable objects', '"#{a}"'
end
end
end
context 'Ruby 3.0 or higher', :ruby30 do
context 'when the frozen string literal comment is missing' do
it_behaves_like 'mutable objects', '"#{a}"'
end
context 'when the frozen string literal comment is true' do
let(:prefix) { '# frozen_string_literal: true' }
it_behaves_like 'mutable objects', '"#{a}"'
it_behaves_like 'immutable objects', <<~'RUBY'
<<~HERE
foo
bar
HERE
RUBY
it 'registers an offense when using interpolated heredoc constant' do
expect_offense(<<~'RUBY')
# frozen_string_literal: true
CONST = <<~HERE
^^^^^^^ Freeze mutable objects assigned to constants.
foo #{use_interpolation}
bar
HERE
RUBY
end
end
context 'when the frozen string literal comment is false' do
let(:prefix) { '# frozen_string_literal: false' }
it_behaves_like 'mutable objects', '"#{a}"'
end
end
context 'Ruby 2.7 or lower', :ruby27 do
context 'when the frozen string literal comment is missing' do
it_behaves_like 'mutable objects', '"#{a}"'
end
context 'when the frozen string literal comment is true' do
let(:prefix) { '# frozen_string_literal: true' }
it_behaves_like 'immutable objects', '"#{a}"'
it_behaves_like 'immutable objects', <<~'RUBY'
<<~HERE
foo
bar
HERE
RUBY
it 'does not register an offense when using interpolated heredoc constant' do
expect_no_offenses(<<~'RUBY')
# frozen_string_literal: true
CONST = <<~HERE
foo #{use_interpolation}
bar
HERE
RUBY
end
end
context 'when the frozen string literal comment is false' do
let(:prefix) { '# frozen_string_literal: false' }
it_behaves_like 'mutable objects', '"#{a}"'
end
end
end
context 'Strict: false' do
let(:cop_config) { { 'EnforcedStyle' => 'literals' } }
it_behaves_like 'mutable objects', '[1, 2, 3]'
it_behaves_like 'mutable objects', '%w(a b c)'
it_behaves_like 'mutable objects', '{ a: 1, b: 2 }'
it_behaves_like 'mutable objects', "'str'"
it_behaves_like 'mutable objects', '"top#{1 + 2}"'
it_behaves_like 'immutable objects', '1'
it_behaves_like 'immutable objects', '1.5'
it_behaves_like 'immutable objects', ':sym'
it_behaves_like 'immutable objects', 'FOO + BAR'
it_behaves_like 'immutable objects', 'FOO - BAR'
it_behaves_like 'immutable objects', "'foo' + 'bar'"
it_behaves_like 'immutable objects', "ENV['foo']"
it_behaves_like 'immutable objects', "::ENV['foo']"
it 'allows method call assignments' do
expect_no_offenses('TOP_TEST = Something.new')
end
context 'splat expansion' do
context 'expansion of a range' do
it 'registers an offense and corrects to use to_a.freeze' do
expect_offense(<<~RUBY)
FOO = *1..10
^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
FOO = (1..10).to_a.freeze
RUBY
end
context 'with parentheses' do
it 'registers an offense and corrects to use to_a.freeze' do
expect_offense(<<~RUBY)
FOO = *(1..10)
^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
FOO = (1..10).to_a.freeze
RUBY
end
end
end
end
context 'when assigning an array without brackets' do
it 'adds brackets when auto-correcting' do
expect_offense(<<~RUBY)
XXX = YYY, ZZZ
^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = [YYY, ZZZ].freeze
RUBY
end
it 'does not insert brackets for %w() arrays' do
expect_offense(<<~RUBY)
XXX = %w(YYY ZZZ)
^^^^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = %w(YYY ZZZ).freeze
RUBY
end
end
# Ruby 3.0's Regexp and Range literals are frozen.
#
# https://bugs.ruby-lang.org/issues/15504
# https://bugs.ruby-lang.org/issues/16377
context 'Ruby 3.0 or higher', :ruby30 do
context 'when assigning a regexp' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
XXX = /regexp/
RUBY
end
end
context 'when assigning a range (irange)' do
it 'does not register an offense when without parenthesis' do
expect_no_offenses(<<~RUBY)
XXX = 1..99
RUBY
end
it 'does not register an offense when with parenthesis' do
expect_no_offenses(<<~RUBY)
XXX = (1..99)
RUBY
end
end
context 'when assigning a range (erange)' do
it 'does not register an offense when without parenthesis' do
expect_no_offenses(<<~RUBY)
XXX = 1...99
RUBY
end
it 'does not register an offense when with parenthesis' do
expect_no_offenses(<<~RUBY)
XXX = (1...99)
RUBY
end
end
context 'when using shareable_constant_value' do
it_behaves_like 'literals that are frozen', '# shareable_constant_value: literal'
it_behaves_like 'literals that are frozen', '# shareable_constant_value: experimental_everything'
it_behaves_like 'literals that are frozen', '# shareable_constant_value: experimental_copy'
it_behaves_like 'literals that are not frozen', '# shareable_constant_value: none'
end
it 'raises offense when shareable_constant_value is specified as an inline comment' do
expect_offense(<<~RUBY)
X = [1, 2, 3] # shareable_constant_value: literal
^^^^^^^^^ Freeze mutable objects assigned to constants.
Y = [4, 5, 6]
^^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
end
it 'raises offense only for shareable_constant_value as none when set in the order of: literal, none and experimental_everything' do
expect_offense(<<~RUBY)
# shareable_constant_value: literal
X = [1, 2, 3]
# shareable_constant_value: none
Y = [4, 5, 6]
^^^^^^^^^ Freeze mutable objects assigned to constants.
# shareable_constant_value: experimental_everything
Z = [7, 8, 9]
RUBY
end
end
context 'Ruby 2.7 or lower', :ruby27 do
context 'when assigning a regexp' do
it 'registers an offense' do
expect_offense(<<~RUBY)
XXX = /regexp/
^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = /regexp/.freeze
RUBY
end
end
context 'when assigning a range (irange) without parenthesis' do
it 'adds parenthesis when auto-correcting' do
expect_offense(<<~RUBY)
XXX = 1..99
^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = (1..99).freeze
RUBY
end
it 'does not insert parenthesis to range enclosed in parentheses' do
expect_offense(<<~RUBY)
XXX = (1..99)
^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = (1..99).freeze
RUBY
end
end
context 'when assigning a range (erange) without parenthesis' do
it 'adds parenthesis when auto-correcting' do
expect_offense(<<~RUBY)
XXX = 1...99
^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = (1...99).freeze
RUBY
end
it 'does not insert parenthesis to range enclosed in parentheses' do
expect_offense(<<~RUBY)
XXX = (1...99)
^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = (1...99).freeze
RUBY
end
end
context 'when using shareable_constant_values' do
it_behaves_like 'literals that are not frozen', '# shareable_constant_value: literal'
it_behaves_like 'literals that are not frozen', '# shareable_constant_value: experimental_everything'
it_behaves_like 'literals that are not frozen', '# shareable_constant_value: experimental_copy'
it_behaves_like 'literals that are not frozen', '# shareable_constant_value: none'
end
end
it_behaves_like 'string literal'
end
context 'Strict: true' do
let(:cop_config) { { 'EnforcedStyle' => 'strict' } }
it_behaves_like 'mutable objects', '[1, 2, 3]'
it_behaves_like 'mutable objects', '%w(a b c)'
it_behaves_like 'mutable objects', '{ a: 1, b: 2 }'
it_behaves_like 'mutable objects', "'str'"
it_behaves_like 'mutable objects', '"top#{1 + 2}"'
it_behaves_like 'mutable objects', 'Something.new'
it_behaves_like 'immutable objects', '1'
it_behaves_like 'immutable objects', '1.5'
it_behaves_like 'immutable objects', ':sym'
it_behaves_like 'immutable objects', "ENV['foo']"
it_behaves_like 'immutable objects', "::ENV['foo']"
it_behaves_like 'immutable objects', 'OTHER_CONST'
it_behaves_like 'immutable objects', '::OTHER_CONST'
it_behaves_like 'immutable objects', 'Namespace::OTHER_CONST'
it_behaves_like 'immutable objects', '::Namespace::OTHER_CONST'
it_behaves_like 'immutable objects', 'Struct.new'
it_behaves_like 'immutable objects', '::Struct.new'
it_behaves_like 'immutable objects', 'Struct.new(:a, :b)'
it_behaves_like 'immutable objects', <<~RUBY
Struct.new(:node) do
def assignment?
true
end
end
RUBY
it 'allows calls to freeze' do
expect_no_offenses(<<~RUBY)
CONST = [1].freeze
RUBY
end
context 'splat expansion' do
context 'expansion of a range' do
it 'registers an offense and corrects to use to_a.freeze' do
expect_offense(<<~RUBY)
FOO = *1..10
^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
FOO = (1..10).to_a.freeze
RUBY
end
context 'with parentheses' do
it 'registers an offense and corrects to use to_a.freeze' do
expect_offense(<<~RUBY)
FOO = *(1..10)
^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
FOO = (1..10).to_a.freeze
RUBY
end
end
end
end
context 'when assigning with an operator' do
shared_examples 'operator methods' do |o|
it 'registers an offense and corrects with parens and freeze' do
expect_offense(<<~RUBY, o: o)
CONST = FOO %{o} BAR
^^^^^{o}^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
CONST = (FOO #{o} BAR).freeze
RUBY
end
end
it_behaves_like 'operator methods', '+'
it_behaves_like 'operator methods', '-'
it_behaves_like 'operator methods', '*'
it_behaves_like 'operator methods', '/'
it_behaves_like 'operator methods', '%'
it_behaves_like 'operator methods', '**'
end
context 'when assigning with multiple operator calls' do
it 'registers an offense and corrects with parens and freeze' do
expect_offense(<<~RUBY)
FOO = [1].freeze
BAR = [2].freeze
BAZ = [3].freeze
CONST = FOO + BAR + BAZ
^^^^^^^^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
FOO = [1].freeze
BAR = [2].freeze
BAZ = [3].freeze
CONST = (FOO + BAR + BAZ).freeze
RUBY
end
end
context 'methods and operators that produce frozen objects' do
it 'accepts assigning to an environment variable with a fallback' do
expect_no_offenses(<<~RUBY)
CONST = ENV['foo'] || 'foo'
RUBY
expect_no_offenses(<<~RUBY)
CONST = ::ENV['foo'] || 'foo'
RUBY
end
it 'accepts operating on a constant and an interger' do
expect_no_offenses(<<~RUBY)
CONST = FOO + 2
RUBY
end
it 'accepts operating on multiple integers' do
expect_no_offenses(<<~RUBY)
CONST = 1 + 2
RUBY
end
it 'accepts operating on a constant and a float' do
expect_no_offenses(<<~RUBY)
CONST = FOO + 2.1
RUBY
end
it 'accepts operating on multiple floats' do
expect_no_offenses(<<~RUBY)
CONST = 1.2 + 2.1
RUBY
end
it 'accepts comparison operators' do
expect_no_offenses(<<~RUBY)
CONST = FOO == BAR
RUBY
end
it 'accepts checking fixed size' do
expect_no_offenses(<<~RUBY)
CONST = 'foo'.count
CONST = 'foo'.count('f')
CONST = [1, 2, 3].count { |n| n > 2 }
CONST = [1, 2, 3].count(2) { |n| n > 2 }
CONST = 'foo'.length
CONST = 'foo'.size
RUBY
end
end
context 'operators that produce unfrozen objects' do
it 'registers an offense when operating on a constant and a string' do
expect_offense(<<~RUBY)
CONST = FOO + 'bar'
^^^^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
CONST = (FOO + 'bar').freeze
RUBY
end
it 'registers an offense when operating on multiple strings' do
expect_offense(<<~RUBY)
CONST = 'foo' + 'bar' + 'baz'
^^^^^^^^^^^^^^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
CONST = ('foo' + 'bar' + 'baz').freeze
RUBY
end
end
context 'when assigning an array without brackets' do
it 'adds brackets when auto-correcting' do
expect_offense(<<~RUBY)
XXX = YYY, ZZZ
^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = [YYY, ZZZ].freeze
RUBY
end
it 'does not insert brackets for %w() arrays' do
expect_offense(<<~RUBY)
XXX = %w(YYY ZZZ)
^^^^^^^^^^^ Freeze mutable objects assigned to constants.
RUBY
expect_correction(<<~RUBY)
XXX = %w(YYY ZZZ).freeze
RUBY
end
end
it 'freezes a heredoc' do
expect_offense(<<~RUBY)
FOO = <<-HERE
^^^^^^^ Freeze mutable objects assigned to constants.
SOMETHING
HERE
RUBY
expect_correction(<<~RUBY)
FOO = <<-HERE.freeze
SOMETHING
HERE
RUBY
end
it_behaves_like 'string literal'
end
end