rubocop-rspec 2.16.0 → 2.24.1

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

@@ -4,69 +4,32 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # 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
-        # values, however using booleans can have unwanted effects. `visible:
-        # 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`.
-        # Read more in
-        # https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all[the documentation].
-        #
-        # @example
-        #   # bad
-        #   expect(page).to have_selector('.foo', visible: false)
-        #   expect(page).to have_css('.foo', visible: true)
-        #   expect(page).to have_link('my link', visible: false)
-        #
-        #   # good
-        #   expect(page).to have_selector('.foo', visible: :visible)
-        #   expect(page).to have_css('.foo', visible: :all)
-        #   expect(page).to have_link('my link', visible: :hidden)
-        #
-        class VisibilityMatcher < ::RuboCop::Cop::Base
-          MSG_FALSE = 'Use `:all` or `:hidden` instead of `false`.'
-          MSG_TRUE = 'Use `:visible` instead of `true`.'
-          CAPYBARA_MATCHER_METHODS = %w[
-            button
-            checked_field
-            css
-            field
-            link
-            select
-            selector
-            table
-            unchecked_field
-            xpath
-          ].flat_map do |element|
-            ["have_#{element}".to_sym, "have_no_#{element}".to_sym]
-          end
-
-          RESTRICT_ON_SEND = CAPYBARA_MATCHER_METHODS
-
-          # @!method visible_true?(node)
-          def_node_matcher :visible_true?, <<~PATTERN
-            (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) true) ...>))
-          PATTERN
-
-          # @!method visible_false?(node)
-          def_node_matcher :visible_false?, <<~PATTERN
-            (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) false) ...>))
-          PATTERN
-
-          def on_send(node)
-            visible_false?(node) { |arg| add_offense(arg, message: MSG_FALSE) }
-            visible_true?(node) { |arg| add_offense(arg, message: MSG_TRUE) }
-          end
-
-          private
-
-          def capybara_matcher?(method_name)
-            CAPYBARA_MATCHER_METHODS.include? method_name
-          end
-        end
+        # @!parse
+        #   # 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 values, however using booleans can have unwanted
+        #   # effects. `visible: 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`.
+        #   # Read more in
+        #   # https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all[the documentation].
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   expect(page).to have_selector('.foo', visible: false)
+        #   #   expect(page).to have_css('.foo', visible: true)
+        #   #   expect(page).to have_link('my link', visible: false)
+        #   #
+        #   #   # good
+        #   #   expect(page).to have_selector('.foo', visible: :visible)
+        #   #   expect(page).to have_css('.foo', visible: :all)
+        #   #   expect(page).to have_link('my link', visible: :hidden)
+        #   #
+        #   class VisibilityMatcher < ::RuboCop::Cop::Base; end
+        VisibilityMatcher = ::RuboCop::Cop::Capybara::VisibilityMatcher
       end
     end
   end

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

@@ -59,15 +59,16 @@ module RuboCop
       #
       class ChangeByZero < Base
         extend AutoCorrector
-        MSG = 'Prefer `not_to change` over `to change.by(0)`.'
+        MSG = 'Prefer `not_to change` over `to %<method>s.by(0)`.'
         MSG_COMPOUND = 'Prefer %<preferred>s with compound expectations ' \
-                       'over `change.by(0)`.'
-        RESTRICT_ON_SEND = %i[change].freeze
+                       'over `%<method>s.by(0)`.'
+        CHANGE_METHODS = Set[:change, :a_block_changing, :changing].freeze
+        RESTRICT_ON_SEND = CHANGE_METHODS.freeze
 
         # @!method expect_change_with_arguments(node)
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
           (send
-            (send nil? :change ...) :by
+            $(send nil? CHANGE_METHODS ...) :by
             (int 0))
         PATTERN
 
@@ -75,49 +76,62 @@ module RuboCop
         def_node_matcher :expect_change_with_block, <<-PATTERN
           (send
             (block
-              (send nil? :change)
+              $(send nil? CHANGE_METHODS)
               (args)
-              (send (...) $_)) :by
+              (send (...) _)) :by
             (int 0))
         PATTERN
 
         # @!method change_nodes(node)
         def_node_search :change_nodes, <<-PATTERN
-          $(send nil? :change ...)
+          $(send nil? CHANGE_METHODS ...)
         PATTERN
 
         def on_send(node)
-          expect_change_with_arguments(node.parent) do
-            check_offense(node.parent)
+          expect_change_with_arguments(node.parent) do |change|
+            register_offense(node.parent, change)
           end
 
-          expect_change_with_block(node.parent.parent) do
-            check_offense(node.parent.parent)
+          expect_change_with_block(node.parent.parent) do |change|
+            register_offense(node.parent.parent, change)
           end
         end
 
         private
 
