rubocop-rspec 2.16.0 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c31ad963289938a78bf4a8439ad44c6f1a2eaf852a25d715be483ebe71e622fc
-  data.tar.gz: 70b4e942004dd6654fa12c3ecaf7367c1f6bcf4bcd122573129984f5f0a66ff5
+  metadata.gz: 5b2ef643f2d262910bba4db8e0e6a722b96d0cb6424d04d4261326155176f321
+  data.tar.gz: 29ae9b634075bd3dc11d44969fb00a7542aad3302f3a1aa360a2637e3875a3bc
 SHA512:
-  metadata.gz: 250a68082a8e6406df3934035e5ccba4e1a7f9a13e021e196911c15981a2f4557e7b7a98efa93f995ad164d2a52e41bf948f4c1fa7c9637829c3c219c8116f74
-  data.tar.gz: 7ce965fc56bf214eb65b63d2138cc710766ac16b476a63399271cc5562fb259cefc81cddcf3878f6324faf104d6552e48efcba2eff1fa0865bf463963e5a1a8e
+  metadata.gz: b14f91843dcbc6cd8abfca82a8f21244991aacb79d09a92e975c1eb6d36e554adc44bd1d8b14d2d014fed60b6383f1e102f5142c4a771532be1b60db47c01df1
+  data.tar.gz: 0626b43df05da5b5f386d18be195d2aaa14347a7f70cd99d2d1731e9f9107536c8a0076897b78d9f2f4e69cdeb2a79bc0caaab488a6bee822ea08add9b083fe9

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## Master (Unreleased)
 
