forked from rubocop/rubocop
/
inclusive_language_spec.rb
421 lines (357 loc) · 11.6 KB
/
inclusive_language_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Naming::InclusiveLanguage, :config do
context 'flagged term matching' do
let(:cop_config) do
{ 'FlaggedTerms' => { 'whitelist' => {} } }
end
it 'registers an offense when using a flagged term' do
expect_offense(<<~RUBY)
whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist'.
RUBY
end
it 'registers an offense when using a flagged term with mixed case' do
expect_offense(<<~RUBY)
class WhiteList
^^^^^^^^^ Consider replacing problematic term 'WhiteList'.
end
RUBY
end
it 'registers an offense for a partial word match' do
expect_offense(<<~RUBY)
class Nodewhitelist
^^^^^^^^^ Consider replacing problematic term 'whitelist'.
end
RUBY
end
context 'disable default flagged term' do
let(:cop_config) do
{ 'FlaggedTerms' => { 'whitelist' => nil, 'blacklist' => {} } }
end
it 'ignores flagged terms that are set to nil' do
expect_offense(<<~RUBY)
# working on replacing whitelist and blacklist
^^^^^^^^^ Consider replacing problematic term 'blacklist'.
RUBY
end
end
context 'multiple offenses on a line' do
let(:cop_config) do
{ 'FlaggedTerms' => {
'master' => { 'Suggestions' => %w[main primary leader] },
'slave' => { 'Suggestions' => %w[replica secondary follower] }
} }
end
it 'registers an offense for each word' do
expect_offense(<<~RUBY)
master, slave = nodes
^^^^^ Consider replacing problematic term 'slave' with 'replica', 'secondary', or 'follower'.
^^^^^^ Consider replacing problematic term 'master' with 'main', 'primary', or 'leader'.
RUBY
end
end
context 'regex' do
let(:cop_config) do
{ 'FlaggedTerms' => { 'whitelist' => { 'Regex' => /white[-_\s]?list/ } } }
end
it 'registers an offense for a flagged term matched with a regexp' do
expect_offense(<<~RUBY)
# white-list of IPs
^^^^^^^^^^ Consider replacing problematic term 'white-list'.
RUBY
end
end
end
context 'allowed use' do
let(:cop_config) do
{ 'FlaggedTerms' => {
'master' => { 'AllowedRegex' => 'master\'s degree' }
} }
end
it 'does not register an offense for an allowed use' do
expect_no_offenses(<<~RUBY)
# They had a Master's Degree
RUBY
end
context 'offense after an allowed use' do
let(:cop_config) do
{ 'FlaggedTerms' => {
'foo' => {},
'bar' => { 'AllowedRegex' => 'barx' }
} }
end
it 'registers an offense at the correct location' do
expect_offense(<<~RUBY)
barx, foo = method_call
^^^ Consider replacing problematic term 'foo'.
RUBY
end
end
end
context 'suggestions' do
context 'flagged term with one suggestion' do
let(:cop_config) do
{ 'FlaggedTerms' => {
'whitelist' => { 'Suggestions' => 'allowlist' }
} }
end
it 'includes the suggestion in the offense message' do
expect_offense(<<~RUBY)
whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist' with 'allowlist'.
RUBY
end
end
context 'flagged term with two suggestions' do
let(:cop_config) do
{ 'FlaggedTerms' => {
'whitelist' => { 'Suggestions' => %w[allowlist permit] }
} }
end
it 'includes both suggestions in the offense message' do
expect_offense(<<~RUBY)
whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist' with 'allowlist' or 'permit'.
RUBY
end
end
context 'flagged term with three or more suggestions' do
let(:cop_config) do
{
'CheckStrings' => true,
'FlaggedTerms' => {
'master' => { 'Suggestions' => %w[main primary leader] }
}
}
end
it 'includes all suggestions in the message' do
expect_offense(<<~RUBY)
default_branch = 'master'
^^^^^^ Consider replacing problematic term 'master' with 'main', 'primary', or 'leader'.
RUBY
end
end
end
context 'identifiers' do
let(:cop_config) do
{ 'CheckIdentifiers' => check_identifiers, 'FlaggedTerms' => { 'whitelist' => {} } }
end
context 'when CheckIdentifiers config is true' do
let(:check_identifiers) { true }
it 'registers an offense' do
expect_offense(<<~RUBY)
whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist'.
RUBY
end
end
context 'when CheckIdentifiers config is false' do
let(:check_identifiers) { false }
it 'does not register offenses for identifiers' do
expect_no_offenses(<<~RUBY)
whitelist = %w(user1 user2)
RUBY
end
end
end
context 'variables' do
let(:cop_config) do
{ 'CheckVariables' => check_variables, 'FlaggedTerms' => { 'whitelist' => {} } }
end
context 'when CheckVariables config is true' do
let(:check_variables) { true }
it 'registers offenses for instance variables' do
expect_offense(<<~RUBY)
@whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist'.
RUBY
end
it 'registers offenses for class variables' do
expect_offense(<<~RUBY)
@@whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist'.
RUBY
end
it 'registers offenses for global variables' do
expect_offense(<<~RUBY)
$whitelist = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'whitelist'.
RUBY
end
end
context 'when CheckVariables config is false' do
let(:check_variables) { false }
it 'does not register offenses for variables' do
expect_no_offenses(<<~RUBY)
@whitelist = %w(user1 user2)
RUBY
end
end
end
context 'constants' do
let(:cop_config) do
{ 'CheckConstants' => check_constants, 'FlaggedTerms' => { 'whitelist' => {} } }
end
context 'when CheckConstants config is true' do
let(:check_constants) { true }
it 'registers offenses for constants' do
expect_offense(<<~RUBY)
WHITELIST = %w(user1 user2)
^^^^^^^^^ Consider replacing problematic term 'WHITELIST'.
RUBY
end
end
context 'when CheckConstants config is false' do
let(:check_constants) { false }
it 'does not register offenses for constants' do
expect_no_offenses(<<~RUBY)
WHITELIST = %w(user1 user2)
RUBY
end
end
end
context 'strings' do
let(:check_strings) { true }
let(:cop_config) do
{ 'CheckStrings' => check_strings, 'FlaggedTerms' => { 'master' => {}, 'slave' => {} } }
end
it 'registers an offense for an interpolated string' do
expect_offense(<<~RUBY)
puts "master node \#{node}"
^^^^^^ Consider replacing problematic term 'master'.
RUBY
end
it 'registers an offense for a multiline string' do
expect_offense(<<~RUBY)
node_types = "master
^^^^^^ Consider replacing problematic term 'master'.
slave
^^^^^ Consider replacing problematic term 'slave'.
primary
secondary"
RUBY
end
it 'registers an offense in a heredoc' do
expect_offense(<<~RUBY)
node_text = <<~TEXT
master
^^^^^^ Consider replacing problematic term 'master'.
primary
slave
^^^^^ Consider replacing problematic term 'slave'.
secondary
TEXT
RUBY
end
context 'when CheckStrings config is false' do
let(:check_strings) { false }
it 'does not register offenses for strings' do
expect_no_offenses(<<~RUBY)
puts "master node \#{node}"
RUBY
end
end
end
context 'symbols' do
let(:cop_config) do
{ 'CheckSymbols' => check_symbols, 'FlaggedTerms' => { 'master' => {} } }
end
context 'when CheckSymbols is true' do
let(:check_symbols) { true }
it 'registers an offense' do
expect_offense(<<~RUBY)
config[:master] = {}
^^^^^^ Consider replacing problematic term 'master'.
RUBY
end
end
context 'when CheckSymbols is false' do
let(:check_symbols) { false }
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
config[:master] = {}
RUBY
end
end
end
context 'comments' do
let(:check_comments) { true }
let(:cop_config) do
{ 'CheckComments' => check_comments, 'FlaggedTerms' => { 'foo' => {} } }
end
it 'registers an offense in a single line comment' do
expect_offense(<<~RUBY)
# is it a foo?
^^^ Consider replacing problematic term 'foo'.
bar = baz # it's a foo!
^^^ Consider replacing problematic term 'foo'.
RUBY
end
it 'registers an offense in a block comment' do
expect_offense(<<~RUBY)
=begin
foo
^^^ Consider replacing problematic term 'foo'.
bar
=end
RUBY
end
context 'when CheckComments is false' do
let(:check_comments) { false }
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
# is it a foo?
RUBY
end
end
end
context 'filepath' do
let(:source) { 'print 1' }
let(:processed_source) { parse_source(source) }
let(:offenses) { _investigate(cop, processed_source) }
let(:messages) { offenses.sort.map(&:message) }
before { allow(processed_source.buffer).to receive(:name).and_return(filename) }
context 'one offense in filename' do
let(:cop_config) do
{ 'FlaggedTerms' => { 'master' => { 'Suggestions' => 'main' } } }
end
let(:filename) { '/some/dir/master.rb' }
it 'registers an offense' do
expect(offenses.size).to eq(1)
expect(messages)
.to eq(["Consider replacing problematic term 'master' with 'main' in file path."])
end
end
context 'multiple offenses in filename' do
let(:cop_config) do
{ 'FlaggedTerms' => { 'master' => {}, 'slave' => {} } }
end
let(:filename) { '/some/config/master-slave.rb' }
it 'registers an offense with all problematic words' do
expect(offenses.size).to eq(1)
expect(messages)
.to eq(["Consider replacing problematic terms 'master', 'slave' in file path."])
end
end
context 'offense in directory name' do
let(:cop_config) do
{ 'FlaggedTerms' => { 'master' => {} } }
end
let(:filename) { '/db/master/config.yml' }
it 'registers an offense for a director' do
expect(offenses.size).to eq(1)
expect(messages).to eq(["Consider replacing problematic term 'master' in file path."])
end
end
context 'CheckFilepaths is false' do
let(:cop_config) do
{ 'CheckFilepaths' => false, 'FlaggedTerms' => { 'master' => {} } }
end
let(:filename) { '/some/dir/master.rb' }
it 'does not register an offense' do
expect(offenses.size).to eq(0)
expect(messages.empty?).to be(true)
end
end
end
end