/
empty_lines_around_access_modifier_spec.rb
415 lines (346 loc) · 9.99 KB
/
empty_lines_around_access_modifier_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Layout::EmptyLinesAroundAccessModifier, :config do
context 'EnforcedStyle is `around`' do
let(:cop_config) { { 'EnforcedStyle' => 'around' } }
%w[private protected public module_function].each do |access_modifier|
it "requires blank line before #{access_modifier}" do
expect_offense(<<~RUBY)
class Test
something
#{access_modifier}
#{'^' * access_modifier.size} Keep a blank line before and after `#{access_modifier}`.
def test; end
end
RUBY
expect_correction(<<~RUBY)
class Test
something
#{access_modifier}
def test; end
end
RUBY
end
it "requires blank line after #{access_modifier}" do
expect_offense(<<~RUBY)
class Test
something
#{access_modifier}
#{'^' * access_modifier.size} Keep a blank line before and after `#{access_modifier}`.
def test; end
end
RUBY
expect_correction(<<~RUBY)
class Test
something
#{access_modifier}
def test; end
end
RUBY
end
it "ignores comment line before #{access_modifier}" do
expect_no_offenses(<<~RUBY)
class Test
something
# This comment is fine
#{access_modifier}
def test; end
end
RUBY
end
it "ignores #{access_modifier} inside a method call" do
expect_no_offenses(<<~RUBY)
class Test
def #{access_modifier}?
#{access_modifier}
end
end
RUBY
end
it "ignores an accessor with the same name as #{access_modifier} " \
'above a method definition' do
expect_no_offenses(<<~RUBY)
class Test
attr_reader #{access_modifier}
def foo
end
end
RUBY
end
it "ignores #{access_modifier} deep inside a method call" do
expect_no_offenses(<<~RUBY)
class Test
def #{access_modifier}?
if true
#{access_modifier}
end
end
end
RUBY
end
it "ignores #{access_modifier} with a right-hand-side condition" do
expect_no_offenses(<<~RUBY)
class Test
def #{access_modifier}?
#{access_modifier} if true
end
end
RUBY
end
it "ignores #{access_modifier} with block argument" do
expect_no_offenses(<<~RUBY)
def foo
#{access_modifier} { do_something }
end
RUBY
end
it 'autocorrects blank line after #{access_modifier} with comment' do
expect_offense(<<~RUBY)
class Test
something
#{access_modifier} # let's modify the rest
#{'^' * access_modifier.size} Keep a blank line before and after `#{access_modifier}`.
def test; end
end
RUBY
expect_correction(<<~RUBY)
class Test
something
#{access_modifier} # let's modify the rest
def test; end
end
RUBY
end
it 'accepts missing blank line when at the beginning of class' do
expect_no_offenses(<<~RUBY)
class Test
#{access_modifier}
def test; end
end
RUBY
end
it 'accepts missing blank line when at the beginning of module' do
expect_no_offenses(<<~RUBY)
module Test
#{access_modifier}
def test; end
end
RUBY
end
it 'accepts missing blank line when at the beginning of sclass' do
expect_no_offenses(<<~RUBY)
class << self
#{access_modifier}
def test; end
end
RUBY
end
it 'accepts missing blank line when specifying a superclass ' \
'that breaks the line' do
expect_no_offenses(<<~RUBY)
class Foo <
Bar
#{access_modifier}
def do_something
end
end
RUBY
end
it 'accepts missing blank line when specifying `self` ' \
'that breaks the line' do
expect_no_offenses(<<~RUBY)
class <<
self
#{access_modifier}
def do_something
end
end
RUBY
end
it 'accepts missing blank line when at the beginning of file' \
'when specifying a superclass that breaks the line' do
expect_no_offenses(<<~RUBY)
#{access_modifier}
def do_something
end
RUBY
end
it "requires blank line after, but not before, #{access_modifier} " \
'when at the beginning of class/module' do
expect_offense(<<~RUBY)
class Test
#{access_modifier}
#{'^' * access_modifier.size} Keep a blank line after `#{access_modifier}`.
def test
end
end
RUBY
end
context 'at the beginning of block' do
context 'for blocks defined with do' do
it 'accepts missing blank line' do
expect_no_offenses(<<~RUBY)
included do
#{access_modifier}
def test; end
end
RUBY
end
it 'accepts missing blank line with arguments' do
expect_no_offenses(<<~RUBY)
included do |foo|
#{access_modifier}
def test; end
end
RUBY
end
it "requires blank line after, but not before, #{access_modifier}" do
expect_offense(<<~RUBY)
included do
#{access_modifier}
#{'^' * access_modifier.size} Keep a blank line after `#{access_modifier}`.
def test
end
end
RUBY
end
end
context 'for blocks defined with {}' do
it 'accepts missing blank line' do
expect_no_offenses(<<~RUBY)
included {
#{access_modifier}
def test; end
}
RUBY
end
it 'accepts missing blank line with arguments' do
expect_no_offenses(<<~RUBY)
included { |foo|
#{access_modifier}
def test; end
}
RUBY
end
end
end
it 'accepts missing blank line when at the end of block' do
expect_no_offenses(<<~RUBY)
class Test
def test; end
#{access_modifier}
end
RUBY
end
it 'accepts missing blank line when at the end of specifying ' \
'a superclass' do
expect_no_offenses(<<~RUBY)
class Test < Base
def test; end
#{access_modifier}
end
RUBY
end
it 'accepts missing blank line when at the end of specifying ' \
'`self`' do
expect_no_offenses(<<~RUBY)
class << self
def test; end
#{access_modifier}
end
RUBY
end
it 'requires blank line when next line started with end' do
expect_offense(<<~RUBY)
class Test
#{access_modifier}
#{'^' * access_modifier.size} Keep a blank line after `#{access_modifier}`.
end_this!
end
RUBY
end
it 'recognizes blank lines with DOS style line endings' do
expect_no_offenses(<<~RUBY)
class Test\r
\r
#{access_modifier}\r
\r
def test; end\r
end\r
RUBY
end
it 'accepts only using access modifier' do
expect_no_offenses(<<~RUBY)
#{access_modifier}
RUBY
end
end
end
context 'EnforcedStyle is `only_before`' do
let(:cop_config) { { 'EnforcedStyle' => 'only_before' } }
%w[private protected].each do |access_modifier|
it "accepts missing blank line after #{access_modifier}" do
expect_no_offenses(<<~RUBY)
class Test
something
#{access_modifier}
def test; end
end
RUBY
end
it "registers an offense for blank line after #{access_modifier}" do
expect_offense(<<~RUBY)
class Test
something
#{access_modifier}
#{'^' * access_modifier.size} Remove a blank line after `#{access_modifier}`.
def test; end
end
RUBY
expect_correction(<<~RUBY)
class Test
something
#{access_modifier}
def test; end
end
RUBY
end
it "does not register an offense when `end` immediately after #{access_modifier}" do
expect_no_offenses(<<~RUBY)
class Test
#{access_modifier}
end
RUBY
end
end
%w[public module_function].each do |access_modifier|
it "accepts blank line after #{access_modifier}" do
expect_no_offenses(<<~RUBY)
module Kernel
#{access_modifier}
def do_something
end
end
RUBY
end
end
%w[private protected public module_function].each do |access_modifier|
it "registers an offense for missing blank line before #{access_modifier}" do
expect_offense(<<~RUBY)
class Test
something
#{access_modifier}
#{'^' * access_modifier.size} Keep a blank line before `#{access_modifier}`.
def test; end
end
RUBY
expect_correction(<<~RUBY)
class Test
something
#{access_modifier}
def test; end
end
RUBY
end
end
end
end