forked from rubocop/rubocop
/
method_name_spec.rb
353 lines (299 loc) · 9.79 KB
/
method_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Naming::MethodName, :config do
shared_examples 'never accepted' do |enforced_style|
it 'registers an offense for mixed snake case and camel case in attr.' do
expect_offense(<<~RUBY)
attr :visit_Arel_Nodes_SelectStatement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_reader :visit_Arel_Nodes_SelectStatement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_accessor :visit_Arel_Nodes_SelectStatement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_writer :visit_Arel_Nodes_SelectStatement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr 'visit_Arel_Nodes_SelectStatement'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
RUBY
end
it 'registers an offense for mixed snake case and camel case in attr.' do
expect_offense(<<~RUBY)
attr_reader :visit_Arel_Nodes_SelectStatement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_reader 'visit_Arel_Nodes_SelectStatement'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
RUBY
end
it 'registers an offense for mixed snake case and camel case' do
expect_offense(<<~RUBY)
def visit_Arel_Nodes_SelectStatement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
end
RUBY
end
it 'registers an offense for capitalized camel case name in attr.' do
expect_offense(<<~RUBY)
attr :MyMethod
^^^^^^^^^ Use #{enforced_style} for method names.
attr_reader :MyMethod
^^^^^^^^^ Use #{enforced_style} for method names.
attr_accessor :MyMethod
^^^^^^^^^ Use #{enforced_style} for method names.
attr_writer :MyMethod
^^^^^^^^^ Use #{enforced_style} for method names.
RUBY
end
it 'registers an offense for capitalized camel case' do
expect_offense(<<~RUBY)
class MyClass
def MyMethod
^^^^^^^^ Use #{enforced_style} for method names.
end
end
RUBY
end
it 'registers an offense for singleton upper case method without ' \
'corresponding class' do
expect_offense(<<~RUBY)
module Sequel
def self.Model(source)
^^^^^ Use #{enforced_style} for method names.
end
end
RUBY
end
end
shared_examples 'always accepted' do |enforced_style|
it 'accepts one line methods' do
expect_no_offenses("def body; '' end")
end
it 'accepts operator definitions' do
expect_no_offenses(<<~RUBY)
def +(other)
# ...
end
RUBY
end
it 'accepts unary operator definitions' do
expect_no_offenses(<<~RUBY)
def ~@; end
RUBY
expect_no_offenses(<<~RUBY)
def !@; end
RUBY
end
%w[class module].each do |kind|
it "accepts class emitter method in a #{kind}" do
expect_no_offenses(<<~RUBY)
#{kind} Sequel
def self.Model(source)
end
class Model
end
end
RUBY
end
it "accepts class emitter method in a #{kind}, even when it is " \
'defined inside another method' do
expect_no_offenses(<<~RUBY)
module DPN
module Flow
module BaseFlow
class Start
end
def self.included(base)
def base.Start(aws_env, *args)
end
end
end
end
end
RUBY
end
end
context 'when specifying `IgnoredPatterns`' do
let(:cop_config) do
{
'EnforcedStyle' => enforced_style,
'IgnoredPatterns' => [
'\A\s*onSelectionBulkChange\s*',
'\A\s*on_selection_cleared\s*'
]
}
end
it 'does not register an offense for camel case method name in attr.' do
expect_no_offenses(<<~RUBY)
attr_reader :onSelectionBulkChange
attr_accessor :onSelectionBulkChange
attr_writer :onSelectionBulkChange
RUBY
end
it 'does not register an offense for camel case method name ' \
' matching `IgnoredPatterns`' do
expect_no_offenses(<<~RUBY)
def onSelectionBulkChange(arg)
end
RUBY
end
it 'does not register an offense for snake case method name in attr.' do
expect_no_offenses(<<~RUBY)
attr_reader :on_selection_cleared
attr_accessor :on_selection_cleared
attr_writer :on_selection_cleared
RUBY
end
it 'does not register an offense for snake case method name ' \
' matching `IgnoredPatterns`' do
expect_no_offenses(<<~RUBY)
def on_selection_cleared(arg)
end
RUBY
end
end
end
shared_examples 'multiple attr methods' do |enforced_style|
it 'registers an offense for camel case methods names in attr.' do
expect_offense(<<~RUBY)
attr :my_method, :myMethod
^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_reader :my_method, :myMethod
^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_accessor :myMethod, :my_method
^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
attr_accessor 'myMethod', 'my_method'
^^^^^^^^^^^^^^^^^^^^^^^ Use #{enforced_style} for method names.
RUBY
end
end
context 'when configured for snake_case' do
let(:cop_config) { { 'EnforcedStyle' => 'snake_case' } }
it 'registers an offense for camel case method names in attr.' do
expect_offense(<<~RUBY)
attr_reader :myMethod
^^^^^^^^^ Use snake_case for method names.
attr_accessor :myMethod
^^^^^^^^^ Use snake_case for method names.
attr_writer :myMethod
^^^^^^^^^ Use snake_case for method names.
RUBY
end
it 'registers an offense for camel case in instance method name' do
expect_offense(<<~RUBY)
def myMethod
^^^^^^^^ Use snake_case for method names.
# ...
end
RUBY
end
it 'registers an offense for opposite + correct' do
expect_offense(<<~RUBY)
def my_method
end
def myMethod
^^^^^^^^ Use snake_case for method names.
end
RUBY
end
it 'registers an offense for camel case in singleton method name' do
expect_offense(<<~RUBY)
def self.myMethod
^^^^^^^^ Use snake_case for method names.
# ...
end
RUBY
end
it 'accepts snake case in attr.' do
expect_no_offenses(<<~RUBY)
attr_reader :my_method
attr_accessor :my_method
attr_writer :my_method
RUBY
end
it 'accepts snake case in names' do
expect_no_offenses(<<~RUBY)
def my_method
end
RUBY
end
it 'registers an offense for singleton camelCase method within class' do
expect_offense(<<~RUBY)
class Sequel
def self.fooBar
^^^^^^ Use snake_case for method names.
end
end
RUBY
end
include_examples 'never accepted', 'snake_case'
include_examples 'always accepted', 'snake_case'
include_examples 'multiple attr methods', 'snake_case'
end
context 'when configured for camelCase' do
let(:cop_config) { { 'EnforcedStyle' => 'camelCase' } }
it 'accepts camel case names in attr.' do
expect_no_offenses(<<~RUBY)
attr_reader :myMethod
attr_accessor :myMethod
attr_writer :myMethod
RUBY
end
it 'accepts camel case in instance method name' do
expect_no_offenses(<<~RUBY)
def myMethod
# ...
end
RUBY
end
it 'accepts camel case in singleton method name' do
expect_no_offenses(<<~RUBY)
def self.myMethod
# ...
end
RUBY
end
it 'registers an offense for snake case name in attr.' do
expect_offense(<<~RUBY)
attr_reader :my_method
^^^^^^^^^^ Use camelCase for method names.
attr_accessor :my_method
^^^^^^^^^^ Use camelCase for method names.
attr_writer :my_method
^^^^^^^^^^ Use camelCase for method names.
attr_writer 'my_method'
^^^^^^^^^^^ Use camelCase for method names.
RUBY
end
it 'registers an offense for snake case in names' do
expect_offense(<<~RUBY)
def my_method
^^^^^^^^^ Use camelCase for method names.
end
RUBY
end
it 'registers an offense for correct + opposite' do
expect_offense(<<~RUBY)
def myMethod
end
def my_method
^^^^^^^^^ Use camelCase for method names.
end
RUBY
end
it 'registers an offense for singleton snake_case method within class' do
expect_offense(<<~RUBY)
class Sequel
def self.foo_bar
^^^^^^^ Use camelCase for method names.
end
end
RUBY
end
include_examples 'always accepted', 'camelCase'
include_examples 'never accepted', 'camelCase'
include_examples 'multiple attr methods', 'camelCase'
end
it 'works for non-ascii characters' do
expect_no_offenses(<<~RUBY)
def última_vista; end
RUBY
end
end