rubocop-minitest 0.11.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e45de61660959fcc0e02a2dd6754d7042cb167b1ef5277d327563e8bb2277c
-  data.tar.gz: 0f36c86abdde0b5b23dd2672f295a4383da2f5ff68b8414e96bb4f932c4eb7bc
+  metadata.gz: bcdc752936f6002cc925a5ca82039770b2977685a53f182250b0cc75fffbb412
+  data.tar.gz: a634c0d0fa393ef7f00b07ebb8c17063df18c8e4d92643eb361699c1fa327097
 SHA512:
-  metadata.gz: c643b9d4e81ce5f966e11cebe55c40359799130eba6591a52cf7b10dca759b289167ede842a89eb3bf0f62119fbc189a28e1da611cb82afaa825662bc271aa6a
-  data.tar.gz: 15aab2f0884dd25ef98e61b1728736f21311004c06d1d8b86454bb2bc4f9367e31e558b8843315fb1f3d7502f11ffea5ec1cbfb5acddd966bf373c4ad0b01482
+  metadata.gz: 1879892d3bb7d99c4e2e1c483f1c9f93b990f55fecc71f5ae37b0193bfde0ae7167588d21fbf3a62abdfa26f4e88efc2655d0ddc4e0f078f23fe5f05843e95ca
+  data.tar.gz: c411392994e053920757c682c793defae132d9fd4e556c131f6c4a74fef3d93dca05fab0f3bd91a3081e038a943dd41a00b88626966b0c74928e97afa0cec65f

data/.circleci/config.yml

@@ -38,9 +38,6 @@ workflows:
   build:
     jobs:
       - documentation-checks
-      - rake_default:
-          name: Ruby 2.4
-          image: circleci/ruby:2.4
       - rake_default:
           name: Ruby 2.5
           image: circleci/ruby:2.5

data/.rubocop.yml

@@ -9,7 +9,7 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   SuggestExtensions: false
 
 InternalAffairs/NodeMatcherDirective:
@@ -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,40 @@
 
 ## 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
