forked from rubocop/rubocop-rails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
deprecated_active_model_errors_methods_spec.rb
378 lines (321 loc) · 11.6 KB
/
deprecated_active_model_errors_methods_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Rails::DeprecatedActiveModelErrorsMethods, :config do
shared_examples 'errors call with explicit receiver' do
context 'when accessing errors' do
it 'registers and corrects an offense' do
expect_offense(<<~RUBY, file_path)
user.errors[:name] << 'msg'
^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user.errors.add(:name, 'msg')
RUBY
end
context 'when assigning' do
it 'registers an offense' do
expect_offense(<<~RUBY, file_path)
user.errors[:name] = []
^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_no_corrections
end
end
context 'when using `clear` method' do
it 'registers and corrects an offense' do
expect_offense(<<~RUBY, file_path)
user.errors[:name].clear
^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user.errors.delete(:name)
RUBY
end
end
context 'Rails >= 6.1', :rails61 do
context 'when using `keys` method' do
it 'registers and corrects an offense when root receiver is a variable' do
expect_offense(<<~RUBY, file_path)
user = create_user
user.errors.keys
^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user = create_user
user.errors.attribute_names
RUBY
end
it 'registers and corrects an offense when root receiver is a method' do
expect_offense(<<~RUBY, file_path)
user.errors.keys.include?(:name)
^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user.errors.attribute_names.include?(:name)
RUBY
end
end
end
context 'Rails <= 6.0', :rails60 do
context 'when using `keys` method' do
it 'does not register an offense when root receiver is a variable' do
expect_no_offenses(<<~RUBY, file_path)
user = create_user
user.errors.keys
RUBY
end
it 'does not register an offense when root receiver is a method' do
expect_no_offenses(<<~RUBY, file_path)
user.errors.keys.include?(:name)
RUBY
end
end
end
end
context 'when modifying errors.messages' do
it 'registers and corrects an offense' do
expect_offense(<<~RUBY, file_path)
user.errors.messages[:name] << 'msg'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user.errors.add(:name, 'msg')
RUBY
end
context 'when assigning' do
it 'registers an offense' do
expect_offense(<<~RUBY, file_path)
user.errors.messages[:name] = []
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_no_corrections
end
end
context 'when using `clear` method' do
it 'registers and corrects an offense' do
expect_offense(<<~RUBY, file_path)
user.errors.messages[:name].clear
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user.errors.delete(:name)
RUBY
end
end
context 'when calling non-manipulative methods' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.messages[:name].present?
RUBY
end
end
end
context 'when modifying errors.details' do
it 'registers an offense' do
expect_offense(<<~RUBY, file_path)
user.errors.details[:name] << {}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
end
context 'when assigning' do
it 'registers an offense' do
expect_offense(<<~RUBY, file_path)
user.errors.details[:name] = []
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_no_corrections
end
end
context 'when using `clear` method' do
it 'registers and corrects an offense' do
expect_offense(<<~RUBY, file_path)
user.errors.details[:name].clear
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction(<<~RUBY)
user.errors.delete(:name)
RUBY
end
end
context 'when calling non-manipulative methods' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.details[:name].present?
RUBY
end
end
end
end
shared_examples 'errors call without explicit receiver' do
def expect_offense_if_model_file(code, file_path)
if file_path.include?('/models/')
expect_offense(code, file_path)
else
code = code.gsub(/^\^+ .+$/, '')
expect_no_offenses(code, file_path)
end
end
def expect_correction_if_model_file(code, file_path)
expect_correction(code) if file_path.include?('/models/')
end
def expect_no_corrections_if_model_file(file_path)
expect_no_corrections if file_path.include?('/models/')
end
context 'when accessing errors' do
it 'registers an offense for model file' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors[:name] << 'msg'
^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction_if_model_file(<<~RUBY, file_path)
errors.add(:name, 'msg')
RUBY
end
context 'when assigning' do
it 'registers an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors[:name] = []
^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_no_corrections_if_model_file(file_path)
end
end
context 'when using `clear` method' do
it 'registers and corrects an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors[:name].clear
^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction_if_model_file(<<~RUBY, file_path)
errors.delete(:name)
RUBY
end
end
context 'Rails >= 6.1', :rails61 do
context 'when using `keys` method' do
it 'registers and corrects an offense when root receiver is a variable' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.keys
^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction_if_model_file(<<~RUBY, file_path)
errors.attribute_names
RUBY
end
end
end
context 'Rails <= 6.0', :rails60 do
context 'when using `keys` method' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.keys
RUBY
end
end
end
context 'when calling non-manipulative methods' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors[:name].present?
RUBY
end
end
end
context 'when modifying errors.messages' do
it 'registers an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.messages[:name] << 'msg'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction_if_model_file(<<~RUBY, file_path)
errors.add(:name, 'msg')
RUBY
end
context 'when assigning' do
it 'registers an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.messages[:name] = []
^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_no_corrections_if_model_file(file_path)
end
end
context 'when using `clear` method' do
it 'registers and corrects an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.messages[:name].clear
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction_if_model_file(<<~RUBY, file_path)
errors.delete(:name)
RUBY
end
end
context 'when using `keys` method' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.messages[:name].keys
RUBY
end
end
context 'when calling non-manipulative methods' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.messages[:name].present?
RUBY
end
end
end
context 'when modifying errors.details' do
it 'registers an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.details[:name] << {}
^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
end
context 'when assigning' do
it 'registers an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.details[:name] = []
^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_no_corrections_if_model_file(file_path)
end
end
context 'when using `clear` method' do
it 'registers and corrects an offense' do
expect_offense_if_model_file(<<~RUBY, file_path)
errors.details[:name].clear
^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid manipulating ActiveModel errors as hash directly.
RUBY
expect_correction_if_model_file(<<~RUBY, file_path)
errors.delete(:name)
RUBY
end
end
context 'when using `keys` method' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.details[:name].keys
RUBY
end
end
context 'when calling non-manipulative methods' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, file_path)
errors.details[:name].present?
RUBY
end
end
end
end
context 'when file is model file' do
let(:file_path) { '/foo/app/models/bar.rb' }
it_behaves_like 'errors call with explicit receiver'
it_behaves_like 'errors call without explicit receiver'
end
context 'when file is generic' do
let(:file_path) { '/foo/app/lib/bar.rb' }
it_behaves_like 'errors call with explicit receiver'
it_behaves_like 'errors call without explicit receiver'
end
end