/
symbol_conversion_spec.rb
272 lines (236 loc) · 6.46 KB
/
symbol_conversion_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Lint::SymbolConversion, :config do
shared_examples 'offense' do |from, to|
it "registers an offense for #{from}" do
expect_offense(<<~RUBY, from: from)
#{from}
^{from} Unnecessary symbol conversion; use `#{to}` instead.
RUBY
expect_correction(<<~RUBY, loop: false)
#{to}
RUBY
end
end
# Unnecessary `to_sym`
it_behaves_like 'offense', ':foo.to_sym', ':foo'
it_behaves_like 'offense', '"foo".to_sym', ':foo'
it_behaves_like 'offense', '"foo_bar".to_sym', ':foo_bar'
it_behaves_like 'offense', '"foo-bar".to_sym', ':"foo-bar"'
# Unnecessary `intern`
it_behaves_like 'offense', ':foo.intern', ':foo'
it_behaves_like 'offense', '"foo".intern', ':foo'
it_behaves_like 'offense', '"foo_bar".intern', ':foo_bar'
it_behaves_like 'offense', '"foo-bar".intern', ':"foo-bar"'
# Unnecessary quoted symbol
it_behaves_like 'offense', ':"foo"', ':foo'
it_behaves_like 'offense', ':"foo_bar"', ':foo_bar'
it 'does not register an offense for a normal symbol' do
expect_no_offenses(<<~RUBY)
:foo
RUBY
end
it 'does not register an offense for a dstr' do
expect_no_offenses(<<~'RUBY')
"#{foo}".to_sym
RUBY
end
it 'does not register an offense for a symbol that requires quotes' do
expect_no_offenses(<<~RUBY)
:"foo-bar"
RUBY
end
context 'in a hash' do
context 'keys' do
it 'does not register an offense for a normal symbol' do
expect_no_offenses(<<~RUBY)
{ foo: 'bar' }
RUBY
end
it 'does not register an offense for a require quoted symbol' do
expect_no_offenses(<<~RUBY)
{ 'foo-bar': 'bar' }
RUBY
end
it 'does not register an offense for a require quoted symbol that contains `:`' do
expect_no_offenses(<<~RUBY)
{ 'foo:bar': 'bar' }
RUBY
end
it 'does not register an offense for a require quoted symbol that ends with `=`' do
expect_no_offenses(<<~RUBY)
{ 'foo=': 'bar' }
RUBY
end
it 'registers an offense for a quoted symbol' do
expect_offense(<<~RUBY)
{ 'foo': 'bar' }
^^^^^ Unnecessary symbol conversion; use `foo:` instead.
RUBY
expect_correction(<<~RUBY)
{ foo: 'bar' }
RUBY
end
it 'registers and corrects an offense for a quoted symbol that ends with `!`' do
expect_offense(<<~RUBY)
{ 'foo!': 'bar' }
^^^^^^ Unnecessary symbol conversion; use `foo!:` instead.
RUBY
expect_correction(<<~RUBY)
{ foo!: 'bar' }
RUBY
end
it 'registers and corrects an offense for a quoted symbol that ends with `?`' do
expect_offense(<<~RUBY)
{ 'foo?': 'bar' }
^^^^^^ Unnecessary symbol conversion; use `foo?:` instead.
RUBY
expect_correction(<<~RUBY)
{ foo?: 'bar' }
RUBY
end
it 'does not register an offense for operators' do
expect_no_offenses(<<~RUBY)
{ '==': 'bar' }
RUBY
end
end
context 'values' do
it 'does not register an offense for a normal symbol' do
expect_no_offenses(<<~RUBY)
{ foo: :bar }
RUBY
end
it 'registers an offense for a quoted symbol' do
expect_offense(<<~RUBY)
{ foo: :'bar' }
^^^^^^ Unnecessary symbol conversion; use `:bar` instead.
RUBY
expect_correction(<<~RUBY)
{ foo: :bar }
RUBY
end
end
end
context 'in an alias' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
alias foo bar
alias == equal
alias eq? ==
RUBY
end
end
context 'inside a percent literal array' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
%i(foo bar foo-bar)
%I(foo bar foo-bar)
RUBY
end
end
context 'single quoted symbol' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
:'Foo/Bar/Baz'
RUBY
end
end
context 'implicit `to_sym` call' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
to_sym == other
RUBY
end
end
context 'EnforcedStyle: consistent' do
let(:cop_config) { { 'EnforcedStyle' => 'consistent' } }
context 'hash where no keys need to be quoted' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
{
a: 1,
b: 2
}
RUBY
end
end
context 'hash where keys are quoted but do not need to be' do
it 'registers an offense' do
expect_offense(<<~RUBY)
{
a: 1,
'b': 2
^^^ Unnecessary symbol conversion; use `b:` instead.
}
RUBY
expect_correction(<<~RUBY)
{
a: 1,
b: 2
}
RUBY
end
end
context 'hash where there are keys needing quoting' do
it 'registers an offense for unquoted keys' do
expect_offense(<<~RUBY)
{
a: 1,
^ Symbol hash key should be quoted for consistency; use `"a":` instead.
b: 2,
^ Symbol hash key should be quoted for consistency; use `"b":` instead.
'c': 3,
'd-e': 4
}
RUBY
expect_correction(<<~RUBY)
{
"a": 1,
"b": 2,
'c': 3,
'd-e': 4
}
RUBY
end
end
context 'with a key with =' do
it 'requires symbols to be quoted' do
expect_offense(<<~RUBY)
{
'a=': 1,
b: 2
^ Symbol hash key should be quoted for consistency; use `"b":` instead.
}
RUBY
expect_correction(<<~RUBY)
{
'a=': 1,
"b": 2
}
RUBY
end
end
context 'with different quote styles' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
{
'a': 1,
"b": 2,
"c-d": 3,
'e-f': 4
}
RUBY
end
end
context 'with a mix of string and symbol keys' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
{
'a' => 1,
'b-c': 2
}
RUBY
end
end
end
end