rubocop-rspec 3.10.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5b6ac2158196f3722c9b53e233a5f96becfced4ae47abe76ad577f3e258ff1c
-  data.tar.gz: be3134943d1be32c95f193ef984e27ba7ce3091b862e0e338afb8167c3e3b106
+  metadata.gz: 4dd90ecda80edb7aeadd84bf5866b0d6b7d44dca8d56601782b5686fa75c970e
+  data.tar.gz: 5205b01345d70457d949142a464639589df5f87f3cd1ddfe7c8a64439bb519a1
 SHA512:
-  metadata.gz: 51df438548b237d380ada23cfc3e38d399e86951588acda134bf23abe6ad7b36d206e4eddd52457695ac74aba24ec84535074828827b953ad46ac6932315f0c4
-  data.tar.gz: 93eb7b7f6c8cfad2a5e816488ef9a60df934814947086b4b702d634ac9f6643dbafdd8acec8ab1eb8449c8e76e710ff794990b22213d7335e916b65054b87981
+  metadata.gz: cca8c27b7c61499264c8dd30009dd00a1c3d13cc5dda8efa4ff930706845d8c7ce7630f1402520dd421d36a1ed2971dfa62f0f182fc032ebae7920618ba3aaa9
+  data.tar.gz: b605960f8d588ccab7ebfa78874fe317e0fdf9c7db3b5cd0bdf682d226ac5326475f0cb05a123b491c21ccde6c60f82cc2cee18c30e593b6dc0ac204520fdebc

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 3.10.1 (2026-06-05)
+
+- Add `Strict` option to `RSpec/SharedContext` to flag `shared_context` whenever it contains examples, even alongside setup code. ([@Darhazer])
+- Add `NegatedMatcher` configuration option `RSpec/ExpectChange`. ([@Darhazer])
+- Fix `RSpec/MatchWithSimpleRegex` to ignore regular expressions with interpolations. ([@bquorning])
+
 ## 3.10.0 (2026-06-05)
 
 - Add new cop `RSpec/MatchWithSimpleRegex` to suggest `include` matcher when `match` is used with simple string literals without regex-specific features. ([@bquorning])

data/config/default.yml

@@ -460,7 +460,8 @@ RSpec/ExpectChange:
     - block
   SafeAutoCorrect: false
   VersionAdded: '1.22'
-  VersionChanged: '2.5'
+  VersionChanged: '3.10'
+  NegatedMatcher: ~
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectChange
 
 RSpec/ExpectInHook:
@@ -915,7 +916,9 @@ RSpec/ScatteredSetup:
 RSpec/SharedContext:
   Description: Checks for proper shared_context and shared_examples usage.
   Enabled: true
+  Strict: false
   VersionAdded: '1.13'
+  VersionChanged: '3.10'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SharedContext
 
 RSpec/SharedExamples:

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

@@ -10,6 +10,10 @@ module RuboCop
       #
       # This cop can be configured using the `EnforcedStyle` option.
       #
+      # When using compound expectations with `change` and a negated matcher
+      # (e.g., `not_change`), you can configure the `NegatedMatcher` option
+      # to ensure consistent style enforcement across both matchers.
+      #
       # @safety
       #   Autocorrection is unsafe because `method_call` style calls the
       #   receiver *once* and sends the message to it before and after
@@ -48,23 +52,29 @@ module RuboCop
       #   # good
       #   expect { run }.to change { Foo.bar }
       #
+      # @example `NegatedMatcher: not_change` (with compound expectations)
+      #   # bad
+      #   expect { run }.to change(Foo, :bar).and not_change { Foo.baz }
+      #
+      #   # good
+      #   expect { run }.to change(Foo, :bar).and not_change(Foo, :baz)
+      #
       class ExpectChange < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 
-        MSG_BLOCK = 'Prefer `change(%<obj>s, :%<attr>s)`.'
-        MSG_CALL = 'Prefer `change { %<obj>s.%<attr>s }`.'
-        RESTRICT_ON_SEND = %i[change].freeze
+        MSG_BLOCK = 'Prefer `%<matcher>s(%<obj>s, :%<attr>s)`.'
+        MSG_CALL = 'Prefer `%<matcher>s { %<obj>s.%<attr>s }`.'
 