-        def check_offense(node)
-          expression = node.loc.expression
+        # rubocop:disable Metrics/MethodLength
+        def register_offense(node, change_node)
           if compound_expectations?(node)
-            add_offense(expression, message: message_compound) do |corrector|
+            add_offense(node.source_range,
+                        message: message_compound(change_node)) do |corrector|
               autocorrect_compound(corrector, node)
             end
           else
-            add_offense(expression) do |corrector|
-              autocorrect(corrector, node)
+            add_offense(node.source_range,
+                        message: message(change_node)) do |corrector|
+              autocorrect(corrector, node, change_node)
             end
           end
         end
+        # rubocop:enable Metrics/MethodLength
 
         def compound_expectations?(node)
           %i[and or & |].include?(node.parent.method_name)
         end
 
-        def autocorrect(corrector, node)
+        def message(change_node)
+          format(MSG, method: change_node.method_name)
+        end
+
+        def message_compound(change_node)
+          format(MSG_COMPOUND, preferred: preferred_method,
+                               method: change_node.method_name)
+        end
+
+        def autocorrect(corrector, node, change_node)
           corrector.replace(node.parent.loc.selector, 'not_to')
-          range = node.loc.dot.with(end_pos: node.loc.expression.end_pos)
+          corrector.replace(change_node.loc.selector, 'change')
+          range = node.loc.dot.with(end_pos: node.source_range.end_pos)
           corrector.remove(range)
         end
 
@@ -126,7 +140,7 @@ module RuboCop
 
           change_nodes(node) do |change_node|
             corrector.replace(change_node.loc.selector, negated_matcher)
-            range = node.loc.dot.with(end_pos: node.loc.expression.end_pos)
+            range = node.loc.dot.with(end_pos: node.source_range.end_pos)
             corrector.remove(range)
           end
         end
@@ -135,10 +149,6 @@ module RuboCop
           cop_config['NegatedMatcher']
         end
 
-        def message_compound
-          format(MSG_COMPOUND, preferred: preferred_method)
-        end
-
         def preferred_method
           negated_matcher ? "`#{negated_matcher}`" : 'negated matchers'
         end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # 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.
