rubocop-rspec 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4727f136d1a399d3108fd010c76ac61f7fce57e3c89cb2d97ad121d558af44
-  data.tar.gz: dcc8c7f61c420d5938807dae3a610f53c6be8c657687e38542f701db2aec4ce2
+  metadata.gz: 645fbfddd891af3477e31993bc8da92fc57300cbcfcd8274ee0f68cfbbe97983
+  data.tar.gz: 6a97e91acb933ecbe09691c090efbff715ca12adcaef7027e8d324411ec0d78d
 SHA512:
-  metadata.gz: 651f8b53a0b70738f9dc084df5bdf471ce65ae4d7f0c2db8cc2eb557178fd541f317bee36ae062b8109aed72b452f69eb1c965db923d5d9875c86de9ab84f23e
-  data.tar.gz: f189ec83b4b663df4e3aca303f2f273fded6d5529e689d7f9421f379dd46203da95236a4f649414466b0f6050b0d9e7d952df003b4b63ed45722c1764fd1a094
+  metadata.gz: ca10e4b0b7e285136c60aa0035a018407263968fcced15155999ef5e2b6ac4edac45bcbd6c82dd355616a40ef110f9191cc986d5a8922aaab42c8118bff55c89
+  data.tar.gz: 7a22acf8143f309128504884a1634e23504b40821aabf14d9b20392c6c11ce7a34ad3ab48945e1b023594a794677bdf6526e7236f705fd331ab244a746375453

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master (Unreleased)
 
+## 3.7.0 (2025-09-01)
+
+- Mark `RSpec/IncludeExamples` as `SafeAutoCorrect: false`. ([@yujideveloper])
+- Fix a false positive for `RSpec/LeakyConstantDeclaration` when defining constants in explicit namespaces. ([@naveg])
+- Add support for error matchers (`raise_exception` and `raise_error`) to `RSpec/Dialect`. ([@lovro-bikic])
+- Don't register offenses for `RSpec/DescribedClass` within `Data.define` blocks. ([@lovro-bikic])
+- Add autocorrection support for `RSpec/IteratedExpectation` for single expectations. ([@lovro-bikic])
+- Exclude all cops from inspecting factorybot files, except if explicitly included. ([@Mth0158])
+- Fix a false positive for `RSpec/ExcessiveDocstringSpacing` when receivers are not RSpec methods. ([@ydah])
+
 ## 3.6.0 (2025-04-18)
 
 - Fix false positive in `RSpec/Pending`, where it would mark the default block `it` as an offense. ([@bquorning])
@@ -1021,6 +1031,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@mlarraz]: https://github.com/mlarraz
 [@mockdeep]: https://github.com/mockdeep
 [@mothonmars]: https://github.com/MothOnMars
+[@mth0158]: https://github.com/Mth0158
 [@mvz]: https://github.com/mvz
 [@naveg]: https://github.com/naveg
 [@nc-holodakg]: https://github.com/nc-holodakg
@@ -1073,5 +1084,6 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@ydah]: https://github.com/ydah
 [@yevhene]: https://github.com/yevhene
 [@ypresto]: https://github.com/ypresto
+[@yujideveloper]: https://github.com/yujideveloper
 [@zdennis]: https://github.com/zdennis
 [@zverok]: https://github.com/zverok

data/config/default.yml

@@ -6,6 +6,10 @@ RSpec:
   Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"
+  Exclude:
+    - "**/spec/factories.rb"
+    - "**/spec/factories/**/*.rb"
+    - "**/features/support/factories/**/*.rb"
   Language:
     inherit_mode:
       merge:
@@ -79,6 +83,9 @@ RSpec:
       - prepend_after
       - after
       - append_after
+    ErrorMatchers:
+      - raise_error
+      - raise_exception
     Includes:
       inherit_mode:
         merge:
@@ -535,7 +542,9 @@ RSpec/ImplicitSubject:
 RSpec/IncludeExamples:
   Description: Checks for usage of `include_examples`.
   Enabled: pending
+  SafeAutoCorrect: false
   VersionAdded: '3.6'
+  VersionChanged: '3.7'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IncludeExamples
 
 RSpec/IndexedLet:
@@ -782,7 +791,7 @@ RSpec/ReceiveCounts:
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ReceiveCounts
 
 RSpec/ReceiveMessages:
-  Description: Checks for multiple messages stubbed on the same object.
+  Description: Prefer `receive_messages` over multiple `receive`s on the same object.
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '2.23'

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

@@ -13,6 +13,20 @@ module RuboCop
       # `OnlyStaticConstants` is only relevant when `EnforcedStyle` is
       # `described_class`.
       #
+      # There's a known caveat with rspec-rails's `controller` helper that
+      # runs its block in a different context, and `described_class` is not
+      # available to it. `SkipBlocks` option excludes detection in all
+      # non-RSpec related blocks.
+      #
+      # To narrow down this setting to only a specific directory, it is
+      # possible to use an overriding configuration file local to that
+      # directory.
+      #
+      # @safety
+      #   Autocorrection is unsafe when `SkipBlocks: false` because
+      #   `described_class` might not be available within the block (for
+      #   example, in rspec-rails's `controller` helper).
+      #
       # @example `EnforcedStyle: described_class` (default)
       #   # bad
       #   describe MyClass do
@@ -47,15 +61,6 @@ module RuboCop
       #     subject { MyClass.do_something }
       #   end
       #
-      # There's a known caveat with rspec-rails's `controller` helper that
-      # runs its block in a different context, and `described_class` is not
-      # available to it. `SkipBlocks` option excludes detection in all
-      # non-RSpec related blocks.
-      #
-      # To narrow down this setting to only a specific directory, it is
-      # possible to use an overriding configuration file local to that
-      # directory.
-      #
       # @example `SkipBlocks: true`
       #   # spec/controllers/.rubocop.yml
       #   # RSpec/DescribedClass:
@@ -78,7 +83,13 @@ module RuboCop
 
         # @!method common_instance_exec_closure?(node)
         def_node_matcher :common_instance_exec_closure?, <<~PATTERN