+
+* [#136](https://github.com/rubocop/rubocop-minitest/pull/136): Support Active Support's `test` method for `Minitest/MultipleAssertions` and `Minitest/NoAssertions` cops. ([@koic][])
+
+## 0.12.1 (2021-04-25)
+
+### Bug fixes
+
+* [#131](https://github.com/rubocop/rubocop-minitest/issues/131): Fix an error for `Minitest/MultipleAssertions` and fixes a false positive for `test` block. ([@koic][])
+
+## 0.12.0 (2021-04-23)
+
+### New features
+
+* [#124](https://github.com/rubocop/rubocop-minitest/pull/124): Add new `Minitest/NoAssertions` cop. ([@ghiculescu][])
+
+### Changes
+
+* [#129](https://github.com/rubocop/rubocop-minitest/pull/129): Drop Ruby 2.4 support. ([@koic][])
+
+## 0.11.1 (2021-03-31)
+
+### Changes
+
+* [#126](https://github.com/rubocop/rubocop-minitest/issues/126): Mark `Minitest/AssertWithExpectedArgument` as unsafe. ([@koic][])
+
 ## 0.11.0 (2021-03-22)
 
 ### New features

data/Gemfile

@@ -9,5 +9,5 @@ gemspec
 gem 'bump', require: false
 gem 'rake'
 gem 'rubocop', github: 'rubocop/rubocop'
-gem 'rubocop-performance', '~> 1.10.0'
+gem 'rubocop-performance', '~> 1.11.0'
 gem 'yard', '~> 0.9'

data/config/default.yml

@@ -97,6 +97,7 @@ Minitest/AssertTruthy:
 Minitest/AssertWithExpectedArgument:
   Description: 'This cop tries to detect when a user accidentally used `assert` when they meant to use `assert_equal`.'
   Enabled: pending
+  Safe: false
   VersionAdded: '0.11'
 
 Minitest/GlobalExpectations:
@@ -117,6 +118,11 @@ Minitest/MultipleAssertions:
   VersionAdded: '0.10'
   Max: 3
 
+Minitest/NoAssertions:
+  Description: 'This cop checks for at least one assertion (or flunk) in tests.'
+  Enabled: false
+  VersionAdded: '0.12'
+
 Minitest/RefuteEmpty:
   Description: 'This cop enforces to use `refute_empty` instead of using `refute(object.empty?)`.'
   StyleGuide: 'https://minitest.rubystyle.guide#refute-empty'
@@ -188,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.11'
+version: '0.14'
 nav:
 - modules/ROOT/nav.adoc

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

@@ -32,6 +32,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestglobalexpectations[Minitest/GlobalExpectations]
 * xref:cops_minitest.adoc#minitestliteralasactualargument[Minitest/LiteralAsActualArgument]
 * xref:cops_minitest.adoc#minitestmultipleassertions[Minitest/MultipleAssertions]
+* xref:cops_minitest.adoc#minitestnoassertions[Minitest/NoAssertions]
 * xref:cops_minitest.adoc#minitestrefuteempty[Minitest/RefuteEmpty]
 * xref:cops_minitest.adoc#minitestrefuteequal[Minitest/RefuteEqual]
 * xref:cops_minitest.adoc#minitestrefutefalse[Minitest/RefuteFalse]
@@ -44,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

@@ -447,7 +447,7 @@ assert(actual, 'message')
 | Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 
 | Pending
-| Yes
+| No
 | No
 | 0.11
 | -
@@ -456,6 +456,9 @@ assert(actual, 'message')
 This cop tries to detect when a user accidentally used
 `assert` when they meant to use `assert_equal`.
 
+It is marked as unsafe because it is not possible to determine
+whether the second argument of `assert` is a message or not.
+
 === Examples
 
 [source,ruby]
@@ -622,6 +625,38 @@ end
 | Integer
 |===
 
+== Minitest/NoAssertions
+
+|===
+| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+
+| Disabled
+| Yes
+| No
+| 0.12
+| -
+|===
+
+This cop checks if test cases contain any assertion calls.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+class FooTest < Minitest::Test
+  def test_the_truth
+  end
+end
+
+# good
+class FooTest < Minitest::Test
+  def test_the_truth
+    assert true
+  end
+end
+----
+
 == Minitest/RefuteEmpty
 
 |===
@@ -1018,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/assert_empty.rb

@@ -15,7 +15,7 @@ module RuboCop
       #   assert_empty(object)
       #   assert_empty(object, 'message')
       #
-      class AssertEmpty < Cop
+      class AssertEmpty < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :empty?

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

@@ -14,8 +14,9 @@ module RuboCop
       #   # good
       #   assert_empty(object)
       #
-      class AssertEmptyLiteral < Cop
+      class AssertEmptyLiteral < Base
         include ArgumentRangeHelper
+        extend AutoCorrector
 
         MSG = 'Prefer using `assert_empty(%<arguments>s)` over ' \
               '`assert_equal(%<literal>s, %<arguments>s)`.'
@@ -32,15 +33,9 @@ module RuboCop
             args = matchers.map(&:source).join(', ')
 
             message = format(MSG, literal: literal.source, arguments: args)
-            add_offense(node, message: message)
-          end
-        end
-
-        def autocorrect(node)
-          assert_equal_with_empty_literal(node) do |_literal, matchers|
-            object = matchers.first
+            add_offense(node, message: message) do |corrector|
+              object = matchers.first
 
-            lambda do |corrector|
               corrector.replace(node.loc.selector, 'assert_empty')
               corrector.replace(first_and_second_arguments_range(node), object.source)
             end

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

@@ -13,7 +13,7 @@ module RuboCop
       #   # good
       #   assert_equal("rubocop-minitest", actual)
       #
-      class AssertEqual < Cop
+      class AssertEqual < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :==, preferred_method: :assert_equal

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

@@ -15,8 +15,9 @@ module RuboCop
       #   assert_in_delta(0.2, actual)
       #   assert_in_delta(0.2, actual, 0.001, 'message')
       #
-      class AssertInDelta < Cop
+      class AssertInDelta < Base
         include InDeltaMixin
+        extend AutoCorrector
 
         RESTRICT_ON_SEND = %i[assert_equal].freeze
 

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

@@ -15,7 +15,7 @@ module RuboCop
       #   assert_includes(collection, object)
       #   assert_includes(collection, object, 'message')
       #
-      class AssertIncludes < Cop
+      class AssertIncludes < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :include?, preferred_method: :assert_includes

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

@@ -15,7 +15,7 @@ module RuboCop
       #   assert_instance_of(Class, object)
       #   assert_instance_of(Class, object, 'message')
       #
-      class AssertInstanceOf < Cop
+      class AssertInstanceOf < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :instance_of?, inverse: true

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

@@ -15,7 +15,7 @@ module RuboCop
       #   assert_kind_of(Class, object)
       #   assert_kind_of(Class, object, 'message')
       #
-      class AssertKindOf < Cop
+      class AssertKindOf < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :kind_of?, inverse: true

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

@@ -15,7 +15,7 @@ module RuboCop
       #   assert_match(regex, string)
       #   assert_match(matcher, string, 'message')
       #
-      class AssertMatch < Cop
+      class AssertMatch < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :match

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

@@ -15,8 +15,9 @@ module RuboCop
       #   assert_nil(actual)
       #   assert_nil(actual, 'message')
       #
-      class AssertNil < Cop
+      class AssertNil < Base
         include ArgumentRangeHelper
+        extend AutoCorrector
 
         MSG = 'Prefer using `assert_nil(%<arguments>s)` over ' \
               '`assert_equal(nil, %<arguments>s)`.'
@@ -32,17 +33,9 @@ module RuboCop
 
             arguments = [actual.source, message&.source].compact.join(', ')
 
-            add_offense(node, message: format(MSG, arguments: arguments))
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            assert_equal_with_nil(node) do |actual|
+            add_offense(node, message: format(MSG, arguments: arguments)) do |corrector|
               corrector.replace(node.loc.selector, 'assert_nil')
-              corrector.replace(
-                first_and_second_arguments_range(node), actual.source
-              )
+              corrector.replace(first_and_second_arguments_range(node), actual.source)
             end
           end
         end

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

@@ -15,7 +15,7 @@ module RuboCop
       #   # good
       #   assert_output(expected) { puts object.method }
       #
-      class AssertOutput < Cop
+      class AssertOutput < Base
         include MinitestExplorationHelpers
 
         MSG = 'Use `assert_output` instead of mutating %<name>s.'

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

@@ -15,7 +15,9 @@ module RuboCop
       #   assert_path_exists(path)
       #   assert_path_exists(path, 'message')
       #
-      class AssertPathExists < Cop
+      class AssertPathExists < Base
+        extend AutoCorrector
+
         MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
         RESTRICT_ON_SEND = %i[assert].freeze
 
@@ -32,17 +34,8 @@ module RuboCop
             good_method = build_good_method(path, failure_message)
             message = format(MSG, good_method: good_method, bad_method: node.source)
 
-            add_offense(node, message: message)
-          end
-        end
-
-        def autocorrect(node)
-          assert_file_exists(node) do |path, failure_message|
-            failure_message = failure_message.first
-
-            lambda do |corrector|
-              replacement = build_good_method(path, failure_message)
-              corrector.replace(node, replacement)
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(node, good_method)
             end
           end
         end

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

@@ -17,7 +17,7 @@ module RuboCop
       #   assert_respond_to(object, :do_something, 'message')
       #   assert_respond_to(self, :do_something)
       #
-      class AssertRespondTo < Cop
+      class AssertRespondTo < Base
         extend MinitestCopRule
 
         define_rule :assert, target_method: :respond_to?

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

@@ -13,7 +13,9 @@ module RuboCop
       #   # good
       #   assert_silent { puts object.do_something }
       #
-      class AssertSilent < Cop
+      class AssertSilent < Base
+        extend AutoCorrector
+
         MSG = 'Prefer using `assert_silent` over `assert_output("", "")`.'
 
         def_node_matcher :assert_silent_candidate?, <<~PATTERN
@@ -25,12 +27,12 @@ module RuboCop
         PATTERN
 
         def on_block(node)
-          add_offense(node.send_node) if assert_silent_candidate?(node)
-        end
+          return unless assert_silent_candidate?(node)
+
+          send_node = node.send_node
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node, 'assert_silent')
+          add_offense(send_node) do |corrector|
+            corrector.replace(send_node, 'assert_silent')
           end
         end