rubocop-minitest 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb85f2ad7f928abf4e8f8e2c22c8508700960b11bdb8215b4ca8ea792a96dd73
-  data.tar.gz: 404314baeb561c4be2bd64eb1ec154d014942975ce4c0780b43df4c1a35e9286
+  metadata.gz: bcdc752936f6002cc925a5ca82039770b2977685a53f182250b0cc75fffbb412
+  data.tar.gz: a634c0d0fa393ef7f00b07ebb8c17063df18c8e4d92643eb361699c1fa327097
 SHA512:
-  metadata.gz: b20af6e92af74832f025aad226808d3343da4dd427149137b331a0ad177ab6aabcf5f326dfc83022aa50b73dc21fc48e4bb5149f2aa2506c7cf4ba7a0b7a97ac
-  data.tar.gz: a535fb3d220ec32ceb6c1fb2cd75f7cdd7061709334609e566900e65c47506ea15751827f8b49d3f73af8cc8b39705534c817b55aead18c3f3206e877f0996b8
+  metadata.gz: 1879892d3bb7d99c4e2e1c483f1c9f93b990f55fecc71f5ae37b0193bfde0ae7167588d21fbf3a62abdfa26f4e88efc2655d0ddc4e0f078f23fe5f05843e95ca
+  data.tar.gz: c411392994e053920757c682c793defae132d9fd4e556c131f6c4a74fef3d93dca05fab0f3bd91a3081e038a943dd41a00b88626966b0c74928e97afa0cec65f

data/.rubocop.yml

@@ -23,6 +23,19 @@ Naming/PredicateName:
     - def_node_matcher
     - def_node_search
 
+Naming/InclusiveLanguage:
+  FlaggedTerms:
+    whitelist:
+      Suggestions:
+        - allowlist
+    blacklist:
+      Suggestions:
+        - denylist
+    master:
+      AllowedRegex:
+        - 'blob/master/'
+        - 'master \(unreleased\)'
+
 Style/FormatStringToken:
   # Because we parse a lot of source codes from strings. Percent arrays
   # look like unannotated format string tokens to this cop.

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.14.0 (2021-07-03)
+
+### New features
+
+* [#133](https://github.com/rubocop/rubocop-minitest/issues/133): Add new `Minitest/UnreachableAssertion` cop. ([@koic][])
+
 ## 0.13.0 (2021-06-20)
 
 ### New features

data/config/default.yml

@@ -194,6 +194,11 @@ Minitest/TestMethodName:
   Enabled: 'pending'
   VersionAdded: '0.10'
 
+Minitest/UnreachableAssertion:
+  Description: 'This cop checks for an `assert_raises` block containing any unreachable assertions.'
+  Enabled: pending
+  VersionAdded: '0.14'
+
 Minitest/UnspecifiedException:
   Description: 'This cop checks for a specified error in `assert_raises`.'
   StyleGuide: 'https://minitest.rubystyle.guide#unspecified-exception'

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.13'
+version: '0.14'
 nav:
 - modules/ROOT/nav.adoc

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

@@ -45,6 +45,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestrefutepathexists[Minitest/RefutePathExists]
 * xref:cops_minitest.adoc#minitestrefuterespondto[Minitest/RefuteRespondTo]
 * xref:cops_minitest.adoc#minitesttestmethodname[Minitest/TestMethodName]
+* xref:cops_minitest.adoc#minitestunreachableassertion[Minitest/UnreachableAssertion]
 * xref:cops_minitest.adoc#minitestunspecifiedexception[Minitest/UnspecifiedException]
 
 // END_COP_LIST

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

@@ -1053,6 +1053,38 @@ class FooTest < Minitest::Test
 end
 ----
 
+== Minitest/UnreachableAssertion
+
+|===
+| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+
+| Pending
+| Yes
+| No
+| 0.14
+| -
+|===
+
+This cop checks for `assert_raises` has an assertion method at
+the bottom of block because the assertion will be never reached.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+assert_raises FooError do
+  obj.occur_error
+  assert_equal('foo', obj.bar) # Never asserted.
+end
+
+# good
+assert_raises FooError do
+  obj.occur_error
+end
+assert_equal('foo', obj.bar)
+----
+
 == Minitest/UnspecifiedException
 
 |===

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

@@ -22,10 +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)` over `assert_equal(false, %<arguments>s)`.'
+        MSG_FOR_ASSERT = 'Prefer using `refute(%<arguments>s)` over `assert(!%<arguments>s)`.'
         RESTRICT_ON_SEND = %i[assert_equal assert].freeze
 
         def_node_matcher :assert_equal_with_false, <<~PATTERN

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop checks for `assert_raises` has an assertion method at
+      # the bottom of block because the assertion will be never reached.
+      #
+      # @example
+      #
+      #   # bad
+      #   assert_raises FooError do
+      #     obj.occur_error
+      #     assert_equal('foo', obj.bar) # Never asserted.
+      #   end
+      #
+      #   # good
+      #   assert_raises FooError do
+      #     obj.occur_error
+      #   end
+      #   assert_equal('foo', obj.bar)
+      #
+      class UnreachableAssertion < Base
+        include MinitestExplorationHelpers
+
+        MSG = 'Unreachable `%<assertion_method>s` detected.'
+
+        def on_block(node)
+          return unless node.method?(:assert_raises) && (body = node.body)
+
+          last_node = body.begin_type? ? body.children.last : body
+          return unless last_node.send_type?
+
+          method_name = last_node.method_name
+          return unless assertion_method?(method_name)
+
+          add_offense(last_node, message: format(MSG, assertion_method: method_name))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest_cops.rb

@@ -36,4 +36,5 @@ require_relative 'minitest/refute_instance_of'
 require_relative 'minitest/refute_path_exists'
 require_relative 'minitest/refute_respond_to'
 require_relative 'minitest/test_method_name'
+require_relative 'minitest/unreachable_assertion'
 require_relative 'minitest/unspecified_exception'

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.13.0'
+      STRING = '0.14.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/relnotes/v0.14.0.md

@@ -0,0 +1,5 @@
+### New features
+
+* [#133](https://github.com/rubocop/rubocop-minitest/issues/133): Add new `Minitest/UnreachableAssertion` cop. ([@koic][])
+
+[@koic]: https://github.com/koic

data/tasks/cops_documentation.rake

@@ -25,8 +25,7 @@ task verify_cops_documentation: :generate_cops_documentation do
     # Output diff before raising error
     sh('GIT_PAGER=cat git diff docs')
 
-    warn 'The docs directory is out of sync. ' \
-      'Run `rake generate_cops_documentation` and commit the results.'
+    warn 'The docs directory is out of sync. Run `rake generate_cops_documentation` and commit the results.'
     exit!
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -118,6 +118,7 @@ files:
 - lib/rubocop/cop/minitest/refute_path_exists.rb
 - lib/rubocop/cop/minitest/refute_respond_to.rb
 - lib/rubocop/cop/minitest/test_method_name.rb
+- lib/rubocop/cop/minitest/unreachable_assertion.rb
 - lib/rubocop/cop/minitest/unspecified_exception.rb
 - lib/rubocop/cop/minitest_cops.rb
 - lib/rubocop/cop/mixin/argument_range_helper.rb
@@ -139,6 +140,7 @@ files:
 - relnotes/v0.12.0.md
 - relnotes/v0.12.1.md
 - relnotes/v0.13.0.md
+- relnotes/v0.14.0.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -163,7 +165,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.13
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.14
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
 post_install_message:
 rdoc_options: []