/
save_bang_spec.rb
582 lines (487 loc) · 16.8 KB
/
save_bang_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Rails::SaveBang, :config do
subject(:cop) { described_class.new(config) }
let(:cop_config) { { 'AllowImplicitReturn' => true } }
shared_examples 'checks_common_offense' do |method|
it "when using #{method} with arguments" do
inspect_source("object.#{method}(name: 'Tom', age: 20)")
if method == :destroy
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
end
it "when using #{method} with variable arguments" do
inspect_source("object.#{method}(variable)")
if method == :destroy
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
end
it "when using #{method} with variable star arguments" do
inspect_source("object.#{method}(*variable)")
if method == :destroy
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
end
it "when using #{method} with variable star star arguments" do
inspect_source("object.#{method}(**variable)")
if method == :destroy
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
end
it "when using #{method} without arguments" do
inspect_source(method.to_s)
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
it "when using #{method} without arguments" do
inspect_source("object&.#{method}")
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
it "when using #{method}!" do
expect_no_offenses("object.#{method}!")
end
it "when using #{method} with 2 arguments" do
expect_no_offenses("Model.#{method}(1, name: 'Tom')")
end
it "when using #{method} with wrong argument" do
expect_no_offenses("object.#{method}('Tom')")
end
it 'autocorrects' do
new_source = autocorrect_source("object.#{method}()")
expect(new_source).to eq("object.#{method}!()")
end
it 'autocorrects' do
new_source = autocorrect_source("object&.#{method}()")
expect(new_source).to eq("object&.#{method}!()")
end
end
shared_examples 'checks_variable_return_use_offense' do |method, update|
it "when assigning the return value of #{method}" do
inspect_source("x = object.#{method}\n")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.' \
" Or check `persisted?` on model returned from `#{method}`."])
end
end
it "when assigning the return value of #{method} with block" do
inspect_source("x = object.#{method} do |obj|\n" \
" obj.name = 'Tom'\n" \
'end')
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.' \
" Or check `persisted?` on model returned from `#{method}`."])
end
end
it "when using #{method} with if" do
inspect_source("if object.#{method}; something; end")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with if with method chain" do
inspect_source(<<~RUBY)
if object.tap(&:prepare_for_save).#{method}
something
end
RUBY
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with if with block" do
inspect_source(<<~RUBY)
if object.#{method} { |o| o.name = 'Tom' }
something
end
RUBY
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with referenced block" do
inspect_source("if object.#{method}(&:values); something; end")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with negated if" do
inspect_source("if !object.#{method}; something; end")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with multiple conditional" do
inspect_source(<<~RUBY)
if true && object.active? && object.#{method}
something
end
RUBY
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with oneline if" do
inspect_source("something if object.#{method}")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with oneline if and multiple conditional" do
inspect_source("something if false || object.#{method}")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with a bunch of hashes & arrays" do
inspect_source(<<~RUBY)
return [{ success: object.#{method} }, true]
RUBY
expect(cop.messages.empty?).to be(true)
end
it "when using #{method} with case statement" do
inspect_source(<<~RUBY)
case object.#{method}
when true
puts "true"
when false
puts "false"
end
RUBY
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with '&&'" do
inspect_source("object.#{method} && false")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with 'and'" do
inspect_source("object.#{method} and false")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it "when using #{method} with '||'" do
inspect_source("object.#{method} || false")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it 'when passing to a method' do
expect_no_offenses("handle_save(object.#{method})")
end
it 'when passing to a method as the non-last argument' do
expect_no_offenses("handle_save(object.#{method}, true)")
end
it "when using #{method} with 'or'" do
inspect_source("object.#{method} or false")
if update
expect(cop.messages.empty?).to be(true)
else
expect(cop.messages)
.to eq(["`#{method}` returns a model which is always truthy."])
end
end
it 'when passing to a method as a keyword argument' do
expect_no_offenses("handle_save(success: object.#{method})")
end
it 'when assigning as a hash value' do
expect_no_offenses("result = { success: object.#{method} }")
end
it 'when using an explicit early return' do
expect_no_offenses(<<~RUBY)
def foo
return foo.#{method} if do_the_save
do_something_else
end
RUBY
end
it 'when using an explicit final return' do
expect_no_offenses(<<~RUBY)
def foo
return foo.#{method}
end
RUBY
end
it 'when using an explicit early return from a block' do
expect_no_offenses(<<~RUBY)
objects.each do |object|
next object.#{method} if do_the_save
do_something_else
end
RUBY
end
it 'when using an explicit final return from a block' do
expect_no_offenses(<<~RUBY)
objects.each do |object|
next foo.#{method}
end
RUBY
end
it 'when using an allowed variable receiver' do
cop_config['AllowedReceivers'] = ['gateway']
expect_no_offenses(<<~RUBY)
gateway = true
gateway.#{method}
gateway.#{method} { |t| t.name = 'Tom' }
merchant.gateway = true
merchant.gateway.#{method}
merchant.gateway.#{method} { |t| t.name = 'Tom' }
RUBY
end
it 'when using an allowed method receiver' do
cop_config['AllowedReceivers'] = ['customer']
expect_no_offenses(<<~RUBY)
customer.#{method}
merchant.customer.#{method}
customer(true).#{method}
merchant.customer(true).#{method}
customer.#{method} { |t| t.name = 'Tom' }
merchant.customer.#{method} { |t| t.name = 'Tom' }
RUBY
end
it 'when using an allowed const receiver' do
cop_config['AllowedReceivers'] = ['NonActiveRecord']
expect_no_offenses(<<~RUBY)
NonActiveRecord.#{method}
NameSpace::NonActiveRecord.#{method}
::NonActiveRecord.#{method}
NonActiveRecord::#{method}
RUBY
end
it 'when using an allowed namespaced const receiver' do
cop_config['AllowedReceivers'] = ['NameSpace::NonActiveRecord']
expect_no_offenses(<<~RUBY)
NameSpace::NonActiveRecord.#{method}
::NameSpace::NonActiveRecord.#{method}
NameSpace::NonActiveRecord::#{method}
RUBY
end
it 'when using only part of an allowed namespaced const receiver' do
cop_config['AllowedReceivers'] = ['NameSpace::NonActiveRecord']
inspect_source(<<~RUBY)
NonActiveRecord.#{method}
RUBY
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
it 'when using a namespaced const with an allowed absolute const' do
cop_config['AllowedReceivers'] = ['::NonActiveRecord']
inspect_source(<<~RUBY)
NameSpace::NonActiveRecord.#{method}
RUBY
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
it 'when using an allowed method chain receiver' do
cop_config['AllowedReceivers'] = ['merchant.gateway']
expect_no_offenses(<<~RUBY)
merchant.gateway.#{method}
RUBY
end
it 'when using only part of an allowed method chain receiver' do
cop_config['AllowedReceivers'] = ['merchant.gateway']
inspect_source(<<~RUBY)
gateway.#{method}
RUBY
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
it 'when using an allowed class and method receiver' do
cop_config['AllowedReceivers'] = ['A::B.merchant.gateway']
expect_no_offenses(<<~RUBY)
A::B.merchant.gateway.#{method}
A::B::merchant::gateway::#{method}
RUBY
end
it 'when using only part of an allowed class and method receiver' do
cop_config['AllowedReceivers'] = ['A::B.merchant.gateway']
inspect_source(<<~RUBY)
B.merchant.#{method}
RUBY
expect(cop.messages)
.to eq(["Use `#{method}!` instead of `#{method}` " \
'if the return value is not checked.'])
end
# Bug: https://github.com/rubocop-hq/rubocop/issues/4264
it 'when using the assigned variable as value in a hash' do
inspect_source(<<~RUBY)
def foo
foo = Foo.#{method}
render json: foo
end
RUBY
if update
expect(cop.offenses.empty?).to be(true)
else
expect(cop.offenses.size).to eq(1)
end
end
end
shared_examples 'check_implicit_return' do |method, allow_implicit_return|
it "when using #{method} as last method call" do
inspect_source(<<~RUBY)
def foo
object.#{method}
end
RUBY
if allow_implicit_return
expect(cop.offenses.empty?).to be true
else
expect(cop.messages)
.to match_array(start_with("Use `#{method}!` instead of `#{method}`" \
' if the return value is not checked.'))
end
end
it "when using #{method} as last method call of a block" do
inspect_source(<<~RUBY)
objects.each do |object|
object.#{method}
end
RUBY
if allow_implicit_return
expect(cop.offenses.empty?).to be true
else
expect(cop.messages)
.to match_array(start_with("Use `#{method}!` instead of `#{method}`" \
' if the return value is not checked.'))
end
end
it "when using #{method} as part of the last line" do
inspect_source(<<~RUBY)
def whatever
[{ success: object.#{method} }, true]
end
RUBY
if allow_implicit_return
expect(cop.offenses.empty?).to be true
else
expect(cop.messages)
.to match_array(start_with("Use `#{method}!` instead of `#{method}`" \
' if the return value is not checked.'))
end
end
end
described_class::MODIFY_PERSIST_METHODS.each do |method|
context method.to_s do
let(:cop_config) { { 'AllowImplicitReturn' => true } }
it_behaves_like('checks_common_offense', method)
it_behaves_like('checks_variable_return_use_offense', method, true)
it_behaves_like('check_implicit_return', method, true)
context 'with AllowImplicitReturn false' do
let(:cop_config) { { 'AllowImplicitReturn' => false } }
it_behaves_like('checks_variable_return_use_offense', method, true)
it_behaves_like('check_implicit_return', method, false)
end
end
end
shared_examples 'checks_create_offense' do |method|
it "when using persisted? after #{method}" do
expect_no_offenses("x = object.#{method}\n" \
'if x.persisted? then; something; end')
end
it "when using persisted? after #{method} with block" do
expect_no_offenses("x = object.#{method} do |obj|\n" \
" obj.name = 'Tom'\n" \
"end\n" \
'if x.persisted? then; something; end')
end
it "when using persisted? after #{method} called on a chain" do
expect_no_offenses(<<~RUBY)
x = User.unverified.with_initial_values.#{method}
if x.persisted?; something; end
RUBY
end
it "when using #{method} with `||`" do
expect_no_offenses(<<~RUBY)
def find_or_create(**opts)
find(**opts) || #{method}(**opts)
end
RUBY
end
end
described_class::CREATE_PERSIST_METHODS.each do |method|
context method.to_s do
let(:cop_config) { { 'AllowImplicitReturn' => true } }
it_behaves_like('checks_common_offense', method)
it_behaves_like('checks_variable_return_use_offense', method, false)
it_behaves_like('checks_create_offense', method)
it_behaves_like('check_implicit_return', method, true)
context 'with AllowImplicitReturn false' do
let(:cop_config) { { 'AllowImplicitReturn' => false } }
it_behaves_like('checks_variable_return_use_offense', method, false)
it_behaves_like('check_implicit_return', method, false)
end
end
end
it 'properly ignores lvasign without right hand side' do
expect_no_offenses('variable += 1')
end
end