rubocop-rspec 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c31ad963289938a78bf4a8439ad44c6f1a2eaf852a25d715be483ebe71e622fc
-  data.tar.gz: 70b4e942004dd6654fa12c3ecaf7367c1f6bcf4bcd122573129984f5f0a66ff5
+  metadata.gz: 803b0cb494f6f1204fdb3ec31f7d4a4113b57fb2384066fb322e84107abbc65a
+  data.tar.gz: cb5a6a141c0af43cf179ac9d3e568e8bc3b5764abf4fda4e8a09340e7d311161
 SHA512:
-  metadata.gz: 250a68082a8e6406df3934035e5ccba4e1a7f9a13e021e196911c15981a2f4557e7b7a98efa93f995ad164d2a52e41bf948f4c1fa7c9637829c3c219c8116f74
-  data.tar.gz: 7ce965fc56bf214eb65b63d2138cc710766ac16b476a63399271cc5562fb259cefc81cddcf3878f6324faf104d6552e48efcba2eff1fa0865bf463963e5a1a8e
+  metadata.gz: 263c0f3e23a10ba54a9fc888646ab9f4e55ea4a08e0adb5b2b32db14c1fc773ed3fa956df3c7a12794c7c3ebea4415e68a42a5d7d109e2da6b88d623417e2102
+  data.tar.gz: d976c48d81cfd2d33b4857f08c9860d3857d5f8b51017f99c5ae650102184884dc76d95096d1efc2b70472a063a1887ef4d8e72dc7a6d003b131bf4ca67c4c5e

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 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/lib/rubocop/cop/rspec/capybara/match_style.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Capybara
+        # 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 < Base
+          extend AutoCorrector
+
+          MSG = 'Use `%<good>s` instead of `%<bad>s`.'
+          RESTRICT_ON_SEND = %i[assert_style has_style? have_style].freeze
+          PREFERRED_METHOD = {
+            'assert_style' => 'assert_matches_style',
+            'has_style?' => 'matches_style?',
+            'have_style' => 'match_style'
+          }.freeze
+
+          def on_send(node)
+            method_node = node.loc.selector
+            add_offense(method_node) do |corrector|
+              corrector.replace(method_node,
+                                PREFERRED_METHOD[method_node.source])
+            end
+          end
+
+          private
+
+          def message(node)
+            format(MSG, good: PREFERRED_METHOD[node.source], bad: node.source)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -179,7 +179,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)

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/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.17.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.0
 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-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -58,6 +58,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
@@ -142,6 +143,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 +209,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