rubocop-rspec 3.0.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce22630f88fd7a9b996711a4af330a186471fdc8a6dd99b05830ad695a09118
-  data.tar.gz: 44a91f15e435ec623b2a25ae6e7b890772d7cf3066206f97b0ca1abf42c62c7a
+  metadata.gz: 47c427b063cba22b4601d8244b18db288081f95889e287be82473e9148748c2e
+  data.tar.gz: 9d9543614cb00ee6cf4c94c750ce2368a4e34dae73f1a778e3fc9a7470698526
 SHA512:
-  metadata.gz: 0d6b6f4113c4fc5253dcd59525e348879ae5763d09bb416de752d037b3ee20c38774df54322a8c7abd4c21652b22e6c4ac708bce51a2f1df61fecb4aab9dc4ac
-  data.tar.gz: ec0278b64e0dc0ca9cf0e9558ae02224ea5a3360ee86380336b4bc07e134801e46011f5ef673586eac6b85557884b3d3986d05935b3255ba48c227ecd760227c
+  metadata.gz: 04fb1fe03b1fb818c7ee43d937fbb394e93a91e70c0cc00c06d259c53210ebb6b5243b584342838de566e99d0263d60b975113362b3a6306acf31f46ea2ed0ff
+  data.tar.gz: 66daeeaff0d894825dfcf0dc836b0fc614490b358b508ddaacc98652c37f0dc6e9c29e38222493e21a662f848a20efce503fe25a349b7a16fcc3693b9ecac4a1

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Master (Unreleased)
 
+## 3.2.0 (2024-10-26)
+
+- Fix `RSpec/VoidExpect` to only operate inside an example block. ([@corsonknowles])
+- Change `RSpec/ContextWording` cop to always report an offense when both `Prefixes` and `AllowedPatterns` are empty. ([@ydah])
+- Add support for `and` and `or` compound matchers to `RSpec/ChangeByZero` cop. ([@ydah])
+
+## 3.1.0 (2024-10-01)
+
+- Add `RSpec/StringAsInstanceDoubleConstant` to check for and correct strings used as instance_doubles. ([@corsonknowles])
+- Fix false-positive for `RSpec/UnspecifiedException` when a method is literally named `raise_exception`. ([@aarestad])
+- Fix false-positive for `RSpec/UnspecifiedException` when `not_to raise_error` is used within a block. ([@aarestad], [@G-Rath])
+
 ## 3.0.5 (2024-09-07)
 
 - Fix false-negative and error for `RSpec/MetadataStyle` when non-literal args are used in metadata in `EnforceStyle: hash`. ([@cbliard])
@@ -899,6 +911,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 
 <!-- Contributors (alphabetically) -->
 
+[@aarestad]: https://github.com/aarestad
 [@abrom]: https://github.com/abrom
 [@ahukkanen]: https://github.com/ahukkanen
 [@akiomik]: https://github.com/akiomik
@@ -920,6 +933,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@cfabianski]: https://github.com/cfabianski
 [@clupprich]: https://github.com/clupprich
 [@composerinteralia]: https://github.com/composerinteralia
+[@corsonknowles]: https://github.com/corsonknowles
 [@corydiamand]: https://github.com/corydiamand
 [@darhazer]: https://github.com/Darhazer
 [@daveworth]: https://github.com/daveworth

data/config/default.yml

@@ -403,6 +403,7 @@ RSpec/ExampleWithoutDescription:
     - single_line_only
     - disallow
   VersionAdded: '1.22'
+  StyleGuide: https://rspec.rubystyle.guide/#it-and-specify
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWithoutDescription
 
 RSpec/ExampleWording:
@@ -929,6 +930,13 @@ 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

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

@@ -104,12 +104,12 @@ module RuboCop
         # rubocop:disable Metrics/MethodLength
         def register_offense(node, change_node)
           if compound_expectations?(node)
-            add_offense(node.source_range,
+            add_offense(node,
                         message: message_compound(change_node)) do |corrector|
               autocorrect_compound(corrector, node)
             end
           else
-            add_offense(node.source_range,
+            add_offense(node,
                         message: message(change_node)) do |corrector|
               autocorrect(corrector, node, change_node)
             end
@@ -118,7 +118,8 @@ module RuboCop
         # rubocop:enable Metrics/MethodLength
 
         def compound_expectations?(node)
-          %i[and or & |].include?(node.parent.method_name)
+          node.parent.send_type? &&
+            %i[and or & |].include?(node.parent.method_name)
         end
 
         def message(change_node)

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

@@ -12,6 +12,9 @@ module RuboCop
       #
       # @see http://www.betterspecs.org/#contexts
       #
+      # If both `Prefixes` and `AllowedPatterns` are empty, this cop will always
+      # report an offense. So you need to set at least one of them.
+      #
       # @example `Prefixes` configuration
       #   # .rubocop.yml
       #   # RSpec/ContextWording:
@@ -58,7 +61,9 @@ module RuboCop
       class ContextWording < Base
         include AllowedPattern
 
-        MSG = 'Context description should match %<patterns>s.'
+        MSG_MATCH = 'Context description should match %<patterns>s.'
+        MSG_ALWAYS = 'Current settings will always report an offense. Please ' \
+                     'add allowed words to `Prefixes` or `AllowedPatterns`.'
 
         # @!method context_wording(node)
         def_node_matcher :context_wording, <<~PATTERN
@@ -67,8 +72,7 @@ module RuboCop
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           context_wording(node) do |context|
-            if bad_pattern?(context)
-              message = format(MSG, patterns: expect_patterns)
+            unless matches_allowed_pattern?(description(context))
               add_offense(context, message: message)
             end
           end
@@ -84,12 +88,6 @@ module RuboCop
           @prefix_regexes ||= prefixes.map { |pre| /^#{Regexp.escape(pre)}\b/ }
         end
 
-        def bad_pattern?(node)
-          return false if allowed_patterns.empty?
-
-          !matches_allowed_pattern?(description(node))
-        end
-
         def description(context)
           if context.xstr_type?
             context.value.value
@@ -98,6 +96,14 @@ module RuboCop
           end
         end
 
+        def message
+          if allowed_patterns.empty?
+            MSG_ALWAYS
+          else
+            format(MSG_MATCH, patterns: expect_patterns)
+          end
+        end
+
         def expect_patterns
           inspected = allowed_patterns.map do |pattern|
             pattern.inspect.gsub(/\A"|"\z/, '/')

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

@@ -69,7 +69,7 @@ module RuboCop
           expect_literal(node) do |actual, send_node, matcher, expected|
             next if SKIPPED_MATCHERS.include?(matcher)
 
-            add_offense(actual.source_range) do |corrector|
+            add_offense(actual) do |corrector|
               next unless CORRECTABLE_MATCHERS.include?(matcher)
               next if literal?(expected)
 

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

@@ -0,0 +1,45 @@
+# 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

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

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

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

@@ -29,12 +29,14 @@ module RuboCop
 
         def on_send(node)
           return unless expect?(node)
+          return unless inside_example?(node)
 
           check_expect(node)
         end
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless expect_block?(node)
+          return unless inside_example?(node)
 
           check_expect(node)
         end
@@ -49,11 +51,14 @@ module RuboCop
 
         def void?(expect)
           parent = expect.parent
-          return true unless parent
           return true if parent.begin_type?
 
           parent.block_type? && parent.body == expect
         end
+
+        def inside_example?(node)
+          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec_cops.rb

@@ -99,6 +99,7 @@ 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/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '3.0.5'
+      STRING = '3.2.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.2.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -157,6 +157,7 @@ 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