Merge pull request #1256 from luke-hill/patch-1

Exclude all spec blocks from Metrics/BlockLength

Author: pirj

.rubocop.yml

@@ -51,7 +51,6 @@ Metrics/BlockLength:
     - rubocop-rspec.gemspec
     - Rakefile
     - '**/*.rake'
-    - spec/**/*.rb
 
 Naming/FileName:
   Exclude:

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Drop Ruby 2.5 support. ([@ydah][])
 * Add new `RSpec/ChangeByZero` cop. ([@ydah][])
 * Improve `RSpec/ExpectChange` to detect namespaced and top-level constants. ([@M-Yamashita01][])
+* Introduce an amendment to `Metrics/BlockLength` to exclude spec files. ([@luke-hill][])
 
 ## 2.10.0 (2022-04-19)
 
@@ -686,3 +687,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@ydah]: https://github.com/ydah
 [@t3h2mas]: https://github.com/t3h2mas
 [@M-Yamashita01]: https://github.com/M-Yamashita01
+[@luke-hill]: https://github.com/luke-hill

config/default.yml

@@ -110,6 +110,14 @@ RSpec:
       - subject
       - subject!
 
+Metrics/BlockLength:
+  inherit_mode:
+    merge:
+      - Exclude
+  Exclude:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+
 RSpec/AlignLeftLetBrace:
   Description: Checks that left braces for adjacent single line lets are aligned.
   Enabled: false

lib/rubocop/rspec/config_formatter.rb

@@ -8,6 +8,7 @@ module RSpec
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
+      AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
 
       def initialize(config, descriptions)
@@ -18,6 +19,7 @@ def initialize(config, descriptions)
       def dump
         YAML.dump(unified_config)
           .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
+          .gsub(*AMENDMENTS, "\n\\0")
           .gsub(/^(\s+)- /, '\1  - ')
       end
 
@@ -26,6 +28,7 @@ def dump
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
           next if SUBDEPARTMENTS.include?(cop)
+          next if AMENDMENTS.include?(cop)
 
           unified[cop].merge!(descriptions.fetch(cop))
           unified[cop]['Reference'] = COP_DOC_BASE_URL + cop.sub('RSpec/', '')

spec/project/default_config_spec.rb

@@ -42,8 +42,9 @@ def cop_configuration(config_key)
     end
   end
 
-  it 'has configuration for all cops' do
-    expect(default_config.keys).to match_array(config_keys)
+  it 'has configuration for all cops and amendments' do
+    expect(default_config.keys)
+      .to match_array([*config_keys, 'Metrics/BlockLength'])
   end
 
   it 'sorts configuration keys alphabetically', :pending do