rubocop-rspec 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5852eb2103d4a2993b2174b7e4c97f5f7f09041c49407122ab6568d744d52c09
-  data.tar.gz: 710d277b8be358c99cadf4ca500141d23fa73347ba3f29db0585a1e7026abd73
+  metadata.gz: 4e4727f136d1a399d3108fd010c76ac61f7fce57e3c89cb2d97ad121d558af44
+  data.tar.gz: dcc8c7f61c420d5938807dae3a610f53c6be8c657687e38542f701db2aec4ce2
 SHA512:
-  metadata.gz: e27d20e6945c05f12af9fc24e17e42691186b332611d96eb9e7a5444476de44209517ccdb4829096cff659e7a7d1b98941ff632b3f7f5a547aa4dc82d3e18e38
-  data.tar.gz: 93a9cb481828abc2e313129cec383d38de5261f382d7ae6fcabe42bd0146b5a134b90991df47cc0bade3c1e4266cbfcf733f35ea7bee8eafaa3e5e4236a0b3ca
+  metadata.gz: 651f8b53a0b70738f9dc084df5bdf471ce65ae4d7f0c2db8cc2eb557178fd541f317bee36ae062b8109aed72b452f69eb1c965db923d5d9875c86de9ab84f23e
+  data.tar.gz: f189ec83b4b663df4e3aca303f2f273fded6d5529e689d7f9421f379dd46203da95236a4f649414466b0f6050b0d9e7d952df003b4b63ed45722c1764fd1a094

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 3.6.0 (2025-04-18)
+
+- Fix false positive in `RSpec/Pending`, where it would mark the default block `it` as an offense. ([@bquorning])
+- Fix issue when `Style/ContextWording` is configured with a Prefix being interpreted as a boolean, like `on`. ([@sakuro])
+- Add new `RSpec/IncludeExamples` cop to enforce using `it_behaves_like` over `include_examples`. ([@dvandersluis])
+- Change `RSpec/ScatteredSetup` to allow `around` hooks to be scattered. ([@ydah])
+- Fix an error `RSpec/ChangeByZero` cop when without expect block. ([@lee266])
+- Fix a false positive for `RSpec/DescribedClass` when `SkipBlocks` is true and numblocks are used. ([@earlopain])
+
 ## 3.5.0 (2025-02-16)
 
 - Don't let `RSpec/PredicateMatcher` replace `respond_to?` with two arguments with the RSpec `respond_to` matcher. ([@bquorning])
@@ -998,6 +1007,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@krororo]: https://github.com/krororo
 [@kuahyeow]: https://github.com/kuahyeow
 [@lazycoder9]: https://github.com/lazycoder9
+[@lee266]: https://github.com/lee266
 [@leoarnold]: https://github.com/leoarnold
 [@liberatys]: https://github.com/Liberatys
 [@lokhi]: https://github.com/lokhi
@@ -1038,6 +1048,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@rrosenblum]: https://github.com/rrosenblum
 [@rspeicher]: https://github.com/rspeicher
 [@rst-j]: https://github.com/RST-J
+[@sakuro]: https://github.com/sakuro
 [@samrjenkins]: https://github.com/samrjenkins
 [@schmijos]: https://github.com/schmijos
 [@seanpdoyle]: https://github.com/seanpdoyle

data/config/default.yml

@@ -532,6 +532,12 @@ RSpec/ImplicitSubject:
   VersionChanged: '2.13'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ImplicitSubject
 
+RSpec/IncludeExamples:
+  Description: Checks for usage of `include_examples`.
+  Enabled: pending
+  VersionAdded: '3.6'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IncludeExamples
+
 RSpec/IndexedLet:
   Description: Do not set up test data using indexes (e.g., `item_1`, `item_2`).
   Enabled: true

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

@@ -102,6 +102,8 @@ module RuboCop
         private
 
         def register_offense(node, change_node)
+          return unless node.parent.send_type?
+
           if compound_expectations?(node)
             add_offense(node,
                         message: message_compound(change_node)) do |corrector|
@@ -116,8 +118,7 @@ module RuboCop
         end
 
         def compound_expectations?(node)
-          node.parent.send_type? &&
-            %i[and or & |].include?(node.parent.method_name)
+          %i[and or & |].include?(node.parent.method_name)
         end
 
         def message(change_node)

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

@@ -115,7 +115,12 @@ module RuboCop
         end
 
         def prefixes