+## 2.18.1 (2023-01-19)
+
+- Add `rubocop-capybara` version constraint to prevent sudden cop enabling when it hits 3.0. ([@pirj])
+
+## 2.18.0 (2023-01-16)
+
+- Extract Capybara cops to a separate repository, [`rubocop-capybara`](https://github.com/rubocop/rubocop-capybara). The `rubocop-capybara` repository is a dependency of `rubocop-rspec` and the Capybara cops are aliased (`RSpec/Capybara/Foo` == `Capybara/Foo`) until v3.0 is released, so the change will be invisible to users until then. ([@pirj])
+
+## 2.17.1 (2023-01-16)
+
+- Fix a false negative for `RSpec/Pending` when using skipped in metadata is multiline string. ([@ydah])
+- Fix a false positive for `RSpec/NoExpectationExample` when using skipped in metadata is multiline string. ([@ydah])
+- Fix a false positive for `RSpec/ContextMethod` when multi-line context with `#` at the beginning. ([@ydah])
+- Fix an incorrect autocorrect for `RSpec/PredicateMatcher` when multiline expect and predicate method with heredoc. ([@ydah])
+- Fix a false positive for `RSpec/PredicateMatcher` when `include` with multiple argument. ([@ydah])
+
+## 2.17.0 (2023-01-13)
+
+- Fix a false positive for `RSpec/PendingWithoutReason` when pending/skip is argument of methods. ([@ydah])
+- Add new `RSpec/Capybara/MatchStyle` cop. ([@ydah])
+- Add new `RSpec/Rails/MinitestAssertions` cop. ([@ydah])
+- Fix a false positive for `RSpec/PendingWithoutReason` when not inside example. ([@ydah])
+- Fix a false negative for `RSpec/PredicateMatcher` when using `include` and `respond_to`. ([@ydah])
+- Fix a false positive for `RSpec/StubbedMock` when stubbed message expectation with a block and block parameter. ([@ydah])
+
 ## 2.16.0 (2022-12-13)
 
 - Add new `RSpec/FactoryBot/FactoryNameStyle` cop. ([@ydah])

data/README.md

@@ -2,7 +2,7 @@
 
 [![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
 [![Gem Version](https://badge.fury.io/rb/rubocop-rspec.svg)](https://rubygems.org/gems/rubocop-rspec)
-![CI](https://github.com/rubocop-hq/rubocop-rspec/workflows/CI/badge.svg)
+![CI](https://github.com/rubocop/rubocop-rspec/workflows/CI/badge.svg)
 
 RSpec-specific analysis for your projects, as an extension to
 [RuboCop](https://github.com/rubocop/rubocop).

data/config/default.yml

@@ -887,6 +887,12 @@ RSpec/Capybara/FeatureMethods:
   VersionChanged: '2.0'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/FeatureMethods
 
+RSpec/Capybara/MatchStyle:
+  Description: Checks for usage of deprecated style methods.
+  Enabled: pending
+  VersionAdded: '2.17'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/MatchStyle
+
 RSpec/Capybara/NegationMatcher:
   Description: Enforces use of `have_no_*` or `not_to` for negated expectations.
   Enabled: pending
@@ -1044,3 +1050,9 @@ RSpec/Rails/InferredSpecType:
     routing: routing
     system: system
     views: view
+
+RSpec/Rails/MinitestAssertions:
+  Description: Check if using Minitest matchers.
+  Enabled: pending
+  VersionAdded: '2.17'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/MinitestAssertions

data/config/obsoletion.yml

@@ -12,3 +12,12 @@ changed_parameters:
     parameters: IgnoredPatterns
     alternative: AllowedPatterns
     severity: warning
+
+renamed:
+  RSpec/Capybara/CurrentPathExpectation: Capybara/CurrentPathExpectation
+  RSpec/Capybara/MatchStyle: Capybara/MatchStyle
+  RSpec/Capybara/NegationMatcher: Capybara/NegationMatcher
+  RSpec/Capybara/SpecificActions: Capybara/SpecificActions
+  RSpec/Capybara/SpecificFinders: Capybara/SpecificFinders
+  RSpec/Capybara/SpecificMatcher: Capybara/SpecificMatcher
+  RSpec/Capybara/VisibilityMatcher: Capybara/VisibilityMatcher

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

@@ -4,121 +4,35 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # Checks that no expectations are set on Capybara's `current_path`.
-        #
-        # 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.
-        #
-        # This cop does not support autocorrection in some cases.
-        #
-        # @example
-        #   # bad
-        #   expect(current_path).to eq('/callback')
-        #
-        #   # good
-        #   expect(page).to have_current_path('/callback')
-        #
-        #   # bad (does not support autocorrection)
-        #   expect(page.current_path).to match(variable)
-        #
-        #   # good
-        #   expect(page).to have_current_path('/callback')
-        #
-        class CurrentPathExpectation < ::RuboCop::Cop::Base
-          extend AutoCorrector
-
-          MSG = 'Do not set an RSpec expectation on `current_path` in ' \
-                'Capybara feature specs - instead, use the ' \
-                '`have_current_path` matcher on `page`'
-
-          RESTRICT_ON_SEND = %i[expect].freeze
-
-          # @!method expectation_set_on_current_path(node)
-          def_node_matcher :expectation_set_on_current_path, <<-PATTERN
-            (send nil? :expect (send {(send nil? :page) nil?} :current_path))
-          PATTERN
-
-          # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
-          # @!method as_is_matcher(node)
-          def_node_matcher :as_is_matcher, <<-PATTERN
-            (send
-              #expectation_set_on_current_path ${:to :to_not :not_to}
-              ${(send nil? :eq ...) (send nil? :match (regexp ...))})
-          PATTERN
-
-          # @!method regexp_str_matcher(node)
-          def_node_matcher :regexp_str_matcher, <<-PATTERN
-            (send
-              #expectation_set_on_current_path ${:to :to_not :not_to}
-              $(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|
-                next unless node.chained?
-
-                autocorrect(corrector, node)
-              end
-            end
-          end
-
-          private
-
-          def autocorrect(corrector, node)
-            as_is_matcher(node.parent) do |to_sym, matcher_node|
-              rewrite_expectation(corrector, node, to_sym, matcher_node)
-            end
-
-            regexp_str_matcher(node.parent) do |to_sym, matcher_node, regexp|
-              rewrite_expectation(corrector, node, to_sym, matcher_node)
-              convert_regexp_str_to_literal(corrector, matcher_node, regexp)
-            end
-          end
-
-          def rewrite_expectation(corrector, node, to_symbol, matcher_node)
-            current_path_node = node.first_argument
-            corrector.replace(current_path_node, 'page')
-            corrector.replace(node.parent.loc.selector, 'to')
-            matcher_method = if to_symbol == :to
-                               'have_current_path'
-                             else
-                               'have_no_current_path'
-                             end
-            corrector.replace(matcher_node.loc.selector, matcher_method)
-            add_ignore_query_options(corrector, node)
-          end
-
-          def convert_regexp_str_to_literal(corrector, matcher_node, regexp_str)
-            str_node = matcher_node.first_argument
-            regexp_expr = Regexp.new(regexp_str).inspect
-            corrector.replace(str_node, regexp_expr)
-          end
-
-          # `have_current_path` with no options will include the querystring
-          # while `page.current_path` does not.
-          # This ensures the option `ignore_query: true` is added
-          # except when the expectation is a regexp or string
-          def add_ignore_query_options(corrector, node)
-            expectation_node = node.parent.last_argument
-            expectation_last_child = expectation_node.children.last
-            return if %i[regexp str].include?(expectation_last_child.type)
-
-            corrector.insert_after(
-              expectation_last_child,
-              ', ignore_query: true'
-            )
-          end
-        end
+        # @!parse
+        #   # Checks that no expectations are set on Capybara's `current_path`.
+        #   #
+        #   # 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.
+        #   #
+        #   # This cop does not support autocorrection in some cases.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   expect(current_path).to eq('/callback')
+        #   #
+        #   #   # good
+        #   #   expect(page).to have_current_path('/callback')
+        #   #
+        #   #   # bad (does not support autocorrection)
+        #   #   expect(page.current_path).to match(variable)
+        #   #
+        #   #   # good
+        #   #   expect(page).to have_current_path('/callback')
+        #   #
+        #   class CurrentPathExpectation < ::RuboCop::Cop::Base; end
+        CurrentPathExpectation =
+          ::RuboCop::Cop::Capybara::CurrentPathExpectation
       end
     end
   end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Capybara
+        # @!parse
+        #   # Checks for usage of deprecated style methods.
+        #   #
+        #   # @example when using `assert_style`
+        #   #   # bad
+        #   #   page.find(:css, '#first').assert_style(display: 'block')
+        #   #
+        #   #   # good
+        #   #   page.find(:css, '#first').assert_matches_style(display: 'block')
+        #   #
+        #   # @example when using `has_style?`
+        #   #   # bad
+        #   #   expect(page.find(:css, 'first')
+        #   #     .has_style?(display: 'block')).to be true
+        #   #
+        #   #   # good
+        #   #   expect(page.find(:css, 'first')
+        #   #     .matches_style?(display: 'block')).to be true
+        #   #
+        #   # @example when using `have_style`
+        #   #   # bad
+        #   #   expect(page).to have_style(display: 'block')
+        #   #
+        #   #   # good
+        #   #   expect(page).to match_style(display: 'block')
+        #   #
+        #   class MatchStyle < ::RuboCop::Cop::Base; end
+        MatchStyle = ::RuboCop::Cop::Capybara::MatchStyle
+      end
+    end
+  end
+end

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

@@ -4,102 +4,29 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # Enforces use of `have_no_*` or `not_to` for negated expectations.
-        #
-        # @example EnforcedStyle: not_to (default)
-        #   # bad
-        #   expect(page).to have_no_selector
-        #   expect(page).to have_no_css('a')
-        #
-        #   # good
-        #   expect(page).not_to have_selector
-        #   expect(page).not_to have_css('a')
-        #
-        # @example EnforcedStyle: have_no
-        #   # bad
-        #   expect(page).not_to have_selector
-        #   expect(page).not_to have_css('a')
-        #
-        #   # good
-        #   expect(page).to have_no_selector
-        #   expect(page).to have_no_css('a')
-        #
-        class NegationMatcher < ::RuboCop::Cop::Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-
-          MSG = 'Use `expect(...).%<runner>s %<matcher>s`.'
-          CAPYBARA_MATCHERS = %w[
-            selector css xpath text title current_path link button
-            field checked_field unchecked_field select table
-            sibling ancestor
-          ].freeze
-          POSITIVE_MATCHERS =
-            Set.new(CAPYBARA_MATCHERS) { |element| :"have_#{element}" }.freeze
-          NEGATIVE_MATCHERS =
-            Set.new(CAPYBARA_MATCHERS) { |element| :"have_no_#{element}" }
-              .freeze
-          RESTRICT_ON_SEND = (POSITIVE_MATCHERS + NEGATIVE_MATCHERS).freeze
-
-          # @!method not_to?(node)
-          def_node_matcher :not_to?, <<~PATTERN
-            (send ... :not_to
-              (send nil? %POSITIVE_MATCHERS ...))
-          PATTERN
-
-          # @!method have_no?(node)
-          def_node_matcher :have_no?, <<~PATTERN
-            (send ... :to
-              (send nil? %NEGATIVE_MATCHERS ...))
-          PATTERN
-
-          def on_send(node)
-            return unless offense?(node.parent)
-
-            matcher = node.method_name.to_s
-            add_offense(offense_range(node),
-                        message: message(matcher)) do |corrector|
-              corrector.replace(node.parent.loc.selector, replaced_runner)
-              corrector.replace(node.loc.selector,
-                                replaced_matcher(matcher))
-            end
-          end
-
-          private
-
-          def offense?(node)
-            (style == :have_no && not_to?(node)) ||
-              (style == :not_to && have_no?(node))
-          end
-
-          def offense_range(node)
-            node.parent.loc.selector.with(end_pos: node.loc.selector.end_pos)
-          end
-
-          def message(matcher)
-            format(MSG,
-                   runner: replaced_runner,
-                   matcher: replaced_matcher(matcher))
-          end
-
-          def replaced_runner
-            case style
-            when :have_no
-              'to'
-            when :not_to
-              'not_to'
-            end
-          end
-
-          def replaced_matcher(matcher)
-            case style
-            when :have_no
-              matcher.sub('have_', 'have_no_')
-            when :not_to
-              matcher.sub('have_no_', 'have_')
-            end
-          end
-        end
+        # @!parse
+        #   # Enforces use of `have_no_*` or `not_to` for negated expectations.
+        #   #
+        #   # @example EnforcedStyle: not_to (default)
+        #   #   # bad
+        #   #   expect(page).to have_no_selector
+        #   #   expect(page).to have_no_css('a')
+        #   #
+        #   #   # good
+        #   #   expect(page).not_to have_selector
+        #   #   expect(page).not_to have_css('a')
+        #   #
+        #   # @example EnforcedStyle: have_no
+        #   #   # bad
+        #   #   expect(page).not_to have_selector
+        #   #   expect(page).not_to have_css('a')
+        #   #
+        #   #   # good
+        #   #   expect(page).to have_no_selector
+        #   #   expect(page).to have_no_css('a')
+        #   #
+        #   class NegationMatcher < ::RuboCop::Cop::Base; end
+        NegationMatcher = ::RuboCop::Cop::Capybara::NegationMatcher
       end
     end
   end

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

@@ -4,81 +4,25 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # Checks for there is a more specific actions offered by Capybara.
-        #
-        # @example
-        #
-        #   # bad
-        #   find('a').click
-        #   find('button.cls').click
-        #   find('a', exact_text: 'foo').click
-        #   find('div button').click
-        #
-        #   # good
-        #   click_link
-        #   click_button(class: 'cls')
-        #   click_link(exact_text: 'foo')
-        #   find('div').click_button
-        #
-        class SpecificActions < ::RuboCop::Cop::Base
-          MSG = "Prefer `%<good_action>s` over `find('%<selector>s').click`."
-          RESTRICT_ON_SEND = %i[click].freeze
-          SPECIFIC_ACTION = {
-            'button' => 'button',
-            'a' => 'link'
-          }.freeze
-
-          # @!method click_on_selector(node)
-          def_node_matcher :click_on_selector, <<-PATTERN
-            (send _ :find (str $_) ...)
-          PATTERN
-
-          def on_send(node)
-            click_on_selector(node.receiver) do |arg|
-              next unless supported_selector?(arg)
-              # Always check the last selector in the case of multiple selectors
-              # separated by whitespace.
-              # because the `.click` is executed on the element to
-              # which the last selector points.
-              next unless (selector = last_selector(arg))
-              next unless (action = specific_action(selector))
-              next unless CapybaraHelp.specific_option?(node.receiver, arg,
-                                                        action)
-              next unless CapybaraHelp.specific_pseudo_classes?(arg)
-
-              range = offense_range(node, node.receiver)
-              add_offense(range, message: message(action, selector))
-            end
-          end
-
-          private
-
-          def specific_action(selector)
-            SPECIFIC_ACTION[last_selector(selector)]
-          end
-
-          def supported_selector?(selector)
-            !selector.match?(/[>,+~]/)
-          end
-
-          def last_selector(arg)
-            arg.split.last[/^\w+/, 0]
-          end
-
-          def offense_range(node, receiver)
-            receiver.loc.selector.with(end_pos: node.loc.expression.end_pos)
-          end
-
-          def message(action, selector)
-            format(MSG,
-                   good_action: good_action(action),
-                   selector: selector)
-          end
-
-          def good_action(action)
-            "click_#{action}"
-          end
-        end
+        # @!parse
+        #   # Checks for there is a more specific actions offered by Capybara.
+        #   #
+        #   # @example
+        #   #
+        #   #   # bad
+        #   #   find('a').click
+        #   #   find('button.cls').click
+        #   #   find('a', exact_text: 'foo').click
+        #   #   find('div button').click
+        #   #
+        #   #   # good
+        #   #   click_link
+        #   #   click_button(class: 'cls')
+        #   #   click_link(exact_text: 'foo')
+        #   #   find('div').click_button
+        #   #
+        #   class SpecificActions < ::RuboCop::Cop::Base; end
+        SpecificActions = ::RuboCop::Cop::Capybara::SpecificActions
       end
     end
   end

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

@@ -4,89 +4,20 @@ module RuboCop
   module Cop
     module RSpec
       module Capybara
-        # Checks if there is a more specific finder offered by Capybara.
-        #
-        # @example
-        #   # bad
-        #   find('#some-id')
-        #   find('[visible][id=some-id]')
-        #
-        #   # good
-        #   find_by_id('some-id')
-        #   find_by_id('some-id', visible: true)
-        #
-        class SpecificFinders < ::RuboCop::Cop::Base
-          extend AutoCorrector
-
-          include RangeHelp
-
-          MSG = 'Prefer `find_by` over `find`.'
-          RESTRICT_ON_SEND = %i[find].freeze
-
-          # @!method find_argument(node)
-          def_node_matcher :find_argument, <<~PATTERN
-            (send _ :find (str $_) ...)
-          PATTERN
-
-          def on_send(node)
-            find_argument(node) do |arg|
-              next if CssSelector.multiple_selectors?(arg)
-
-              on_attr(node, arg) if attribute?(arg)
-              on_id(node, arg) if CssSelector.id?(arg)
-            end
-          end
-
-          private
-
-          def on_attr(node, arg)
-            return unless (id = CssSelector.attributes(arg)['id'])
-
-            register_offense(node, replaced_arguments(arg, id))
-          end
-
-          def on_id(node, arg)
-            register_offense(node, "'#{arg.to_s.delete('#')}'")
-          end
-
-          def attribute?(arg)
-            CssSelector.attribute?(arg) &&
-              CssSelector.common_attributes?(arg)
-          end
-
-          def register_offense(node, arg_replacement)
-            add_offense(offense_range(node)) do |corrector|
-              corrector.replace(node.loc.selector, 'find_by_id')
-              corrector.replace(node.first_argument.loc.expression,
-                                arg_replacement)
-            end
-          end
-
-          def replaced_arguments(arg, id)
-            options = to_options(CssSelector.attributes(arg))
-            options.empty? ? id : "#{id}, #{options}"
-          end
-
-          def to_options(attrs)
-            attrs.each.map do |key, value|
-              next if key == 'id'
-
-              "#{key}: #{value}"
-            end.compact.join(', ')
-          end
-
-          def offense_range(node)
-            range_between(node.loc.selector.begin_pos, end_pos(node))
-          end
-
-          def end_pos(node)
-            if node.loc.end
-              node.loc.end.end_pos
-            else
-              node.loc.expression.end_pos
-            end
-          end
-        end
+        # @!parse
+        #   # Checks if there is a more specific finder offered by Capybara.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   find('#some-id')
+        #   #   find('[visible][id=some-id]')
+        #   #
+        #   #   # good
+        #   #   find_by_id('some-id')
+        #   #   find_by_id('some-id', visible: true)
+        #   #
+        #   class SpecificFinders < ::RuboCop::Cop::Base; end
+        SpecificFinders = ::RuboCop::Cop::Capybara::SpecificFinders
       end
     end
   end