-        # @!method expect_change_with_arguments(node)
-        def_node_matcher :expect_change_with_arguments, <<~PATTERN
-          (send nil? :change $_ ({sym str} $_))
+        # @!method expect_matcher_with_arguments(node)
+        def_node_matcher :expect_matcher_with_arguments, <<~PATTERN
+          (send nil? _ $_ ({sym str} $_))
         PATTERN
 
-        # @!method expect_change_with_block(node)
-        def_node_matcher :expect_change_with_block, <<~PATTERN
+        # @!method expect_matcher_with_block(node)
+        def_node_matcher :expect_matcher_with_block, <<~PATTERN
           (block
-            (send nil? :change)
+            (send nil? _)
             (args)
             (send
               ${
@@ -78,11 +88,14 @@ module RuboCop
 
         def on_send(node)
           return unless style == :block
+          return unless matcher_method?(node.method_name)
 
-          expect_change_with_arguments(node) do |receiver, message|
-            msg = format(MSG_CALL, obj: receiver.source, attr: message)
+          expect_matcher_with_arguments(node) do |receiver, message|
+            matcher_name = node.method_name.to_s
+            msg = format(MSG_CALL, matcher: matcher_name,
+                                   obj: receiver.source, attr: message)
             add_offense(node, message: msg) do |corrector|
-              replacement = "change { #{receiver.source}.#{message} }"
+              replacement = "#{matcher_name} { #{receiver.source}.#{message} }"
               corrector.replace(node, replacement)
             end
           end
@@ -90,15 +103,32 @@ module RuboCop
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless style == :method_call
+          return unless matcher_method?(node.method_name)
 
-          expect_change_with_block(node) do |receiver, message|
-            msg = format(MSG_BLOCK, obj: receiver.source, attr: message)
+          expect_matcher_with_block(node) do |receiver, message|
+            matcher_name = node.method_name.to_s
+            msg = format(MSG_BLOCK, matcher: matcher_name,
+                                    obj: receiver.source, attr: message)
             add_offense(node, message: msg) do |corrector|
-              replacement = "change(#{receiver.source}, :#{message})"
+              replacement = "#{matcher_name}(#{receiver.source}, :#{message})"
               corrector.replace(node, replacement)
             end
           end
         end
+
+        private
+
+        def matcher_method_names
+          [:change, negated_matcher&.to_sym].compact
+        end
+
+        def matcher_method?(method_name)
+          matcher_method_names.include?(method_name)
+        end
+
+        def negated_matcher
+          cop_config['NegatedMatcher']
+        end
       end
     end
   end

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

@@ -54,6 +54,8 @@ module RuboCop
         private
 
         def simple_regexp?(node)
+          return false if node.interpolation?
+
           parsed = Regexp::Parser.parse(node.content)
           parsed.expressions.all? { |expr| simple_expression?(expr) }
         end

data/lib/rubocop/cop/rspec/mixin/repeated_items.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps find repeated items in a collection
+      #
+      # Provides a generic method to find repeated items by grouping them
+      # by a key and returning pairs of [item, repeated_lines] for items
+      # that appear more than once.
+      module RepeatedItems
+        # Groups items by key and returns only groups with more than one item
+        #
+        # @param items [Enumerable] the filtered collection to group
+        # @param key_proc [Proc] block returning the grouping key for each item
+        # @return [Array<Array>] array of groups containing more than one item
+        #   that share the same key and there are multiple items in the group
+        def find_repeated_groups(items, key_proc:)
+          items
+            .group_by(&key_proc)
+            .values
+            .reject(&:one?)
+        end
+
+        # Maps a group of items to pairs of [item, repeated_lines]
+        #
+        # @param items [Array] array of items that share the same key
+        # @return [Array<Array>] array of [item, repeated_lines] pairs
+        def add_repeated_lines(items)
+          repeated_lines = items.map(&:first_line)
+          items.map { |item| [item, repeated_lines - [item.first_line]] }
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,8 @@ module RuboCop
       #   end
       #
       class RepeatedExample < Base
+        include RepeatedItems
+
         MSG = "Don't repeat examples within an example group. " \
               'Repeated on line(s) %<lines>s.'
 
@@ -32,10 +34,10 @@ module RuboCop
         def find_repeated_examples(node)
           examples = RuboCop::RSpec::ExampleGroup.new(node).examples
 
-          examples
-            .group_by { |example| build_example_signature(example) }
-            .values
-            .select { |group| group.size > 1 }
+          find_repeated_groups(
+            examples,
+            key_proc: ->(example) { build_example_signature(example) }
+          )
         end
 
         def build_example_signature(example)

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

@@ -44,6 +44,7 @@ module RuboCop
       #
       class RepeatedExampleGroupBody < Base
         include SkipOrPending
+        include RepeatedItems
 
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
 
@@ -72,19 +73,14 @@ module RuboCop
         private
 
         def repeated_group_bodies(node)
-          node
-            .children
+          items = node.children
             .select { |child| example_group_with_body?(child) }
             .reject { |child| skip_or_pending_inside_block?(child) }
-            .group_by { |group| signature_keys(group) }
-            .values
-            .reject(&:one?)
-            .flat_map { |groups| add_repeated_lines(groups) }
-        end
 
-        def add_repeated_lines(groups)
-          repeated_lines = groups.map(&:first_line)
-          groups.map { |group| [group, repeated_lines - [group.first_line]] }
+          find_repeated_groups(
+            items,
+            key_proc: ->(group) { signature_keys(group) }
+          ).flat_map { |group| add_repeated_lines(group) }
         end
 
         def signature_keys(group)

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

@@ -44,6 +44,7 @@ module RuboCop
       #
       class RepeatedExampleGroupDescription < Base
         include SkipOrPending
+        include RepeatedItems
 
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
 
@@ -71,20 +72,15 @@ module RuboCop
         private
 
         def repeated_group_descriptions(node)
-          node
-            .children
+          items = node.children
             .select { |child| example_group?(child) }
             .reject { |child| skip_or_pending_inside_block?(child) }
             .reject { |child| empty_description?(child) }
-            .group_by { |group| doc_string_and_metadata(group) }
-            .values
-            .reject(&:one?)
-            .flat_map { |groups| add_repeated_lines(groups) }
-        end
 
-        def add_repeated_lines(groups)
-          repeated_lines = groups.map(&:first_line)
-          groups.map { |group| [group, repeated_lines - [group.first_line]] }
+          find_repeated_groups(
+            items,
+            key_proc: ->(group) { doc_string_and_metadata(group) }
+          ).flat_map { |group| add_repeated_lines(group) }
         end
 
         def message(group, repeats)

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

@@ -46,6 +46,8 @@ module RuboCop
       #   end
       #
       class RepeatedIncludeExample < Base
+        include RepeatedItems
+
         MSG = 'Repeated include of shared_examples %<name>s ' \
               'on line(s) %<repeat>s'
 
@@ -73,13 +75,13 @@ module RuboCop
         private
 
         def repeated_include_examples(node)
-          node
-            .children
+          items = node.children
             .select { |child| literal_include_examples?(child) }
-            .group_by { |child| signature_keys(child) }
-            .values
-            .reject(&:one?)
-            .flat_map { |items| add_repeated_lines(items) }
+
+          find_repeated_groups(
+            items,
+            key_proc: ->(child) { signature_keys(child) }
+          ).flat_map { |group| add_repeated_lines(group) }
         end
 
         def literal_include_examples?(node)
@@ -87,11 +89,6 @@ module RuboCop
             node.arguments.all?(&:recursive_literal_or_const?)
         end
 
-        def add_repeated_lines(items)
-          repeated_lines = items.map(&:first_line)
-          items.map { |item| [item, repeated_lines - [item.first_line]] }
-        end
-
         def signature_keys(item)
           item.arguments
         end

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

@@ -42,6 +42,7 @@ module RuboCop
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
+        include RepeatedItems
         extend AutoCorrector
 
         MSG = 'Do not define multiple `%<hook_name>s` hooks in the same ' \
@@ -63,17 +64,14 @@ module RuboCop
         private
 
         def repeated_hooks(node) # rubocop:disable Metrics/CyclomaticComplexity
-          hooks = RuboCop::RSpec::ExampleGroup.new(node)
-            .hooks
+          hooks = RuboCop::RSpec::ExampleGroup.new(node).hooks
             .reject(&:inside_class_method?)
             .select { |hook| hook.knowable_scope? && hook.name != :around }
-            .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
-            .values
-            .reject(&:one?)
 
-          hooks.map do |hook|
-            hook.map(&:to_node)
-          end
+          find_repeated_groups(
+            hooks,
+            key_proc: ->(hook) { [hook.name, hook.scope, hook.metadata] }
+          ).map { |hook_group| hook_group.map(&:to_node) }
         end
 
         def lines_msg(numbers)

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

@@ -8,6 +8,9 @@ module RuboCop
       # If there are no examples defined, use shared_context.
       # If there is no setup defined, use shared_examples.
       #
+      # With `Strict: true`, `shared_context` is flagged whenever it contains
+      # any examples, even if it also contains setup code.
+      #
       # @example
       #   # bad
       #   RSpec.shared_context 'only examples here' do
@@ -50,11 +53,31 @@ module RuboCop
       #     end
       #   end
       #
+      # @example Strict: true
+      #   # bad - shared_context with examples is flagged
+      #   RSpec.shared_context 'setup and examples' do
+      #     let(:foo) { :bar }
+      #
+      #     it 'does x' do
+      #     end
+      #   end
+      #
+      #   # good - split into separate shared_context and shared_examples
+      #   RSpec.shared_context 'setup' do
+      #     let(:foo) { :bar }
+      #   end
+      #
+      #   RSpec.shared_examples 'examples' do
+      #     it 'does x' do
+      #     end
+      #   end
+      #
       class SharedContext < Base
         extend AutoCorrector
 
         MSG_EXAMPLES = "Use `shared_examples` when you don't define context."
-        MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
+        MSG_EXAMPLES_STRICT = 'Use `shared_examples` when you define examples.'
+        MSG_CONTEXT = "Use `shared_context` when you don't define examples."
 
         # @!method examples?(node)
         def_node_search :examples?, <<~PATTERN
@@ -79,9 +102,12 @@ module RuboCop
         PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
-          context_with_only_examples(node) do
-            add_offense(node.send_node, message: MSG_EXAMPLES) do |corrector|
-              corrector.replace(node.send_node.loc.selector, 'shared_examples')
+          offending_node(node) do
+            add_offense(node.send_node, message: message) do |corrector|
+              if can_correct?(node)
+                corrector.replace(node.send_node.loc.selector,
+                                  'shared_examples')
+              end
             end
           end
 
@@ -94,8 +120,22 @@ module RuboCop
 
         private
 
-        def context_with_only_examples(node)
-          shared_context(node) { yield if examples?(node) && !context?(node) }
+        def strict?
+          cop_config.fetch('Strict', false)
+        end
+
+        def message
+          strict? ? MSG_EXAMPLES_STRICT : MSG_EXAMPLES
+        end
+
+        def can_correct?(node)
+          !strict? || !context?(node)
+        end
+
+        def offending_node(node)
+          shared_context(node) do
+            yield if examples?(node) && (strict? || !context?(node))
+          end
         end
 
         def examples_with_only_context(node)

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.10.0'
+      STRING = '3.10.1'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -19,6 +19,7 @@ require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
 require_relative 'rubocop/cop/rspec/mixin/location_help'
 require_relative 'rubocop/cop/rspec/mixin/metadata'
 require_relative 'rubocop/cop/rspec/mixin/namespace'
+require_relative 'rubocop/cop/rspec/mixin/repeated_items'
 require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'
 require_relative 'rubocop/cop/rspec/mixin/top_level_group'
 require_relative 'rubocop/cop/rspec/mixin/variable'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.10.1
 platform: ruby
 authors:
 - John Backus
@@ -158,6 +158,7 @@ files:
 - lib/rubocop/cop/rspec/mixin/location_help.rb
 - lib/rubocop/cop/rspec/mixin/metadata.rb
 - lib/rubocop/cop/rspec/mixin/namespace.rb
+- lib/rubocop/cop/rspec/mixin/repeated_items.rb
 - lib/rubocop/cop/rspec/mixin/skip_or_pending.rb
 - lib/rubocop/cop/rspec/mixin/top_level_group.rb
 - lib/rubocop/cop/rspec/mixin/variable.rb