rubocop-rspec 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c427b063cba22b4601d8244b18db288081f95889e287be82473e9148748c2e
-  data.tar.gz: 9d9543614cb00ee6cf4c94c750ce2368a4e34dae73f1a778e3fc9a7470698526
+  metadata.gz: 4a2433cc3212de48725bca4fa2f8216ef0742950d1b0ad0a52e0d717050ede4e
+  data.tar.gz: 3e43165a772275ece7344813b6dfc5196669763013c0bedc3b75107cf6fa0f30
 SHA512:
-  metadata.gz: 04fb1fe03b1fb818c7ee43d937fbb394e93a91e70c0cc00c06d259c53210ebb6b5243b584342838de566e99d0263d60b975113362b3a6306acf31f46ea2ed0ff
-  data.tar.gz: 66daeeaff0d894825dfcf0dc836b0fc614490b358b508ddaacc98652c37f0dc6e9c29e38222493e21a662f848a20efce503fe25a349b7a16fcc3693b9ecac4a1
+  metadata.gz: 41a9171c098150e3349977cd08df5f369fe2d33c0bb4f1b29edcfb2633eae2c880ab1ff71a9c4a1ee5dc28645a6359ecd3e4ab99a822ac576523386e78364ee2
+  data.tar.gz: af1c164ac3d8c9e9ed61611fa9877c459656f695fd45c057c776af99304fcd8471fa00d958d7bf650ba46f82056ae96accd12cfeec17eb1a00129baffdb51768

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Master (Unreleased)
 
+## 3.4.0 (2025-01-20)
+
+- Fix `RSpec/SortMetadata` cop to limit sorting to trailing metadata arguments. ([@cbliard])
+- Replace `RSpec/StringAsInstanceDoubleConstant` with `RSpec/VerifiedDoubleReference` configured to only support constant class references. ([@corsonknowles])
+- Fix `RSpec/EmptyExampleGroup` cop false positive when a simple conditional is used inside an iterator. ([@lovro-bikic])
+
+## 3.3.0 (2024-12-12)
+
+- Deprecate `top_level_group?` method from `TopLevelGroup` mixin as all of its callers were intentionally removed from `Rubocop/RSpec`. ([@corsonknowles])
+- Fix false positive for RSpec/EmptyMetadata for splat kwargs. ([@pirj])
+
 ## 3.2.0 (2024-10-26)
 
 - Fix `RSpec/VoidExpect` to only operate inside an example block. ([@corsonknowles])
@@ -88,7 +99,7 @@ Read more about how to upgrade in https://docs.rubocop.org/rubocop-rspec/upgrade
 - Add new `RSpec/IsExpectedSpecify` cop. ([@ydah])
 - Add new `RSpec/RepeatedSubjectCall` cop. ([@drcapulet])
 - Add support for `assert_true`, `assert_false`, `assert_not_equal`, `assert_not_nil`, `*_empty`, `*_predicate`, `*_kind_of`, `*_in_delta`, `*_match`, `*_instance_of` and `*_includes` assertions in `RSpec/Rails/MinitestAssertions`. ([@ydah], [@G-Rath])
-- Support asserts with messages in `Rspec/BeEmpty`. ([@G-Rath])
+- Support asserts with messages in `RSpec/BeEmpty`. ([@G-Rath])
 - Fix a false positive for `RSpec/ExpectActual` when used with rspec-rails routing matchers. ([@naveg])
 - Add configuration option `ResponseMethods` to `RSpec/Rails/HaveHttpStatus`. ([@ydah])
 - Fix a false negative for `RSpec/DescribedClass` when class with constant. ([@ydah])
@@ -283,7 +294,7 @@ Read more about how to upgrade in https://docs.rubocop.org/rubocop-rspec/upgrade
 ## 2.13.0 (2022-09-12)
 
 - Fix `RSpec/FilePath` cop missing mismatched expanded namespace. ([@sl4vr])
-- Add new `AllowConsecutiveOneLiners` (default true) option for `Rspec/EmptyLineAfterHook` cop. ([@ngouy])
+- Add new `AllowConsecutiveOneLiners` (default true) option for `RSpec/EmptyLineAfterHook` cop. ([@ngouy])
 - Add autocorrect support for `RSpec/EmptyExampleGroup`. ([@r7kamura])
 - Fix `RSpec/ChangeByZero` with compound expressions using `&` or `|` operators. ([@BrianHawley])
 - Add `RSpec/NoExpectationExample`. ([@r7kamura])
