rubocop-rspec 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d9511a08dde997c269b9bfe065a23b16296a607ce561a68bbe09ccd5eb37dee
-  data.tar.gz: 7966471067098d603c1098e544ad9c573e63037398126fbb9838aefbec992e25
+  metadata.gz: 8d0bedaa464141123a49b02ad1a31ed8a63b9960304014c0ef5e52f96fb78176
+  data.tar.gz: e310236f596a19629629c70d9f94fcb46a39183c43908b5864860efb2abd7602
 SHA512:
-  metadata.gz: 8020a1e38b6c8bf50ebccd9524d9fd513193ec2bdb9829edb1832d456abbdf57bc8386a51f58b6b19ea335de5991c6dec182a428f9579dfc91d7871990f83c54
-  data.tar.gz: 91aaec82daf89de819e93f4cadea65928b0b2178465db8997c0f928feaf4d5a11a3ecd1e927ab401e50aed1081dcdde41499101b6f5b166ae380bfbf4c1bfd89
+  metadata.gz: 7cd82a374f1cd9362070fe6561f9c04927a2ac33f5e1b5ee97a80bc443b0a4c3c90a75d93778e7bf6f439ff759b60857cdeccc2a7b51bfdc8feebccc519e36c8
+  data.tar.gz: 19bbbdd2d38ef4802be62f44a18e95e83caaf6899c654dff281fe7058fc9bdf6f776cf0491b825b274f67450388a7aef292c2ee51033f6ae96a9d8671829c5e4

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Master (Unreleased)
 
+## 2.10.0 (2022-04-19)
+
+* Fix a false positive for `RSpec/EmptyExampleGroup` when expectations in case statement. ([@ydah][])
+* Add `RSpec/VerifiedDoubleReference` cop. ([@t3h2mas][])
+* Make `RSpec/BeNil` cop configurable with a `be_nil` style and a `be` style. ([@bquorning][])
+* Fix `Capybara/CurrentPathExpectation` autocorrect incompatible with `Style/TrailingCommaInArguments` autocorrect. ([@ydah][])
+
 ## 2.9.0 (2022-02-28)
 
 * Add new `RSpec/BeNil` cop. ([@bquorning][])
@@ -672,3 +679,5 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@leoarnold]: https://github.com/leoarnold
 [@harry-graham]: https://github.com/harry-graham
 [@oshiro3]: https://github.com/oshiro3
+[@ydah]: https://github.com/ydah
+[@t3h2mas]: https://github.com/t3h2mas

data/config/default.yml

@@ -155,9 +155,14 @@ RSpec/BeEql:
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeEql
 
 RSpec/BeNil:
-  Description: Check that `be_nil` is used instead of `be(nil)`.
+  Description: Ensures a consistent style is used when matching `nil`.
   Enabled: pending
+  EnforcedStyle: be_nil
+  SupportedStyles:
+    - be
+    - be_nil
   VersionAdded: 2.9.0
+  VersionChanged: 2.10.0
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeNil
 
 RSpec/BeforeAfterAll:
@@ -761,6 +766,16 @@ RSpec/VariableName:
   VersionChanged: '1.43'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VariableName
 
+RSpec/VerifiedDoubleReference:
+  Description: Checks for consistent verified double reference style.
+  Enabled: pending
+  EnforcedStyle: constant
+  SupportedStyles:
+    - constant
+    - string
+  VersionAdded: 2.10.0
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VerifiedDoubleReference
+
 RSpec/VerifiedDoubles:
   Description: Prefer using verifying doubles over normal doubles.
   Enabled: true

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

@@ -3,24 +3,39 @@
 module RuboCop
   module Cop
     module RSpec
-      # Check that `be_nil` is used instead of `be(nil)`.
+      # Ensures a consistent style is used when matching `nil`.
       #
-      # RSpec has a built-in `be_nil` matcher specifically for expecting `nil`.
-      # For consistent specs, we recommend using that instead of `be(nil)`.
+      # You can either use the more specific `be_nil` matcher, or the more
+      # generic `be` matcher with a `nil` argument.
       #
-      # @example
+      # This cop can be configured using the `EnforcedStyle` option
       #
+      # @example `EnforcedStyle: be_nil` (default)
       #   # bad
       #   expect(foo).to be(nil)
       #
       #   # good
       #   expect(foo).to be_nil
       #
+      # @example `EnforcedStyle: be`
+      #   # bad
+      #   expect(foo).to be_nil
+      #
+      #   # good
+      #   expect(foo).to be(nil)
+      #
       class BeNil < Base
         extend AutoCorrector
+        include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `be_nil` over `be(nil)`.'
-        RESTRICT_ON_SEND = %i[be].freeze
+        BE_MSG = 'Prefer `be(nil)` over `be_nil`.'
+        BE_NIL_MSG = 'Prefer `be_nil` over `be(nil)`.'
+        RESTRICT_ON_SEND = %i[be be_nil].freeze
+
+        # @!method be_nil_matcher?(node)
+        def_node_matcher :be_nil_matcher?, <<-PATTERN
+          (send nil? :be_nil)
+        PATTERN
 
         # @!method nil_value_expectation?(node)
         def_node_matcher :nil_value_expectation?, <<-PATTERN
