/
described_class_spec.rb
362 lines (312 loc) · 9.18 KB
/
described_class_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::RSpec::DescribedClass do
let(:cop_config) { {} }
context 'when SkipBlocks is `true`' do
let(:cop_config) { { 'SkipBlocks' => true } }
it 'ignores violations within non-rspec blocks' do
expect_offense(<<-RUBY)
describe MyClass do
controller(ApplicationController) do
bar = MyClass
end
before do
MyClass
^^^^^^^ Use `described_class` instead of `MyClass`.
Foo.custom_block do
MyClass
end
end
end
RUBY
end
end
context 'when SkipBlocks is `false`' do
it 'flags violations within all blocks' do
expect_offense(<<-RUBY)
describe MyClass do
controller(ApplicationController) do
bar = MyClass
^^^^^^^ Use `described_class` instead of `MyClass`.
end
before do
MyClass
^^^^^^^ Use `described_class` instead of `MyClass`.
Foo.custom_block do
MyClass
^^^^^^^ Use `described_class` instead of `MyClass`.
end
end
end
RUBY
end
end
context 'when EnforcedStyle is :described_class' do
let(:cop_config) { { 'EnforcedStyle' => :described_class } }
it 'flags for the use of the described class' do
expect_offense(<<-RUBY)
describe MyClass do
include MyClass
^^^^^^^ Use `described_class` instead of `MyClass`.
subject { MyClass.do_something }
^^^^^^^ Use `described_class` instead of `MyClass`.
before { MyClass.do_something }
^^^^^^^ Use `described_class` instead of `MyClass`.
end
RUBY
expect_correction(<<-RUBY)
describe MyClass do
include described_class
subject { described_class.do_something }
before { described_class.do_something }
end
RUBY
end
it 'flags with metadata' do
expect_offense(<<-RUBY)
describe MyClass, some: :metadata do
subject { MyClass }
^^^^^^^ Use `described_class` instead of `MyClass`.
end
RUBY
end
it 'ignores described class as string' do
expect_no_offenses(<<-RUBY)
describe MyClass do
subject { "MyClass" }
end
RUBY
end
it 'ignores describe that do not reference to a class' do
expect_no_offenses(<<-RUBY)
describe "MyClass" do
subject { "MyClass" }
end
RUBY
end
it 'ignores class if the scope is changing' do
expect_no_offenses(<<-RUBY)
describe MyClass do
Class.new { foo = MyClass }
Module.new { bar = MyClass }
Struct.new { lol = MyClass }
def method
include MyClass
end
class OtherClass
include MyClass
end
module MyModule
include MyClass
end
end
RUBY
end
it 'takes class from innermost describe' do
expect_offense(<<-RUBY)
describe MyClass do
describe MyClass::Foo do
subject { MyClass::Foo }
^^^^^^^^^^^^ Use `described_class` instead of `MyClass::Foo`.
let(:foo) { MyClass }
end
end
RUBY
end
it 'ignores subclasses' do
expect_no_offenses(<<-RUBY)
describe MyClass do
subject { MyClass::SubClass }
end
RUBY
end
it 'ignores non-matching namespace defined on `describe` level' do
expect_no_offenses(<<-RUBY)
describe MyNamespace::MyClass do
subject { ::MyClass }
let(:foo) { MyClass }
end
RUBY
end
it 'ignores non-matching namespace' do
expect_no_offenses(<<-RUBY)
module MyNamespace
describe MyClass do
subject { ::MyClass }
end
end
RUBY
end
it 'flags the use of described class with namespace' do
expect_offense(<<-RUBY)
describe MyNamespace::MyClass do
subject { MyNamespace::MyClass }
^^^^^^^^^^^^^^^^^^^^ Use `described_class` instead of `MyNamespace::MyClass`.
end
RUBY
end
it 'ignores non-matching namespace in usages' do
expect_no_offenses(<<-RUBY)
module UnrelatedNamespace
describe MyClass do
subject { MyNamespace::MyClass }
end
end
RUBY
end
it 'ignores violations within a class scope change' do
expect_no_offenses(<<-RUBY)
describe MyNamespace::MyClass do
before do
class Foo
thing = MyNamespace::MyClass.new
end
end
end
RUBY
end
it 'ignores violations within a hook scope change' do
expect_no_offenses(<<-RUBY)
describe do
before do
MyNamespace::MyClass.new
end
end
RUBY
end
it 'flags the use of described class with module' do
expect_offense(<<-RUBY)
module MyNamespace
describe MyClass do
subject { MyNamespace::MyClass }
^^^^^^^^^^^^^^^^^^^^ Use `described_class` instead of `MyNamespace::MyClass`.
end
end
RUBY
expect_correction(<<-RUBY)
module MyNamespace
describe MyClass do
subject { described_class }
end
end
RUBY
end
it 'flags the use of described class with nested namespace' do
expect_offense(<<-RUBY)
module A
class B::C
module D
describe E do
subject { A::B::C::D::E }
^^^^^^^^^^^^^ Use `described_class` instead of `A::B::C::D::E`.
let(:one) { B::C::D::E }
^^^^^^^^^^ Use `described_class` instead of `B::C::D::E`.
let(:two) { C::D::E }
^^^^^^^ Use `described_class` instead of `C::D::E`.
let(:six) { D::E }
^^^^ Use `described_class` instead of `D::E`.
let(:ten) { E }
^ Use `described_class` instead of `E`.
end
end
end
end
RUBY
end
it 'accepts an empty block' do
expect_no_offenses(<<-RUBY)
describe MyClass do
end
RUBY
end
it 'ignores if a local variable is part of the namespace' do
expect_no_offenses(<<-RUBY)
describe Broken do
[Foo, Bar].each do |klass|
describe klass::Baz.name do
it { }
end
end
end
RUBY
end
it 'ignores if `described_class` is a part of the constant' do
expect_no_offenses(<<-RUBY)
module SomeGem
describe VERSION do
it 'returns proper version string' do
expect(described_class::STRING).to eq('1.1.1')
end
end
end
RUBY
end
end
context 'when EnforcedStyle is :explicit' do
let(:cop_config) { { 'EnforcedStyle' => :explicit } }
it 'flags the use of the described_class' do
expect_offense(<<-RUBY)
describe MyClass do
include described_class
^^^^^^^^^^^^^^^ Use `MyClass` instead of `described_class`.
subject { described_class.do_something }
^^^^^^^^^^^^^^^ Use `MyClass` instead of `described_class`.
before { described_class.do_something }
^^^^^^^^^^^^^^^ Use `MyClass` instead of `described_class`.
end
RUBY
expect_correction(<<-RUBY)
describe MyClass do
include MyClass
subject { MyClass.do_something }
before { MyClass.do_something }
end
RUBY
end
it 'ignores described_class as string' do
expect_no_offenses(<<-RUBY)
describe MyClass do
subject { "described_class" }
end
RUBY
end
it 'ignores describe that do not reference to a class' do
expect_no_offenses(<<-RUBY)
describe "MyClass" do
subject { described_class }
end
RUBY
end
it 'ignores violations within a class scope change' do
expect_no_offenses(<<-RUBY)
describe MyNamespace::MyClass do
before do
class Foo
thing = described_class.new
end
end
end
RUBY
end
it 'ignores violations within a hook scope change' do
expect_no_offenses(<<-RUBY)
describe do
before do
described_class.new
end
end
RUBY
end
it 'autocorrects corresponding' do
expect_offense(<<-RUBY)
describe(Foo) { include described_class }
^^^^^^^^^^^^^^^ Use `Foo` instead of `described_class`.
describe(Bar) { include described_class }
^^^^^^^^^^^^^^^ Use `Bar` instead of `described_class`.
RUBY
expect_correction(<<-RUBY)
describe(Foo) { include Foo }
describe(Bar) { include Bar }
RUBY
end
end
end