@@ -740,7 +751,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 ## 1.13.0 (2017-03-07)
 
 - Add repeated 'it' detection to `RSpec/ExampleWording` cop. ([@dgollahon])
-- Add \[observed_nesting/max_nesting\] info to `RSpec/NestedGroups` messages. ([@dgollahon])
+- Add [observed_nesting/max_nesting] info to `RSpec/NestedGroups` messages. ([@dgollahon])
 - Add `RSpec/ItBehavesLike` cop. ([@dgollahon])
 - Add `RSpec/SharedContext` cop. ([@Darhazer])
 - `RSpec/MultipleExpectations`: Count aggregate_failures block as single expectation. ([@Darhazer])
@@ -984,6 +995,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@leoarnold]: https://github.com/leoarnold
 [@liberatys]: https://github.com/Liberatys
 [@lokhi]: https://github.com/lokhi
+[@lovro-bikic]: https://github.com/lovro-bikic
 [@luke-hill]: https://github.com/luke-hill
 [@m-yamashita01]: https://github.com/M-Yamashita01
 [@marocchino]: https://github.com/marocchino

data/config/default.yml

@@ -930,13 +930,6 @@ RSpec/SpecFilePathSuffix:
     - "**/spec/**/*"
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SpecFilePathSuffix
 
-RSpec/StringAsInstanceDoubleConstant:
-  Description: Do not use a string as `instance_double` constant.
-  Enabled: pending
-  Safe: false
-  VersionAdded: '3.1'
-  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/StringAsInstanceDoubleConstant
-
 RSpec/StubbedMock:
   Description: Checks that message expectations do not have a configured response.
   Enabled: true
@@ -995,12 +988,8 @@ RSpec/VerifiedDoubleReference:
   Description: Checks for consistent verified double reference style.
   Enabled: true
   SafeAutoCorrect: false
-  EnforcedStyle: constant
-  SupportedStyles:
-    - constant
-    - string
   VersionAdded: 2.10.0
-  VersionChanged: '2.12'
+  VersionChanged: '3.4'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VerifiedDoubleReference
 
 RSpec/VerifiedDoubles:

data/config/obsoletion.yml

@@ -12,6 +12,9 @@ changed_parameters:
     parameters: IgnoredPatterns
     alternative: AllowedPatterns
     severity: warning
+  - cops: RSpec/VerifiedDoubleReference
+    parameters: EnforcedStyle
+    reason: String references are not verifying unless the class is loaded.
 
 split:
   RSpec/FilePath:
@@ -23,6 +26,8 @@ removed:
   RSpec/Capybara/FeatureMethods:
     reason: >
       this cop has migrated to `RSpec/Dialect`. Please use `RSpec/Dialect` instead
