rubocop-rspec 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe85fc893e4ec59cb9b5f1e999d35bb41692feacc4dba579d135b3eefd6e4c7
-  data.tar.gz: 953ba29bf3fce28b79943e69039b638574d74432dac8b896f3dc8e589a20581c
+  metadata.gz: 9159cd716027712a72b3a3e675f83a92c55070200ae0f628a8b00c7333bc99f0
+  data.tar.gz: 5e84a7c7108c0f745cfa3e32ab75fd9fe50a1b0f2dae4ba6e0433d6cf5cd30dc
 SHA512:
-  metadata.gz: acdf813781e2081ec34540e83a9a48fc289dab5cc8bff69d9610beb4a3f21c30955794eb4226d40b9f0460a04d38665c2aa4ce0857f35d8bd3a7325d91a861be
-  data.tar.gz: 752074b0fdce204596efc71e2358982c73c2fccff07da5da364c88b8ad5e99d5a8bfdbc855a9dd422169adeddf278266352f732092b5aa86d14502016ca77837
+  metadata.gz: bc41fe5a7eccbb4452fd4bc6459d03ceb5dcd8a13316245b223db3088ea25e38bfa029e834f527dbb511b80ce5b553c83673a6e6f957c974f599d7140d4f7d40
+  data.tar.gz: 0c6a077dd4b221d68524ed4b2734727000efb97c5fb553c31016aab51f57e0049f67c701727f6d7eeb04c42ad2866b96592793bc768bac7361ca4e7ca0d81248

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Master (Unreleased)
 
+## 3.9.0 (2026-01-07)
+
+- Fix a false positive for `RSpec/LeakyLocalVariable` when variables are used only in example metadata (e.g., skip messages). ([@ydah])
+- Fix a false positive for `RSpec/ScatteredSetup` when the hook is defined inside a class method. ([@d4rky-pl])
+- Fix a false positive for `RSpec/DescribedClass` inside dynamically evaluated blocks (`class_eval`, `module_eval`, `instance_eval`, `class_exec`, `module_exec`, `instance_exec`). ([@sucicfilip])
+- Add new cop `RSpec/Output`. ([@kevinrobell-st])
+
 ## 3.8.0 (2025-11-12)
 
 - Add new cop `RSpec/LeakyLocalVariable`. ([@lovro-bikic])
@@ -981,6 +988,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@composerinteralia]: https://github.com/composerinteralia
 [@corsonknowles]: https://github.com/corsonknowles
 [@corydiamand]: https://github.com/corydiamand
+[@d4rky-pl]: https://github.com/d4rky-pl
 [@darhazer]: https://github.com/Darhazer
 [@daveworth]: https://github.com/daveworth
 [@dduugg]: https://github.com/dduugg
@@ -1023,6 +1031,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@jtannas]: https://github.com/jtannas
 [@k-s-a]: https://github.com/K-S-A
 [@kellysutton]: https://github.com/kellysutton
+[@kevinrobell-st]: https://github.com/kevinrobell-st
 [@koic]: https://github.com/koic
 [@krororo]: https://github.com/krororo
 [@kuahyeow]: https://github.com/kuahyeow
@@ -1077,6 +1086,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@smcgivern]: https://github.com/smcgivern
 [@splattael]: https://github.com/splattael
 [@stephannv]: https://github.com/stephannv
+[@sucicfilip]: https://github.com/sucicfilip
 [@swelther]: https://github.com/swelther
 [@t3h2mas]: https://github.com/t3h2mas
 [@tdeo]: https://github.com/tdeo

data/config/default.yml

@@ -758,6 +758,14 @@ RSpec/NotToNot:
   VersionAdded: '1.4'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NotToNot
 
+RSpec/Output:
+  Description: Checks for the use of output calls like puts and print in specs.
+  Enabled: pending
+  AutoCorrect: contextual
+  SafeAutoCorrect: false
+  VersionAdded: '3.9'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Output
+
 RSpec/OverwritingSetup:
   Description: Checks if there is a let/subject that overwrites an existing one.
   Enabled: true

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

@@ -87,6 +87,8 @@ module RuboCop
             {
               (send (const nil? {:Class :Module :Struct}) :new ...)
               (send (const nil? :Data) :define ...)
+              (send _ {:class_eval :module_eval :instance_eval} ...)
+              (send _ {:class_exec :module_exec :instance_exec} ...)
             }
             ...
           )

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

@@ -57,6 +57,13 @@ module RuboCop
       #     expectations
       #   end
       #
+      #   # good - when variable is used only in example metadata
+      #   skip_message = 'not yet implemented'
+      #
+      #   it 'does something', skip: skip_message do
+      #     expectations
+      #   end
+      #
       #   # good - when variable is used only to include other examples
       #   examples = foo ? 'some examples' : 'other examples'
       #
@@ -103,6 +110,8 @@ module RuboCop
         def allowed_reference?(node)
           node.each_ancestor.any? do |ancestor|
             next true if example_method?(ancestor)
