Merge pull request #838 from mkrawc/feature/configure_allowed_explicit_predicate_matchers

Add AllowedExplicitMatchers config option for RSpec/PredicateMatcher

Author: bquorning

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Fix documentation rake task to support Rubocop 0.75. ([@nickcampbell18][])
 * Fix `RSpec/SubjectStub` to detect implicit subjects stubbed. ([@QQism][])
 * Fix `RSpec/Pending` not flagging `skip` with string values. ([@pirj][])
+* Add `AllowedExplicitMatchers` config option for `RSpec/PredicateMatcher`. ([@mkrawc][])
 
 ## 1.36.0 (2019-09-27)
 
@@ -460,3 +461,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@nickcampbell18]: https://github.com/nickcampbell18
 [@QQism]: https://github.com/QQism
 [@kellysutton]: https://github.com/kellysutton
+[@mkrawc]: https://github.com/mkrawc

config/default.yml

@@ -368,6 +368,7 @@ RSpec/PredicateMatcher:
   Enabled: true
   Strict: true
   EnforcedStyle: inflected
+  AllowedExplicitMatchers: []
   SupportedStyles:
   - inflected
   - explicit

lib/rubocop/cop/rspec/predicate_matcher.rb

@@ -138,6 +138,10 @@ module ExplicitHelper
 
         private
 
+        def allowed_explicit_matchers
+          cop_config.fetch('AllowedExplicitMatchers', []) + BUILT_IN_MATCHERS
+        end
+
         def check_explicit(node) # rubocop:disable Metrics/MethodLength
           predicate_matcher_block?(node) do |_actual, matcher|
             add_offense(
@@ -178,7 +182,7 @@ def check_explicit(node) # rubocop:disable Metrics/MethodLength
         def predicate_matcher_name?(name)
           name = name.to_s
 
-          return false if BUILT_IN_MATCHERS.include?(name)
+          return false if allowed_explicit_matchers.include?(name)
 
           name.start_with?('be_', 'have_') && !name.end_with?('?')
         end

manual/cops_rspec.md

@@ -2430,6 +2430,7 @@ Name | Default value | Configurable values
 --- | --- | ---
 Strict | `true` | Boolean
 EnforcedStyle | `inflected` | `inflected`, `explicit`
+AllowedExplicitMatchers | `[]` | Array
 
 ### References
 

spec/rubocop/cop/rspec/predicate_matcher_spec.rb

@@ -5,8 +5,10 @@
 
   let(:cop_config) do
     { 'EnforcedStyle' => enforced_style,
-      'Strict' => strict }
+      'Strict' => strict,
+      'AllowedExplicitMatchers' => allowed_explicit_matchers }
   end
+  let(:allowed_explicit_matchers) { [] }
 
   context 'when enforced style is `inflected`' do
     let(:enforced_style) { 'inflected' }
@@ -270,6 +272,16 @@
         RUBY
       end
 
+      context 'when custom matchers are allowed' do
+        let(:allowed_explicit_matchers) { ['have_http_status'] }
+
+        it 'accepts custom allowed explicit matchers' do
+          expect_no_offenses(<<-RUBY)
+            expect(foo).to have_http_status(:ok)
+          RUBY
+        end
+      end
+
       it 'accepts non-predicate matcher' do
         expect_no_offenses(<<-RUBY)
           expect(foo).to be(true)