Merge pull request rubocop#695 from rubocop-hq/sort-config-alphabetically

bquorning · web-flow · commit a791b4d45134 · 2018-10-04T15:30:51.000+02:00
Sort config alphabetically
diff --git a/config/default.yml b/config/default.yml
@@ -10,16 +10,6 @@ AllCops:
     - spec/factories/**/*.rb
     - features/support/factories/**/*.rb
 
-RSpec/AnyInstance:
-  Description: Check that instances are not being stubbed globally.
-  Enabled: true
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AnyInstance
-
-RSpec/AroundBlock:
-  Description: Checks that around blocks actually run the test.
-  Enabled: true
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AroundBlock
-
 RSpec/AlignLeftLetBrace:
   Description: Checks that left braces for adjacent single line lets are aligned.
   Enabled: false
@@ -30,6 +20,16 @@ RSpec/AlignRightLetBrace:
   Enabled: false
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AlignRightLetBrace
 
+RSpec/AnyInstance:
+  Description: Check that instances are not being stubbed globally.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AnyInstance
+
+RSpec/AroundBlock:
+  Description: Checks that around blocks actually run the test.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AroundBlock
+
 RSpec/Be:
   Description: Check for expectations where `be` is used without argument.
   Enabled: true
@@ -63,16 +63,6 @@ RSpec/DescribeClass:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeClass
 
-RSpec/DescribedClass:
-  Description: Checks that tests use `described_class`.
-  SkipBlocks: false
-  Enabled: true
-  EnforcedStyle: described_class
-  SupportedStyles:
-  - described_class
-  - explicit
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribedClass
-
 RSpec/DescribeMethod:
   Description: Checks that the second argument to `describe` specifies a method.
   Enabled: true
@@ -83,10 +73,15 @@ RSpec/DescribeSymbol:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeSymbol
 
-RSpec/IteratedExpectation:
-  Description: Check that `all` matcher is used instead of iterating over an array.
+RSpec/DescribedClass:
+  Description: Checks that tests use `described_class`.
+  SkipBlocks: false
   Enabled: true
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IteratedExpectation
+  EnforcedStyle: described_class
+  SupportedStyles:
+  - described_class
+  - explicit
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribedClass
 
 RSpec/EmptyExampleGroup:
   Description: Checks if an example group does not include any tests.
@@ -240,6 +235,11 @@ RSpec/ItBehavesLike:
   - it_should_behave_like
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ItBehavesLike
 
+RSpec/IteratedExpectation:
+  Description: Check that `all` matcher is used instead of iterating over an array.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IteratedExpectation
+
 RSpec/LeadingSubject:
   Description: Enforce that subject is the first definition in the test.
   Enabled: true
@@ -369,6 +369,16 @@ RSpec/ReturnFromStub:
   - block
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ReturnFromStub
 
+RSpec/ScatteredLet:
+  Description: Checks for let scattered across the example group.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ScatteredLet
+
+RSpec/ScatteredSetup:
+  Description: Checks for setup scattered across multiple hooks in an example group.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ScatteredSetup
+
 RSpec/SharedContext:
   Description: Checks for proper shared_context and shared_examples usage.
   Enabled: true
@@ -384,16 +394,6 @@ RSpec/SingleArgumentMessageChain:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SingleArgumentMessageChain
 
-RSpec/ScatteredLet:
-  Description: Checks for let scattered across the example group.
-  Enabled: true
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ScatteredLet
-
-RSpec/ScatteredSetup:
-  Description: Checks for setup scattered across multiple hooks in an example group.
-  Enabled: true
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ScatteredSetup
-
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: true
diff --git a/spec/project/default_config_spec.rb b/spec/project/default_config_spec.rb
@@ -3,13 +3,16 @@
     RuboCop::ConfigLoader.load_file('config/default.yml')
   end
 
-  let(:cop_names) do
-    namespaces = {
+  let(:namespaces) do
+    {
       'rspec' => 'RSpec',
       'capybara' => 'Capybara',
       'factory_bot' => 'FactoryBot',
       'rails' => 'Rails'
     }
+  end
+
+  let(:cop_names) do
     glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec',
                                  '{,capybara,factory_bot,rails}', '*.rb')
     cop_names =
@@ -38,7 +41,17 @@ def cop_configuration(config_key)
   end
 
   it 'has configuration for all cops' do
-    expect(default_config.keys.sort).to eq(config_keys.sort)
+    expect(default_config.keys).to match_array(config_keys)
+  end
+
+  it 'sorts configuration keys alphabetically' do
+    namespaces.each do |_path, prefix|
+      expected = config_keys.select { |key| key.start_with?(prefix) }.sort
+      actual = default_config.keys.select { |key| key.start_with?(prefix) }
+      actual.each_with_index do |key, idx|
+        expect(key).to eq expected[idx]
+      end
+    end
   end
 
   it 'has descriptions for all cops' do