-          Array(cop_config.fetch('Prefixes', []))
+          Array(cop_config.fetch('Prefixes', [])).tap do |prefixes|
+            non_strings = prefixes.reject { |pre| pre.is_a?(String) }
+            unless non_strings.empty?
+              raise "Non-string prefixes #{non_strings.inspect} detected."
+            end
+          end
         end
       end
     end

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

@@ -83,7 +83,7 @@ module RuboCop
 
         # @!method rspec_block?(node)
         def_node_matcher :rspec_block?,
-                         '({block numblock} (send #rspec? #ALL.all ...) ...)'
+                         '(any_block (send #rspec? #ALL.all ...) ...)'
 
         # @!method scope_changing_syntax?(node)
         def_node_matcher :scope_changing_syntax?, '{def class module}'
@@ -153,7 +153,9 @@ module RuboCop
         end
 
         def skippable_block?(node)
-          node.block_type? && !rspec_block?(node) && cop_config['SkipBlocks']
+          return false unless cop_config['SkipBlocks']
+
+          node.any_block_type? && !rspec_block?(node)
         end
 
         def only_static_constants?

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

@@ -24,7 +24,7 @@ module RuboCop
 
         # @!method include_rspec_blocks?(node)
         def_node_search :include_rspec_blocks?, <<~PATTERN
