rubocop-rspec 2.16.0 → 2.18.1

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

@@ -4,75 +4,31 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # Checks for there is a more specific matcher offered by Capybara.
-        #
-        # @example
-        #
-        #   # bad
-        #   expect(page).to have_selector('button')
-        #   expect(page).to have_no_selector('button.cls')
-        #   expect(page).to have_css('button')
-        #   expect(page).to have_no_css('a.cls', href: 'http://example.com')
-        #   expect(page).to have_css('table.cls')
-        #   expect(page).to have_css('select')
-        #   expect(page).to have_css('input', exact_text: 'foo')
-        #
-        #   # good
-        #   expect(page).to have_button
-        #   expect(page).to have_no_button(class: 'cls')
-        #   expect(page).to have_button
-        #   expect(page).to have_no_link('foo', class: 'cls', href: 'http://example.com')
-        #   expect(page).to have_table(class: 'cls')
-        #   expect(page).to have_select
-        #   expect(page).to have_field('foo')
-        #
-        class SpecificMatcher < ::RuboCop::Cop::Base
-          MSG = 'Prefer `%<good_matcher>s` over `%<bad_matcher>s`.'
-          RESTRICT_ON_SEND = %i[have_selector have_no_selector have_css
-                                have_no_css].freeze
-          SPECIFIC_MATCHER = {
-            'button' => 'button',
-            'a' => 'link',
-            'table' => 'table',
-            'select' => 'select',
-            'input' => 'field'
-          }.freeze
-
-          # @!method first_argument(node)
-          def_node_matcher :first_argument, <<-PATTERN
-            (send nil? _ (str $_) ... )
-          PATTERN
-
-          def on_send(node)
-            first_argument(node) do |arg|
-              next unless (matcher = specific_matcher(arg))
-              next if CssSelector.multiple_selectors?(arg)
-              next unless CapybaraHelp.specific_option?(node, arg, matcher)
-              next unless CapybaraHelp.specific_pseudo_classes?(arg)
-
-              add_offense(node, message: message(node, matcher))
-            end
-          end
-
-          private
-
-          def specific_matcher(arg)
-            splitted_arg = arg[/^\w+/, 0]
-            SPECIFIC_MATCHER[splitted_arg]
-          end
-
-          def message(node, matcher)
-            format(MSG,
-                   good_matcher: good_matcher(node, matcher),
-                   bad_matcher: node.method_name)
-          end
-
-          def good_matcher(node, matcher)
-            node.method_name
-              .to_s
-              .gsub(/selector|css/, matcher.to_s)
-          end
-        end
+        # @!parse
+        #   # Checks for there is a more specific matcher offered by Capybara.
+        #   #
+        #   # @example
+        #   #
+        #   #   # bad
+        #   #   expect(page).to have_selector('button')
+        #   #   expect(page).to have_no_selector('button.cls')
+        #   #   expect(page).to have_css('button')
+        #   #   expect(page).to have_no_css('a.cls', href: 'http://example.com')
+        #   #   expect(page).to have_css('table.cls')
+        #   #   expect(page).to have_css('select')
+        #   #   expect(page).to have_css('input', exact_text: 'foo')
+        #   #
+        #   #   # good
+        #   #   expect(page).to have_button
+        #   #   expect(page).to have_no_button(class: 'cls')
+        #   #   expect(page).to have_button
+        #   #   expect(page).to have_no_link('foo', class: 'cls', href: 'http://example.com')
+        #   #   expect(page).to have_table(class: 'cls')
+        #   #   expect(page).to have_select
+        #   #   expect(page).to have_field('foo')
+        #   #
+        #   class SpecificMatcher < ::RuboCop::Cop::Base; end
+        SpecificMatcher = ::RuboCop::Cop::Capybara::SpecificMatcher
       end
     end
   end

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/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

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

@@ -11,7 +11,7 @@ module RuboCop
         def_node_matcher :skipped_in_metadata?, <<-PATTERN
           {
             (send _ _ <#skip_or_pending? ...>)
-            (send _ _ ... (hash <(pair #skip_or_pending? { true str }) ...>))
+            (send _ _ ... (hash <(pair #skip_or_pending? { true str dstr }) ...>))
           }
         PATTERN
 

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

@@ -87,35 +87,33 @@ module RuboCop
           (send #rspec? {#ExampleGroups.all #Examples.all} ... {<(sym :skip) ...> (hash <(pair (sym :skip) true) ...>)})
         PATTERN
 
+        # @!method without_reason?(node)
+        def_node_matcher :without_reason?, <<~PATTERN
+          (send nil? ${:pending :skip})
+        PATTERN
+
         def on_send(node)
           if pending_without_reason?(node)
             add_offense(node, message: 'Give the reason for pending.')
           elsif skipped_without_reason?(node)
             add_offense(node, message: 'Give the reason for skip.')
+          elsif without_reason?(node) && example?(node.parent)
+            add_offense(node,
+                        message: "Give the reason for #{node.method_name}.")
           end
         end
 
         private
 
-        def pending_by_pending_step_without_reason?(node)
-          node.method?(:pending) && node.first_argument.nil?
-        end
-
         def pending_without_reason?(node)
           pending_by_example_method?(node.block_node) ||
-            pending_by_metadata_without_reason?(node) ||
-            pending_by_pending_step_without_reason?(node)
-        end
-
-        def skipped_by_skip_step_without_reason?(node)
-          node.method?(:skip) && node.first_argument.nil?
+            pending_by_metadata_without_reason?(node)
         end
 
         def skipped_without_reason?(node)
           skipped_by_example_group_method?(node.block_node) ||
             skipped_by_example_method?(node.block_node) ||
-            skipped_by_metadata_without_reason?(node) ||
-            skipped_by_skip_step_without_reason?(node)
+            skipped_by_metadata_without_reason?(node)
         end
       end
     end

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

@@ -118,7 +118,7 @@ module RuboCop
       end
 
       # A helper for `explicit` style
-      module ExplicitHelper
+      module ExplicitHelper # rubocop:disable Metrics/ModuleLength
         include RuboCop::RSpec::Language
         extend NodePattern::Macros
 
@@ -149,12 +149,35 @@ module RuboCop
           return if part_of_ignored_node?(node)
 
           predicate_matcher?(node) do |actual, matcher|
+            next unless replaceable_matcher?(matcher)
+
             add_offense(node, message: message_explicit(matcher)) do |corrector|
+              next if uncorrectable_matcher?(node, matcher)
+
               corrector_explicit(corrector, node, actual, matcher, matcher)
             end
           end
         end
 
+        def replaceable_matcher?(matcher)
+          case matcher.method_name.to_s
+          when 'include'
+            matcher.arguments.one?
+          else
+            true
+          end
+        end
+
+        def uncorrectable_matcher?(node, matcher)
+          heredoc_argument?(matcher) && !same_line?(node, matcher)
+        end
+
+        def heredoc_argument?(matcher)
+          matcher.arguments.select do |arg|
+            %i[str dstr xstr].include?(arg.type)
+          end.any?(&:heredoc?)
+        end
+
         # @!method predicate_matcher?(node)
         def_node_matcher :predicate_matcher?, <<-PATTERN
           (send
@@ -179,7 +202,8 @@ module RuboCop
 
           return false if allowed_explicit_matchers.include?(name)
 
-          name.start_with?('be_', 'have_') && !name.end_with?('?')
+          name.start_with?('be_', 'have_') && !name.end_with?('?') ||
+            %w[include respond_to].include?(name)
         end
 
         def message_explicit(matcher)
@@ -270,6 +294,17 @@ module RuboCop
       #   # good - the above code is rewritten to it by this cop
       #   expect(foo.something?).to be(true)
       #
+      #   # bad - no autocorrect
+      #   expect(foo)
+      #     .to be_something(<<~TEXT)
+      #       bar
+      #     TEXT
+      #
+      #   # good
+      #   expect(foo.something?(<<~TEXT)).to be(true)
+      #     bar
+      #   TEXT
+      #
       # @example Strict: false, EnforcedStyle: explicit
       #   # bad
       #   expect(foo).to be_something

data/lib/rubocop/cop/rspec/rails/minitest_assertions.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Rails
+        # Check if using Minitest matchers.
+        #
+        # @example
+        #   # bad
+        #   assert_equal(a, b)
+        #   assert_equal a, b, "must be equal"
+        #   refute_equal(a, b)
+        #
+        #   # good
+        #   expect(a).to eq(b)
+        #   expect(a).to(eq(b), "must be equal")
+        #   expect(a).not_to eq(b)
+        #
+        class MinitestAssertions < Base
+          extend AutoCorrector
+
+          MSG = 'Use `%<prefer>s`.'
+          RESTRICT_ON_SEND = %i[assert_equal refute_equal].freeze
+
+          # @!method minitest_assertion(node)
+          def_node_matcher :minitest_assertion, <<-PATTERN
+          (send nil? {:assert_equal :refute_equal} $_ $_ $_?)
+          PATTERN
+
+          def on_send(node)
+            minitest_assertion(node) do |expected, actual, failure_message|
+              prefer = replacement(node, expected, actual,
+                                   failure_message.first)
+              add_offense(node, message: message(prefer)) do |corrector|
+                corrector.replace(node, prefer)
+              end
+            end
+          end
+
+          private
+
+          def replacement(node, expected, actual, failure_message)
+            runner = node.method?(:assert_equal) ? 'to' : 'not_to'
+            if failure_message.nil?
+              "expect(#{expected.source}).#{runner} eq(#{actual.source})"
+            else
+              "expect(#{expected.source}).#{runner}(eq(#{actual.source}), " \
+                "#{failure_message.source})"
+            end
+          end
+
+          def message(prefer)
+            format(MSG, prefer: prefer)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -91,7 +91,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @yield [RuboCop::AST::Node] matcher
         def_node_matcher :matcher_with_return_block, <<~PATTERN
-          (block #message_expectation? args _)  # receive(:foo) { 'bar' }
+          (block #message_expectation? (args) _)  # receive(:foo) { 'bar' }
         PATTERN
 
         # @!method matcher_with_hash(node)

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

@@ -12,7 +12,6 @@ module RuboCop
       #
       # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
       # @see https://penelope.zone/2015/12/27/introducing-rspec-smells-and-where-to-find-them.html#smell-1-stubjec
-      # @see https://github.com/rubocop-hq/rspec-style-guide#dont-stub-subject
       #
       # @example
       #   # bad

data/lib/rubocop/cop/rspec_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
+require_relative 'rspec/capybara/match_style'
 require_relative 'rspec/capybara/negation_matcher'
 require_relative 'rspec/capybara/specific_actions'
 require_relative 'rspec/capybara/specific_finders'
@@ -23,6 +24,7 @@ rescue LoadError
   # Rails/HttpStatus cannot be loaded if rack/utils is unavailable.
 end
 require_relative 'rspec/rails/inferred_spec_type'
+require_relative 'rspec/rails/minitest_assertions'
 
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'

data/lib/rubocop/rspec/config_formatter.rb

@@ -8,6 +8,15 @@ module RuboCop
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
+      EXTRACTED_COPS = %(
+        RSpec/Capybara/CurrentPathExpectation
+        RSpec/Capybara/MatchStyle
+        RSpec/Capybara/NegationMatcher
+        RSpec/Capybara/SpecificActions
+        RSpec/Capybara/SpecificFinders
+        RSpec/Capybara/SpecificMatcher
+        RSpec/Capybara/VisibilityMatcher
+      )
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
@@ -29,6 +38,7 @@ module RuboCop
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
           next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
+          next if EXTRACTED_COPS.include?(cop)
 
           replace_nil(unified[cop])
           unified[cop].merge!(descriptions.fetch(cop))

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.16.0'
+      STRING = '2.18.1'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -4,6 +4,7 @@ require 'pathname'
 require 'yaml'
 
 require 'rubocop'
+require 'rubocop-capybara'
 
 require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/inject'
@@ -17,8 +18,6 @@ require_relative 'rubocop/rspec/language'
 
 require_relative 'rubocop/rspec/factory_bot/language'
 
-require_relative 'rubocop/cop/rspec/mixin/capybara_help'
-require_relative 'rubocop/cop/rspec/mixin/css_selector'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
 require_relative 'rubocop/cop/rspec/mixin/metadata'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.18.1
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.33'
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
 description: |2
       Code style checking for RSpec files.
       A plugin for the RuboCop code style enforcing & linting tool.
@@ -58,6 +72,7 @@ files:
 - 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
+- lib/rubocop/cop/rspec/capybara/match_style.rb
 - lib/rubocop/cop/rspec/capybara/negation_matcher.rb
 - lib/rubocop/cop/rspec/capybara/specific_actions.rb
 - lib/rubocop/cop/rspec/capybara/specific_finders.rb
@@ -115,9 +130,7 @@ files:
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
 - lib/rubocop/cop/rspec/missing_example_group_argument.rb
-- lib/rubocop/cop/rspec/mixin/capybara_help.rb
 - lib/rubocop/cop/rspec/mixin/comments_help.rb
-- lib/rubocop/cop/rspec/mixin/css_selector.rb
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
 - lib/rubocop/cop/rspec/mixin/inside_example_group.rb
@@ -142,6 +155,7 @@ files:
 - lib/rubocop/cop/rspec/rails/have_http_status.rb
 - lib/rubocop/cop/rspec/rails/http_status.rb
 - lib/rubocop/cop/rspec/rails/inferred_spec_type.rb
+- lib/rubocop/cop/rspec/rails/minitest_assertions.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
@@ -207,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files

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

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      # Help methods for capybara.
-      module CapybaraHelp
-        module_function
-
-        # @param node [RuboCop::AST::SendNode]
-        # @param locator [String]
-        # @param element [String]
-        # @return [Boolean]
-        def specific_option?(node, locator, element)
-          attrs = CssSelector.attributes(locator).keys
-          return false unless replaceable_element?(node, element, attrs)
-
-          attrs.all? do |attr|
-            CssSelector.specific_options?(element, attr)
-          end
-        end
-
-        # @param locator [String]
-        # @return [Boolean]
-        def specific_pseudo_classes?(locator)
-          CssSelector.pseudo_classes(locator).all? do |pseudo_class|
-            replaceable_pseudo_class?(pseudo_class, locator)
-          end
-        end
-
-        # @param pseudo_class [String]
-        # @param locator [String]
-        # @return [Boolean]
-        def replaceable_pseudo_class?(pseudo_class, locator)
-          return false unless CssSelector.specific_pesudo_classes?(pseudo_class)
-
-          case pseudo_class
-          when 'not()' then replaceable_pseudo_class_not?(locator)
-          else true
-          end
-        end
-
-        # @param locator [String]
-        # @return [Boolean]
-        def replaceable_pseudo_class_not?(locator)
-          locator.scan(/not\(.*?\)/).all? do |negation|
-            CssSelector.attributes(negation).values.all? do |v|
-              v.is_a?(TrueClass) || v.is_a?(FalseClass)
-            end
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @param element [String]
-        # @param attrs [Array<String>]
-        # @return [Boolean]
-        def replaceable_element?(node, element, attrs)
-          case element
-          when 'link' then replaceable_to_link?(node, attrs)
-          else true
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @param attrs [Array<String>]
-        # @return [Boolean]
-        def replaceable_to_link?(node, attrs)
-          include_option?(node, :href) || attrs.include?('href')
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @param option [Symbol]
-        # @return [Boolean]
-        def include_option?(node, option)
-          node.each_descendant(:sym).find { |opt| opt.value == option }
-        end
-      end
-    end
-  end
-end