/
variable_name_spec.rb
222 lines (184 loc) · 6.16 KB
/
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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Naming::VariableName, :config do
shared_examples 'always accepted' do
it 'accepts screaming snake case globals' do
expect_no_offenses('$MY_GLOBAL = 0')
end
it 'accepts screaming snake case constants' do
expect_no_offenses('MY_CONSTANT = 0')
end
it 'accepts assigning to camel case constant' do
expect_no_offenses('Paren = Struct.new :left, :right, :kind')
end
it 'accepts assignment with indexing of self' do
expect_no_offenses('self[:a] = b')
end
it 'accepts local variables marked as unused' do
expect_no_offenses('_ = 1')
end
it 'accepts one symbol size local variables' do
expect_no_offenses('i = 1')
end
end
context 'when configured for snake_case' do
let(:cop_config) { { 'EnforcedStyle' => 'snake_case' } }
it 'registers an offense for camel case in local variable name' do
expect_offense(<<~RUBY)
myLocal = 1
^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for correct + opposite' do
expect_offense(<<~RUBY)
my_local = 1
myLocal = 1
^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for camel case in instance variable name' do
expect_offense(<<~RUBY)
@myAttribute = 3
^^^^^^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for camel case in class variable name' do
expect_offense(<<~RUBY)
@@myAttr = 2
^^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for camel case local variables marked as unused' do
expect_offense(<<~RUBY)
_myLocal = 1
^^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for method arguments' do
expect_offense(<<~RUBY)
def method(funnyArg); end
^^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for default method arguments' do
expect_offense(<<~RUBY)
def foo(optArg = 1); end
^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for rest arguments' do
expect_offense(<<~RUBY)
def foo(*restArg); end
^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for keyword arguments' do
expect_offense(<<~RUBY)
def foo(kwArg: 1); end
^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for keyword rest arguments' do
expect_offense(<<~RUBY)
def foo(**kwRest); end
^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for block arguments' do
expect_offense(<<~RUBY)
def foo(&blockArg); end
^^^^^^^^ Use snake_case for variable names.
RUBY
end
it 'registers an offense for camel case when invoking method args' do
expect_offense(<<~RUBY)
firstArg = 'foo'
^^^^^^^^ Use snake_case for variable names.
secondArg = 'foo'
^^^^^^^^^ Use snake_case for variable names.
do_something(firstArg, secondArg)
^^^^^^^^ Use snake_case for variable names.
^^^^^^^^^ Use snake_case for variable names.
RUBY
end
include_examples 'always accepted'
end
context 'when configured for camelCase' do
let(:cop_config) { { 'EnforcedStyle' => 'camelCase' } }
it 'registers an offense for snake case in local variable name' do
expect_offense(<<~RUBY)
my_local = 1
^^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'registers an offense for opposite + correct' do
expect_offense(<<~RUBY)
my_local = 1
^^^^^^^^ Use camelCase for variable names.
myLocal = 1
RUBY
end
it 'accepts camel case in local variable name' do
expect_no_offenses('myLocal = 1')
end
it 'accepts camel case in instance variable name' do
expect_no_offenses('@myAttribute = 3')
end
it 'accepts camel case in class variable name' do
expect_no_offenses('@@myAttr = 2')
end
it 'registers an offense for snake case in method parameter' do
expect_offense(<<~RUBY)
def method(funny_arg); end
^^^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'accepts camel case local variables marked as unused' do
expect_no_offenses('_myLocal = 1')
end
it 'registers an offense for default method arguments' do
expect_offense(<<~RUBY)
def foo(opt_arg = 1); end
^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'registers an offense for rest arguments' do
expect_offense(<<~RUBY)
def foo(*rest_arg); end
^^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'registers an offense for keyword arguments' do
expect_offense(<<~RUBY)
def foo(kw_arg: 1); end
^^^^^^ Use camelCase for variable names.
RUBY
end
it 'registers an offense for keyword rest arguments' do
expect_offense(<<~RUBY)
def foo(**kw_rest); end
^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'registers an offense for block arguments' do
expect_offense(<<~RUBY)
def foo(&block_arg); end
^^^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'registers an offense for camel case when invoking method args' do
expect_offense(<<~RUBY)
first_arg = 'foo'
^^^^^^^^^ Use camelCase for variable names.
second_arg = 'foo'
^^^^^^^^^^ Use camelCase for variable names.
do_something(first_arg, second_arg)
^^^^^^^^^ Use camelCase for variable names.
^^^^^^^^^^ Use camelCase for variable names.
RUBY
end
it 'works with non-ascii characters' do
expect_no_offenses('léo = 1')
end
include_examples 'always accepted'
end
end