rubocop-rspec 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a2433cc3212de48725bca4fa2f8216ef0742950d1b0ad0a52e0d717050ede4e
-  data.tar.gz: 3e43165a772275ece7344813b6dfc5196669763013c0bedc3b75107cf6fa0f30
+  metadata.gz: 5852eb2103d4a2993b2174b7e4c97f5f7f09041c49407122ab6568d744d52c09
+  data.tar.gz: 710d277b8be358c99cadf4ca500141d23fa73347ba3f29db0585a1e7026abd73
 SHA512:
-  metadata.gz: 41a9171c098150e3349977cd08df5f369fe2d33c0bb4f1b29edcfb2633eae2c880ab1ff71a9c4a1ee5dc28645a6359ecd3e4ab99a822ac576523386e78364ee2
-  data.tar.gz: af1c164ac3d8c9e9ed61611fa9877c459656f695fd45c057c776af99304fcd8471fa00d958d7bf650ba46f82056ae96accd12cfeec17eb1a00129baffdb51768
+  metadata.gz: e27d20e6945c05f12af9fc24e17e42691186b332611d96eb9e7a5444476de44209517ccdb4829096cff659e7a7d1b98941ff632b3f7f5a547aa4dc82d3e18e38
+  data.tar.gz: 93a9cb481828abc2e313129cec383d38de5261f382d7ae6fcabe42bd0146b5a134b90991df47cc0bade3c1e4266cbfcf733f35ea7bee8eafaa3e5e4236a0b3ca

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 3.5.0 (2025-02-16)
+
+- Don't let `RSpec/PredicateMatcher` replace `respond_to?` with two arguments with the RSpec `respond_to` matcher. ([@bquorning])
+- Fix `RSpec/PredicateMatcher` support for `eql` and `equal` matchers. ([@bquorning])
+- Pluginfy RuboCop RSpec. ([@koic])
+
 ## 3.4.0 (2025-01-20)
 
 - Fix `RSpec/SortMetadata` cop to limit sorting to trailing metadata arguments. ([@cbliard])

data/README.md