-          ({block numblock} (send #explicit_rspec? #ExampleGroups.all ...) ...)
+          (any_block (send #explicit_rspec? #ExampleGroups.all ...) ...)
         PATTERN
 
         def on_module(node)

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

@@ -137,7 +137,7 @@ module RuboCop
         PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-          return if node.each_ancestor(:def, :defs).any?
+          return if node.each_ancestor(:any_def).any?
           return if node.each_ancestor(:block).any? { |block| example?(block) }
 
           example_group_body(node) do |body|
@@ -155,7 +155,7 @@ module RuboCop
           return true unless body
           return false if conditionals_with_examples?(body)
 
-          if body.if_type? || body.case_type?
+          if body.type?(:if, :case)
             !examples_in_branches?(body)
           else
             !examples?(body)
@@ -163,7 +163,7 @@ module RuboCop
         end
 
         def conditionals_with_examples?(body)
-          return false unless body.begin_type? || body.case_type?
+          return false unless body.type?(:begin, :case)
 
           body.each_descendant(:if, :case).any? do |condition_node|
             examples_in_branches?(condition_node)
@@ -172,7 +172,7 @@ module RuboCop
 
         def examples_in_branches?(condition_node)
           return false unless condition_node
-          return false if !condition_node.if_type? && !condition_node.case_type?
+          return false unless condition_node.type?(:if, :case)
 
           condition_node.branches.any? { |branch| examples?(branch) }
         end

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

@@ -5,11 +5,30 @@ module RuboCop
     module RSpec
       # Checks for consistent style of change matcher.
       #
-      # Enforces either passing object and attribute as arguments to the matcher
-      # or passing a block that reads the attribute value.
+      # Enforces either passing a receiver and message as method arguments,
+      # or a block.
       #
       # This cop can be configured using the `EnforcedStyle` option.
       #
+      # @safety
+      #   Autocorrection is unsafe because `method_call` style calls the
+      #   receiver *once* and sends the message to it before and after
+      #   calling the `expect` block, whereas `block` style calls the
+      #   expression *twice*, including the receiver.
+      #
+      #   If your receiver is dynamic (e.g., the result of a method call) and
+      #   you expect it to be called before and after the `expect` block,
+      #   changing from `block` to `method_call` style may break your test.
+      #
+      #   [source,ruby]
+      #   ----
+      #   expect { run }.to change { my_method.message }
+      #   # `my_method` is called before and after `run`
+      #
+      #   expect { run }.to change(my_method, :message)
+      #   # `my_method` is called once, but `message` is called on it twice
+      #   ----
+      #
       # @example `EnforcedStyle: method_call` (default)
       #   # bad
       #   expect { run }.to change { Foo.bar }

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

@@ -73,7 +73,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return if node.chained? || node.each_ancestor(:def, :defs).any?
+          return if node.chained? || node.each_ancestor(:any_def).any?
 
           if focused_block?(node)
             on_focused_block(node)

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

@@ -67,12 +67,12 @@ module RuboCop
 
         # @!method scoped_hook(node)
         def_node_matcher :scoped_hook, <<~PATTERN
-          ({block numblock} $(send _ #Hooks.all (sym ${:each :example})) ...)
+          (any_block $(send _ #Hooks.all (sym ${:each :example})) ...)
         PATTERN
 
         # @!method unscoped_hook(node)
         def_node_matcher :unscoped_hook, <<~PATTERN
-          ({block numblock} $(send _ #Hooks.all) ...)
+          (any_block $(send _ #Hooks.all) ...)
         PATTERN
 
         def on_block(node)

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

@@ -30,7 +30,7 @@ module RuboCop
         # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<~PATTERN
           {
-            ({block numblock} {
+            (any_block {
               (send #rspec? #ExampleGroups.all ...)
               (send nil? #Examples.all ...)
             } ...)

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for usage of `include_examples`.
+      #
+      # `include_examples`, unlike `it_behaves_like`, does not create its
+      # own context. As such, using `subject`, `let`, `before`/`after`, etc.
+      # within shared examples included with `include_examples` can have
+      # unexpected behavior and side effects.
+      #
+      # Prefer using `it_behaves_like` instead.
+      #
+      # @example
+      #   # bad
+      #   include_examples 'examples'
+      #
+      #   # good
+      #   it_behaves_like 'examples'
+      #
+      class IncludeExamples < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `it_behaves_like` over `include_examples`.'
+
+        RESTRICT_ON_SEND = %i[include_examples].freeze
+
+        def on_send(node)
+          selector = node.loc.selector
+
+          add_offense(selector) do |corrector|
+            corrector.replace(selector, 'it_behaves_like')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -133,8 +133,8 @@ module RuboCop
 
         def count_up_nesting?(node, example_group)
           example_group &&
-            (node.block_type? &&
-            !allowed_groups.include?(node.method_name.to_s))
+            node.block_type? &&
+            !allowed_groups.include?(node.method_name.to_s)
         end
 
         def message(nesting)

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

@@ -65,7 +65,7 @@ module RuboCop
         # @param [RuboCop::AST::Node] node
         # @return [Boolean]
         def_node_matcher :regular_or_focused_example?, <<~PATTERN
-          ({block numblock} (send nil? {#Examples.regular #Examples.focused} ...) ...)
+          (any_block (send nil? {#Examples.regular #Examples.focused} ...) ...)
         PATTERN
 
         # @!method includes_expectation?(node)

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

@@ -47,7 +47,7 @@ module RuboCop
 
         # @!method skippable_example?(node)
         def_node_matcher :skippable_example?, <<~PATTERN
-          (send nil? #Examples.regular ...)
+          (send nil? #Examples.regular _ ...)
         PATTERN
 
         # @!method pending_block?(node)

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

@@ -63,8 +63,7 @@ module RuboCop
         def_node_matcher :skipped_in_example?, <<~PATTERN
           {
             (send nil? ${#Examples.skipped #Examples.pending})
-            (block (send nil? ${#Examples.skipped}) ...)
-            (numblock (send nil? ${#Examples.skipped}) ...)
+            (any_block (send nil? ${#Examples.skipped}) ...)
           }
         PATTERN
 
@@ -75,7 +74,7 @@ module RuboCop
 
         # @!method skipped_by_example_method_with_block?(node)
         def_node_matcher :skipped_by_example_method_with_block?, <<~PATTERN
-          ({block numblock} (send nil? ${#Examples.skipped #Examples.pending} ...) ...)
+          (any_block (send nil? ${#Examples.skipped #Examples.pending} ...) ...)
         PATTERN
 
         # @!method metadata_without_reason?(node)

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

@@ -182,7 +182,7 @@ module RuboCop
 
         def heredoc_argument?(matcher)
           matcher.arguments.select do |arg|
-            arg.str_type? || arg.dstr_type? || arg.xstr_type?
+            arg.type?(:str, :dstr, :xstr)
           end.any?(&:heredoc?)
         end
 

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

@@ -148,8 +148,7 @@ module RuboCop
         end
 
         def heredoc_or_splat?(node)
-          ((node.str_type? || node.dstr_type?) && node.heredoc?) ||
-            node.splat_type?
+          (node.type?(:str, :dstr) && node.heredoc?) || node.splat_type?
         end
 
         def requires_quotes?(value)

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

@@ -41,7 +41,7 @@ module RuboCop
 
         # @!method match_redundant_around_hook_block?(node)
         def_node_matcher :match_redundant_around_hook_block?, <<~PATTERN
-          ({block numblock} (send _ :around ...) ... (send _ :run))
+          (any_block (send _ :around ...) ... (send _ :run))
         PATTERN
 
         # @!method match_redundant_around_hook_send?(node)

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

@@ -5,7 +5,9 @@ module RuboCop
     module RSpec
       # Checks for setup scattered across multiple hooks in an example group.
       #
-      # Unify `before`, `after`, and `around` hooks when possible.
+      # Unify `before` and `after` hooks when possible.
+      # However, `around` hooks are allowed to be defined multiple times,
+      # as unifying them would typically make the code harder to read.
       #
       # @example
       #   # bad
@@ -22,6 +24,12 @@ module RuboCop
       #     end
       #   end
       #
+      #   # good
+      #   describe Foo do
+      #     around { |example| before1; example.call; after1 }
+      #     around { |example| before2; example.call; after2 }
+      #   end
+      #
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
@@ -48,7 +56,7 @@ module RuboCop
         def repeated_hooks(node)
           hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks
-            .select(&:knowable_scope?)
+            .select { |hook| hook.knowable_scope? && hook.name != :around }
             .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
             .values
             .reject(&:one?)

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

@@ -69,7 +69,7 @@ module RuboCop
         end
 
         def symbol?(node)
-          node.sym_type? || node.dsym_type?
+          node.type?(:sym, :dsym)
         end
       end
     end

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

@@ -50,7 +50,7 @@ module RuboCop
           return unless inside_example_group?(node)
 
           variable_definition?(node) do |variable|
-            return if variable.dstr_type? || variable.dsym_type?
+            return if variable.type?(:dstr, :dsym)
             return if matches_allowed_pattern?(variable.value)
 
             check_name(node, variable.value, variable.source_range)

data/lib/rubocop/cop/rspec_cops.rb

@@ -48,6 +48,7 @@ require_relative 'rspec/identical_equality_assertion'
 require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'
+require_relative 'rspec/include_examples'
 require_relative 'rspec/indexed_let'
 require_relative 'rspec/instance_spy'
 require_relative 'rspec/instance_variable'

data/lib/rubocop/rspec/hook.rb

@@ -64,7 +64,9 @@ module RuboCop
       end
 
       def transform_true(node)
-        node.true_type? ? true : node
+        return true if node.true_type?
+
+        node
       end
 
       def scope_name

data/lib/rubocop/rspec/language.rb

@@ -26,7 +26,7 @@ module RuboCop
 
       # @!method example_group?(node)
       def_node_matcher :example_group?, <<~PATTERN
-        ({block numblock} (send #rspec? #ExampleGroups.all ...) ...)
+        (any_block (send #rspec? #ExampleGroups.all ...) ...)
       PATTERN
 
       # @!method shared_group?(node)
@@ -35,7 +35,7 @@ module RuboCop
 
       # @!method spec_group?(node)
       def_node_matcher :spec_group?, <<~PATTERN
-        ({block numblock} (send #rspec?
+        (any_block (send #rspec?
              {#SharedGroups.all #ExampleGroups.all}
           ...) ...)
       PATTERN
@@ -50,10 +50,7 @@ module RuboCop
 
       # @!method hook?(node)
       def_node_matcher :hook?, <<~PATTERN
-        {
-          (numblock (send nil? #Hooks.all ...) ...)
-          (block (send nil? #Hooks.all ...) ...)
-        }
+        (any_block (send nil? #Hooks.all ...) ...)
       PATTERN
 
       # @!method let?(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.5.0'
+      STRING = '3.6.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - John Backus
@@ -9,7 +9,7 @@ authors:
 - Nils Gemeinhardt
 bindir: bin
 cert_chain: []
-date: 2025-02-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lint_roller
@@ -114,6 +114,7 @@ files:
 - lib/rubocop/cop/rspec/implicit_block_expectation.rb
 - lib/rubocop/cop/rspec/implicit_expect.rb
 - lib/rubocop/cop/rspec/implicit_subject.rb
+- lib/rubocop/cop/rspec/include_examples.rb
 - lib/rubocop/cop/rspec/indexed_let.rb
 - lib/rubocop/cop/rspec/instance_spy.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
@@ -226,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []