rubocop-rspec 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 645fbfddd891af3477e31993bc8da92fc57300cbcfcd8274ee0f68cfbbe97983
-  data.tar.gz: 6a97e91acb933ecbe09691c090efbff715ca12adcaef7027e8d324411ec0d78d
+  metadata.gz: abe85fc893e4ec59cb9b5f1e999d35bb41692feacc4dba579d135b3eefd6e4c7
+  data.tar.gz: 953ba29bf3fce28b79943e69039b638574d74432dac8b896f3dc8e589a20581c
 SHA512:
-  metadata.gz: ca10e4b0b7e285136c60aa0035a018407263968fcced15155999ef5e2b6ac4edac45bcbd6c82dd355616a40ef110f9191cc986d5a8922aaab42c8118bff55c89
-  data.tar.gz: 7a22acf8143f309128504884a1634e23504b40821aabf14d9b20392c6c11ce7a34ad3ab48945e1b023594a794677bdf6526e7236f705fd331ab244a746375453
+  metadata.gz: acdf813781e2081ec34540e83a9a48fc289dab5cc8bff69d9610beb4a3f21c30955794eb4226d40b9f0460a04d38665c2aa4ce0857f35d8bd3a7325d91a861be
+  data.tar.gz: 752074b0fdce204596efc71e2358982c73c2fccff07da5da364c88b8ad5e99d5a8bfdbc855a9dd422169adeddf278266352f732092b5aa86d14502016ca77837

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master (Unreleased)
 
+## 3.8.0 (2025-11-12)
+
+- Add new cop `RSpec/LeakyLocalVariable`. ([@lovro-bikic])
+- Bump RuboCop requirement to +1.81. ([@ydah])
+- Fix a false positive for `RSpec/LetSetup` when `let!` used in outer scope. ([@ydah])
+- Fix a false positive for `RSpec/ReceiveNever` cop when `allow(...).to receive(...).never`. ([@ydah])
+- Fix detection of nameless doubles with methods in `RSpec/VerifiedDoubles`. ([@ushi-as])
+- Improve an offense message for `RSpec/RepeatedExample` cop. ([@ydah])
+- Let `RSpec/SpecFilePathFormat` leverage ActiveSupport inflections when configured. ([@corsonknowles], [@bquorning])
+
 ## 3.7.0 (2025-09-01)
 
 - Mark `RSpec/IncludeExamples` as `SafeAutoCorrect: false`. ([@yujideveloper])
@@ -1077,6 +1087,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@tmaier]: https://github.com/tmaier
 [@topalovic]: https://github.com/topalovic
 [@twalpole]: https://github.com/twalpole
+[@ushi-as]: https://github.com/ushi-as
 [@vzvu3k6k]: https://github.com/vzvu3k6k
 [@walf443]: https://github.com/walf443
 [@yasu551]: https://github.com/yasu551

data/config/default.yml

@@ -610,6 +610,12 @@ RSpec/LeakyConstantDeclaration:
   StyleGuide: https://rspec.rubystyle.guide/#declare-constants
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/LeakyConstantDeclaration
 
+RSpec/LeakyLocalVariable:
+  Description: Checks for local variables from outer scopes used inside examples.
+  Enabled: pending
+  VersionAdded: '3.8'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/LeakyLocalVariable
+
 RSpec/LetBeforeExamples:
   Description: Checks for `let` definitions that come after an example.
   Enabled: true
@@ -933,7 +939,13 @@ RSpec/SpecFilePathFormat:
   IgnoreMethods: false
   IgnoreMetadata:
     type: routing
+  InflectorPath: "./config/initializers/inflections.rb"
+  SupportedInflectors:
+    - default
+    - active_support
+  EnforcedInflector: default
   VersionAdded: '2.24'
+  VersionChanged: '3.8'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SpecFilePathFormat
 
 RSpec/SpecFilePathSuffix:

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

@@ -67,7 +67,7 @@ module RuboCop
 
         # @!method context_wording(node)
         def_node_matcher :context_wording, <<~PATTERN