+            next true if in_example_arguments?(ancestor, node)
+
             if includes_method?(ancestor)
               next allowed_includes_arguments?(ancestor, node)
             end
@@ -111,6 +120,15 @@ module RuboCop
           end
         end
 
+        def in_example_arguments?(ancestor, node)
+          return false unless ancestor.send_type?
+          return false unless Examples.all(ancestor.method_name)
+
+          ancestor.arguments.any? do |arg|
+            arg.equal?(node) || arg.each_descendant.any?(node)
+          end
+        end
+
         def allowed_includes_arguments?(node, argument)
           node.arguments[1..].all? do |argument_node|
             next true if argument_node.type?(:dstr, :dsym)

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # NOTE: Originally based on the `Rails/Output` cop.
+    module RSpec
+      # Checks for the use of output calls like puts and print in specs.
+      #
+      # @safety
+      #   This autocorrection is marked as unsafe because, in rare cases, print
+      #   statements can be used on purpose for integration testing and deleting
+      #   them will cause tests to fail.
+      #
+      # @example
+      #   # bad
+      #   puts 'A debug message'
+      #   pp 'A debug message'
+      #   print 'A debug message'
+      class Output < Base
+        extend AutoCorrector
+
+        MSG = 'Do not write to stdout in specs.'
+
+        KERNEL_METHODS = %i[
+          ap
+          p
+          pp
+          pretty_print
+          print
+          puts
+        ].to_set.freeze
+        private_constant :KERNEL_METHODS
+
+        IO_METHODS = %i[
+          binwrite
+          syswrite
+          write
+          write_nonblock
+        ].to_set.freeze
+        private_constant :IO_METHODS
+
+        RESTRICT_ON_SEND = (KERNEL_METHODS + IO_METHODS).to_a.freeze
+
+        # @!method output?(node)
+        def_node_matcher :output?, <<~PATTERN
+          (send nil? KERNEL_METHODS ...)
+        PATTERN
+
+        # @!method io_output?(node)
+        def_node_matcher :io_output?, <<~PATTERN
+          (send
+            {
+              (gvar #match_gvar?)
+              (const {nil? cbase} {:STDOUT :STDERR})
+            }
+            IO_METHODS
+            ...)
+        PATTERN
+
+        def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
+          return if node.parent&.call_type? || node.block_node
+          return if !output?(node) && !io_output?(node)
+          return if node.arguments.any? { |arg| arg.type?(:hash, :block_pass) }
+
+          add_offense(node) do |corrector|
+            corrector.remove(node)
+          end
+        end
+
+        private
+
+        def match_gvar?(sym)
+          %i[$stdout $stderr].include?(sym)
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module RuboCop
       # 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.
+      # Hooks defined in class methods are also ignored.
       #
       # @example
       #   # bad
@@ -30,6 +31,14 @@ module RuboCop
       #     around { |example| before2; example.call; after2 }
       #   end
       #
+      #   # good
+      #   describe Foo do
+      #     before { setup1 }
+      #     def self.setup
+      #       before { setup2 }
+      #     end
+      #   end
+      #
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
@@ -53,9 +62,10 @@ module RuboCop
 
         private
 
-        def repeated_hooks(node)
+        def repeated_hooks(node) # rubocop:disable Metrics/CyclomaticComplexity
           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

data/lib/rubocop/cop/rspec_cops.rb

@@ -75,6 +75,7 @@ require_relative 'rspec/named_subject'
 require_relative 'rspec/nested_groups'
 require_relative 'rspec/no_expectation_example'
 require_relative 'rspec/not_to_not'
+require_relative 'rspec/output'
 require_relative 'rspec/overwriting_setup'
 require_relative 'rspec/pending'
 require_relative 'rspec/pending_without_reason'

data/lib/rubocop/rspec/hook.rb

@@ -25,6 +25,13 @@ module RuboCop
         scope.equal?(:each)
       end
 
+      def inside_class_method? # rubocop:disable Metrics/CyclomaticComplexity
+        parent = node.parent
+        return false unless parent
+
+        parent.defs_type? || (parent.def_type? && inside_class_self?(parent))
+      end
+
       def scope
         return :each if scope_argument&.hash_type?
 
@@ -76,6 +83,12 @@ module RuboCop
       def scope_argument
         node.send_node.first_argument
       end
+
+      def inside_class_self?(node)
+        node.parent&.sclass_type? ||
+          (node.parent&.begin_type? && node.parent.parent&.sclass_type?) ||
+          false
+      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.8.0'
+      STRING = '3.9.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - John Backus
@@ -146,6 +146,7 @@ files:
 - lib/rubocop/cop/rspec/nested_groups.rb
 - lib/rubocop/cop/rspec/no_expectation_example.rb
 - lib/rubocop/cop/rspec/not_to_not.rb
+- lib/rubocop/cop/rspec/output.rb
 - lib/rubocop/cop/rspec/overwriting_setup.rb
 - lib/rubocop/cop/rspec/pending.rb
 - lib/rubocop/cop/rspec/pending_without_reason.rb
@@ -222,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []