/
options_spec.rb
532 lines (454 loc) · 21.7 KB
/
options_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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
# frozen_string_literal: true
RSpec.describe RuboCop::Options, :isolated_environment do
include FileHelper
subject(:options) { described_class.new }
before do
$stdout = StringIO.new
$stderr = StringIO.new
end
after do
$stdout = STDOUT
$stderr = STDERR
end
def abs(path)
File.expand_path(path)
end
describe 'option' do
describe '-h/--help' do
it 'exits cleanly' do
expect { options.parse ['-h'] }.to exit_with_code(0)
expect { options.parse ['--help'] }.to exit_with_code(0)
end
it 'shows help text' do
begin
options.parse(['--help'])
rescue SystemExit # rubocop:disable Lint/SuppressedException
end
expected_help = <<~OUTPUT
Usage: rubocop [options] [file1, file2, ...]
-L, --list-target-files List all files RuboCop will inspect.
--except [COP1,COP2,...] Disable the given cop(s).
--only [COP1,COP2,...] Run only the given cop(s).
--only-guide-cops Run only cops for rules that link to a
style guide.
-c, --config FILE Specify configuration file.
--force-exclusion Force excluding files specified in the
configuration `Exclude` even if they are
explicitly passed as arguments.
--only-recognized-file-types Inspect files given on the command line only if
they are listed in AllCops/Include parameters
of user configuration or default configuration.
--ignore-parent-exclusion Prevent from inheriting AllCops/Exclude from
parent folders.
--force-default-config Use default configuration even if configuration
files are present in the directory tree.
--auto-gen-config Generate a configuration file acting as a
TODO list.
--regenerate-todo Regenerate the TODO configuration file using
the last configuration. If there is no existing
TODO file, acts like --auto-gen-config.
--exclude-limit COUNT Used together with --auto-gen-config to
set the limit for how many Exclude
properties to generate. Default is 15.
--disable-uncorrectable Used with --auto-correct to annotate any
offenses that do not support autocorrect
with `rubocop:todo` comments.
--[no-]offense-counts Include offense counts in configuration
file generated by --auto-gen-config.
Default is true.
--[no-]auto-gen-only-exclude Generate only Exclude parameters and not Max
when running --auto-gen-config, except if the
number of files with offenses is bigger than
exclude-limit. Default is false.
--[no-]auto-gen-timestamp Include the date and time when the --auto-gen-config
was run in the file it generates. Default is true.
--init Generate a .rubocop.yml file in the current directory.
-f, --format FORMATTER Choose an output formatter. This option
can be specified multiple times to enable
multiple formatters at the same time.
[p]rogress is used by default
[a]utogenconf
[c]lang
[e]macs
[fi]les
[fu]ubar
[g]ithub
[h]tml
[j]son
[ju]nit
[o]ffenses
[pa]cman
[p]rogress
[q]uiet
[s]imple
[t]ap
[w]orst
custom formatter class name
-o, --out FILE Write output to a file instead of STDOUT.
This option applies to the previously
specified --format, or the default format
if no format is specified.
--display-time Display elapsed time in seconds.
--display-only-failed Only output offense messages. Omit passing
cops. Only valid for --format junit.
-r, --require FILE Require Ruby file.
--fail-level SEVERITY Minimum severity (A/I/R/C/W/E/F) for exit
with error code.
--display-only-fail-level-offenses
Only output offense messages at
the specified --fail-level or above
--show-cops [COP1,COP2,...] Shows the given cops, or all cops by
default, and their configurations for the
current directory.
-C, --cache FLAG Use result caching (FLAG=true) or don't
(FLAG=false), default determined by
configuration parameter AllCops: UseCache.
--cache-root DIR Set the cache root directory.
Takes precedence over the configuration
parameter AllCops: CacheRootDirectory and
the $RUBOCOP_CACHE_ROOT environment variable.
-F, --fail-fast Inspect files in order of modification
time and stop after the first file
containing offenses.
-d, --debug Display debug info.
-D, --[no-]display-cop-names Display cop names in offense messages.
Default is true.
-E, --extra-details Display extra details in offense messages.
-S, --display-style-guide Display style guide URLs in offense messages.
-a, --auto-correct Auto-correct offenses (only when it's safe).
--safe-auto-correct (same, deprecated)
-A, --auto-correct-all Auto-correct offenses (safe and unsafe)
--disable-pending-cops Run without pending cops.
--enable-pending-cops Run with pending cops.
--ignore-disable-comments Run cops even when they are disabled locally
with a comment.
--safe Run only safe cops.
--stderr Write all output to stderr except for the
autocorrected source. This is especially useful
when combined with --auto-correct and --stdin.
--[no-]color Force color output on or off.
-v, --version Display version.
-V, --verbose-version Display verbose version.
-P, --[no-]parallel Use available CPUs to execute inspection in
parallel. Default is true.
-l, --lint Run only lint cops.
-x, --fix-layout Run only layout cops, with auto-correct on.
-s, --stdin FILE Pipe source from STDIN, using FILE in offense
reports. This is useful for editor integration.
OUTPUT
expect($stdout.string).to eq(expected_help)
end
it 'lists all builtin formatters' do
begin
options.parse(['--help'])
rescue SystemExit # rubocop:disable Lint/SuppressedException
end
option_sections = $stdout.string.lines.slice_before(/^\s*-/)
format_section = option_sections.find { |lines| /^\s*-f/.match?(lines.first) }
formatter_keys = format_section.reduce([]) do |keys, line|
match = line.match(/^ {39}(\[[a-z\]]+)/)
next keys unless match
keys << match.captures.first
end.sort
expected_formatter_keys =
RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys.sort
expect(formatter_keys).to eq(expected_formatter_keys)
end
end
describe 'incompatible cli options' do
it 'rejects using -v with -V' do
msg = 'Incompatible cli options: [:version, :verbose_version]'
expect { options.parse %w[-vV] }.to raise_error(RuboCop::OptionArgumentError, msg)
end
it 'rejects using -v with --show-cops' do
msg = 'Incompatible cli options: [:version, :show_cops]'
expect { options.parse %w[-v --show-cops] }
.to raise_error(RuboCop::OptionArgumentError, msg)
end
it 'rejects using -V with --show-cops' do
msg = 'Incompatible cli options: [:verbose_version, :show_cops]'
expect { options.parse %w[-V --show-cops] }
.to raise_error(RuboCop::OptionArgumentError, msg)
end
it 'mentions all incompatible options when more than two are used' do
msg = 'Incompatible cli options: [:version, :verbose_version, :show_cops]'
expect { options.parse %w[-vV --show-cops] }
.to raise_error(RuboCop::OptionArgumentError, msg)
end
end
describe '--parallel' do
context 'combined with --cache false' do
it 'ignores parallel' do
msg = '-P/--parallel is being ignored because it is not compatible with --cache false'
options.parse %w[--parallel --cache false]
expect($stdout.string).to include(msg)
expect(options.instance_variable_get('@options').keys).not_to include(:parallel)
end
end
context 'combined with --auto-correct' do
it 'ignores parallel' do
msg = '-P/--parallel is being ignored because it is not compatible with --auto-correct'
options.parse %w[--parallel --auto-correct]
expect($stdout.string).to include(msg)
expect(options.instance_variable_get('@options').keys).not_to include(:parallel)
end
end
context 'combined with --auto-gen-config' do
it 'ignore parallel' do
msg = '-P/--parallel is being ignored because it is not compatible with --auto-gen-config'
options.parse %w[--parallel --auto-gen-config]
expect($stdout.string).to include(msg)
expect(options.instance_variable_get('@options').keys).not_to include(:parallel)
end
end
context 'combined with --fail-fast' do
it 'ignores parallel' do
msg = '-P/--parallel is being ignored because it is not compatible with -F/--fail-fast'
options.parse %w[--parallel --fail-fast]
expect($stdout.string).to include(msg)
expect(options.instance_variable_get('@options').keys).not_to include(:parallel)
end
end
end
context 'combined with --auto-correct and --fail-fast' do
it 'ignores parallel' do
msg = '-P/--parallel is being ignored because it is not compatible with -F/--fail-fast'
options.parse %w[--parallel --fail-fast --auto-correct]
expect($stdout.string).to include(msg)
expect(options.instance_variable_get('@options').keys).not_to include(:parallel)
end
end
describe '--no-parallel' do
it 'disables parallel from file' do
results = options.parse %w[--no-parallel]
expect(results).to eq([{ parallel: false }, []])
end
end
describe '--display-only-failed' do
it 'fails if given without --format junit' do
expect { options.parse %w[--display-only-failed] }
.to raise_error(RuboCop::OptionArgumentError)
end
it 'works if given with --format junit' do
expect { options.parse %w[--format junit --display-only-failed] }
.not_to raise_error(RuboCop::OptionArgumentError)
end
end
describe '--fail-level' do
it 'accepts full severity names' do
%w[info refactor convention warning error fatal].each do |severity|
expect { options.parse(['--fail-level', severity]) }
.not_to raise_error
end
end
it 'accepts severity initial letters' do
%w[I R C W E F].each do |severity|
expect { options.parse(['--fail-level', severity]) }
.not_to raise_error
end
end
it 'accepts the "fake" severities A/autocorrect' do
%w[autocorrect A].each do |severity|
expect { options.parse(['--fail-level', severity]) }
.not_to raise_error
end
end
end
describe '--require' do
let(:required_file_path) { './path/to/required_file.rb' }
before do
create_empty_file('example.rb')
create_file(required_file_path, "puts 'Hello from required file!'")
end
it 'requires the passed path' do
options.parse(['--require', required_file_path, 'example.rb'])
expect($stdout.string).to start_with('Hello from required file!')
end
end
describe '--cache' do
it 'fails if no argument is given' do
expect { options.parse %w[--cache] }.to raise_error(OptionParser::MissingArgument)
end
it 'fails if unrecognized argument is given' do
expect { options.parse %w[--cache maybe] }.to raise_error(RuboCop::OptionArgumentError)
end
it 'accepts true as argument' do
expect { options.parse %w[--cache true] }.not_to raise_error
end
it 'accepts false as argument' do
expect { options.parse %w[--cache false] }.not_to raise_error
end
end
describe '--cache-root' do
it 'fails if no argument is given' do
expect { options.parse %w[--cache-root] }.to raise_error(OptionParser::MissingArgument)
end
it 'fails if also `--cache false` is given' do
expect { options.parse %w[--cache false --cache-root /some/dir] }
.to raise_error(RuboCop::OptionArgumentError)
end
it 'accepts a path as argument' do
expect { options.parse %w[--cache-root /some/dir] }.not_to raise_error
end
end
describe '--disable-uncorrectable' do
it 'accepts together with --auto-correct' do
expect { options.parse %w[--auto-correct --disable-uncorrectable] }.not_to raise_error
end
it 'accepts together with --auto-correct-all' do
expect { options.parse %w[--auto-correct-all --disable-uncorrectable] }.not_to raise_error
end
it 'fails if given alone without --auto-correct/-a' do
expect { options.parse %w[--disable-uncorrectable] }
.to raise_error(RuboCop::OptionArgumentError)
end
end
describe '--exclude-limit' do
it 'fails if given last without argument' do
expect { options.parse %w[--auto-gen-config --exclude-limit] }
.to raise_error(OptionParser::MissingArgument)
end
it 'fails if given alone without argument' do
expect { options.parse %w[--exclude-limit] }.to raise_error(OptionParser::MissingArgument)
end
it 'fails if given first without argument' do
expect { options.parse %w[--exclude-limit --auto-gen-config] }
.to raise_error(OptionParser::MissingArgument)
end
it 'fails if given without --auto-gen-config' do
expect { options.parse %w[--exclude-limit 10] }
.to raise_error(RuboCop::OptionArgumentError)
end
end
describe '--auto-gen-only-exclude' do
it 'fails if given without --auto-gen-config' do
expect { options.parse %w[--auto-gen-only-exclude] }
.to raise_error(RuboCop::OptionArgumentError)
end
end
describe '--auto-gen-config' do
it 'accepts other options' do
expect { options.parse %w[--auto-gen-config --lint] }.not_to raise_error
end
end
describe '--regenerate-todo' do
subject(:parsed_options) { options.parse(command_line_options).first }
let(:config_regeneration) do
instance_double(RuboCop::ConfigRegeneration, options: todo_options)
end
let(:todo_options) { { auto_gen_config: true, exclude_limit: '100', offense_counts: false } }
before do
allow(RuboCop::ConfigRegeneration).to receive(:new).and_return(config_regeneration)
end
context 'when no other options are given' do
let(:command_line_options) { %w[--regenerate-todo] }
let(:expected_options) do
{
auto_gen_config: true,
exclude_limit: '100',
offense_counts: false,
regenerate_todo: true
}
end
it { is_expected.to eq(expected_options) }
end
context 'when todo options are overridden before --regenerate-todo' do
let(:command_line_options) { %w[--exclude-limit 50 --regenerate-todo] }
let(:expected_options) do
{
auto_gen_config: true,
exclude_limit: '50',
offense_counts: false,
regenerate_todo: true
}
end
it { is_expected.to eq(expected_options) }
end
context 'when todo options are overridden after --regenerate-todo' do
let(:command_line_options) { %w[--regenerate-todo --exclude-limit 50] }
let(:expected_options) do
{
auto_gen_config: true,
exclude_limit: '50',
offense_counts: false,
regenerate_todo: true
}
end
it { is_expected.to eq(expected_options) }
end
context 'when disabled options are overridden to be enabled' do
let(:command_line_options) { %w[--regenerate-todo --offense-counts] }
let(:expected_options) do
{
auto_gen_config: true,
exclude_limit: '100',
offense_counts: true,
regenerate_todo: true
}
end
it { is_expected.to eq(expected_options) }
end
end
describe '-s/--stdin' do
before do
$stdin = StringIO.new
$stdin.puts("{ foo: 'bar' }")
$stdin.rewind
end
it 'fails if no paths are given' do
expect { options.parse %w[-s] }.to raise_error(OptionParser::MissingArgument)
end
it 'succeeds with exactly one path' do
expect { options.parse %w[--stdin foo] }.not_to raise_error
end
it 'fails if more than one path is given' do
expect { options.parse %w[--stdin foo bar] }.to raise_error(RuboCop::OptionArgumentError)
end
end
describe '--safe-auto-correct' do
it 'is a deprecated alias' do
expect { options.parse %w[--safe-auto-correct] }.to output(/deprecated/).to_stderr
end
end
end
describe 'options precedence' do
def with_env_options(options)
ENV['RUBOCOP_OPTS'] = options
yield
ensure
ENV.delete('RUBOCOP_OPTS')
end
subject(:parsed_options) { options.parse(command_line_options).first }
let(:command_line_options) { %w[--no-color] }
describe '.rubocop file' do
before { create_file('.rubocop', '--color --fail-level C') }
it 'has lower precedence then command line options' do
expect(parsed_options).to eq(color: false, fail_level: :convention)
end
it 'has lower precedence then options from RUBOCOP_OPTS env variable' do
with_env_options '--fail-level W' do
expect(parsed_options).to eq(color: false, fail_level: :warning)
end
end
end
describe '.rubocop directory' do
before { FileUtils.mkdir '.rubocop' }
it 'is ignored and command line options are used' do
expect(parsed_options).to eq(color: false)
end
end
context 'RUBOCOP_OPTS environment variable' do
it 'has lower precedence then command line options' do
with_env_options '--color' do
expect(parsed_options).to eq(color: false)
end
end
it 'has higher precedence then options from .rubocop file' do
create_file('.rubocop', '--color --fail-level C')
with_env_options '--fail-level W' do
expect(parsed_options).to eq(color: false, fail_level: :warning)
end
end
end
end
end