-          (block (send #rspec? { :context :shared_context } $({str dstr xstr} ...) ...) ...)
+          (block (send #rspec? { :context :shared_context } $(any_str ...) ...) ...)
         PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler

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

@@ -10,8 +10,19 @@ module RuboCop
       #
       # @see http://betterspecs.org/#should
       #
-      # The autocorrect is experimental - use with care! It can be configured
-      # with CustomTransform (e.g. have => has) and IgnoredWords (e.g. only).
+      # @safety
+      #   The autocorrect is experimental - use with care! It can be configured
+      #   with CustomTransform (e.g. have => has) and IgnoredWords (e.g. only).
+      #
+      #   While the autocorrect will not break your code (it only modifies test
+      #   description strings, not the actual test logic), it may produce
+      #   grammatically incorrect English in some cases. Always review the diff
+      #   when using autocorrect to ensure the descriptions remain natural and
+      #   accurate.
+      #
+      #   This is not classified as an unsafe autocorrect because it does not
+      #   affect code behavior, but manual review of changes is strongly
+      #   recommended.
       #
       # Use the DisallowedExamples setting to prevent unclear or insufficient
       # descriptions. Please note that this config will not be treated as

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

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for local variables from outer scopes used inside examples.
+      #
+      # Local variables assigned outside an example but used within it act
+      # as shared state, which can make tests non-deterministic.
+      #
+      # @example
+      #   # bad - outside variable used in a hook
+      #   user = create(:user)
+      #
+      #   before { user.update(admin: true) }
+      #
+      #   # good
+      #   let(:user) { create(:user) }
+      #
+      #   before { user.update(admin: true) }
+      #
+      #   # bad - outside variable used in an example
+      #   user = create(:user)
+      #
+      #   it 'is persisted' do
+      #     expect(user).to be_persisted
+      #   end
+      #
+      #   # good
+      #   let(:user) { create(:user) }
+      #
+      #   it 'is persisted' do
+      #     expect(user).to be_persisted
+      #   end
+      #
+      #   # also good - assigning the variable within the example
+      #   it 'is persisted' do
+      #     user = create(:user)
+      #
+      #     expect(user).to be_persisted
+      #   end
+      #
+      #   # bad - outside variable passed to included examples
+      #   attrs = ['foo', 'bar']
+      #
+      #   it_behaves_like 'some examples', attrs
+      #
+      #   # good
+      #   it_behaves_like 'some examples' do
+      #     let(:attrs) { ['foo', 'bar'] }
+      #   end
+      #
+      #   # good - when variable is used only as example description
+      #   attribute = 'foo'
+      #
+      #   it "#{attribute} is persisted" do
+      #     expectations
+      #   end
+      #
+      #   # good - when variable is used only to include other examples
+      #   examples = foo ? 'some examples' : 'other examples'
+      #
+      #   it_behaves_like examples, another_argument
+      #
+      class LeakyLocalVariable < Base
+        MSG = 'Do not use local variables defined outside of ' \
+              'examples inside of them.'
+
+        # @!method example_method?(node)
+        def_node_matcher :example_method?, <<~PATTERN
+          (send nil? #Examples.all _)
+        PATTERN
+
+        # @!method includes_method?(node)
+        def_node_matcher :includes_method?, <<~PATTERN
+          (send nil? #Includes.all ...)
+        PATTERN
+
+        def self.joining_forces
+          VariableForce
+        end
+
+        def after_leaving_scope(scope, _variable_table)
+          scope.variables.each_value { |variable| check_references(variable) }
+        end
+
+        private
+
+        def check_references(variable)
+          variable.assignments.each do |assignment|
+            next if part_of_example_scope?(assignment.node)
+
+            assignment.references.each do |reference|
+              next unless inside_describe_block?(reference)
+              next unless part_of_example_scope?(reference)
+              next if allowed_reference?(reference)
+
+              add_offense(assignment.node)
+            end
+          end
+        end
+
+        def allowed_reference?(node)
+          node.each_ancestor.any? do |ancestor|
+            next true if example_method?(ancestor)
+            if includes_method?(ancestor)
+              next allowed_includes_arguments?(ancestor, node)
+            end
+
+            false
+          end
+        end
+
+        def allowed_includes_arguments?(node, argument)
+          node.arguments[1..].all? do |argument_node|
+            next true if argument_node.type?(:dstr, :dsym)
+
+            argument_node != argument &&
+              argument_node.each_descendant.none?(argument)
+          end
+        end
+
+        def part_of_example_scope?(node)
+          node.each_ancestor.any? { |ancestor| example_scope?(ancestor) }
+        end
+
+        def example_scope?(node)
+          subject?(node) || let?(node) || hook?(node) || example?(node) ||
+            include?(node)
+        end
+
+        def inside_describe_block?(node)
+          node.each_ancestor(:block).any? { |ancestor| spec_group?(ancestor) }
+        end
+      end
+    end
+  end
+end

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

@@ -25,6 +25,18 @@ module RuboCop
       #   it 'counts widgets' do
       #     expect(Widget.count).to eq(1)
       #   end
+      #
+      #   # good
+      #   describe 'a widget' do
+      #     let!(:my_widget) { create(:widget) }
+      #     context 'when visiting its page' do
+      #       let!(:my_widget) { create(:widget, name: 'Special') }
+      #       it 'counts widgets' do
+      #         expect(Widget.count).to eq(1)
+      #       end
+      #     end
+      #   end
+      #
       class LetSetup < Base
         MSG = 'Do not use `let!` to setup objects not referenced in tests.'
 
@@ -59,6 +71,8 @@ module RuboCop
 
         def unused_let_bang(node)
           child_let_bang(node) do |method_send, method_name|
+            next if overrides_outer_let_bang?(node, method_name)
+
             yield(method_send) unless method_called?(node, method_name.to_sym)
           end
         end
@@ -68,6 +82,22 @@ module RuboCop
             let_bang(let, &block)
           end
         end
+
+        def overrides_outer_let_bang?(node, method_name)
+          node.each_ancestor(:block).any? do |ancestor|
+            next unless example_or_shared_group_or_including?(ancestor)
+
+            outer_let_bang?(ancestor, method_name)
+          end
+        end
+
+        def outer_let_bang?(ancestor_node, method_name)
+          RuboCop::RSpec::ExampleGroup.new(ancestor_node).lets.any? do |let|
+            let_bang(let) do |_send, name|
+              name == method_name
+            end
+          end
+        end
       end
     end
   end

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

@@ -7,7 +7,7 @@ module RuboCop
       module FinalEndLocation
         def final_end_location(start_node)
           heredoc_endings =
-            start_node.each_node(:str, :dstr, :xstr)
+            start_node.each_node(:any_str)
               .select(&:heredoc?)
               .map { |node| node.loc.heredoc_end }
 

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

@@ -13,7 +13,7 @@ module RuboCop
         # @!method variable_definition?(node)
         def_node_matcher :variable_definition?, <<~PATTERN
           (send nil? {#Subjects.all #Helpers.all}
-            $({sym str dsym dstr} ...) ...)
+            $({any_sym str dstr} ...) ...)
         PATTERN
       end
     end

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

@@ -181,9 +181,7 @@ module RuboCop
         end
 
         def heredoc_argument?(matcher)
-          matcher.arguments.select do |arg|
-            arg.type?(:str, :dstr, :xstr)
-          end.any?(&:heredoc?)
+          matcher.arguments.select(&:any_str_type?).any?(&:heredoc?)
         end
 
         # @!method predicate_matcher?(node)

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

@@ -5,6 +5,11 @@ module RuboCop
     module RSpec
       # Prefer `not_to receive(...)` over `receive(...).never`.
       #
+      # This cop only flags usage with `expect`. It ignores `allow` because
+      # `allow(...).to receive(...).never` is a valid way to ensure a method
+      # is not called, while `allow(...).not_to receive(...)` would have
+      # different semantics.
+      #
       # @example
       #   # bad
       #   expect(foo).to receive(:bar).never
@@ -12,6 +17,9 @@ module RuboCop
       #   # good
       #   expect(foo).not_to receive(:bar)
       #
+      #   # not flagged by this cop
+      #   allow(foo).to receive(:bar).never
+      #
       class ReceiveNever < Base
         extend AutoCorrector
         MSG = 'Use `not_to receive` instead of `never`.'
@@ -20,8 +28,20 @@ module RuboCop
         # @!method method_on_stub?(node)
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 
+        # @!method expect_to_receive?(node)
+        def_node_matcher :expect_to_receive?, <<~PATTERN
+          (send
+            {
+              (send #rspec? {:expect :expect_any_instance_of} ...)
+              (block (send #rspec? :expect) ...)
+              (send nil? :is_expected)
+            }
+            :to ...)
+        PATTERN
+
         def on_send(node)
           return unless node.method?(:never) && method_on_stub?(node)
+          return unless used_with_expect?(node)
 
           add_offense(node.loc.selector) do |corrector|
             autocorrect(corrector, node)
@@ -30,6 +50,12 @@ module RuboCop
 
         private
 
+        def used_with_expect?(node)
+          node.each_ancestor(:send).any? do |ancestor|
+            expect_to_receive?(ancestor)
+          end
+        end
+
         def autocorrect(corrector, node)
           corrector.replace(node.parent.loc.selector, 'not_to')
           range = node.loc.dot.with(end_pos: node.loc.selector.end_pos)

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

@@ -16,36 +16,55 @@ module RuboCop
       #   end
       #
       class RepeatedExample < Base
-        MSG = "Don't repeat examples within an example group."
+        MSG = "Don't repeat examples within an example group. " \
+              'Repeated on line(s) %<lines>s.'
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
-          repeated_examples(node).each do |repeated_example|
-            add_offense(repeated_example)
+          find_repeated_examples(node).each do |repeated_examples|
+            add_offenses_for_repeated_group(repeated_examples)
           end
         end
 
         private
 
-        def repeated_examples(node)
-          RuboCop::RSpec::ExampleGroup.new(node)
-            .examples
-            .group_by { |example| example_signature(example) }
+        def find_repeated_examples(node)
+          examples = RuboCop::RSpec::ExampleGroup.new(node).examples
+
+          examples
+            .group_by { |example| build_example_signature(example) }
             .values
-            .reject(&:one?)
-            .flatten
-            .map(&:to_node)
+            .select { |group| group.size > 1 }
         end
 
-        def example_signature(example)
-          key_parts = [example.metadata, example.implementation]
-
+        def build_example_signature(example)
+          signature = [example.metadata, example.implementation]
           if example.definition.method?(:its)
-            key_parts << example.definition.arguments
+            signature << example.definition.arguments
+          end
+          signature
+        end
+
+        def add_offenses_for_repeated_group(repeated_examples)
+          repeated_examples.each do |example|
+            other_lines = extract_other_lines(repeated_examples, example)
+            add_offense(example.to_node, message: message(other_lines))
           end
+        end
+
+        def extract_other_lines(examples_group, current_example)
+          current_node = current_example.to_node
+
+          examples_group
+            .reject { |ex| ex.to_node.equal?(current_node) }
+            .map { |ex| ex.to_node.first_line }
+            .uniq
+            .sort
+        end
 
-          key_parts
+        def message(other_lines)
+          format(MSG, lines: other_lines.join(', '))
         end
       end
     end

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

@@ -30,7 +30,7 @@ module RuboCop
 
         # @!method match_ambiguous_trailing_metadata?(node)
         def_node_matcher :match_ambiguous_trailing_metadata?, <<~PATTERN
-          (send _ _ _ ... !{hash sym str dstr xstr})
+          (send _ _ _ ... !{hash sym any_str})
         PATTERN
 
         def on_metadata(args, hash)

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

@@ -32,6 +32,12 @@ module RuboCop
       #   # good
       #   whatever_spec.rb         # describe MyClass, type: :routing do; end
       #
+      # @example `EnforcedInflector: active_support`
+      #   # Enable to use ActiveSupport's inflector for custom acronyms
+      #   # like HTTP, etc. Set to "default" by default.
+      #   # Configure `InflectorPath` with the path to the inflector file.
+      #   # The default is ./config/initializers/inflections.rb.
+      #
       class SpecFilePathFormat < Base
         include TopLevelGroup
         include Namespace
@@ -59,6 +65,53 @@ module RuboCop
 
         private
 
+        # Inflector module that uses ActiveSupport for advanced inflection rules
+        module ActiveSupportInflector
+          def self.call(string)
+            ActiveSupport::Inflector.underscore(string)
+          end
+
+          def self.prepare_availability(config)
+            return if @prepared
+
+            @prepared = true
+
+            inflector_path = config.fetch('InflectorPath')
+
+            unless File.exist?(inflector_path)
+              raise "The configured `InflectorPath` #{inflector_path} does " \
+                    'not exist.'
+            end
+
+            require 'active_support/inflector'
+            require inflector_path
+          end
+        end
+
+        # Inflector module that uses basic regex-based conversion
+        module DefaultInflector
+          def self.call(string)
+            string
+              .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
+              .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
+              .downcase
+          end
+        end
+
+        def inflector
+          case cop_config.fetch('EnforcedInflector')
+          when 'active_support'
+            ActiveSupportInflector.prepare_availability(cop_config)
+            ActiveSupportInflector
+          when 'default'
+            DefaultInflector
+          else
+            # :nocov:
+            :noop
+            # :nocov:
+          end
+        end
+
         def ensure_correct_file_path(send_node, class_name, arguments)
           pattern = correct_path_pattern(class_name, arguments)
           return if filename_ends_with?(pattern)
@@ -106,10 +159,7 @@ module RuboCop
         end
 
         def camel_to_snake_case(string)
-          string
-            .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
-            .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
-            .downcase
+          inflector.call(string)
         end
 
         def custom_transform

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

@@ -60,16 +60,8 @@ module RuboCop
         end
 
         def style_offense?(variable)
-          (style == :symbols && string?(variable)) ||
-            (style == :strings && symbol?(variable))
-        end
-
-        def string?(node)
-          node.str_type?
-        end
-
-        def symbol?(node)
-          node.type?(:sym, :dsym)
+          (style == :symbols && variable.str_type?) ||
+            (style == :strings && variable.any_sym_type?)
         end
       end
     end

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

@@ -10,12 +10,12 @@ module RuboCop
       # @example
       #   # bad
       #   let(:foo) do
-      #     double(method_name: 'returned value')
+      #     double("ClassName", method_name: 'returned value')
       #   end
       #
       #   # bad
       #   let(:foo) do
-      #     double("ClassName", method_name: 'returned value')
+      #     spy("ClassName", method_name: 'returned value')
       #   end
       #
       #   # good
@@ -23,6 +23,50 @@ module RuboCop
       #     instance_double("ClassName", method_name: 'returned value')
       #   end
       #
+      #   # good
+      #   let(:foo) do
+      #     class_double("ClassName", method_name: 'returned value')
+      #   end
+      #
+      #   # good
+      #   let(:foo) do
+      #     object_double("some object", method_name: 'returned value')
+      #   end
+      #
+      # @example `IgnoreNameless: true (default)`
+      #   # good
+      #   let(:foo) do
+      #     double(method_name: 'returned value')
+      #   end
+      #
+      #   # good
+      #   let(:foo) do
+      #     double
+      #   end
+      #
+      # @example `IgnoreNameless: false`
+      #   # bad
+      #   let(:foo) do
+      #     double(method_name: 'returned value')
+      #   end
+      #
+      #   # bad
+      #   let(:foo) do
+      #     double
+      #   end
+      #
+      # @example `IgnoreSymbolicNames: false (default)`
+      #   # bad
+      #   let(:foo) do
+      #     double(:foo)
+      #   end
+      #
+      # @example `IgnoreSymbolicNames: true`
+      #   # good
+      #   let(:foo) do
+      #     double(:foo)
+      #   end
+      #
       class VerifiedDoubles < Base
         MSG = 'Prefer using verifying doubles over normal doubles.'
         RESTRICT_ON_SEND = %i[double spy].freeze
@@ -34,7 +78,7 @@ module RuboCop
 
         def on_send(node)
           unverified_double(node) do |name, *_args|
-            return if name.nil? && cop_config['IgnoreNameless']
+            return if (name.nil? || hash?(name)) && cop_config['IgnoreNameless']
             return if symbol?(name) && cop_config['IgnoreSymbolicNames']
 
             add_offense(node)
@@ -46,6 +90,10 @@ module RuboCop
         def symbol?(name)
           name&.sym_type?
         end
+
+        def hash?(arg)
+          arg.hash_type?
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec_cops.rb

@@ -57,6 +57,7 @@ require_relative 'rspec/it_behaves_like'
 require_relative 'rspec/iterated_expectation'
 require_relative 'rspec/leading_subject'
 require_relative 'rspec/leaky_constant_declaration'
+require_relative 'rspec/leaky_local_variable'
 require_relative 'rspec/let_before_examples'
 require_relative 'rspec/let_setup'
 require_relative 'rspec/match_array'

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.7.0'
+      STRING = '3.8.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - John Backus
@@ -31,20 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.72'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.72.1
+        version: '1.81'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.72'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.72.1
+        version: '1.81'
 description: |
   Code style checking for RSpec files.
   A plugin for the RuboCop code style enforcing & linting tool.
@@ -123,6 +117,7 @@ files:
 - lib/rubocop/cop/rspec/iterated_expectation.rb
 - lib/rubocop/cop/rspec/leading_subject.rb
 - lib/rubocop/cop/rspec/leaky_constant_declaration.rb
+- lib/rubocop/cop/rspec/leaky_local_variable.rb
 - lib/rubocop/cop/rspec/let_before_examples.rb
 - lib/rubocop/cop/rspec/let_setup.rb
 - lib/rubocop/cop/rspec/match_array.rb