/
string_literals_spec.rb
450 lines (372 loc) · 12.1 KB
/
string_literals_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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Style::StringLiterals, :config do
context 'configured with single quotes preferred' do
let(:cop_config) { { 'EnforcedStyle' => 'single_quotes' } }
it 'registers offense for double quotes when single quotes suffice' do
expect_offense(<<~'RUBY')
s = "abc"
^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
x = "a\\b"
^^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
y ="\\b"
^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
z = "a\\"
^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
RUBY
expect(cop.config_to_allow_offenses).to eq('EnforcedStyle' => 'double_quotes')
expect_correction(<<~'RUBY')
s = 'abc'
x = 'a\\b'
y ='\\b'
z = 'a\\'
RUBY
end
it 'registers offense for correct + opposite' do
expect_offense(<<~RUBY)
s = "abc"
^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
x = 'abc'
RUBY
expect_correction(<<~RUBY)
s = 'abc'
x = 'abc'
RUBY
end
it 'accepts single quotes' do
expect_no_offenses("a = 'x'")
end
it 'accepts single quotes in interpolation' do
expect_no_offenses(%q("hello#{hash['there']}"))
end
it 'accepts %q and %Q quotes' do
expect_no_offenses('a = %q(x) + %Q[x]')
end
it 'accepts % quotes' do
expect_no_offenses('a = %(x)')
end
it 'accepts heredocs' do
expect_no_offenses(<<~RUBY)
execute <<-SQL
SELECT name from users
SQL
RUBY
end
it 'accepts double quotes when new line is used' do
expect_no_offenses('"\n"')
end
it 'accepts double quotes when interpolating & quotes in multiple lines' do
expect_no_offenses(<<~'RUBY')
"#{encode_severity}:#{sprintf('%3d', line_number)}: #{m}"
RUBY
end
it 'accepts double quotes when single quotes are used' do
expect_no_offenses('"\'"')
end
it 'accepts double quotes when interpolating an instance variable' do
expect_no_offenses('"#@test"')
end
it 'accepts double quotes when interpolating a global variable' do
expect_no_offenses('"#$test"')
end
it 'accepts double quotes when interpolating a class variable' do
expect_no_offenses('"#@@test"')
end
it 'accepts double quotes when control characters are used' do
expect_no_offenses('"\e"')
end
it 'accepts double quotes when unicode control sequence is used' do
expect_no_offenses('"Espa\u00f1a"')
end
it 'accepts double quotes at the start of regexp literals' do
expect_no_offenses('s = /"((?:[^\\"]|\\.)*)"/')
end
it 'accepts double quotes with some other special symbols' do
# "Substitutions in double-quoted strings"
# http://www.ruby-doc.org/docs/ProgrammingRuby/html/language.html
expect_no_offenses(<<~'RUBY')
g = "\xf9"
copyright = "\u00A9"
RUBY
end
it 'accepts " in a %w' do
expect_no_offenses('%w(")')
end
it 'accepts \\\\\n in a string' do # this would be: "\\\n"
expect_no_offenses('"foo \\\\\n bar"')
end
it 'accepts double quotes in interpolation' do
expect_no_offenses("\"\#{\"A\"}\"")
end
it 'detects unneeded double quotes within concatenated string' do
expect_offense(<<~'RUBY')
"#{x}" \
"y"
^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
RUBY
expect_correction(<<~'RUBY')
"#{x}" \
'y'
RUBY
end
it 'can handle a built-in constant parsed as string' do
# Parser will produce str nodes for constants such as __FILE__.
expect_no_offenses(<<~RUBY)
if __FILE__ == $PROGRAM_NAME
end
RUBY
end
it 'can handle character literals' do
expect_no_offenses('a = ?/')
end
it 'registers an offense for "\""' do
expect_offense(<<~'RUBY')
"\""
^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
RUBY
expect_correction(<<~'RUBY')
'"'
RUBY
end
it 'registers an offense for "\\"' do
expect_offense(<<~'RUBY')
"\\"
^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
RUBY
expect_correction(<<~'RUBY')
'\\'
RUBY
end
it 'registers an offense for words with non-ascii chars' do
expect_offense(<<~RUBY)
"España"
^^^^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
RUBY
expect_correction(<<~RUBY)
'España'
RUBY
end
it 'does not register an offense for words with non-ascii chars and other control sequences' do
expect_no_offenses('"España\n"')
end
end
context 'configured with double quotes preferred' do
let(:cop_config) { { 'EnforcedStyle' => 'double_quotes' } }
it 'registers offense for single quotes when double quotes would be equivalent' do
expect_offense(<<~RUBY)
s = 'abc'
^^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
RUBY
expect(cop.config_to_allow_offenses).to eq('EnforcedStyle' => 'single_quotes')
expect_correction(<<~RUBY)
s = "abc"
RUBY
end
it 'registers offense for opposite + correct' do
expect_offense(<<~'RUBY')
s = "abc"
x = 'abc'
^^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
RUBY
expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
expect_correction(<<~'RUBY')
s = "abc"
x = "abc"
RUBY
end
it 'registers offense for escaped single quote in single quotes' do
expect_offense(<<~'RUBY')
'\''
^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
'\\'
^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
RUBY
expect_correction(<<~'RUBY')
"'"
"\\"
RUBY
end
it 'does not accept multiple escaped single quotes in single quotes' do
expect_offense(<<~'RUBY')
'This \'string\' has \'multiple\' escaped quotes'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
RUBY
expect_correction(<<~'RUBY')
"This 'string' has 'multiple' escaped quotes"
RUBY
end
it 'accepts double quotes' do
expect_no_offenses('a = "x"')
end
it 'accepts single quotes in interpolation' do
expect_no_offenses(%q("hello#{hash['there']}"))
end
it 'accepts %q and %Q quotes' do
expect_no_offenses('a = %q(x) + %Q[x]')
end
it 'accepts % quotes' do
expect_no_offenses('a = %(x)')
end
it 'accepts heredocs' do
expect_no_offenses(<<~RUBY)
execute <<-SQL
SELECT name from users
SQL
RUBY
end
it 'accepts single quotes in string with escaped non-\' character' do
expect_no_offenses(%q('\n'))
end
it 'accepts escaped single quote in string with escaped non-\' character' do
expect_no_offenses(%q('\'\n'))
end
it 'accepts single quotes when they are needed' do
expect_no_offenses(<<~'RUBY')
a = '\n'
b = '"'
c = '#{x}'
d = '#@x'
e = '#$x'
f = '\s'
g = '\z'
RUBY
end
it 'flags single quotes with plain # (not #@var or #{interpolation} or #$global' do
expect_offense(<<~RUBY)
a = 'blah #'
^^^^^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
RUBY
expect_correction(<<~RUBY)
a = "blah #"
RUBY
end
it 'accepts single quotes at the start of regexp literals' do
expect_no_offenses("s = /'((?:[^\\']|\\.)*)'/")
end
it "accepts ' in a %w" do
expect_no_offenses("%w(')")
end
it 'can handle a built-in constant parsed as string' do
# Parser will produce str nodes for constants such as __FILE__.
expect_no_offenses(<<~RUBY)
if __FILE__ == $PROGRAM_NAME
end
RUBY
end
end
context 'when configured with a bad value' do
let(:cop_config) { { 'EnforcedStyle' => 'other' } }
it 'fails' do
expect { expect_no_offenses('a = "b"') }.to raise_error(RuntimeError)
end
end
context 'when ConsistentQuotesInMultiline is true' do
context 'and EnforcedStyle is single_quotes' do
let(:cop_config) do
{
'ConsistentQuotesInMultiline' => true,
'EnforcedStyle' => 'single_quotes'
}
end
it 'registers an offense for strings with line breaks in them' do
expect_offense(<<~'RUBY')
"--
^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
SELECT *
LEFT JOIN X on Y
FROM Models"
RUBY
expect_no_corrections
end
it 'accepts continued strings using all single quotes' do
expect_no_offenses(<<~'RUBY')
'abc' \
'def'
RUBY
end
it 'registers an offense for mixed quote styles in a continued string' do
expect_offense(<<~'RUBY')
'abc' \
^^^^^^^ Inconsistent quote style.
"def"
RUBY
expect_no_corrections
end
it 'registers an offense for unneeded double quotes in continuation' do
expect_offense(<<~'RUBY')
"abc" \
^^^^^^^ Prefer single-quoted strings when you don't need string interpolation or special symbols.
"def"
RUBY
expect_no_corrections
end
it "doesn't register offense for double quotes with interpolation" do
expect_no_offenses(<<~'RUBY')
"abc" \
"def#{1}"
RUBY
end
it "doesn't register offense for double quotes with embedded single" do
expect_no_offenses(<<~'RUBY')
"abc'" \
"def"
RUBY
end
it 'accepts for double quotes with an escaped special character' do
expect_no_offenses(<<~'RUBY')
"abc\t" \
"def"
RUBY
end
it 'accepts for double quotes with an escaped normal character' do
expect_no_offenses(<<~'RUBY')
"abc\!" \
"def"
RUBY
end
it "doesn't choke on heredocs with inconsistent indentation" do
expect_no_offenses(<<~RUBY)
<<-QUERY_STRING
DEFINE
BLAH
QUERY_STRING
RUBY
end
end
context 'and EnforcedStyle is double_quotes' do
let(:cop_config) do
{
'ConsistentQuotesInMultiline' => true,
'EnforcedStyle' => 'double_quotes'
}
end
it 'accepts continued strings using all double quotes' do
expect_no_offenses(<<~'RUBY')
"abc" \
"def"
RUBY
end
it 'registers an offense for mixed quote styles in a continued string' do
expect_offense(<<~'RUBY')
'abc' \
^^^^^^^ Inconsistent quote style.
"def"
RUBY
expect_no_corrections
end
it 'registers an offense for unneeded single quotes in continuation' do
expect_offense(<<~'RUBY')
'abs' \
^^^^^^^ Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
'def'
RUBY
expect_no_corrections
end
it "doesn't register offense for single quotes with embedded double" do
expect_no_offenses(<<~'RUBY')
'abc"' \
'def'
RUBY
end
end
end
end