+      #
+      # @example
+      #   # bad
+      #   it { is_expected.to contain_exactly(*array1, *array2) }
+      #
+      #   # good
+      #   it { is_expected.to match_array(array1 + array2) }
+      #
+      #   # good
+      #   it { is_expected.to contain_exactly(content, *array) }
+      #
+      class ContainExactly < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `match_array` when matching array values.'
+        RESTRICT_ON_SEND = %i[contain_exactly].freeze
+
+        def on_send(node)
+          return if node.arguments.empty?
+
+          check_populated_collection(node)
+        end
+
+        private
+
+        def check_populated_collection(node)
+          return unless node.each_child_node.all?(&:splat_type?)
+
+          add_offense(node) do |corrector|
+            autocorrect_for_populated_array(node, corrector)
+          end
+        end
+
+        def autocorrect_for_populated_array(node, corrector)
+          arrays = node.arguments.map do |splat_node|
+            splat_node.children.first
+          end
+          corrector.replace(
+            node,
+            "match_array(#{arrays.map(&:source).join(' + ')})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -31,7 +31,11 @@ module RuboCop
 
         # @!method context_method(node)
         def_node_matcher :context_method, <<-PATTERN
-          (block (send #rspec? :context $(str #method_name?) ...) ...)
+          (block
+            (send #rspec? :context
+              ${(str #method_name?) (dstr (str #method_name?) ...)}
+            ...)
+          ...)
         PATTERN
 
         def on_block(node)  # rubocop:disable InternalAffairs/NumblockHandler

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

@@ -10,7 +10,6 @@ module RuboCop
       # include `if`, `unless`, `for`, `before`, `after`, or `during`.
       # They may consist of multiple words if desired.
       #
-      # @see https://rspec.rubystyle.guide/#context-descriptions
       # @see http://www.betterspecs.org/#contexts
       #
       # @example `Prefixes` configuration
@@ -63,12 +62,12 @@ module RuboCop
 
         # @!method context_wording(node)
         def_node_matcher :context_wording, <<-PATTERN
-          (block (send #rspec? { :context :shared_context } $(str $_) ...) ...)
+          (block (send #rspec? { :context :shared_context } $({str dstr xstr} ...) ...) ...)
         PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-          context_wording(node) do |context, description|
-            if bad_pattern?(description)
+          context_wording(node) do |context|
+            if bad_pattern?(context)
               message = format(MSG, patterns: expect_patterns)
               add_offense(context, message: message)
             end
@@ -85,10 +84,18 @@ module RuboCop
           @prefix_regexes ||= prefixes.map { |pre| /^#{Regexp.escape(pre)}\b/ }
         end
 
-        def bad_pattern?(description)
+        def bad_pattern?(node)
           return false if allowed_patterns.empty?
 
-          !matches_allowed_pattern?(description)
+          !matches_allowed_pattern?(description(node))
+        end
+
+        def description(context)
+          if context.xstr_type?
+            context.value.value
+          else
+            context.value
+          end
         end
 
         def expect_patterns

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

@@ -23,20 +23,28 @@ module RuboCop
         MSG = 'The second argument to describe should be the method ' \
               "being tested. '#instance' or '.class'."
 
-        # @!method second_argument(node)
-        def_node_matcher :second_argument, <<~PATTERN
+        # @!method second_string_literal_argument(node)
+        def_node_matcher :second_string_literal_argument, <<~PATTERN
           (block
-            (send #rspec? :describe _first_argument $(str _) ...) ...
-          )
+            (send #rspec? :describe _first_argument ${str dstr} ...)
+          ...)
+        PATTERN
+
+        # @!method method_name?(node)
+        def_node_matcher :method_name?, <<~PATTERN
+          {(str #method_name_prefix?) (dstr (str #method_name_prefix?) ...)}
         PATTERN
 
         def on_top_level_group(node)
-          second_argument = second_argument(node)
+          second_string_literal_argument(node) do |argument|
+            add_offense(argument) unless method_name?(argument)
+          end
+        end
 
-          return unless second_argument
-          return if second_argument.str_content.start_with?('#', '.')
+        private
 
-          add_offense(second_argument)
+        def method_name_prefix?(description)
+          description.start_with?('.', '#')
         end
       end
     end

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

@@ -68,7 +68,8 @@ module RuboCop
         PATTERN
 
         # @!method rspec_block?(node)
-        def_node_matcher :rspec_block?, block_pattern('#ALL.all')
+        def_node_matcher :rspec_block?,
+                         '({block numblock} (send #rspec? #ALL.all ...) ...)'
 
         # @!method scope_changing_syntax?(node)
         def_node_matcher :scope_changing_syntax?, '{def class module}'

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

@@ -22,13 +22,15 @@ module RuboCop
       class DescribedClassModuleWrapping < Base
         MSG = 'Avoid opening modules and defining specs within them.'
 
-        # @!method find_rspec_blocks(node)
-        def_node_search :find_rspec_blocks, block_pattern('#ExampleGroups.all')
+        # @!method include_rspec_blocks?(node)
+        def_node_search :include_rspec_blocks?, <<~PATTERN
+          ({block numblock} (send #explicit_rspec? #ExampleGroups.all ...) ...)
+        PATTERN
 
         def on_module(node)
-          find_rspec_blocks(node) do
-            add_offense(node)
-          end
+          return unless include_rspec_blocks?(node)
+
+          add_offense(node)
         end
       end
     end

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

@@ -49,7 +49,7 @@ module RuboCop
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
 
         # @!method rspec_method?(node)
-        def_node_matcher :rspec_method?, send_pattern('#ALL.all')
+        def_node_matcher :rspec_method?, '(send #rspec? #ALL.all ...)'
 
         def on_send(node)
           return unless rspec_method?(node)

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

@@ -19,7 +19,7 @@ module RuboCop
 
         MSG = 'Avoid duplicated metadata.'
 
-        def on_metadata(symbols, _pairs)
+        def on_metadata(symbols, _hash)
           symbols.each do |symbol|
             on_metadata_symbol(symbol)
           end
@@ -39,7 +39,7 @@ module RuboCop
           corrector.remove(
             range_with_surrounding_comma(
               range_with_surrounding_space(
-                node.location.expression,
+                node.source_range,
                 side: :left
               ),
               :left

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

@@ -53,7 +53,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @yield [RuboCop::AST::Node] example group body
         def_node_matcher :example_group_body, <<~PATTERN
-          (block #{send_pattern('#ExampleGroups.all')} args $_)
+          (block (send #rspec? #ExampleGroups.all ...) args $_)
         PATTERN
 
         # @!method example_or_group_or_include?(node)
@@ -72,10 +72,10 @@ module RuboCop
         #   @return [Array<RuboCop::AST::Node>] matching nodes
         def_node_matcher :example_or_group_or_include?, <<~PATTERN
           {
-            #{block_pattern(
-              '{#Examples.all #ExampleGroups.all #Includes.all}'
-            )}
-            #{send_pattern('{#Examples.all #Includes.all}')}
+            (block
+              (send #rspec? {#Examples.all #ExampleGroups.all #Includes.all} ...)
+            ...)
+            (send nil? {#Examples.all #Includes.all} ...)
           }
         PATTERN
 
@@ -95,7 +95,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @return [Array<RuboCop::AST::Node>] matching nodes
         def_node_matcher :examples_inside_block?, <<~PATTERN
-          (block !#{send_pattern('#Hooks.all')} _ #examples?)
+          (block !(send nil? #Hooks.all ...) _ #examples?)
         PATTERN
 
         # @!method examples_directly_or_in_block?(node)
@@ -131,6 +131,7 @@ module RuboCop
           {
             #examples_directly_or_in_block?
             (begin <#examples_directly_or_in_block? ...>)
+            (begin <#examples_in_branches? ...>)
           }
         PATTERN
 
@@ -169,12 +170,14 @@ module RuboCop
         end
 
         def examples_in_branches?(condition_node)
+          return if !condition_node.if_type? && !condition_node.case_type?
+
           condition_node.branches.any? { |branch| examples?(branch) }
         end
 
         def removed_range(node)
           range_by_whole_lines(
-            node.location.expression,
+            node.source_range,
             include_final_newline: true
           )
         end

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

@@ -31,14 +31,14 @@ module RuboCop
 
         # @!method empty_hook?(node)
         def_node_matcher :empty_hook?, <<~PATTERN
-          (block $#{send_pattern('#Hooks.all')} _ nil?)
+          (block $(send nil? #Hooks.all ...) _ nil?)
         PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           empty_hook?(node) do |hook|
             add_offense(hook) do |corrector|
               corrector.remove(
-                range_with_surrounding_space(node.loc.expression, side: :left)
+                range_with_surrounding_space(node.source_range, side: :left)
               )
             end
           end

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

@@ -30,7 +30,7 @@ module RuboCop
         MSG = 'Add an empty line after `%<example_group>s`.'
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-          return unless example_group?(node)
+          return unless spec_group?(node)
 
           missing_separating_line_offense(node) do |method|
             format(MSG, example_group: method)

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Avoid empty metadata hash.
+      #
+      # @example EnforcedStyle: symbol (default)
+      #   # bad
+      #   describe 'Something', {}
+      #
+      #   # good
+      #   describe 'Something'
+      class EmptyMetadata < Base
+        extend AutoCorrector
+
+        include Metadata
+        include RangeHelp
+
+        MSG = 'Avoid empty metadata hash.'
+
+        def on_metadata(_symbols, hash)
+          return unless hash&.pairs&.empty?
+
+          add_offense(hash) do |corrector|
+            remove_empty_metadata(corrector, hash)
+          end
+        end
+
+        private
+
+        def remove_empty_metadata(corrector, node)
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.source_range,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Use `eq` instead of `be ==` to compare objects.
+      #
+      # @example
+      #   # bad
+      #   expect(foo).to be == 42
+      #
+      #   # good
+      #   expect(foo).to eq 42
+      #
+      class Eq < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `eq` instead of `be ==` to compare objects.'
+        RESTRICT_ON_SEND = Runners.all
+
+        # @!method be_equals(node)
+        def_node_matcher :be_equals, <<~PATTERN
+          (send _ #Runners.all $(send (send nil? :be) :== _))
+        PATTERN
+
+        def on_send(node)
+          be_equals(node) do |matcher|
+            range = offense_range(matcher)
+            add_offense(range) do |corrector|
+              corrector.replace(range, 'eq')
+            end
+          end
+        end
+
+        private
+
+        def offense_range(matcher)
+          range_between(
+            matcher.source_range.begin_pos,
+            matcher.loc.selector.end_pos
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -88,7 +88,7 @@ module RuboCop
         end
 
         def docstring(node)
-          expr = node.loc.expression
+          expr = node.source_range
 
           Parser::Source::Range.new(
             expr.source_buffer,

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

@@ -52,14 +52,23 @@ module RuboCop
 
         # @param text [String]
         def excessive_whitespace?(text)
-          return true if text.start_with?(' ') || text.end_with?(' ')
-
-          text.match?(/[^\n ]  +[^ ]/)
+          text.match?(/
+            # Leading space
+            \A[[:blank:]]
+            |
+            # Trailing space
+            [[:blank:]]\z
+            |
+            # Two or more consecutive spaces, except if they are leading spaces
+            [^[[:space:]]][[:blank:]]{2,}[^[[:blank:]]]
+          /x)
         end
 
         # @param text [String]
         def strip_excessive_whitespace(text)
-          text.strip.gsub(/  +/, ' ')
+          text
+            .gsub(/[[:blank:]]{2,}/, ' ')
+            .gsub(/\A[[:blank:]]|[[:blank:]]\z/, '')
         end
 
         # @param node [RuboCop::AST::Node]
@@ -74,7 +83,7 @@ module RuboCop
         end
 
         def docstring(node)
-          expr = node.loc.expression
+          expr = node.source_range
 
           Parser::Source::Range.new(
             expr.source_buffer,