forked from rubocop/rubocop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config_loader_spec.rb
1539 lines (1287 loc) · 46.5 KB
/
config_loader_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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# frozen_string_literal: true
RSpec.describe RuboCop::ConfigLoader do
include FileHelper
include_context 'cli spec behavior'
before do
described_class.debug = true
# Force reload of default configuration
described_class.default_configuration = nil
end
after { described_class.debug = false }
let(:default_config) { described_class.default_configuration }
describe '.configuration_file_for', :isolated_environment do
subject(:configuration_file_for) do
described_class.configuration_file_for(dir_path)
end
context 'when no config file exists in ancestor directories' do
let(:dir_path) { 'dir' }
before { create_empty_file('dir/example.rb') }
context 'but a config file exists in home directory' do
before { create_empty_file('~/.rubocop.yml') }
it 'returns the path to the file in home directory' do
expect(configuration_file_for).to end_with('home/.rubocop.yml')
end
end
context 'but a config file exists in default XDG config directory' do
before { create_empty_file('~/.config/rubocop/config.yml') }
it 'returns the path to the file in XDG directory' do
expect(configuration_file_for).to end_with(
'home/.config/rubocop/config.yml'
)
end
end
context 'but a config file exists in a custom XDG config directory' do
before do
ENV['XDG_CONFIG_HOME'] = '~/xdg-stuff'
create_empty_file('~/xdg-stuff/rubocop/config.yml')
end
it 'returns the path to the file in XDG directory' do
expect(configuration_file_for).to end_with(
'home/xdg-stuff/rubocop/config.yml'
)
end
end
context 'but a config file exists in both home and XDG directories' do
before do
create_empty_file('~/.config/rubocop/config.yml')
create_empty_file('~/.rubocop.yml')
end
it 'returns the path to the file in home directory' do
expect(configuration_file_for).to end_with('home/.rubocop.yml')
end
end
context 'and no config file exists in home or XDG directory' do
it 'falls back to the provided default file' do
expect(configuration_file_for).to end_with('config/default.yml')
end
end
context 'and ENV has no `HOME` defined' do
before { ENV.delete 'HOME' }
it 'falls back to the provided default file' do
expect(configuration_file_for).to end_with('config/default.yml')
end
end
end
context 'when there is a spurious rubocop config outside of the project', root: 'dir' do
let(:dir_path) { 'dir' }
before do
# Force reload of project root
described_class.project_root = nil
create_empty_file('Gemfile')
create_empty_file('../.rubocop.yml')
end
after do
# Don't leak project root change
described_class.project_root = nil
end
it 'ignores the spurious config and falls back to the provided default file if run from the project' do
expect(configuration_file_for).to end_with('config/default.yml')
end
end
context 'when a config file exists in the parent directory' do
let(:dir_path) { 'dir' }
before do
create_empty_file('dir/example.rb')
create_empty_file('.rubocop.yml')
end
it 'returns the path to that configuration file' do
expect(configuration_file_for).to end_with('work/.rubocop.yml')
end
end
context 'when multiple config files exist in ancestor directories' do
let(:dir_path) { 'dir' }
before do
create_empty_file('dir/example.rb')
create_empty_file('dir/.rubocop.yml')
create_empty_file('.rubocop.yml')
end
it 'prefers closer config file' do
expect(configuration_file_for).to end_with('dir/.rubocop.yml')
end
end
end
describe '.configuration_from_file', :isolated_environment do
subject(:configuration_from_file) do
described_class.configuration_from_file(file_path)
end
context 'with any config file' do
let(:file_path) { '.rubocop.yml' }
before do
create_file(file_path, <<~YAML)
Style/Encoding:
Enabled: false
YAML
end
it 'returns a configuration inheriting from default.yml' do
config = default_config['Style/Encoding'].dup
config['Enabled'] = false
expect(configuration_from_file.to_h)
.to eql(default_config.merge('Style/Encoding' => config))
end
end
context 'when multiple config files exist in ancestor directories' do
let(:file_path) { 'dir/.rubocop.yml' }
before do
create_file('.rubocop.yml', <<~YAML)
AllCops:
Exclude:
- vendor/**
YAML
create_file(file_path, <<~YAML)
AllCops:
Exclude: []
YAML
end
it 'gets AllCops/Exclude from the highest directory level' do
excludes = configuration_from_file['AllCops']['Exclude']
expect(excludes).to eq([File.expand_path('vendor/**')])
end
context 'and there is a personal config file in the home folder' do
before do
create_file('~/.rubocop.yml', <<~YAML)
AllCops:
Exclude:
- tmp/**
YAML
end
it 'ignores personal AllCops/Exclude' do
excludes = configuration_from_file['AllCops']['Exclude']
expect(excludes).to eq([File.expand_path('vendor/**')])
end
end
end
context 'when configuration has a custom name' do
let(:file_path) { '.custom_rubocop.yml' }
before do
create_file(file_path, <<~YAML)
AllCops:
Exclude:
- vendor/**
YAML
end
context 'and there is a personal config file in the home folder' do
before do
create_file('~/.rubocop.yml', <<~YAML)
AllCops:
Exclude:
- tmp/**
YAML
end
it 'ignores personal AllCops/Exclude' do
excludes = configuration_from_file['AllCops']['Exclude']
expect(excludes).to eq([File.expand_path('vendor/**')])
end
end
end
context 'when project has a Gemfile', :project_inside_home do
let(:file_path) { '.rubocop.yml' }
before do
create_empty_file('Gemfile')
create_file(file_path, <<~YAML)
AllCops:
Exclude:
- vendor/**
YAML
end
context 'and there is a personal config file in the home folder' do
before do
create_file('~/.rubocop.yml', <<~YAML)
AllCops:
Exclude:
- tmp/**
YAML
end
it 'ignores personal AllCops/Exclude' do
excludes = configuration_from_file['AllCops']['Exclude']
expect(excludes).to eq([File.expand_path('vendor/**')])
end
end
end
context 'when a parent file specifies DisabledByDefault: true' do
let(:file_path) { '.rubocop.yml' }
before do
create_file('disable.yml', <<~YAML)
AllCops:
DisabledByDefault: true
YAML
create_file(file_path, ['inherit_from: disable.yml'])
end
it 'disables cops by default' do
cop_options = configuration_from_file['Style/Alias']
expect(cop_options.fetch('Enabled')).to be(false)
end
end
context 'when a file inherits from a parent file' do
let(:file_path) { 'dir/.rubocop.yml' }
before do
create_file('.rubocop.yml', <<~YAML)
AllCops:
Exclude:
- vendor/**
- !ruby/regexp /[A-Z]/
YAML
create_file(file_path, ['inherit_from: ../.rubocop.yml'])
end
it 'gets an absolute AllCops/Exclude' do
excludes = configuration_from_file['AllCops']['Exclude']
expect(excludes).to eq([File.expand_path('vendor/**'), /[A-Z]/])
end
it 'ignores parent AllCops/Exclude if ignore_parent_exclusion is true' do
sub_file_path = 'vendor/.rubocop.yml'
create_file(sub_file_path, <<~YAML)
AllCops:
Exclude:
- 'foo'
YAML
# dup the class so that setting ignore_parent_exclusion doesn't
# interfere with other specs
config_loader = described_class.dup
config_loader.ignore_parent_exclusion = true
configuration = config_loader.configuration_from_file(sub_file_path)
excludes = configuration['AllCops']['Exclude']
expect(excludes).not_to include(File.expand_path('vendor/**'))
expect(excludes).to include(File.expand_path('vendor/foo'))
end
end
context 'when a file inherits from an empty parent file' do
let(:file_path) { 'dir/.rubocop.yml' }
before do
create_file('.rubocop.yml', [''])
create_file(file_path, ['inherit_from: ../.rubocop.yml'])
end
it 'does not fail to load' do
expect { configuration_from_file }.not_to raise_error
end
end
context 'when a file inherits from a sibling file' do
let(:file_path) { 'dir/.rubocop.yml' }
before do
create_file('src/.rubocop.yml', <<~YAML)
AllCops:
Exclude:
- vendor/**
YAML
create_file(file_path, ['inherit_from: ../src/.rubocop.yml'])
end
it 'gets an absolute AllCops/Exclude' do
excludes = configuration_from_file['AllCops']['Exclude']
expect(excludes).to eq([File.expand_path('src/vendor/**')])
end
end
context 'when a file inherits and overrides an Exclude' do
let(:file_path) { '.rubocop.yml' }
let(:message) do
'.rubocop.yml: Style/For:Exclude overrides the same parameter in ' \
'.rubocop_todo.yml'
end
before do
create_file(file_path, <<~YAML)
inherit_from: .rubocop_todo.yml
Style/For:
Exclude:
- spec/requests/group_invite_spec.rb
YAML
create_file('.rubocop_todo.yml', <<~YAML)
Style/For:
Exclude:
- 'spec/models/expense_spec.rb'
- 'spec/models/group_spec.rb'
YAML
end
it 'gets the Exclude overriding the inherited one with a warning' do
expect do
excludes = configuration_from_file['Style/For']['Exclude']
expect(excludes)
.to eq([File.expand_path('spec/requests/group_invite_spec.rb')])
end.to output(/#{message}/).to_stdout
end
end
context 'when a file inherits and overrides a hash with nil' do
let(:file_path) { '.rubocop.yml' }
before do
create_file('.rubocop_parent.yml', <<~YAML)
Style/InverseMethods:
InverseMethods:
:any?: :none?
:even?: :odd?
:==: :!=
:=~: :!~
:<: :>=
:>: :<=
YAML
create_file('.rubocop.yml', <<~YAML)
inherit_from: .rubocop_parent.yml
Style/InverseMethods:
InverseMethods:
:<: ~
:>: ~
:foo: :bar
YAML
end
it 'removes hash keys with nil values' do
inverse_methods =
configuration_from_file['Style/InverseMethods']['InverseMethods']
expect(inverse_methods).to eq(
'==': :!=,
'=~': :!~,
any?: :none?,
even?: :odd?,
foo: :bar
)
end
end
context 'when inherit_mode is set to merge for Exclude' do
let(:file_path) { '.rubocop.yml' }
before do
create_file(file_path, <<~YAML)
inherit_from: .rubocop_parent.yml
inherit_mode:
merge:
- Exclude
AllCops:
Exclude:
- spec/requests/expense_spec.rb
Style/For:
Exclude:
- spec/requests/group_invite_spec.rb
Style/Documentation:
Include:
- extra/*.rb
Exclude:
- junk/*.rb
YAML
create_file('.rubocop_parent.yml', <<~YAML)
Style/For:
Exclude:
- 'spec/models/expense_spec.rb'
- 'spec/models/group_spec.rb'
Style/Documentation:
inherit_mode:
merge:
- Exclude
Exclude:
- funk/*.rb
YAML
end
it 'unions the two lists of Excludes from the parent and child configs ' \
'and does not output a warning' do
expect do
excludes = configuration_from_file['Style/For']['Exclude']
expect(excludes.sort)
.to eq([File.expand_path('spec/requests/group_invite_spec.rb'),
File.expand_path('spec/models/expense_spec.rb'),
File.expand_path('spec/models/group_spec.rb')].sort)
end.not_to output(/overrides the same parameter/).to_stdout
end
it 'merges AllCops:Exclude with the default configuration' do
expect(configuration_from_file['AllCops']['Exclude'].sort)
.to eq(([File.expand_path('spec/requests/expense_spec.rb')] +
default_config['AllCops']['Exclude']).sort)
end
it 'merges Style/Documentation:Exclude with parent and ' \
'default configuration' do
expect(configuration_from_file['Style/Documentation']['Exclude'].sort)
.to eq(([File.expand_path('funk/*.rb'),
File.expand_path('junk/*.rb')] +
default_config['Style/Documentation']['Exclude']).sort)
end
it 'overrides Style/Documentation:Include' do
expect(configuration_from_file['Style/Documentation']['Include'].sort)
.to eq(['extra/*.rb'].sort)
end
end
context 'when inherit_mode overrides the global inherit_mode setting' do
let(:file_path) { '.rubocop.yml' }
before do
create_file(file_path, <<~YAML)
inherit_from: .rubocop_parent.yml
inherit_mode:
merge:
- Exclude
Style/For:
Exclude:
- spec/requests/group_invite_spec.rb
Style/Dir:
inherit_mode:
override:
- Exclude
Exclude:
- spec/requests/group_invite_spec.rb
YAML
create_file('.rubocop_parent.yml', <<~YAML)
Style/For:
Exclude:
- 'spec/models/expense_spec.rb'
- 'spec/models/group_spec.rb'
Style/Dir:
Exclude:
- 'spec/models/expense_spec.rb'
- 'spec/models/group_spec.rb'
YAML
end
it 'unions the two lists of Excludes from the parent and child configs ' \
'for cops that do not override the inherit_mode' do
expect do
excludes = configuration_from_file['Style/For']['Exclude']
expect(excludes.sort)
.to eq([File.expand_path('spec/requests/group_invite_spec.rb'),
File.expand_path('spec/models/expense_spec.rb'),
File.expand_path('spec/models/group_spec.rb')].sort)
end.not_to output(/overrides the same parameter/).to_stdout
end
it 'overwrites the Exclude from the parent when the cop overrides' \
'the global inherit_mode' do
expect do
excludes = configuration_from_file['Style/Dir']['Exclude']
expect(excludes)
.to eq([File.expand_path('spec/requests/group_invite_spec.rb')])
end.not_to output(/overrides the same parameter/).to_stdout
end
end
context 'when a department is disabled' do
let(:file_path) { '.rubocop.yml' }
shared_examples 'resolves enabled/disabled for all cops' do |enabled_by_default, disabled_by_default|
it "handles EnabledByDefault: #{enabled_by_default}, " \
"DisabledByDefault: #{disabled_by_default}" do
create_file('grandparent_rubocop.yml', <<~YAML)
Metrics/AbcSize:
Enabled: true
Metrics/PerceivedComplexity:
Enabled: true
Lint:
Enabled: false
YAML
create_file('parent_rubocop.yml', <<~YAML)
inherit_from: grandparent_rubocop.yml
Metrics:
Enabled: false
Metrics/AbcSize:
Enabled: false
YAML
create_file(file_path, <<~YAML)
inherit_from: parent_rubocop.yml
AllCops:
EnabledByDefault: #{enabled_by_default}
DisabledByDefault: #{disabled_by_default}
Style:
Enabled: false
Metrics/MethodLength:
Enabled: true
Metrics/ClassLength:
Enabled: false
Lint/RaiseException:
Enabled: true
Style/AndOr:
Enabled: true
YAML
def enabled?(cop)
configuration_from_file.for_cop(cop)['Enabled']
end
# Department disabled in parent config, cop enabled in child.
expect(enabled?('Metrics/MethodLength')).to be(true)
# Department disabled in parent config, cop disabled in child.
expect(enabled?('Metrics/ClassLength')).to be(false)
# Enabled in grandparent config, disabled in parent.
expect(enabled?('Metrics/AbcSize')).to be(false)
# Enabled in grandparent config, department disabled in parent.
expect(enabled?('Metrics/PerceivedComplexity')).to be(false)
# Pending in default config, department disabled in grandparent.
expect(enabled?('Lint/StructNewOverride')).to be(false)
# Department disabled in child config.
expect(enabled?('Style/Alias')).to be(false)
# Department disabled in child config, cop enabled in child.
expect(enabled?('Style/AndOr')).to be(true)
# Department disabled in grandparent, cop enabled in child config.
expect(enabled?('Lint/RaiseException')).to be(true)
# Cop enabled in default config, but not mentioned in user config.
expect(enabled?('Bundler/DuplicatedGem')).to eq(!disabled_by_default)
end
end
include_examples 'resolves enabled/disabled for all cops', false, false
include_examples 'resolves enabled/disabled for all cops', false, true
include_examples 'resolves enabled/disabled for all cops', true, false
end
context 'when a third party require defines a new gem' do
around do |example|
RuboCop::Cop::Registry.with_temporary_global { example.run }
end
context 'when the gem is not loaded' do
before do
create_file('.rubocop.yml', <<~YAML)
Custom/Loop:
Enabled: false
YAML
end
it 'emits a warning' do
expect { described_class.configuration_from_file('.rubocop.yml') }
.to output(
a_string_including(
'.rubocop.yml: Custom/Loop has the ' \
"wrong namespace - should be Lint\n"
)
).to_stderr
end
end
context 'when the gem is loaded' do
before do
create_file('third_party/gem.rb', <<~RUBY)
module RuboCop
module Cop
module Custom
class Loop < Cop
end
end
end
end
RUBY
create_file('.rubocop_with_require.yml', <<~YAML)
require: ./third_party/gem
Custom/Loop:
Enabled: false
YAML
end
it 'does not emit a warning' do
expect do
described_class.configuration_from_file('.rubocop_with_require.yml')
end.not_to output.to_stderr
end
end
end
context 'when a file inherits from a parent and grandparent file' do
let(:file_path) { 'dir/subdir/.rubocop.yml' }
before do
create_empty_file('dir/subdir/example.rb')
create_file('.rubocop.yml', <<~YAML)
Layout/LineLength:
Enabled: false
Max: 77
YAML
create_file('dir/.rubocop.yml', <<~YAML)
inherit_from: ../.rubocop.yml
Metrics/MethodLength:
Enabled: true
CountComments: false
Max: 10
YAML
create_file(file_path, <<~YAML)
inherit_from: ../.rubocop.yml
Layout/LineLength:
Enabled: true
Metrics/MethodLength:
Max: 5
YAML
end
it 'returns the ancestor configuration plus local overrides' do
config =
default_config.merge(
'Layout/LineLength' => {
'Description' =>
default_config['Layout/LineLength']['Description'],
'StyleGuide' => '#max-line-length',
'Enabled' => true,
'VersionAdded' =>
default_config['Layout/LineLength']['VersionAdded'],
'VersionChanged' =>
default_config['Layout/LineLength']['VersionChanged'],
'AutoCorrect' => false,
'Max' => 77,
'AllowHeredoc' => true,
'AllowURI' => true,
'URISchemes' => %w[http https],
'IgnoreCopDirectives' => true,
'IgnoredPatterns' => []
},
'Metrics/MethodLength' => {
'Description' =>
default_config['Metrics/MethodLength']['Description'],
'StyleGuide' => '#short-methods',
'Enabled' => true,
'VersionAdded' =>
default_config['Metrics/MethodLength']['VersionAdded'],
'VersionChanged' =>
default_config['Metrics/MethodLength']['VersionChanged'],
'CountComments' => false,
'Max' => 5,
'CountAsOne' => [],
'ExcludedMethods' => []
}
)
expect do
expect(configuration_from_file.to_h).to eq(config)
end.to output('').to_stderr
end
end
context 'when a file inherits from two configurations' do
let(:file_path) { '.rubocop.yml' }
before do
create_empty_file('example.rb')
create_file('normal.yml', <<~YAML)
Metrics/MethodLength:
Enabled: false
CountComments: true
Max: 80
YAML
create_file('special.yml', <<~YAML)
Metrics/MethodLength:
Enabled: false
Max: 200
YAML
create_file(file_path, <<~YAML)
inherit_from:
- normal.yml
- special.yml
Metrics/MethodLength:
Enabled: true
YAML
end
it 'returns values from the last one when possible' do
expected = { 'Enabled' => true, # overridden in .rubocop.yml
'CountComments' => true, # only defined in normal.yml
'Max' => 200 } # special.yml takes precedence
expect do
expect(configuration_from_file['Metrics/MethodLength']
.to_set.superset?(expected.to_set)).to be(true)
end.to output(/#{<<~OUTPUT}/).to_stdout
.rubocop.yml: Metrics/MethodLength:Enabled overrides the same parameter in normal.yml
.rubocop.yml: Metrics/MethodLength:Enabled overrides the same parameter in special.yml
.rubocop.yml: Metrics/MethodLength:Max overrides the same parameter in special.yml
OUTPUT
end
end
context 'when a file inherits and overrides with non-namedspaced cops' do
let(:file_path) { '.rubocop.yml' }
before do
create_empty_file('example.rb')
create_file('line_length.yml', <<~YAML)
LineLength:
Max: 120
YAML
create_file(file_path, <<~YAML)
inherit_from:
- line_length.yml
LineLength:
AllowHeredoc: false
YAML
end
it 'returns includes both of the cop changes' do
config =
default_config.merge(
'Layout/LineLength' => {
'Description' =>
default_config['Layout/LineLength']['Description'],
'StyleGuide' => '#max-line-length',
'Enabled' => true,
'VersionAdded' =>
default_config['Layout/LineLength']['VersionAdded'],
'VersionChanged' =>
default_config['Layout/LineLength']['VersionChanged'],
'AutoCorrect' => false,
'Max' => 120, # overridden in line_length.yml
'AllowHeredoc' => false, # overridden in rubocop.yml
'AllowURI' => true,
'URISchemes' => %w[http https],
'IgnoreCopDirectives' => true,
'IgnoredPatterns' => []
}
)
expect(configuration_from_file.to_h).to eq(config)
end
end
context 'when a file inherits from an expanded path' do
let(:file_path) { '.rubocop.yml' }
before do
create_file('~/.rubocop.yml', [''])
create_file(file_path, ['inherit_from: ~/.rubocop.yml'])
end
it 'does not fail to load expanded path' do
expect { configuration_from_file }.not_to raise_error
end
end
context 'when a file inherits from an unknown gem' do
let(:file_path) { '.rubocop.yml' }
before do
create_file(file_path, <<~YAML)
inherit_gem:
not_a_real_gem: config/rubocop.yml
YAML
end
it 'fails to load' do
expect { configuration_from_file }.to raise_error(Gem::LoadError)
end
end
context 'when a file inherits from the rubocop gem' do
let(:file_path) { '.rubocop.yml' }
before do
create_file(file_path, <<~YAML)
inherit_gem:
rubocop: config/default.yml
YAML
end
it 'fails to load' do
expect { configuration_from_file }.to raise_error(ArgumentError)
end
end
context 'when a file inherits from a known gem' do
let(:file_path) { '.rubocop.yml' }
let(:gem_root) { File.expand_path('gems') }
before do
create_file("#{gem_root}/gemone/config/rubocop.yml",
<<~YAML)
Metrics/MethodLength:
Enabled: false
Max: 200
CountComments: false
YAML
create_file("#{gem_root}/gemtwo/config/default.yml",
<<~YAML)
Layout/LineLength:
Enabled: true
YAML
create_file("#{gem_root}/gemtwo/config/strict.yml",
<<~YAML)
Layout/LineLength:
Max: 72
AllowHeredoc: false
YAML
create_file('local.yml', <<~YAML)
Metrics/MethodLength:
CountComments: true
YAML
create_file(file_path, <<~YAML)
inherit_gem:
gemone: config/rubocop.yml
gemtwo:
- config/default.yml
- config/strict.yml
inherit_from: local.yml
Metrics/MethodLength:
Enabled: true
Layout/LineLength:
AllowURI: false
YAML
end
context 'and the gem is globally installed' do
before do
gem_class = Struct.new(:gem_dir)
%w[gemone gemtwo].each do |gem_name|
mock_spec = gem_class.new(File.join(gem_root, gem_name))
allow(Gem::Specification).to receive(:find_by_name)
.with(gem_name).and_return(mock_spec)
end
allow(Gem).to receive(:path).and_return([gem_root])
end
it 'returns values from the gem config with local overrides' do
expected = { 'Enabled' => true, # overridden in .rubocop.yml
'CountComments' => true, # overridden in local.yml
'Max' => 200 } # inherited from somegem
expect do
expect(configuration_from_file['Metrics/MethodLength']
.to_set.superset?(expected.to_set)).to be(true)
end.to output('').to_stderr
expected = { 'Enabled' => true, # gemtwo/config/default.yml
'Max' => 72, # gemtwo/config/strict.yml
'AllowHeredoc' => false, # gemtwo/config/strict.yml
'AllowURI' => false } # overridden in .rubocop.yml
expect(
configuration_from_file['Layout/LineLength']
.to_set.superset?(expected.to_set)
).to be(true)
end
end
context 'and the gem is bundled' do
before do
specs = {
'gemone' => [OpenStruct.new(full_gem_path: File.join(gem_root, 'gemone'))],
'gemtwo' => [OpenStruct.new(full_gem_path: File.join(gem_root, 'gemtwo'))]
}
allow(Bundler).to receive(:load).and_return(OpenStruct.new(specs: specs))
end
it 'returns values from the gem config with local overrides' do
expected = { 'Enabled' => true, # overridden in .rubocop.yml
'CountComments' => true, # overridden in local.yml
'Max' => 200 } # inherited from somegem
expect do
expect(configuration_from_file['Metrics/MethodLength']
.to_set.superset?(expected.to_set)).to be(true)
end.to output('').to_stderr
expected = { 'Enabled' => true, # gemtwo/config/default.yml
'Max' => 72, # gemtwo/config/strict.yml
'AllowHeredoc' => false, # gemtwo/config/strict.yml
'AllowURI' => false } # overridden in .rubocop.yml
expect(
configuration_from_file['Layout/LineLength']
.to_set.superset?(expected.to_set)
).to be(true)
end
end
end
context 'when a file inherits from a url inheriting from a gem' do
let(:file_path) { '.rubocop.yml' }
let(:cache_file) { '.rubocop-http---example-com-default-yml' }
let(:gem_root) { File.expand_path('gems') }
let(:gem_name) { 'somegem' }
before do
create_file(file_path, ['inherit_from: http://example.com/default.yml'])
stub_request(:get, %r{example.com/default})
.to_return(status: 200, body: "inherit_gem:\n #{gem_name}: default.yml")
create_file("#{gem_root}/#{gem_name}/default.yml", ["Layout/LineLength:\n Max: 48"])
mock_spec = OpenStruct.new(gem_dir: File.join(gem_root, gem_name))
allow(Gem::Specification).to receive(:find_by_name)
.with(gem_name).and_return(mock_spec)