rubocop-rspec 2.7.0 → 2.10.0

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for expectations where `be(...)` can replace `eq(...)`.
+      #
+      # The `be` matcher compares by identity while the `eq` matcher compares
+      # using `==`. Booleans and nil can be compared by identity and therefore
+      # the `be` matcher is preferable as it is a more strict test.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo).to eq(true)
+      #   expect(foo).to eq(false)
+      #   expect(foo).to eq(nil)
+      #
+      #   # good
+      #   expect(foo).to be(true)
+      #   expect(foo).to be(false)
+      #   expect(foo).to be(nil)
+      #
+      class BeEq < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `be` over `eq`.'
+        RESTRICT_ON_SEND = %i[eq].freeze
+
+        # @!method eq_type_with_identity?(node)
+        def_node_matcher :eq_type_with_identity?, <<-PATTERN
+          (send nil? :eq {true false nil})
+        PATTERN
+
+        def on_send(node)
+          return unless eq_type_with_identity?(node)
+
+          add_offense(node.loc.selector) do |corrector|
+            corrector.replace(node.loc.selector, 'be')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -43,7 +43,7 @@ module RuboCop
 
         # @!method eql_type_with_identity(node)
         def_node_matcher :eql_type_with_identity, <<-PATTERN
-          (send _ :to $(send nil? :eql {true false int float sym nil_type?}))
+          (send _ :to $(send nil? :eql {true false int float sym nil}))
         PATTERN
 
         def on_send(node)

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Ensures a consistent style is used when matching `nil`.
+      #
+      # You can either use the more specific `be_nil` matcher, or the more
+      # generic `be` matcher with a `nil` argument.
+      #
+      # 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
+
+        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
+          (send nil? :be nil)
+        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, message: BE_NIL_MSG) do |corrector|
+            corrector.replace(node.loc.expression, 'be_nil')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,13 +6,13 @@ module RuboCop
       module Capybara
         # Checks that no expectations are set on Capybara's `current_path`.
         #
-        # The `have_current_path` matcher (https://www.rubydoc.info/github/
-        # teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path-
-        # instance_method) should be used on `page` to set expectations on
-        # Capybara's current path, since it uses Capybara's waiting
-        # functionality (https://github.com/teamcapybara/capybara/blob/master/
-        # README.md#asynchronous-javascript-ajax-and-friends) which ensures that
-        # preceding actions (like `click_link`) have completed.
+        # The
+        # https://www.rubydoc.info/github/teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path-instance_method[`have_current_path` matcher]
+        # should be used on `page` to set expectations on Capybara's
+        # current path, since it uses
+        # https://github.com/teamcapybara/capybara/blob/master/README.md#asynchronous-javascript-ajax-and-friends[Capybara's waiting functionality]
+        # which ensures that preceding actions (like `click_link`) have
+        # completed.
         #
         # @example
         #   # bad
@@ -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/capybara/visibility_matcher.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # Checks for boolean visibility in capybara finders.
+        # Checks for boolean visibility in Capybara finders.
         #
         # Capybara lets you find elements that match a certain visibility using
         # the `:visible` option. `:visible` accepts both boolean and symbols as
@@ -12,7 +12,8 @@ module RuboCop
         # false` does not find just invisible elements, but both visible and
         # invisible elements. For expressiveness and clarity, use one of the
         # symbol values, `:all`, `:hidden` or `:visible`.
-        # (https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all)
+        # Read more in
+        # https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all[the documentation].
         #
         # @example
         #

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/empty_line_after_subject.rb

@@ -17,24 +17,18 @@ module RuboCop
       class EmptyLineAfterSubject < Base
         extend AutoCorrector
         include EmptyLineSeparation
+        include InsideExampleGroup
 
         MSG = 'Add an empty line after `%<subject>s`.'
 
         def on_block(node)
-          return unless subject?(node) && !in_spec_block?(node)
+          return unless subject?(node)
+          return unless inside_example_group?(node)
 
           missing_separating_line_offense(node) do |method|
             format(MSG, subject: method)
           end
         end
-
-        private
-
-        def in_spec_block?(node)
-          node.each_ancestor(:block).any? do |ancestor|
-            Examples.all(ancestor.method_name)
-          end
-        end
       end
     end
   end

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

@@ -33,11 +33,13 @@ module RuboCop
       #
       class LeadingSubject < Base
         extend AutoCorrector
+        include InsideExampleGroup
 
         MSG = 'Declare `subject` above any other `%<offending>s` declarations.'
 
         def on_block(node)
-          return unless subject?(node) && !in_spec_block?(node)
+          return unless subject?(node)
+          return unless inside_example_group?(node)
 
           check_previous_nodes(node)
         end
@@ -78,12 +80,6 @@ module RuboCop
             spec_group?(node) ||
             include?(node)
         end
-
-        def in_spec_block?(node)
-          node.each_ancestor(:block).any? do |ancestor|
-            example?(ancestor)
-          end
-        end
       end
     end
   end

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

@@ -9,11 +9,11 @@ module RuboCop
         private
 
         def inside_example_group?(node)
-          return example_group?(node) if example_group_root?(node)
+          return spec_group?(node) if example_group_root?(node)
 
           root = node.ancestors.find { |parent| example_group_root?(parent) }
 
-          example_group?(root)
+          spec_group?(root)
         end
 
         def example_group_root?(node)

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

@@ -7,6 +7,9 @@ module RuboCop
     module RSpec
       # Checks for stubbed test subjects.
       #
+      # Checks nested subject stubs for innermost subject definition
+      # when subject is also defined in parent example groups.
+      #
       # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
       # @see https://samphippen.com/introducing-rspec-smells-and-where-to-find-them#smell-1-stubject
       # @see https://github.com/rubocop-hq/rspec-style-guide#dont-stub-subject
@@ -22,6 +25,20 @@ module RuboCop
       #     end
       #   end
       #
+      #   # bad
+      #   describe Article do
+      #     subject(:foo) { Article.new }
+      #
+      #     context 'nested subject' do
+      #       subject(:article) { Article.new }
+      #
+      #       it 'indicates that the author is unknown' do
+      #         allow(article).to receive(:author).and_return(nil)
+      #         expect(article.description).to include('by an unknown author')
+      #       end
+      #     end
+      #   end
+      #
       #   # good
       #   describe Article do
       #     subject(:article) { Article.new(author: nil) }
@@ -36,27 +53,35 @@ module RuboCop
 
         MSG = 'Do not stub methods of the object under test.'
 
-        # @!method subject(node)
+        # @!method subject?(node)
         #   Find a named or unnamed subject definition
         #
         #   @example anonymous subject
-        #     subject(parse('subject { foo }').ast) do |name|
+        #     subject?(parse('subject { foo }').ast) do |name|
         #       name # => :subject
         #     end
         #
         #   @example named subject
-        #     subject(parse('subject(:thing) { foo }').ast) do |name|
+        #     subject?(parse('subject(:thing) { foo }').ast) do |name|
         #       name # => :thing
         #     end
         #
         #   @param node [RuboCop::AST::Node]
         #
         #   @yield [Symbol] subject name
-        def_node_matcher :subject, <<-PATTERN
-            (block
-              (send nil?
-                {:subject (sym $_) | $:subject}
-              ) args ...)
+        def_node_matcher :subject?, <<-PATTERN
+          (block
+            (send nil?
+              {:subject (sym $_) | $:subject}
+            ) args ...)
+        PATTERN
+
+        # @!method let?(node)
+        #   Find a memoized helper
+        def_node_matcher :let?, <<-PATTERN
+          (block
+            (send nil? :let (sym $_)
+            ) args ...)
         PATTERN
 
         # @!method message_expectation?(node, method_name)
@@ -73,7 +98,7 @@ module RuboCop
         def_node_matcher :message_expectation?, <<-PATTERN
           (send
             {
-              (send nil? { :expect :allow } (send nil? {% :subject}))
+              (send nil? { :expect :allow } (send nil? %))
               (send nil? :is_expected)
             }
             #Runners.all
@@ -89,7 +114,8 @@ module RuboCop
         PATTERN
 
         def on_top_level_group(node)
-          @explicit_subjects = find_all_explicit_subjects(node)
+          @explicit_subjects = find_all_explicit(node, &method(:subject?))
+          @subject_overrides = find_all_explicit(node, &method(:let?))
 
           find_subject_expectations(node) do |stub|
             add_offense(stub)
@@ -98,12 +124,12 @@ module RuboCop
 
         private
 
-        def find_all_explicit_subjects(node)
+        def find_all_explicit(node)
           node.each_descendant(:block).with_object({}) do |child, h|
-            name = subject(child)
+            name = yield(child)
             next unless name
 
-            outer_example_group = child.each_ancestor.find do |a|
+            outer_example_group = child.each_ancestor(:block).find do |a|
               example_group?(a)
             end
 
@@ -113,14 +139,14 @@ module RuboCop
         end
 
         def find_subject_expectations(node, subject_names = [], &block)
-          subject_names = @explicit_subjects[node] if @explicit_subjects[node]
+          subject_names = [*subject_names, *@explicit_subjects[node]]
+          subject_names -= @subject_overrides[node] if @subject_overrides[node]
 
-          expectation_detected = (subject_names + [:subject]).any? do |name|
-            message_expectation?(node, name)
-          end
+          names = Set[*subject_names, :subject]
+          expectation_detected = message_expectation?(node, names)
           return yield(node) if expectation_detected
 
-          node.each_child_node do |child|
+          node.each_child_node(:send, :def, :block, :begin) do |child|
             find_subject_expectations(child, subject_names, &block)
           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/yield.rb

@@ -10,7 +10,7 @@ module RuboCop
       #   allow(foo).to receive(:bar) { |&block| block.call(1) }
       #
       #   # good
-      #   expect(foo).to be(:bar).and_yield(1)
+      #   expect(foo).to receive(:bar).and_yield(1)
       class Yield < Base
         extend AutoCorrector
         include RangeHelp

data/lib/rubocop/cop/rspec_cops.rb

@@ -21,7 +21,9 @@ require_relative 'rspec/align_right_let_brace'
 require_relative 'rspec/any_instance'
 require_relative 'rspec/around_block'
 require_relative 'rspec/be'
+require_relative 'rspec/be_eq'
 require_relative 'rspec/be_eql'
+require_relative 'rspec/be_nil'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/context_method'
 require_relative 'rspec/context_wording'
@@ -95,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/config_formatter.rb

@@ -8,7 +8,7 @@ module RuboCop
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
-      STYLE_GUIDE_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
+      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
 
       def initialize(config, descriptions)
         @config       = config
@@ -27,9 +27,8 @@ module RuboCop
         cops.each_with_object(config.dup) do |cop, unified|
           next if SUBDEPARTMENTS.include?(cop)
 
-          unified[cop] = config.fetch(cop)
-            .merge(descriptions.fetch(cop))
-            .merge('StyleGuide' => STYLE_GUIDE_BASE_URL + cop.sub('RSpec/', ''))
+          unified[cop].merge!(descriptions.fetch(cop))
+          unified[cop]['Reference'] = COP_DOC_BASE_URL + cop.sub('RSpec/', '')
         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 = '2.7.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.7.0
+  version: 2.10.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -135,7 +135,9 @@ files:
 - lib/rubocop/cop/rspec/around_block.rb
 - lib/rubocop/cop/rspec/base.rb
 - lib/rubocop/cop/rspec/be.rb
+- lib/rubocop/cop/rspec/be_eq.rb
 - lib/rubocop/cop/rspec/be_eql.rb
+- lib/rubocop/cop/rspec/be_nil.rb
 - lib/rubocop/cop/rspec/before_after_all.rb
 - lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
 - lib/rubocop/cop/rspec/capybara/feature_methods.rb
@@ -224,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