-          (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
+          (block
+            {
+              (send (const nil? {:Class :Module :Struct}) :new ...)
+              (send (const nil? :Data) :define ...)
+            }
+            ...
+          )
         PATTERN
 
         # @!method rspec_block?(node)

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

@@ -21,6 +21,7 @@ module RuboCop
       # - let, let!
       # - subject, subject!
       # - expect, is_expected, expect_any_instance_of
+      # - raise_error, raise_exception
       #
       # By default all of the RSpec methods and aliases are allowed. By setting
       # a config like:

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

@@ -30,7 +30,7 @@ module RuboCop
 
         # @!method example_description(node)
         def_node_matcher :example_description, <<~PATTERN
-          (send _ {#Examples.all #ExampleGroups.all} ${
+          (send #rspec? {#Examples.all #ExampleGroups.all} ${
             $str
             $(dstr ({str dstr `sym} ...) ...)
           } ...)

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

@@ -12,6 +12,57 @@ module RuboCop
       #
       # Prefer using `it_behaves_like` instead.
       #
+      # @safety
+      #   `include_examples` and `it_behaves_like` have different scoping
+      #   behaviors.
+      #   Changing `include_examples` to `it_behaves_like` creates a new
+      #   context, altering setup dependencies, which can lead to unexpected
+      #   test failures.
+      #   Specifically, the scope of hooks (`before`, `after`, `around`)
+      #   changes, which may prevent expected setup from being inherited
+      #   correctly.
+      #
+      #   Additionally, `let` and `subject` are affected by scoping rules.
+      #   When `include_examples` is used, `let` and `subject` defined within
+      #   `shared_examples` are evaluated in the caller's context, allowing
+      #   access to their values.
+      #   In contrast, `it_behaves_like` creates a new context, preventing
+      #   access to `let` or `subject` values from the caller's context.
+      #
+      #   [source,ruby]
+      #   ----
+      #   shared_examples "mock behavior" do
+      #     before do
+      #       allow(service).to receive(:call).and_return("mocked response")
+      #     end
+      #
+      #     it "returns mocked response" do
+      #       expect(service.call).to eq "mocked response"
+      #     end
+      #   end
+      #
+      #   context "working example with include_examples" do
+      #     let(:service) { double(:service) }
+      #
+      #     include_examples "mock behavior"
+      #
+      #     it "uses the mocked service" do
+      #       expect(service.call).to eq "mocked response" # Passes
+      #     end
+      #   end
+      #
+      #   context "broken example with it_behaves_like" do
+      #     let(:service) { double(:service) }
+      #
+      #     it_behaves_like "mock behavior"
+      #
+      #     it "unexpectedly does not use the mocked service" do
+      #       # Fails because `it_behaves_like` does not apply the mock setup
+      #       expect(service.call).to eq "mocked response"
+      #     end
+      #   end
+      #   ----
+      #
       # @example
       #   # bad
       #   include_examples 'examples'

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

@@ -17,6 +17,8 @@ module RuboCop
       #   end
       #
       class IteratedExpectation < Base
+        extend AutoCorrector
+
         MSG = 'Prefer using the `all` matcher instead ' \
               'of iterating over an array.'
 
@@ -25,14 +27,14 @@ module RuboCop
           (block
             (send ... :each)
             (args (arg $_))
-            $(...)
+            (...)
           )
         PATTERN
 
         # @!method each_numblock?(node)
         def_node_matcher :each_numblock?, <<~PATTERN
           (numblock
-            (send ... :each) _ $(...)
+            (send ... :each) _ (...)
           )
         PATTERN
 
@@ -42,23 +44,43 @@ module RuboCop
         PATTERN
 
         def on_block(node)
-          each?(node) do |arg, body|
-            if single_expectation?(body, arg) || only_expectations?(body, arg)
-              add_offense(node.send_node)
-            end
+          each?(node) do |arg|
+            check_offense(node, arg)
           end
         end
 
         def on_numblock(node)
-          each_numblock?(node) do |body|
-            if single_expectation?(body, :_1) || only_expectations?(body, :_1)
-              add_offense(node.send_node)
-            end
+          each_numblock?(node) do
+            check_offense(node, :_1)
           end
         end
 
         private
 
+        def check_offense(node, argument)
+          if single_expectation?(node.body, argument)
+            add_offense(node.send_node) do |corrector|
+              next unless node.body.arguments.one?
+              next if uses_argument_in_matcher?(node, argument)
+
+              corrector.replace(node, single_expectation_replacement(node))
+            end
+          elsif only_expectations?(node.body, argument)
+            add_offense(node.send_node)
+          end
+        end
+
+        def single_expectation_replacement(node)
+          collection = node.receiver.source
+          matcher = node.body.first_argument.source
+
+          "expect(#{collection}).to all(#{matcher})"
+        end
+
+        def uses_argument_in_matcher?(node, argument)
+          node.body.first_argument.each_descendant.any?(s(:lvar, argument))
+        end
+
         def single_expectation?(body, arg)
           expectation?(body, arg)
         end

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

@@ -100,18 +100,21 @@ module RuboCop
 
         def on_casgn(node)
           return unless inside_describe_block?(node)
+          return if explicit_namespace?(node.namespace)
 
           add_offense(node, message: MSG_CONST)
         end
 
         def on_class(node)
           return unless inside_describe_block?(node)
+          return if explicit_namespace?(node.identifier.namespace)
 
           add_offense(node, message: MSG_CLASS)
         end
 
         def on_module(node)
           return unless inside_describe_block?(node)
+          return if explicit_namespace?(node.identifier.namespace)
 
           add_offense(node, message: MSG_MODULE)
         end
@@ -121,6 +124,10 @@ module RuboCop
         def inside_describe_block?(node)
           node.each_ancestor(:block).any? { |ancestor| spec_group?(ancestor) }
         end
+
+        def explicit_namespace?(namespace)
+          !namespace.nil?
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      # Checks for multiple messages stubbed on the same object.
+      # Prefer `receive_messages` over multiple `receive`s on the same object.
       #
       # @safety
       #   The autocorrection is marked as unsafe, because it may change the

data/lib/rubocop/rspec/language.rb

@@ -72,6 +72,12 @@ module RuboCop
       # @!method subject?(node)
       def_node_matcher :subject?, '(block (send nil? #Subjects.all ...) ...)'
 
+      module ErrorMatchers # :nodoc:
+        def self.all(element)
+          Language.config['ErrorMatchers'].include?(element.to_s)
+        end
+      end
+
       module ExampleGroups # :nodoc:
         class << self
           def all(element)
@@ -200,14 +206,14 @@ module RuboCop
       # This is used in Dialect and DescribeClass cops to detect RSpec blocks.
       module ALL # :nodoc:
         def self.all(element)
-          [ExampleGroups, Examples, Expectations, Helpers, Hooks, Includes,
-           Runners, SharedGroups, Subjects]
+          [ErrorMatchers, ExampleGroups, Examples, Expectations, Helpers, Hooks,
+           Includes, Runners, SharedGroups, Subjects]
             .find { |concept| concept.all(element) }
         end
       end
 
-      private_constant :ExampleGroups, :Examples, :Expectations, :Hooks,
-                       :Includes, :Runners, :SharedGroups, :ALL
+      private_constant :ErrorMatchers, :ExampleGroups, :Examples, :Expectations,
+                       :Hooks, :Includes, :Runners, :SharedGroups, :ALL
     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.6.0'
+      STRING = '3.7.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - John Backus
@@ -227,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []