rubocop-minitest 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f04d27399103835be508a28975344afe09018c9f480217824f65c0c43be34b3d
-  data.tar.gz: 3021b9fa8b826d056b69d2c91b6d447dc66a3acecc82bf439a2931e6f25ea9f6
+  metadata.gz: add241b07281db4494e25119722057177e5eb15056360b0907d4b58819b6f371
+  data.tar.gz: 0dbe3916ea796caa3c59e04df1b13ade8a11c25b7613187308b3ea90348380fa
 SHA512:
-  metadata.gz: 61ae0ab74e4a736221044989b3ef08e5c743b6cd43024c6ed236e276a4fefb0ec6c3fd23232f401ef205d0db5e8575c8cb1b85b31186a8e26c7be031e65f9772
-  data.tar.gz: a574a9d994741b69bf4280b91ef7321498aeeaec391cdfee7784230baf55a0d45bf4013a8395418b96b442a39fb13b5a33fa23b8bb03d2cce92bb77c040317c9
+  metadata.gz: 4ab3dd3b82e55154731f600b942f2ef3dd48e85bf55d8d5d09c94bcb5227e409ea201c45be221cfde00cdb434d4877508bfad26cc7d3d3427c531c0babf146c1
+  data.tar.gz: 261d27488e8ee453f9307bb4367a7072dddb544c0dd73c5ac4e70e033875be7916519cf346ede3c5956023d81e5cf0f22b6ab284c85650a8987b0fa95c77f18d

data/.circleci/config.yml

@@ -37,16 +37,19 @@ workflows:
       - documentation-checks
       - rake_default:
           name: Ruby 2.5
-          image: circleci/ruby:2.5
+          image: cimg/ruby:2.5
       - rake_default:
           name: Ruby 2.6
-          image: circleci/ruby:2.6
+          image: cimg/ruby:2.6
       - rake_default:
           name: Ruby 2.7
-          image: circleci/ruby:2.7
+          image: cimg/ruby:2.7
       - rake_default:
           name: Ruby 3.0
-          image: circleci/ruby:3.0
+          image: cimg/ruby:3.0
+      - rake_default:
+          name: Ruby 3.1
+          image: cimg/ruby:3.1
       - rake_default:
           name: Ruby HEAD
           image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -5,14 +5,13 @@ The more detailed you are, the better.**
 
 Before submitting the PR make sure the following are checked:
 
+* [ ] The PR relates to *only* one subject with a clear title and description in grammatically correct, complete sentences.
 * [ ] Wrote [good commit messages][1].
 * [ ] Commit message starts with `[Fix #issue-number]` (if the related issue exists).
 * [ ] Feature branch is up-to-date with `master` (if not - rebase it).
 * [ ] Squashed related commits together.
 * [ ] Added tests.
+* [ ] Ran `bundle exec rake default`. It executes all tests and runs RuboCop on its own code.
 * [ ] Added an entry (file) to the [changelog folder](https://github.com/rubocop/rubocop-minitest/blob/master/changelog/) named `{change_type}_{change_description}.md` if the new code introduces user-observable changes. See [changelog entry format](https://github.com/rubocop/rubocop/blob/master/CONTRIBUTING.md#changelog-entry-format) for details.
-* [ ] The PR relates to *only* one subject with a clear title
-  and description in grammatically correct, complete sentences.
-* [ ] Run `bundle exec rake default`. It executes all tests and RuboCop for itself, and generates the documentation.
 
 [1]: https://chris.beams.io/posts/git-commit/

data/.github/workflows/linting.yml

@@ -0,0 +1,15 @@
+name: Linting
+on:
+  - pull_request
+jobs:
+  yamllint:
+    name: Yamllint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Yamllint
+        uses: karancode/yamllint-github-action@master
+        with:
+          yamllint_comment: true
+        env:
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -55,13 +55,13 @@ Layout/ClassStructure:
       - prepend
       - extend
   ExpectedOrder:
-      - module_inclusion
-      - constants
-      - public_class_methods
-      - initializer
-      - instance_methods
-      - protected_methods
-      - private_methods
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - instance_methods
+    - protected_methods
+    - private_methods
 
 # Trailing white space is meaningful in code examples
 Layout/TrailingWhitespace:

data/.yamllint.yml

@@ -0,0 +1,9 @@
+extends: default
+
+rules:
+  comments:
+    min-spaces-from-content: 1
+  document-start: disable
+  line-length: disable
+  truthy:
+    check-keys: false

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## master (unreleased)
 
+## 0.18.0 (2022-03-13)
+
+### New features
+
+* [#161](https://github.com/rubocop/rubocop-minitest/pull/161): Add new `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops. ([@koic][])
+
+### Changes
+
+* [#162](https://github.com/rubocop/rubocop-minitest/pull/162): Make `Minitest/AssertNil` (`Minitest/RefuteNil`) aware of `assert_predicate(obj, :nil?)` (`refute_predicate(obj, :nil?)`). ([@koic][])
+
+## 0.17.2 (2022-02-12)
+
+### Bug fixes
+
+* [#159](https://github.com/rubocop/rubocop-minitest/issues/159): Fix a false positive for `Minitest/UnreachableAssertion` when using only one assertion method in `assert_raises` block. ([@koic][])
+
+## 0.17.1 (2022-01-30)
+
+### Changes
+
+* [#158](https://github.com/rubocop/rubocop-minitest/pull/158): Make `Minitest/UnreachableAssertion` aware of `assert` and `refute` prefix methods. ([@koic][])
+
 ## 0.17.0 (2021-11-23)
 
 ### New features

data/Gemfile

@@ -11,3 +11,6 @@ gem 'rake'
 gem 'rubocop', github: 'rubocop/rubocop'
 gem 'rubocop-performance', '~> 1.12.0'
 gem 'yard', '~> 0.9'
+
+local_gemfile = File.expand_path('Gemfile.local', __dir__)
+eval_gemfile local_gemfile if File.exist?(local_gemfile)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2021 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
+Copyright (c) 2019-2022 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -48,7 +48,7 @@ task :new_cop, [:cop] do |_task, args|
   generator.write_source
   generator.write_test
   generator.inject_require(root_file_path: 'lib/rubocop/cop/minitest_cops.rb')
-  generator.inject_config(config_file_path: 'config/default.yml', version_added: bump_minor_version)
+  generator.inject_config(config_file_path: 'config/default.yml')
 
   puts generator.todo
 end

data/config/default.yml

@@ -81,6 +81,12 @@ Minitest/AssertRespondTo:
   Enabled: true
   VersionAdded: '0.3'
 
+Minitest/AssertPredicate:
+  Description: 'This cop enforces the test to use `assert_predicate` instead of using `assert(obj.a_predicate_method?)`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#assert-predicate'
+  Enabled: pending
+  VersionAdded: '0.18'
+
 Minitest/AssertSilent:
   Description: "This cop enforces the test to use `assert_silent { ... }` instead of using `assert_output('', '') { ... }`."
   StyleGuide: 'https://github.com/rubocop/minitest-style-guide#assert-silent'
@@ -194,6 +200,12 @@ Minitest/RefutePathExists:
   Enabled: 'pending'
   VersionAdded: '0.10'
 
+Minitest/RefutePredicate:
+  Description: 'This cop enforces the test to use `refute_predicate` instead of using `refute(obj.a_predicate_method?)`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#refute-predicate'
+  Enabled: pending
+  VersionAdded: '0.18'
+
 Minitest/RefuteRespondTo:
   Description: 'This cop enforces the test to use `refute_respond_to(object, :do_something)` over `refute(object.respond_to?(:do_something))`.'
   StyleGuide: 'https://minitest.rubystyle.guide#refute-respond-to'

data/docs/antora.yml

@@ -2,6 +2,6 @@ name: rubocop-minitest
 title: RuboCop Minitest
 # We always provide version without patch here (e.g. 1.1),
 # as patch versions should not appear in the docs.
-version: '0.17'
+version: '0.18'
 nav:
-- modules/ROOT/nav.adoc
+  - modules/ROOT/nav.adoc

data/docs/modules/ROOT/pages/cops.adoc

@@ -24,6 +24,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestassertnil[Minitest/AssertNil]
 * xref:cops_minitest.adoc#minitestassertoutput[Minitest/AssertOutput]
 * xref:cops_minitest.adoc#minitestassertpathexists[Minitest/AssertPathExists]
+* xref:cops_minitest.adoc#minitestassertpredicate[Minitest/AssertPredicate]
 * xref:cops_minitest.adoc#minitestassertrespondto[Minitest/AssertRespondTo]
 * xref:cops_minitest.adoc#minitestassertsilent[Minitest/AssertSilent]
 * xref:cops_minitest.adoc#minitestasserttruthy[Minitest/AssertTruthy]
@@ -43,6 +44,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestrefutematch[Minitest/RefuteMatch]
 * xref:cops_minitest.adoc#minitestrefutenil[Minitest/RefuteNil]
 * xref:cops_minitest.adoc#minitestrefutepathexists[Minitest/RefutePathExists]
+* xref:cops_minitest.adoc#minitestrefutepredicate[Minitest/RefutePredicate]
 * xref:cops_minitest.adoc#minitestrefuterespondto[Minitest/RefuteRespondTo]
 * xref:cops_minitest.adoc#minitesttestmethodname[Minitest/TestMethodName]
 * xref:cops_minitest.adoc#minitestunreachableassertion[Minitest/UnreachableAssertion]

data/docs/modules/ROOT/pages/cops_minitest.adoc

@@ -262,7 +262,7 @@ assert_match(matcher, string, 'message')
 |===
 
 This cop enforces the test to use `assert_nil` instead of using
-`assert_equal(nil, something)` or `assert(something.nil?)`.
+`assert_equal(nil, something)`, `assert(something.nil?)`, or `assert_predicate(something, :nil?)`.
 
 === Examples
 
@@ -273,6 +273,8 @@ assert_equal(nil, actual)
 assert_equal(nil, actual, 'message')
 assert(object.nil?)
 assert(object.nil?, 'message')
+assert_predicate(object, :nil?)
+assert_predicate(object, :nil?, 'message')
 
 # good
 assert_nil(actual)
@@ -347,6 +349,38 @@ assert_path_exists(path, 'message')
 
 * https://minitest.rubystyle.guide/#assert-path-exists
 
+== Minitest/AssertPredicate
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| Yes
+| 0.18
+| -
+|===
+
+This cop enforces the test to use `assert_predicate`
+instead of using `assert(obj.a_predicate_method?)`.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+assert(obj.one?)
+assert(obj.one?, 'message')
+
+# good
+assert_predicate(obj, :one?)
+assert_predicate(obj, :one?, 'message')
+----
+
+=== References
+
+* https://minitest.rubystyle.guide/#assert-predicate
+
 == Minitest/AssertRespondTo
 
 |===
@@ -1025,7 +1059,7 @@ refute_match(matcher, string, 'message')
 |===
 
 This cop enforces the test to use `refute_nil` instead of using
-`refute_equal(nil, something)` or `refute(something.nil?)`.
+`refute_equal(nil, something)`, `refute(something.nil?)`, or `refute_predicate(something, :nil?)`.
 
 === Examples
 
@@ -1036,6 +1070,8 @@ refute_equal(nil, actual)
 refute_equal(nil, actual, 'message')
 refute(actual.nil?)
 refute(actual.nil?, 'message')
+refute_predicate(object, :nil?)
+refute_predicate(object, :nil?, 'message')
 
 # good
 refute_nil(actual)
@@ -1078,6 +1114,38 @@ refute_path_exists(path, 'message')
 
 * https://minitest.rubystyle.guide/#refute-path-exists
 
+== Minitest/RefutePredicate
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| Yes
+| 0.18
+| -
+|===
+
+This cop enforces the test to use `refute_predicate`
+instead of using `refute(obj.a_predicate_method?)`.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+refute(obj.one?)
+refute(obj.one?, 'message')
+
+# good
+refute_predicate(obj, :one?)
+refute_predicate(obj, :one?, 'message')
+----
+
+=== References
+
+* https://minitest.rubystyle.guide/#refute-predicate
+
 == Minitest/RefuteRespondTo
 
 |===

data/docs/modules/ROOT/pages/installation.adoc

@@ -11,5 +11,5 @@ or if you use bundler put this in your `Gemfile`
 
 [source,ruby]
 ----
-gem 'rubocop-minitest'
+gem 'rubocop-minitest', require: false
 ----

data/lib/rubocop/cop/minitest/assert_empty_literal.rb

@@ -18,8 +18,7 @@ module RuboCop
         include ArgumentRangeHelper
         extend AutoCorrector
 
-        MSG = 'Prefer using `assert_empty(%<arguments>s)` over ' \
-              '`assert_equal(%<literal>s, %<arguments>s)`.'
+        MSG = 'Prefer using `assert_empty(%<arguments>s)`.'
         RESTRICT_ON_SEND = %i[assert_equal].freeze
 
         def_node_matcher :assert_equal_with_empty_literal, <<~PATTERN

data/lib/rubocop/cop/minitest/assert_nil.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the test to use `assert_nil` instead of using
-      # `assert_equal(nil, something)` or `assert(something.nil?)`.
+      # `assert_equal(nil, something)`, `assert(something.nil?)`, or `assert_predicate(something, :nil?)`.
       #
       # @example
       #   # bad
@@ -12,6 +12,8 @@ module RuboCop
       #   assert_equal(nil, actual, 'message')
       #   assert(object.nil?)
       #   assert(object.nil?, 'message')
+      #   assert_predicate(object, :nil?)
+      #   assert_predicate(object, :nil?, 'message')
       #
       #   # good
       #   assert_nil(actual)
@@ -23,12 +25,13 @@ module RuboCop
         extend AutoCorrector
 
         ASSERTION_TYPE = 'assert'
-        RESTRICT_ON_SEND = %i[assert_equal assert].freeze
+        RESTRICT_ON_SEND = %i[assert assert_equal assert_predicate].freeze
 
         def_node_matcher :nil_assertion, <<~PATTERN
           {
             (send nil? :assert_equal nil $_ $...)
             (send nil? :assert (send $_ :nil?) $...)
+            (send nil? :assert_predicate $_ (sym :nil?) $...)
           }
         PATTERN
 

data/lib/rubocop/cop/minitest/assert_path_exists.rb

@@ -18,7 +18,7 @@ module RuboCop
       class AssertPathExists < Base
         extend AutoCorrector
 
-        MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
+        MSG = 'Prefer using `%<good_method>s`.'
         RESTRICT_ON_SEND = %i[assert].freeze
 
         def_node_matcher :assert_file_exists, <<~PATTERN
@@ -32,7 +32,7 @@ module RuboCop
           assert_file_exists(node) do |path, failure_message|
             failure_message = failure_message.first
             good_method = build_good_method(path, failure_message)
-            message = format(MSG, good_method: good_method, bad_method: node.source)
+            message = format(MSG, good_method: good_method)
 
             add_offense(node, message: message) do |corrector|
               corrector.replace(node, good_method)

data/lib/rubocop/cop/minitest/assert_predicate.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop enforces the test to use `assert_predicate`
+      # instead of using `assert(obj.a_predicate_method?)`.
+      #
+      # @example
+      #   # bad
+      #   assert(obj.one?)
+      #   assert(obj.one?, 'message')
+      #
+      #   # good
+      #   assert_predicate(obj, :one?)
+      #   assert_predicate(obj, :one?, 'message')
+      #
+      class AssertPredicate < Base
+        include ArgumentRangeHelper
+        include PredicateAssertionHandleable
+        extend AutoCorrector
+
+        MSG = 'Prefer using `assert_predicate(%<new_arguments>s)`.'
+        RESTRICT_ON_SEND = %i[assert].freeze
+
+        private
+
+        def assertion_type
+          'assert'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest/assert_silent.rb

@@ -16,7 +16,7 @@ module RuboCop
       class AssertSilent < Base
         extend AutoCorrector
 
-        MSG = 'Prefer using `assert_silent` over `assert_output("", "")`.'
+        MSG = 'Prefer using `assert_silent`.'
 
         def_node_matcher :assert_silent_candidate?, <<~PATTERN
           (block

data/lib/rubocop/cop/minitest/assert_truthy.rb

@@ -19,8 +19,7 @@ module RuboCop
         include ArgumentRangeHelper
         extend AutoCorrector
 
-        MSG = 'Prefer using `assert(%<arguments>s)` over ' \
-              '`assert_equal(true, %<arguments>s)`.'
+        MSG = 'Prefer using `assert(%<arguments>s)`.'
         RESTRICT_ON_SEND = %i[assert_equal].freeze
 
         def_node_matcher :assert_equal_with_truthy, <<~PATTERN

data/lib/rubocop/cop/minitest/assertion_in_lifecycle_hook.rb

@@ -30,7 +30,7 @@ module RuboCop
 
           lifecycle_hooks(class_node).each do |hook_node|
             hook_node.each_descendant(:send) do |node|
-              if assertion?(node)
+              if assertion_method?(node)
                 message = format(MSG, assertion: node.method_name, hook: hook_node.method_name)
                 add_offense(node, message: message)
               end

data/lib/rubocop/cop/minitest/multiple_assertions.rb

@@ -50,7 +50,7 @@ module RuboCop
         private
 
         def assertions_count(node)
-          base = assertion?(node) ? 1 : 0
+          base = assertion_method?(node) ? 1 : 0
           base + node.each_child_node.sum { |c| assertions_count(c) }
         end
 

data/lib/rubocop/cop/minitest/no_assertions.rb

@@ -39,7 +39,7 @@ module RuboCop
         private
 
         def assertions_count(node)
-          base = assertion?(node) ? 1 : 0
+          base = assertion_method?(node) ? 1 : 0
           base + node.each_child_node.sum { |c| assertions_count(c) }
         end
       end

data/lib/rubocop/cop/minitest/refute_equal.rb

@@ -18,20 +18,19 @@ module RuboCop
         include ArgumentRangeHelper
         extend AutoCorrector
 
-        MSG = 'Prefer using `refute_equal(%<preferred>s)` over ' \
-              '`assert(%<over>s)`.'
+        MSG = 'Prefer using `refute_equal(%<preferred>s)`.'
         RESTRICT_ON_SEND = %i[assert].freeze
 
         def_node_matcher :assert_not_equal, <<~PATTERN
-          (send nil? :assert ${(send $_ :!= $_) (send (send $_ :! ) :== $_) } $... )
+          (send nil? :assert {(send $_ :!= $_) (send (send $_ :! ) :== $_) } $... )
         PATTERN
 
         def on_send(node)
-          preferred, over = process_not_equal(node)
-          return unless preferred && over
+          preferred = process_not_equal(node)
+          return unless preferred
 
-          assert_not_equal(node) do |_, expected, actual|
-            message = format(MSG, preferred: preferred, over: over)
+          assert_not_equal(node) do |expected, actual|
+            message = format(MSG, preferred: preferred)
 
             add_offense(node, message: message) do |corrector|
               corrector.replace(node.loc.selector, 'refute_equal')
@@ -54,11 +53,10 @@ module RuboCop
         end
 
         def process_not_equal(node)
-          assert_not_equal(node) do |over, first_arg, second_arg, rest_args|
+          assert_not_equal(node) do |first_arg, second_arg, rest_args|
             custom_message = rest_args.first
-            preferred = preferred_usage(first_arg, second_arg, custom_message)
-            over = original_usage(over.source, custom_message&.source)
-            return [preferred, over]
+
+            preferred_usage(first_arg, second_arg, custom_message)
           end
         end
       end

data/lib/rubocop/cop/minitest/refute_false.rb

@@ -22,8 +22,8 @@ module RuboCop
         include ArgumentRangeHelper
         extend AutoCorrector
 
-        MSG_FOR_ASSERT_EQUAL = 'Prefer using `refute(%<arguments>s)` over `assert_equal(false, %<arguments>s)`.'
-        MSG_FOR_ASSERT = 'Prefer using `refute(%<arguments>s)` over `assert(!%<arguments>s)`.'
+        MSG_FOR_ASSERT_EQUAL = 'Prefer using `refute(%<arguments>s)`.'
+        MSG_FOR_ASSERT = 'Prefer using `refute(%<arguments>s)`.'
         RESTRICT_ON_SEND = %i[assert_equal assert].freeze
 
         def_node_matcher :assert_equal_with_false, <<~PATTERN

data/lib/rubocop/cop/minitest/refute_nil.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the test to use `refute_nil` instead of using
-      # `refute_equal(nil, something)` or `refute(something.nil?)`.
+      # `refute_equal(nil, something)`, `refute(something.nil?)`, or `refute_predicate(something, :nil?)`.
       #
       # @example
       #   # bad
@@ -12,6 +12,8 @@ module RuboCop
       #   refute_equal(nil, actual, 'message')
       #   refute(actual.nil?)
       #   refute(actual.nil?, 'message')
+      #   refute_predicate(object, :nil?)
+      #   refute_predicate(object, :nil?, 'message')
       #
       #   # good
       #   refute_nil(actual)
@@ -23,12 +25,13 @@ module RuboCop
         extend AutoCorrector
 
         ASSERTION_TYPE = 'refute'
-        RESTRICT_ON_SEND = %i[refute_equal refute].freeze
+        RESTRICT_ON_SEND = %i[refute refute_equal refute_predicate].freeze
 
         def_node_matcher :nil_refutation, <<~PATTERN
           {
             (send nil? :refute_equal nil $_ $...)
             (send nil? :refute (send $_ :nil?) $...)
+            (send nil? :refute_predicate $_ (sym :nil?) $...)
           }
         PATTERN
 

data/lib/rubocop/cop/minitest/refute_path_exists.rb

@@ -18,7 +18,7 @@ module RuboCop
       class RefutePathExists < Base
         extend AutoCorrector
 
-        MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
+        MSG = 'Prefer using `%<good_method>s`.'
         RESTRICT_ON_SEND = %i[refute].freeze
 
         def_node_matcher :refute_file_exists, <<~PATTERN
@@ -32,7 +32,7 @@ module RuboCop
           refute_file_exists(node) do |path, failure_message|
             failure_message = failure_message.first
             good_method = build_good_method(path, failure_message)
-            message = format(MSG, good_method: good_method, bad_method: node.source)
+            message = format(MSG, good_method: good_method)
 
             add_offense(node, message: message) do |corrector|
               corrector.replace(node, good_method)

data/lib/rubocop/cop/minitest/refute_predicate.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop enforces the test to use `refute_predicate`
+      # instead of using `refute(obj.a_predicate_method?)`.
+      #
+      # @example
+      #   # bad
+      #   refute(obj.one?)
+      #   refute(obj.one?, 'message')
+      #
+      #   # good
+      #   refute_predicate(obj, :one?)
+      #   refute_predicate(obj, :one?, 'message')
+      #
+      class RefutePredicate < Base
+        include ArgumentRangeHelper
+        include PredicateAssertionHandleable
+        extend AutoCorrector
+
+        MSG = 'Prefer using `refute_predicate(%<new_arguments>s)`.'
+        RESTRICT_ON_SEND = %i[refute].freeze
+
+        private
+
+        def assertion_type
+          'refute'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest/unreachable_assertion.rb

@@ -30,11 +30,9 @@ module RuboCop
 
           last_node = body.begin_type? ? body.children.last : body
           return unless last_node.send_type?
+          return if !assertion_method?(last_node) || !body.begin_type?
 
-          method_name = last_node.method_name
-          return unless assertion_method?(method_name)
-
-          add_offense(last_node, message: format(MSG, assertion_method: method_name))
+          add_offense(last_node, message: format(MSG, assertion_method: last_node.method_name))
         end
       end
     end

data/lib/rubocop/cop/minitest_cops.rb

@@ -5,10 +5,12 @@ require_relative 'mixin/in_delta_mixin'
 require_relative 'mixin/minitest_cop_rule'
 require_relative 'mixin/minitest_exploration_helpers'
 require_relative 'mixin/nil_assertion_handleable'
+require_relative 'mixin/predicate_assertion_handleable'
 require_relative 'minitest/assert_empty'
 require_relative 'minitest/assert_empty_literal'
 require_relative 'minitest/assert_equal'
 require_relative 'minitest/assert_in_delta'
+require_relative 'minitest/assert_predicate'
 require_relative 'minitest/assert_with_expected_argument'
 require_relative 'minitest/assertion_in_lifecycle_hook'
 require_relative 'minitest/assert_kind_of'
@@ -35,6 +37,7 @@ require_relative 'minitest/refute_includes'
 require_relative 'minitest/refute_match'
 require_relative 'minitest/refute_instance_of'
 require_relative 'minitest/refute_path_exists'
+require_relative 'minitest/refute_predicate'
 require_relative 'minitest/refute_respond_to'
 require_relative 'minitest/test_method_name'
 require_relative 'minitest/unreachable_assertion'

data/lib/rubocop/cop/mixin/in_delta_mixin.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     # Common functionality for `AssertInDelta` and `RefuteInDelta` cops.
     module InDeltaMixin
-      MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
+      MSG = 'Prefer using `%<good_method>s`.'
 
       def on_send(node)
         equal_floats_call(node) do |expected, actual, message|
@@ -12,7 +12,7 @@ module RuboCop
           good_method = build_good_method(expected, actual, message)
 
           if expected.float_type? || actual.float_type?
-            message = format(MSG, good_method: good_method, bad_method: node.source)
+            message = format(MSG, good_method: good_method)
 
             add_offense(node, message: message) do |corrector|
               corrector.replace(node, good_method)

data/lib/rubocop/cop/mixin/minitest_cop_rule.rb

@@ -28,8 +28,7 @@ module RuboCop
           include ArgumentRangeHelper
           extend AutoCorrector
 
-          MSG = 'Prefer using `#{preferred_method}(%<new_arguments>s)` over ' \
-                '`#{assertion_method}(%<original_arguments>s)`.'
+          MSG = 'Prefer using `#{preferred_method}(%<new_arguments>s)`.'
           RESTRICT_ON_SEND = %i[#{assertion_method}].freeze
 
           def on_send(node)
@@ -70,12 +69,9 @@ module RuboCop
               message_argument&.source
             ].flatten.compact.join(', ')
 
-            original_arguments = arguments.map(&:source).join(', ')
-
             format(
               MSG,
-              new_arguments: new_arguments,
-              original_arguments: original_arguments
+              new_arguments: new_arguments
             )
           end
 

data/lib/rubocop/cop/mixin/minitest_exploration_helpers.rb

@@ -10,17 +10,6 @@ module RuboCop
 
       ASSERTION_PREFIXES = %w[assert refute].freeze
 
-      ASSERTION_METHODS = %i[
-        assert assert_empty assert_equal assert_in_delta assert_in_epsilon assert_includes assert_instance_of
-        assert_kind_of assert_match assert_nil assert_operator assert_output assert_path_exists assert_predicate
-        assert_raises assert_respond_to assert_same assert_send assert_silent assert_throws
-        refute refute_empty refute_equal refute_in_delta refute_in_epsilon refute_includes refute_instance_of
-        refute_kind_of refute_match refute_nil refute_operator refute_path_exists refute_predicate
-        refute_respond_to refute_same
-      ].freeze
-
-      FLUNK = 'flunk'
-
       LIFECYCLE_HOOK_METHODS = %i[
         before_setup
         setup
@@ -84,19 +73,18 @@ module RuboCop
             method_def.each_child_node(:send)
           end
 
-        send_nodes.select { |send_node| assertion?(send_node) }
+        send_nodes.select { |send_node| assertion_method?(send_node) }
       end
 
-      def assertion?(node)
-        node.send_type? &&
-          ASSERTION_PREFIXES.any? do |prefix|
-            method_name = node.method_name.to_s
-            method_name == FLUNK || method_name.start_with?(prefix)
-          end
-      end
+      def assertion_method?(node)
+        return false unless node.send_type?
+
+        ASSERTION_PREFIXES.any? do |prefix|
+          method_name = node.method_name
 
-      def assertion_method?(method_name)
-        method_name == FLUNK || ASSERTION_METHODS.include?(method_name)
+          # TODO: Remove the fllowing `to_s` since Ruby 2.7 that supports `Symbol#start_with?`.
+          method_name.to_s.start_with?(prefix) || node.method?(:flunk)
+        end
       end
 
       def lifecycle_hook_method?(node)

data/lib/rubocop/cop/mixin/nil_assertion_handleable.rb

@@ -5,7 +5,7 @@ module RuboCop
     module Minitest
       # Common functionality for `AssertNil` and `RefuteNil` cops.
       module NilAssertionHandleable
-        MSG = 'Prefer using `%<assertion_type>s_nil(%<preferred_args>s)` over `%<method>s(%<current_args>s)`.'
+        MSG = 'Prefer using `%<assertion_type>s_nil(%<preferred_args>s)`.'
 
         private
 
@@ -22,23 +22,18 @@ module RuboCop
           message_source = message&.source
 
           preferred_args = [actual.source, message_source].compact
-          current_args = if comparison_assertion_method?(node)
-                           ['nil', preferred_args].join(', ')
-                         else
-                           ["#{actual.source}.nil?", message_source].compact.join(', ')
-                         end
 
           format(
             MSG,
             assertion_type: assertion_type,
             preferred_args: preferred_args.join(', '),
-            method: node.method_name, current_args: current_args
+            method: node.method_name
           )
         end
 
         def autocorrect(corrector, node, actual)
           corrector.replace(node.loc.selector, :"#{assertion_type}_nil")
-          if comparison_assertion_method?(node)
+          if comparison_or_predicate_assertion_method?(node)
             corrector.replace(first_and_second_arguments_range(node), actual.source)
           else
             corrector.remove(node.first_argument.loc.dot)
@@ -46,8 +41,8 @@ module RuboCop
           end
         end
 
-        def comparison_assertion_method?(node)
-          node.method?(:"#{assertion_type}_equal")
+        def comparison_or_predicate_assertion_method?(node)
+          node.method?(:"#{assertion_type}_equal") || node.method?(:"#{assertion_type}_predicate")
         end
       end
     end

data/lib/rubocop/cop/mixin/predicate_assertion_handleable.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Common functionality for `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops.
+      module PredicateAssertionHandleable
+        MSG = 'Prefer using `%<assertion_type>s_predicate(%<new_arguments>s)`.'
+        RESTRICT_ON_SEND = %i[assert].freeze
+
+        def on_send(node)
+          return unless (arguments = peel_redundant_parentheses_from(node.arguments))
+          return unless arguments.first.respond_to?(:predicate_method?) && arguments.first.predicate_method?
+          return unless arguments.first.arguments.count.zero?
+
+          add_offense(node, message: offense_message(arguments)) do |corrector|
+            autocorrect(corrector, node, arguments)
+          end
+        end
+
+        def autocorrect(corrector, node, arguments)
+          corrector.replace(node.loc.selector, "#{assertion_type}_predicate")
+
+          new_arguments = new_arguments(arguments).join(', ')
+
+          corrector.replace(first_argument_range(node), new_arguments)
+        end
+
+        private
+
+        def peel_redundant_parentheses_from(arguments)
+          return arguments unless arguments.first&.begin_type?
+
+          peel_redundant_parentheses_from(arguments.first.children)
+        end
+
+        def offense_message(arguments)
+          message_argument = arguments.last if arguments.first != arguments.last
+
+          new_arguments = [
+            new_arguments(arguments),
+            message_argument&.source
+          ].flatten.compact.join(', ')
+
+          format(MSG, assertion_type: assertion_type, new_arguments: new_arguments)
+        end
+
+        def new_arguments(arguments)
+          receiver = correct_receiver(arguments.first.receiver)
+          method_name = arguments.first.method_name
+
+          [receiver, ":#{method_name}"]
+        end
+
+        def correct_receiver(receiver)
+          receiver ? receiver.source : 'self'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/minitest/assert_offense.rb

@@ -22,7 +22,7 @@ module RuboCop
     #     class FooTest < Minitest::Test
     #       def test_do_something
     #         assert_equal(nil, somestuff)
-    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)` over `assert_equal(nil, somestuff)`.
+    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)`.
     #       end
     #     end
     #   RUBY
@@ -36,7 +36,7 @@ module RuboCop
     #     class FooTest < Minitest::Test
     #       def test_do_something
     #         assert_equal(nil, somestuff)
-    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)` over `assert_equal(nil, somestuff)`.
+    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)`.
     #       end
     #     end
     #   RUBY
@@ -64,7 +64,7 @@ module RuboCop
     #     class FooTest < Minitest::Test
     #       def test_do_something
     #         assert_equal(nil, somestuff)
-    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)` over `assert_equal(nil, somestuff)`.
+    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)`.
     #       end
     #     end
     #   RUBY

data/lib/rubocop/minitest/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Minitest
     # This module holds the RuboCop Minitest version information.
     module Version
-      STRING = '0.17.0'
+      STRING = '0.18.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/mkdocs.yml

@@ -1,13 +1,13 @@
 site_name: "A RuboCop extension focused on enforcing Minitest best practices and coding conventions."
 repo_url: https://github.com/rubocop/rubocop-minitest
 edit_uri: edit/master/legacy-docs/
-copyright: "Copyright © 2021 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO, and RuboCop contributors"
+copyright: "Copyright © 2022 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO, and RuboCop contributors"
 docs_dir: legacy-docs
 pages:
-- Home: index.md
-- Installation: installation.md
-- Usage: usage.md
-- Cops: cops.md
-- Cops Documentation:
-    - Minitest Cops: cops_minitest.md
+  - Home: index.md
+  - Installation: installation.md
+  - Usage: usage.md
+  - Cops: cops.md
+  - Cops Documentation:
+      - Minitest Cops: cops_minitest.md
 theme: readthedocs

data/relnotes/v0.17.1.md

@@ -0,0 +1,5 @@
+### Changes
+
+* [#158](https://github.com/rubocop/rubocop-minitest/pull/158): Make `Minitest/UnreachableAssertion` aware of `assert` and `refute` prefix methods. ([@koic][])
+
+[@koic]: https://github.com/koic

data/relnotes/v0.17.2.md

@@ -0,0 +1,5 @@
+### Bug fixes
+
+* [#159](https://github.com/rubocop/rubocop-minitest/issues/159): Fix a false positive for `Minitest/UnreachableAssertion` when using only one assertion method in `assert_raises` block. ([@koic][])
+
+[@koic]: https://github.com/koic

data/relnotes/v0.18.0.md

@@ -0,0 +1,9 @@
+### New features
+
+* [#161](https://github.com/rubocop/rubocop-minitest/pull/161): Add new `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops. ([@koic][])
+
+### Changes
+
+* [#162](https://github.com/rubocop/rubocop-minitest/pull/162): Make `Minitest/AssertNil` (`Minitest/RefuteNil`) aware of `assert_predicate(obj, :nil?)` (`refute_predicate(obj, :nil?)`). ([@koic][])
+
+[@koic]: https://github.com/koic

data/tasks/cops_documentation.rake

@@ -12,12 +12,12 @@ end
 
 task update_cops_documentation: :yard_for_generate_documentation do
   deps = ['Minitest']
-  CopsDocumentationGenerator.new(departments: deps).call
-end
 
-desc 'Generate docs of all cops departments (obsolete)'
-task :generate_cops_documentation do
-  puts 'Updating the documentation is now done automatically!'
+  # NOTE: Update `<<next>>` version for docs/modules/ROOT/pages/cops_minitest.adoc
+  # when running release tasks.
+  RuboCop::Minitest::Inject.defaults!
+
+  CopsDocumentationGenerator.new(departments: deps).call
 end
 
 desc 'Syntax check for the documentation comments'

data/tasks/cut_release.rake

@@ -39,7 +39,7 @@ namespace :cut_release do
 
     File.open('docs/antora.yml', 'w') do |f|
       f << antora_metadata.sub(
-        'version: master',
+        "version: 'master'",
         "version: '#{version_sans_patch(new_version)}'"
       )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -60,10 +60,12 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/linting.yml"
 - ".github/workflows/spell_checking.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".yamllint.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -100,6 +102,7 @@ files:
 - lib/rubocop/cop/minitest/assert_nil.rb
 - lib/rubocop/cop/minitest/assert_output.rb
 - lib/rubocop/cop/minitest/assert_path_exists.rb
+- lib/rubocop/cop/minitest/assert_predicate.rb
 - lib/rubocop/cop/minitest/assert_respond_to.rb
 - lib/rubocop/cop/minitest/assert_silent.rb
 - lib/rubocop/cop/minitest/assert_truthy.rb
@@ -119,6 +122,7 @@ files:
 - lib/rubocop/cop/minitest/refute_match.rb
 - lib/rubocop/cop/minitest/refute_nil.rb
 - lib/rubocop/cop/minitest/refute_path_exists.rb
+- lib/rubocop/cop/minitest/refute_predicate.rb
 - lib/rubocop/cop/minitest/refute_respond_to.rb
 - lib/rubocop/cop/minitest/test_method_name.rb
 - lib/rubocop/cop/minitest/unreachable_assertion.rb
@@ -129,6 +133,7 @@ files:
 - lib/rubocop/cop/mixin/minitest_cop_rule.rb
 - lib/rubocop/cop/mixin/minitest_exploration_helpers.rb
 - lib/rubocop/cop/mixin/nil_assertion_handleable.rb
+- lib/rubocop/cop/mixin/predicate_assertion_handleable.rb
 - lib/rubocop/minitest.rb
 - lib/rubocop/minitest/assert_offense.rb
 - lib/rubocop/minitest/inject.rb
@@ -152,6 +157,9 @@ files:
 - relnotes/v0.15.2.md
 - relnotes/v0.16.0.md
 - relnotes/v0.17.0.md
+- relnotes/v0.17.1.md
+- relnotes/v0.17.2.md
+- relnotes/v0.18.0.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -178,7 +186,7 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-minitest/
   changelog_uri: https://github.com/rubocop/rubocop-minitest/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-minitest
-  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.17
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.18
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -196,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Automatic Minitest code style checking tool.