@@ -28,9 +43,28 @@ module RuboCop
         PATTERN
 
         def on_send(node)
+          case style
+          when :be
+            check_be_style(node)
+          when :be_nil
+            check_be_nil_style(node)
+          end
+        end
+
+        private
+
+        def check_be_style(node)
+          return unless be_nil_matcher?(node)
+
+          add_offense(node, message: BE_MSG) do |corrector|
+            corrector.replace(node.loc.expression, 'be(nil)')
+          end
+        end
+
+        def check_be_nil_style(node)
           return unless nil_value_expectation?(node)
 
-          add_offense(node) do |corrector|
+          add_offense(node, message: BE_NIL_MSG) do |corrector|
             corrector.replace(node.loc.expression, 'be_nil')
           end
         end

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -52,6 +52,10 @@ module RuboCop
               $(send nil? :match (str $_)))
           PATTERN
 
+          def self.autocorrect_incompatible_with
+            [Style::TrailingCommaInArguments]
+          end
+
           def on_send(node)
             expectation_set_on_current_path(node) do
               add_offense(node.loc.selector) do |corrector|

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

@@ -145,7 +145,7 @@ module RuboCop
           return true unless body
           return false if conditionals_with_examples?(body)
 
-          if body.if_type?
+          if body.if_type? || body.case_type?
             !examples_in_branches?(body)
           else
             !examples?(body)
@@ -153,15 +153,15 @@ module RuboCop
         end
 
         def conditionals_with_examples?(body)
-          return unless body.begin_type?
+          return unless body.begin_type? || body.case_type?
 
-          body.each_descendant(:if).any? do |if_node|
-            examples_in_branches?(if_node)
+          body.each_descendant(:if, :case).any? do |condition_node|
+            examples_in_branches?(condition_node)
           end
         end
 
-        def examples_in_branches?(if_node)
-          if_node.branches.any? { |branch| examples?(branch) }
+        def examples_in_branches?(condition_node)
+          condition_node.branches.any? { |branch| examples?(branch) }
         end
       end
     end

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for consistent verified double reference style.
+      #
+      # Only investigates references that are one of the supported styles.
+      #
+      # @see https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
+      #
+      # This cop can be configured in your configuration using the
+      # `EnforcedStyle` option and supports `--auto-gen-config`.
+      #
+      # @example `EnforcedStyle: constant` (default)
+      #   # 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 `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
+      #
+      #   # good
+      #   let(:foo) do
+      #     instance_double(@klass, method_name: 'returned_value')
+      #   end
+      class VerifiedDoubleReference < Base
+        extend AutoCorrector
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Use a %<style>s class reference for verified doubles.'
+
+        RESTRICT_ON_SEND = Set[
+          :class_double,
+          :class_spy,
+          :instance_double,
+          :instance_spy,
+          :mock_model,
+          :object_double,
+          :object_spy,
+          :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
+            ...)
+        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.loc.expression
+
+            add_offense(expression, message: message) do |corrector|
+              violation = class_reference.children.last.to_s
+              corrector.replace(expression, correct_style(violation))
+
+              opposite_style_detected
+            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(violation)
+          if style == :string
+            "'#{violation}'"
+          else
+            violation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -97,6 +97,7 @@ require_relative 'rspec/subject_stub'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/variable_definition'
 require_relative 'rspec/variable_name'
+require_relative 'rspec/verified_double_reference'
 require_relative 'rspec/verified_doubles'
 require_relative 'rspec/void_expect'
 require_relative 'rspec/yield'

data/lib/rubocop/rspec/version.rb

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

data/lib/rubocop-rspec.rb

@@ -37,16 +37,21 @@ require_relative 'rubocop/cop/rspec_cops'
 # We have to register our autocorrect incompatibilities in RuboCop's cops
 # as well so we do not hit infinite loops
 
-module RuboCop
-  module Cop
-    module Layout
-      class ExtraSpacing # rubocop:disable Style/Documentation
-        def self.autocorrect_incompatible_with
-          [RSpec::AlignLeftLetBrace, RSpec::AlignRightLetBrace]
-        end
-      end
+RuboCop::Cop::Layout::ExtraSpacing.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::RSpec::AlignLeftLetBrace)
+      .push(RuboCop::Cop::RSpec::AlignRightLetBrace)
     end
   end
-end
+)
+
+RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::RSpec::Capybara::CurrentPathExpectation)
+    end
+  end
+)
 
 RuboCop::AST::Node.include(RuboCop::RSpec::Node)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -226,6 +226,7 @@ files:
 - lib/rubocop/cop/rspec/unspecified_exception.rb
 - lib/rubocop/cop/rspec/variable_definition.rb
 - lib/rubocop/cop/rspec/variable_name.rb
+- lib/rubocop/cop/rspec/verified_double_reference.rb
 - lib/rubocop/cop/rspec/verified_doubles.rb
 - lib/rubocop/cop/rspec/void_expect.rb
 - lib/rubocop/cop/rspec/yield.rb