@@ -48,13 +48,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rspec
+plugins: rubocop-rspec
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-rspec
 ```
@@ -62,17 +62,20 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```bash
-rubocop --require rubocop-rspec
+rubocop --plugin rubocop-rspec
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec'
+  task.plugins << 'rubocop-rspec'
 end
 ```
 

data/lib/rubocop/cop/rspec/be_eq.rb

@@ -31,7 +31,7 @@ module RuboCop
 
         # @!method eq_type_with_identity?(node)
         def_node_matcher :eq_type_with_identity?, <<~PATTERN
-          (send nil? :eq {true false nil})
+          (send nil? :eq {boolean nil})
         PATTERN
 
         def on_send(node)

data/lib/rubocop/cop/rspec/be_eql.rb

@@ -45,7 +45,7 @@ module RuboCop
 
         # @!method eql_type_with_identity(node)
         def_node_matcher :eql_type_with_identity, <<~PATTERN
-          (send _ :to $(send nil? :eql {true false int float sym nil}))
+          (send _ :to $(send nil? :eql {boolean int float sym nil}))
         PATTERN
 
         def on_send(node)

data/lib/rubocop/cop/rspec/be_nil.rb

@@ -48,6 +48,10 @@ module RuboCop
             check_be_style(node)
           when :be_nil
             check_be_nil_style(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

data/lib/rubocop/cop/rspec/change_by_zero.rb

@@ -101,7 +101,6 @@ module RuboCop
 
         private
 
-        # rubocop:disable Metrics/MethodLength
         def register_offense(node, change_node)
           if compound_expectations?(node)
             add_offense(node,
@@ -115,7 +114,6 @@ module RuboCop
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def compound_expectations?(node)
           node.parent.send_type? &&

data/lib/rubocop/cop/rspec/example_wording.rb

@@ -67,7 +67,6 @@ module RuboCop
           } ...) ...)
         PATTERN
 
-        # rubocop:disable Metrics/MethodLength
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           it_description(node) do |description_node, message|
             if message.match?(SHOULD_PREFIX)
@@ -82,7 +81,6 @@ module RuboCop
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 
@@ -128,7 +126,7 @@ module RuboCop
             node.node_parts.map { |child_node| text(child_node) }.join
           when :str
             node.value
-          when :begin
+          else
             node.source
           end
         end

data/lib/rubocop/cop/rspec/excessive_docstring_spacing.rb

@@ -100,7 +100,7 @@ module RuboCop
             node.node_parts.map { |child_node| text(child_node) }.join
           when :str, :sym
             node.value
-          when :begin
+          else
             node.source
           end
         end

data/lib/rubocop/cop/rspec/expect_actual.rb

@@ -65,7 +65,7 @@ module RuboCop
           )
         PATTERN
 
-        def on_send(node) # rubocop:disable Metrics/MethodLength
+        def on_send(node)
           expect_literal(node) do |actual, send_node, matcher, expected|
             next if SKIPPED_MATCHERS.include?(matcher)
 

data/lib/rubocop/cop/rspec/focus.rb

@@ -75,23 +75,27 @@ module RuboCop
         def on_send(node)
           return if node.chained? || node.each_ancestor(:def, :defs).any?
 
-          focus_metadata(node) do |focus|
-            add_offense(focus) do |corrector|
-              if focus.pair_type? || focus.str_type? || focus.sym_type?
-                corrector.remove(with_surrounding(focus))
-              elsif focus.send_type?
-                correct_send(corrector, focus)
-              end
+          if focused_block?(node)
+            on_focused_block(node)
+          else
+            metadata(node) do |focus|
+              on_metadata(focus)
             end
           end
         end
 
         private
 
-        def focus_metadata(node, &block)
-          yield(node) if focused_block?(node)
+        def on_focused_block(node)
+          add_offense(node) do |corrector|
+            correct_send(corrector, node)
+          end
+        end
 
-          metadata(node, &block)
+        def on_metadata(node)
+          add_offense(node) do |corrector|
+            corrector.remove(with_surrounding(node))
+          end
         end
 
         def with_surrounding(focus)

data/lib/rubocop/cop/rspec/implicit_expect.rb

@@ -46,7 +46,7 @@ module RuboCop
 
         ENFORCED_REPLACEMENTS = alternatives.merge(alternatives.invert).freeze
 
-        def on_send(node) # rubocop:disable Metrics/MethodLength
+        def on_send(node)
           return unless (source_range = offending_expect(node))
 
           expectation_source = source_range.source
@@ -69,13 +69,13 @@ module RuboCop
         def offending_expect(node)
           case implicit_expect(node)
           when :is_expected
-            is_expected_range(node.loc)
+            range_for_is_expected(node.loc)
           when :should, :should_not
             node.loc.selector
           end
         end
 
-        def is_expected_range(source_map) # rubocop:disable Naming/PredicateName
+        def range_for_is_expected(source_map)
           Parser::Source::Range.new(
             source_map.expression.source_buffer,
             source_map.expression.begin_pos,

data/lib/rubocop/cop/rspec/implicit_subject.rb

@@ -107,6 +107,10 @@ module RuboCop
             corrector.replace(node.location.selector, 'expect(subject).to')
           when :should_not
             corrector.replace(node.location.selector, 'expect(subject).not_to')
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 
@@ -129,6 +133,10 @@ module RuboCop
             implicit_subject_in_non_its_and_non_single_line?(node)
           when :single_statement_only
             implicit_subject_in_non_its_and_non_single_statement?(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

data/lib/rubocop/cop/rspec/indexed_let.rb

@@ -74,7 +74,9 @@ module RuboCop
         private
 
         SUFFIX_INDEX_REGEX = /_?\d+$/.freeze
+        private_constant :SUFFIX_INDEX_REGEX
         INDEX_REGEX = /\d+/.freeze
+        private_constant :INDEX_REGEX
 
         def filter_indexed_lets(candidates)
           candidates

data/lib/rubocop/cop/rspec/message_spies.rb

@@ -80,6 +80,10 @@ module RuboCop
             MSG_RECEIVE
           when :have_received
             format(MSG_HAVE_RECEIVED, source: receiver.source)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
       end

data/lib/rubocop/cop/rspec/predicate_matcher.rb

@@ -15,6 +15,8 @@ module RuboCop
 
         def check_inflected(node)
           predicate_in_actual?(node) do |predicate, to, matcher|
+            next if cannot_replace_predicate?(predicate)
+
             msg = message_inflected(predicate)
             add_offense(node, message: msg) do |corrector|
               remove_predicate(corrector, predicate)
@@ -35,9 +37,13 @@ module RuboCop
             $#boolean_matcher? ...)
         PATTERN
 
+        def cannot_replace_predicate?(send_node)
+          send_node.method?(:respond_to?) && send_node.arguments.length > 1
+        end
+
         # @!method be_bool?(node)
         def_node_matcher :be_bool?, <<~PATTERN
-          (send nil? {:be :eq :eql :equal} {true false})
+          (send nil? {:be :eq :eql :equal} boolean)
         PATTERN
 
         # @!method be_boolthy?(node)
@@ -63,7 +69,6 @@ module RuboCop
                  matcher_name: to_predicate_matcher(predicate.method_name))
         end
 
-        # rubocop:disable Metrics/MethodLength
         def to_predicate_matcher(name)
           case name = name.to_s
           when 'is_a?'
@@ -80,7 +85,6 @@ module RuboCop
             "be_#{name[0..-2]}"
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def remove_predicate(corrector, predicate)
           range = predicate.loc.dot.with(
@@ -106,12 +110,16 @@ module RuboCop
 
         def true?(to_symbol, matcher)
           result = case matcher.method_name
-                   when :be, :eq
+                   when :be, :eq, :eql, :equal
                      matcher.first_argument.true_type?
                    when :be_truthy, :a_truthy_value
                      true
                    when :be_falsey, :be_falsy, :a_falsey_value, :a_falsy_value
                      false
+                   else
+                     # :nocov:
+                     :noop
+                     # :nocov:
                    end
           to_symbol == :to ? result : !result
         end
@@ -233,7 +241,6 @@ module RuboCop
           corrector.insert_after(actual, ".#{predicate}" + args + block)
         end
 
-        # rubocop:disable Metrics/MethodLength
         def to_predicate_method(matcher)
           case matcher = matcher.to_s
           when 'be_a', 'be_an', 'be_a_kind_of', 'a_kind_of', 'be_kind_of'
@@ -250,7 +257,6 @@ module RuboCop
             "#{matcher[/\Abe_(.+)/, 1]}?"
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def replacement_matcher(node)
           case [cop_config['Strict'], node.method?(:to)]
@@ -260,7 +266,7 @@ module RuboCop
             'be(false)'
           when [false, true]
             'be_truthy'
-          when [false, false]
+          else
             'be_falsey'
           end
         end
@@ -329,6 +335,10 @@ module RuboCop
             check_inflected(node)
           when :explicit
             check_explicit(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

data/lib/rubocop/cop/rspec/return_from_stub.rb

@@ -80,10 +80,10 @@ module RuboCop
 
         def check_block_body(block)
           body = block.body
-          unless dynamic?(body) # rubocop:disable Style/GuardClause
-            add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
-              BlockBodyCorrector.new(block).call(corrector)
-            end
+          return if dynamic?(body)
+
+          add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
+            BlockBodyCorrector.new(block).call(corrector)
           end
         end
 
@@ -162,6 +162,7 @@ module RuboCop
           end
 
           NULL_BLOCK_BODY = Struct.new(:loc, :source).new(nil, 'nil')
+          private_constant :NULL_BLOCK_BODY
         end
       end
     end

data/lib/rubocop/rspec/config_formatter.rb

@@ -6,9 +6,7 @@ module RuboCop
   module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
-      EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
-      SUBDEPARTMENTS = [].freeze
-      AMENDMENTS = %(Metrics/BlockLength)
+      EXTENSION_ROOT_DEPARTMENT = %r{^RSpec/}.freeze
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
       def initialize(config, descriptions)
@@ -18,18 +16,15 @@ module RuboCop
 
       def dump
         YAML.dump(unified_config)
-          .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
-          .gsub(*AMENDMENTS, "\n\\0")
-          .gsub(/^(\s+)- /, '\1  - ')
-          .gsub('"~"', '~')
+          .gsub(%r{^\w+/}, "\n\\0")   # Add an extra newline before each cop.
+          .gsub(/^(\s+)- /, '\1  - ') # Add 2 spaces before each array element.
+          .gsub('"~"', '~')           # Don't quote tilde, YAML's null value.
       end
 
       private
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
-          next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
-
           replace_nil(unified[cop])
           unified[cop].merge!(descriptions.fetch(cop))
           unified[cop]['Reference'] = reference(cop)

data/lib/rubocop/rspec/plugin.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module RSpec
+    # A plugin that integrates RuboCop RSpec with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rspec',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rspec',
+          description: 'Code style checking for RSpec files.'
+        )
+      end
+      # :nocov:
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        ConfigObsoletion.files << project_root.join('config', 'obsoletion.yml')
+
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '3.4.0'
+      STRING = '3.5.0'
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -17,7 +17,6 @@ module RuboCop
         @replacements = replace
       end
 
-      # rubocop:disable Metrics/MethodLength
       def rewrite
         case text
         when SHOULDNT_BE_PREFIX
@@ -32,7 +31,6 @@ module RuboCop
           remove_should_and_pluralize
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/rubocop/rspec.rb

@@ -3,12 +3,5 @@
 module RuboCop
   # RuboCop RSpec project namespace
   module RSpec
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config',
-                                                           'obsoletion.yml')
   end
 end

data/lib/rubocop-rspec.rb

@@ -6,9 +6,9 @@ require 'yaml'
 require 'rubocop'
 
 require_relative 'rubocop/rspec'
-require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/node'
+require_relative 'rubocop/rspec/plugin'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/wording'
 
@@ -34,8 +34,6 @@ require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/hook'
 
-RuboCop::RSpec::Inject.defaults!
-
 require_relative 'rubocop/cop/rspec_cops'
 
 # We have to register our autocorrect incompatibilities in RuboCop's cops

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - John Backus
@@ -9,22 +9,42 @@ authors:
 - Nils Gemeinhardt
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '1.72'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '1.72'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
 description: |
   Code style checking for RSpec files.
   A plugin for the RuboCop code style enforcing & linting tool.
@@ -178,9 +198,9 @@ files:
 - lib/rubocop/rspec/example.rb
 - lib/rubocop/rspec/example_group.rb
 - lib/rubocop/rspec/hook.rb
-- lib/rubocop/rspec/inject.rb
 - lib/rubocop/rspec/language.rb
 - lib/rubocop/rspec/node.rb
+- lib/rubocop/rspec/plugin.rb
 - lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop/rspec/wording.rb
@@ -191,6 +211,7 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
   rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::RSpec::Plugin
 rdoc_options: []
 require_paths:
 - lib

data/lib/rubocop/rspec/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = RuboCop::Config.new(hash, path)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end