forked from rubocop/rubocop
-
Notifications
You must be signed in to change notification settings - Fork 2
/
rescued_exceptions_variable_name_spec.rb
538 lines (489 loc) · 13.3 KB
/
rescued_exceptions_variable_name_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Naming::RescuedExceptionsVariableName, :config do
context 'with default config' do
context 'with explicit rescue' do
context 'with `Exception` variable' do
it 'registers an offense when using `exc`' do
expect_offense(<<~RUBY)
begin
something
rescue MyException => exc
^^^ Use `e` instead of `exc`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue MyException => e
# do something
end
RUBY
end
it 'registers an offense when using `_exc`' do
expect_offense(<<~RUBY)
begin
something
rescue MyException => _exc
^^^^ Use `_e` instead of `_exc`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue MyException => _e
# do something
end
RUBY
end
it 'registers an offense when using `exc` and renames its usage' do
expect_offense(<<~RUBY)
begin
something
rescue MyException => exc
^^^ Use `e` instead of `exc`.
exc
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue MyException => e
e
end
RUBY
end
it 'registers offenses when using `foo` and `bar` ' \
'in multiple rescues' do
expect_offense(<<~RUBY)
begin
something
rescue FooException => foo
^^^ Use `e` instead of `foo`.
# do something
rescue BarException => bar
^^^ Use `e` instead of `bar`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue FooException => e
# do something
rescue BarException => e
# do something
end
RUBY
end
it 'does not register an offense when using `e`' do
expect_no_offenses(<<~RUBY)
begin
something
rescue MyException => e
# do something
end
RUBY
end
it 'does not register an offense when using `_e`' do
expect_no_offenses(<<~RUBY)
begin
something
rescue MyException => _e
# do something
end
RUBY
end
it 'does not register an offense when using _e followed by e' do
expect_no_offenses(<<~RUBY)
begin
something
rescue MyException => _e
# do something
rescue AnotherException => e
# do something
end
RUBY
end
end
context 'without `Exception` variable' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
begin
something
rescue MyException
# do something
end
RUBY
end
end
context 'with lower letters class name' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
begin
something
rescue my_exception
# do something
end
RUBY
end
end
context 'with method as `Exception`' do
it 'does not register an offense without variable name' do
expect_no_offenses(<<~RUBY)
begin
something
rescue ActiveSupport::JSON.my_method
# do something
end
RUBY
end
it 'does not register an offense with expected variable name' do
expect_no_offenses(<<~RUBY)
begin
something
rescue ActiveSupport::JSON.my_method => e
# do something
end
RUBY
end
it 'registers an offense with unexpected variable name' do
expect_offense(<<~RUBY)
begin
something
rescue ActiveSupport::JSON.my_method => exc
^^^ Use `e` instead of `exc`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue ActiveSupport::JSON.my_method => e
# do something
end
RUBY
end
end
context 'with splat operator as `Exception` list' do
it 'does not register an offense without variable name' do
expect_no_offenses(<<~RUBY)
begin
something
rescue *handled
# do something
end
RUBY
end
it 'does not register an offense with expected variable name' do
expect_no_offenses(<<~RUBY)
begin
something
rescue *handled => e
# do something
end
RUBY
end
it 'registers an offense with unexpected variable name' do
expect_offense(<<~RUBY)
begin
something
rescue *handled => exc
^^^ Use `e` instead of `exc`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue *handled => e
# do something
end
RUBY
end
end
end
context 'with implicit rescue' do
context 'with `Exception` variable' do
it 'registers an offense when using `exc`' do
expect_offense(<<~RUBY)
begin
something
rescue => exc
^^^ Use `e` instead of `exc`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue => e
# do something
end
RUBY
end
it 'registers an offense when using `_exc`' do
expect_offense(<<~RUBY)
begin
something
rescue => _exc
^^^^ Use `_e` instead of `_exc`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue => _e
# do something
end
RUBY
end
it 'does not register an offense when using `e`' do
expect_no_offenses(<<~RUBY)
begin
something
rescue => e
# do something
end
RUBY
end
it 'does not register an offense when using `_e`' do
expect_no_offenses(<<~RUBY)
begin
something
rescue => _e
# do something
end
RUBY
end
end
context 'without `Exception` variable' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
begin
something
rescue
# do something
end
RUBY
end
end
end
context 'with variable being referenced' do
it 'renames the variable references when auto-correcting' do
expect_offense(<<~RUBY)
begin
get something
rescue ActiveResource::Redirection => redirection
^^^^^^^^^^^ Use `e` instead of `redirection`.
redirect_to redirection.response['Location']
end
RUBY
expect_correction(<<~RUBY)
begin
get something
rescue ActiveResource::Redirection => e
redirect_to e.response['Location']
end
RUBY
end
end
context 'when the variable is reassigned' do
it 'only corrects uses of the exception' do
expect_offense(<<~RUBY)
def main
raise
rescue StandardError => error
^^^^^ Use `e` instead of `error`.
error = {
error_message: error.message
}
puts error
end
RUBY
expect_correction(<<~RUBY)
def main
raise
rescue StandardError => e
error = {
error_message: e.message
}
puts error
end
RUBY
end
it 'only corrects the exception variable' do
expect_offense(<<~RUBY)
def main
raise
rescue StandardError => error
^^^^^ Use `e` instead of `error`.
message = error.message
puts message
end
RUBY
expect_correction(<<~RUBY)
def main
raise
rescue StandardError => e
message = e.message
puts message
end
RUBY
end
end
context 'when the variable is reassigned using multiple assignment' do
it 'only corrects uses of the exception' do
expect_offense(<<~RUBY)
def main
raise
rescue StandardError => error
^^^^^ Use `e` instead of `error`.
error, foo = 1, error
puts error
end
RUBY
expect_correction(<<~RUBY)
def main
raise
rescue StandardError => e
error, foo = 1, e
puts error
end
RUBY
end
end
context 'with multiple branches' do
it 'registers and corrects each offense' do
expect_offense(<<~RUBY)
begin
something
rescue MyException => exc
^^^ Use `e` instead of `exc`.
# do something
rescue OtherException => exc
^^^ Use `e` instead of `exc`.
# do something else
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue MyException => e
# do something
rescue OtherException => e
# do something else
end
RUBY
end
end
context 'with nested rescues' do
it 'handles it' do
expect_offense(<<~RUBY)
begin
rescue StandardError => e1
^^ Use `e` instead of `e1`.
begin
log(e1)
rescue StandardError => e2
log(e1, e2)
end
end
RUBY
expect_correction(<<~RUBY)
begin
rescue StandardError => e
begin
log(e)
rescue StandardError => e2
log(e, e2)
end
end
RUBY
end
end
end
context 'with the `PreferredName` setup' do
let(:cop_config) do
{
'PreferredName' => 'exception'
}
end
it 'registers an offense when using `e`' do
expect_offense(<<~RUBY)
begin
something
rescue MyException => e
^ Use `exception` instead of `e`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue MyException => exception
# do something
end
RUBY
end
it 'registers an offense when using `_e`' do
expect_offense(<<~RUBY)
begin
something
rescue MyException => _e
^^ Use `_exception` instead of `_e`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue MyException => _exception
# do something
end
RUBY
end
it 'registers offenses when using `foo` and `bar` in multiple rescues' do
expect_offense(<<~RUBY)
begin
something
rescue FooException => foo
^^^ Use `exception` instead of `foo`.
# do something
rescue BarException => bar
^^^ Use `exception` instead of `bar`.
# do something
end
RUBY
expect_correction(<<~RUBY)
begin
something
rescue FooException => exception
# do something
rescue BarException => exception
# do something
end
RUBY
end
it 'does not register an offense when using `exception`' do
expect_no_offenses(<<~RUBY)
begin
something
rescue MyException => exception
# do something
end
RUBY
end
it 'does not register an offense when using `_exception`' do
expect_no_offenses(<<~RUBY)
begin
something
rescue MyException => _exception
# do something
end
RUBY
end
end
end