+  RSpec/StringAsInstanceDoubleConstant:
+    reason: Please use `RSpec/VerifiedDoubleReference` instead
 
 extracted:
   RSpec/Rails/*: rubocop-rspec_rails

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

@@ -69,15 +69,13 @@ module RuboCop
         end
 
         def check_for_unused_proxy(block, proxy)
-          name, = *proxy
-
           find_arg_usage(block) do |usage|
-            return if usage.include?(s(:lvar, name))
+            return if usage.include?(s(:lvar, proxy.name))
           end
 
           add_offense(
             proxy,
-            message: format(MSG_UNUSED_ARG, arg: name)
+            message: format(MSG_UNUSED_ARG, arg: proxy.name)
           )
         end
 

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

@@ -6,6 +6,7 @@ module RuboCop
       # Checks where `contain_exactly` is used.
       #
       # This cop checks for the following:
+      #
       # - Prefer `match_array` when matching array values.
       # - Prefer `be_empty` when using `contain_exactly` with no arguments.
       #

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

@@ -130,6 +130,7 @@ module RuboCop
         def_node_matcher :examples?, <<~PATTERN
           {
             #examples_directly_or_in_block?
+            #examples_in_branches?
             (begin <#examples_directly_or_in_block? ...>)
             (begin <#examples_in_branches? ...>)
           }
@@ -170,6 +171,7 @@ module RuboCop
         end
 
         def examples_in_branches?(condition_node)
+          return false unless condition_node
           return false if !condition_node.if_type? && !condition_node.case_type?
 
           condition_node.branches.any? { |branch| examples?(branch) }

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

@@ -21,6 +21,7 @@ module RuboCop
 
         def on_metadata(_symbols, hash)
           return unless hash&.pairs&.empty?
+          return if hash.children.any?(&:kwsplat_type?)
 
           add_offense(hash) do |corrector|
             remove_empty_metadata(corrector, hash)

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

@@ -29,12 +29,6 @@ module RuboCop
       #   describe 'test' do; end
       #
       #   # bad
-      #   fdescribe 'test' do; end
-      #
-      #   # good
-      #   describe 'test' do; end
-      #
-      #   # bad
       #   shared_examples 'test', focus: true do; end
       #
       #   # good

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

@@ -6,6 +6,7 @@ module RuboCop
       # Checks where `match_array` is used.
       #
       # This cop checks for the following:
+      #
       # - Prefer `contain_exactly` when matching an array with values.
       # - Prefer `eq` when using `match_array` with an empty array literal.
       #

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

@@ -47,15 +47,12 @@ module RuboCop
         private
 
         def on_metadata_arguments(metadata_arguments)
-          *symbols, last = metadata_arguments
-          hash = nil
-          case last&.type
-          when :hash
-            hash = last
-          when :sym
-            symbols << last
+          if metadata_arguments.last&.hash_type?
+            *metadata_arguments, hash = metadata_arguments
+            on_metadata(metadata_arguments, hash)
+          else
+            on_metadata(metadata_arguments, nil)
           end
-          on_metadata(symbols, hash)
         end
       end
     end

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

@@ -7,6 +7,10 @@ module RuboCop
       module TopLevelGroup
         extend RuboCop::NodePattern::Macros
 
+        DEPRECATED_MODULE_METHOD_WARNING =
+          'top_level_group? is deprecated and will be ' \
+          'removed in the next major version of rubocop_rspec.'
+
         def on_new_investigation
           super
 
@@ -28,7 +32,10 @@ module RuboCop
 
         def on_top_level_group(_node); end
 
+        # @private
+        # @deprecated All callers of this method have been removed.
         def top_level_group?(node)
+          warn DEPRECATED_MODULE_METHOD_WARNING, uplevel: 1
           top_level_groups.include?(node)
         end
 

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

@@ -94,11 +94,6 @@ module RuboCop
           (send #rspec? ${#ExampleGroups.skipped} ...)
         PATTERN
 
-        # @!method pending_step_without_reason?(node)
-        def_node_matcher :pending_step_without_reason?, <<~PATTERN
-          (send nil? {:skip :pending})
-        PATTERN
-
         def on_send(node)
           on_pending_by_metadata(node)
           return unless (parent = parent_node(node))

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

@@ -67,11 +67,10 @@ module RuboCop
         end
 
         def autocorrect_hash_arg(corrector, arg)
-          key, value = *arg.children.first
-
-          corrector.replace(arg, key_to_arg(key))
+          pair = arg.pairs.first
+          corrector.replace(arg, key_to_arg(pair.key))
           corrector.insert_after(arg.parent.loc.end,
-                                 ".and_return(#{value.source})")
+                                 ".and_return(#{pair.value.source})")
         end
 
         def autocorrect_array_arg(corrector, arg)

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

@@ -5,6 +5,8 @@ module RuboCop
     module RSpec
       # Sort RSpec metadata alphabetically.
       #
+      # Only the trailing metadata is sorted.
+      #
       # @example
       #   # bad
       #   describe 'Something', :b, :a
@@ -16,6 +18,9 @@ module RuboCop
       #   context 'Something', baz: true, foo: 'bar'
       #   it 'works', :a, :b, baz: true, foo: 'bar'
       #
+      #   # good, trailing metadata is sorted
+      #   describe 'Something', 'description', :a, :b, :z
+      #   context 'Something', :z, variable, :a, :b
       class SortMetadata < Base
         extend AutoCorrector
         include Metadata
@@ -23,8 +28,14 @@ module RuboCop
 
         MSG = 'Sort metadata alphabetically.'
 
-        def on_metadata(symbols, hash)
+        # @!method match_ambiguous_trailing_metadata?(node)
+        def_node_matcher :match_ambiguous_trailing_metadata?, <<~PATTERN
+          (send _ _ _ ... !{hash sym str dstr xstr})
+        PATTERN
+
+        def on_metadata(args, hash)
           pairs = hash&.pairs || []
+          symbols = trailing_symbols(args)
           return if sorted?(symbols, pairs)
 
           crime_scene = crime_scene(symbols, pairs)
@@ -35,6 +46,15 @@ module RuboCop
 
         private
 
+        def trailing_symbols(args)
+          args = args[...-1] if last_arg_could_be_a_hash?(args)
+          args.reverse.take_while(&:sym_type?).reverse
+        end
+
+        def last_arg_could_be_a_hash?(args)
+          args.last && match_ambiguous_trailing_metadata?(args.last.parent)
+        end
+
         def crime_scene(symbols, pairs)
           metadata = symbols + pairs
 
@@ -57,13 +77,7 @@ module RuboCop
         end
 
         def sort_symbols(symbols)
-          symbols.sort_by do |symbol|
-            if symbol.str_type? || symbol.sym_type?
-              symbol.value.to_s.downcase
-            else
-              symbol.source.downcase
-            end
-          end
+          symbols.sort_by { |symbol| symbol.value.to_s.downcase }
         end
       end
     end

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

@@ -14,8 +14,9 @@ module RuboCop
       #   expect(foo).to receive(:bar).with(42)
       #
       class StubbedMock < Base
-        MSG = 'Prefer `%<replacement>s` over `%<method_name>s` when ' \
+        MSG = 'Prefer %<replacement>s over `%<method_name>s` when ' \
               'configuring a response.'
+        RESTRICT_ON_SEND = %i[to].freeze
 
         # @!method message_expectation?(node)
         #   Match message expectation matcher
@@ -133,8 +134,6 @@ module RuboCop
           }
         PATTERN
 
-        RESTRICT_ON_SEND = %i[to].freeze
-
         def on_send(node)
           expectation(node) do |expectation, method_name, matcher|
             on_expectation(expectation, method_name, matcher)
@@ -155,19 +154,23 @@ module RuboCop
         end
 
         def msg(method_name)
-          format(MSG,
-                 method_name: method_name,
-                 replacement: replacement(method_name))
+          format(
+            MSG,
+            method_name: method_name,
+            replacement: replacement(method_name)
+          )
         end
 
         def replacement(method_name)
           case method_name
           when :expect
-            :allow
+            '`allow`'
           when :is_expected
-            'allow(subject)'
+            '`allow(subject)`'
           when :expect_any_instance_of
-            :allow_any_instance_of
+            '`allow_any_instance_of`'
+          else
+            'an allow statement'
           end
         end
       end

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

@@ -64,7 +64,6 @@ module RuboCop
         def find_expect_to(node)
           node.each_ancestor.find do |ancestor|
             break if ancestor.block_type?
-            next unless ancestor.send_type?
 
             expect_to?(ancestor)
           end

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

@@ -5,14 +5,14 @@ module RuboCop
     module RSpec
       # Checks for consistent verified double reference style.
       #
-      # Only investigates references that are one of the supported styles.
-      #
       # @see https://rspec.info/features/3-12/rspec-mocks/verifying-doubles
       #
-      # This cop can be configured in your configuration using the
-      # `EnforcedStyle` option and supports `--auto-gen-config`.
+      # @safety
+      #   This cop is unsafe because the correction requires loading the class.
+      #   Loading before stubbing causes RSpec to only allow instance methods
+      #   to be stubbed.
       #
-      # @example `EnforcedStyle: constant` (default)
+      # @example
       #   # bad
       #   let(:foo) do
       #     instance_double('ClassName', method_name: 'returned_value')
@@ -23,18 +23,7 @@ module RuboCop
       #     instance_double(ClassName, method_name: 'returned_value')
       #   end
       #
-      # @example `EnforcedStyle: string`
-      #   # bad
-      #   let(:foo) do
-      #     instance_double(ClassName, method_name: 'returned_value')
-      #   end
-      #
-      #   # good
-      #   let(:foo) do
-      #     instance_double('ClassName', method_name: 'returned_value')
-      #   end
-      #
-      # @example Reference is not in the supported style list. No enforcement
+      # @example Reference is any dynamic variable. No enforcement
       #
       #   # good
       #   let(:foo) do
@@ -42,9 +31,9 @@ module RuboCop
       #   end
       class VerifiedDoubleReference < Base
         extend AutoCorrector
-        include ConfigurableEnforcedStyle
 
-        MSG = 'Use a %<style>s class reference for verified doubles.'
+        MSG = 'Use a constant class reference for verified doubles. ' \
+              'String references are not verifying unless the class is loaded.'
 
         RESTRICT_ON_SEND = Set[
           :class_double,
@@ -57,53 +46,25 @@ module RuboCop
           :stub_model
         ].freeze
 
-        REFERENCE_TYPE_STYLES = {
-          str: :string,
-          const: :constant
-        }.freeze
-
         # @!method verified_double(node)
         def_node_matcher :verified_double, <<~PATTERN
           (send
             nil?
             RESTRICT_ON_SEND
-            $_class_reference
+            $str
             ...)
         PATTERN
 
         def on_send(node)
-          verified_double(node) do |class_reference|
-            break correct_style_detected unless opposing_style?(class_reference)
-
-            message = format(MSG, style: style)
-            expression = class_reference.source_range
-
-            add_offense(expression, message: message) do |corrector|
-              offense = class_reference.source
-              corrector.replace(expression, correct_style(offense))
-
-              opposite_style_detected
+          verified_double(node) do |string_argument_node|
+            add_offense(string_argument_node) do |corrector|
+              autocorrect(corrector, string_argument_node)
             end
           end
         end
 
-        private
-
-        def opposing_style?(class_reference)
-          class_reference_style = REFERENCE_TYPE_STYLES[class_reference.type]
-
-          # Only enforce supported styles
-          return false unless class_reference_style
-
-          class_reference_style != style
-        end
-
-        def correct_style(offense)
-          if style == :string
-            "'#{offense}'"
-          else
-            offense.gsub(/^['"]|['"]$/, '')
-          end
+        def autocorrect(corrector, node)
+          corrector.replace(node, node.value)
         end
       end
     end

data/lib/rubocop/cop/rspec_cops.rb

@@ -99,7 +99,6 @@ require_relative 'rspec/skip_block_inside_example'
 require_relative 'rspec/sort_metadata'
 require_relative 'rspec/spec_file_path_format'
 require_relative 'rspec/spec_file_path_suffix'
-require_relative 'rspec/string_as_instance_double_constant'
 require_relative 'rspec/stubbed_mock'
 require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'

data/lib/rubocop/rspec/description_extractor.rb

@@ -62,8 +62,8 @@ module RuboCop
         end
 
         def cop_subclass?
-          yardoc.superclass.path == RSPEC_COP_CLASS_NAME ||
-            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
+          [RSPEC_COP_CLASS_NAME,
+           RUBOCOP_COP_CLASS_NAME].include?(yardoc.superclass.path)
         end
 
         def abstract?

data/lib/rubocop/rspec/hook.rb

@@ -45,7 +45,7 @@ module RuboCop
       private
 
       def valid_scope?(node)
-        node&.sym_type? && Language::HookScopes.all(node.value)
+        node.sym_type? && Language::HookScopes.all(node.value)
       end
 
       def transform_metadata(meta)

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.2.0'
+      STRING = '3.4.0'
     end
   end
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -157,7 +156,6 @@ files:
 - lib/rubocop/cop/rspec/sort_metadata.rb
 - lib/rubocop/cop/rspec/spec_file_path_format.rb
 - lib/rubocop/cop/rspec/spec_file_path_suffix.rb
-- lib/rubocop/cop/rspec/string_as_instance_double_constant.rb
 - lib/rubocop/cop/rspec/stubbed_mock.rb
 - lib/rubocop/cop/rspec/subject_declaration.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
@@ -193,7 +191,6 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -208,8 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      # Do not use a string as `instance_double` constant.
-      #
-      # @safety
-      #   This cop is unsafe because the correction requires loading the class.
-      #   Loading before stubbing causes RSpec to only allow instance methods
-      #   to be stubbed.
-      #
-      # @example
-      #   # bad
-      #   instance_double('User', name: 'John')
-      #
-      #   # good
-      #   instance_double(User, name: 'John')
-      #
-      class StringAsInstanceDoubleConstant < Base
-        extend AutoCorrector
-
-        MSG = 'Do not use a string as `instance_double` constant.'
-        RESTRICT_ON_SEND = %i[instance_double].freeze
-
-        # @!method stringified_instance_double_const?(node)
-        def_node_matcher :stringified_instance_double_const?, <<~PATTERN
-          (send nil? :instance_double $str ...)
-        PATTERN
-
-        def on_send(node)
-          stringified_instance_double_const?(node) do |args_node|
-            add_offense(args_node) do |corrector|
-              autocorrect(corrector, args_node)
-            end
-          end
-        end
-
-        def autocorrect(corrector, node)
-          corrector.replace(node, node.value)
-        end
-      end
-    end
-  end
-end