rubocop-minitest 0.10.0 → 0.11.1

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

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

@@ -1,6 +1,17 @@
+= Cops
+
+In RuboCop lingo the various checks performed on the code are called cops.
+Each cop is responsible for detecting one particular offense.
+RuboCop Minitest has only one Minitest department.
+
+== Minitest
+
+Minitest cops check for Minitest best practices and coding conventions. Many of the them are
+based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
+
 // START_COP_LIST
 
-= Department xref:cops_minitest.adoc[Minitest]
+=== Department xref:cops_minitest.adoc[Minitest]
 
 * xref:cops_minitest.adoc#minitestassertempty[Minitest/AssertEmpty]
 * xref:cops_minitest.adoc#minitestassertemptyliteral[Minitest/AssertEmptyLiteral]
@@ -16,6 +27,7 @@
 * xref:cops_minitest.adoc#minitestassertrespondto[Minitest/AssertRespondTo]
 * xref:cops_minitest.adoc#minitestassertsilent[Minitest/AssertSilent]
 * xref:cops_minitest.adoc#minitestasserttruthy[Minitest/AssertTruthy]
+* xref:cops_minitest.adoc#minitestassertwithexpectedargument[Minitest/AssertWithExpectedArgument]
 * xref:cops_minitest.adoc#minitestassertioninlifecyclehook[Minitest/AssertionInLifecycleHook]
 * xref:cops_minitest.adoc#minitestglobalexpectations[Minitest/GlobalExpectations]
 * xref:cops_minitest.adoc#minitestliteralasactualargument[Minitest/LiteralAsActualArgument]

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

@@ -41,19 +41,19 @@ assert_empty(object, 'message')
 | Yes
 | Yes (Unsafe)
 | 0.5
-| 0.10
+| 0.11
 |===
 
 This cop enforces the test to use `assert_empty`
-instead of using `assert([], object)`.
+instead of using `assert_equal([], object)`.
 
 === Examples
 
 [source,ruby]
 ----
 # bad
-assert([], object)
-assert({}, object)
+assert_equal([], object)
+assert_equal({}, object)
 
 # good
 assert_empty(object)
@@ -215,7 +215,7 @@ assert_kind_of(Class, object, 'message')
 
 === References
 
-* https://github.com/rubocop-hq/minitest-style-guide#assert-kind-of
+* https://github.com/rubocop/minitest-style-guide#assert-kind-of
 
 == Minitest/AssertMatch
 
@@ -407,7 +407,7 @@ assert_silent { puts object.do_something }
 
 === References
 
-* https://github.com/rubocop-hq/minitest-style-guide#assert-silent
+* https://github.com/rubocop/minitest-style-guide#assert-silent
 
 == Minitest/AssertTruthy
 
@@ -441,6 +441,38 @@ assert(actual, 'message')
 
 * https://minitest.rubystyle.guide#assert-truthy
 
+== Minitest/AssertWithExpectedArgument
+
+|===
+| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+
+| Pending
+| No
+| No
+| 0.11
+| -
+|===
+
+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]
+----
+# bad
+assert(3, my_list.length)
+assert(expected, actual)
+
+# good
+assert_equal(3, my_list.length)
+assert_equal(expected, actual)
+assert(foo, 'message')
+----
+
 == Minitest/AssertionInLifecycleHook
 
 |===
@@ -638,7 +670,7 @@ refute_empty(object, 'message')
 |===
 
 This cop enforces the use of `refute_equal(expected, object)`
-over `assert_equal(expected != actual)` or `assert(! expected == actual)`.
+over `assert(expected != actual)` or `assert(! expected == actual)`.
 
 === Examples
 
@@ -817,7 +849,7 @@ refute_kind_of(Class, object, 'message')
 
 === References
 
-* https://github.com/rubocop-hq/minitest-style-guide#refute-kind-of
+* https://github.com/rubocop/minitest-style-guide#refute-kind-of
 
 == Minitest/RefuteMatch
 
@@ -962,6 +994,7 @@ refute_respond_to(self, :do_something)
 |===
 
 This cop enforces that test method names start with `test_` prefix.
+It aims to prevent tests that aren't executed by forgetting to start test method name with `test_`.
 
 === Examples
 
@@ -980,6 +1013,12 @@ class FooTest < Minitest::Test
     assert_equal 42, do_something
   end
 end
+
+# good
+class FooTest < Minitest::Test
+  def helper_method(argument)
+  end
+end
 ----
 
 == Minitest/UnspecifiedException

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

@@ -1,5 +1,5 @@
 = RuboCop Minitest
 
-A https://github.com/rubocop-hq/rubocop[RuboCop] extension focused on enforcing Minitest best practices and coding conventions.
+A https://github.com/rubocop/rubocop[RuboCop] extension focused on enforcing Minitest best practices and coding conventions.
 
 It's based on the community-driven https://minitest.rubystyle.guide[Minitest style guide].

data/legacy-docs/cops_minitest.md

@@ -23,7 +23,7 @@ assert_empty(object, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-empty](https://github.com/rubocop-hq/minitest-style-guide#assert-empty)
+* [https://github.com/rubocop/minitest-style-guide#assert-empty](https://github.com/rubocop/minitest-style-guide#assert-empty)
 
 ## Minitest/AssertEmptyLiteral
 
@@ -66,7 +66,7 @@ assert_equal("rubocop-minitest", actual)
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-equal-arguments-order](https://github.com/rubocop-hq/minitest-style-guide#assert-equal-arguments-order)
+* [https://github.com/rubocop/minitest-style-guide#assert-equal-arguments-order](https://github.com/rubocop/minitest-style-guide#assert-equal-arguments-order)
 
 ## Minitest/AssertIncludes
 
@@ -91,7 +91,7 @@ assert_includes(collection, object, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-includes](https://github.com/rubocop-hq/minitest-style-guide#assert-includes)
+* [https://github.com/rubocop/minitest-style-guide#assert-includes](https://github.com/rubocop/minitest-style-guide#assert-includes)
 
 ## Minitest/AssertInstanceOf
 
@@ -116,7 +116,7 @@ assert_instance_of(Class, object, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-instance-of](https://github.com/rubocop-hq/minitest-style-guide#assert-instance-of)
+* [https://github.com/rubocop/minitest-style-guide#assert-instance-of](https://github.com/rubocop/minitest-style-guide#assert-instance-of)
 
 ## Minitest/AssertMatch
 
@@ -141,7 +141,7 @@ assert_match(matcher, string, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-match](https://github.com/rubocop-hq/minitest-style-guide#assert-match)
+* [https://github.com/rubocop/minitest-style-guide#assert-match](https://github.com/rubocop/minitest-style-guide#assert-match)
 
 ## Minitest/AssertNil
 
@@ -166,7 +166,7 @@ assert_nil(actual, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-nil](https://github.com/rubocop-hq/minitest-style-guide#assert-nil)
+* [https://github.com/rubocop/minitest-style-guide#assert-nil](https://github.com/rubocop/minitest-style-guide#assert-nil)
 
 ## Minitest/AssertRespondTo
 
@@ -193,7 +193,7 @@ assert_respond_to(self, :do_something)
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-responds-to-method](https://github.com/rubocop-hq/minitest-style-guide#assert-responds-to-method)
+* [https://github.com/rubocop/minitest-style-guide#assert-responds-to-method](https://github.com/rubocop/minitest-style-guide#assert-responds-to-method)
 
 ## Minitest/AssertTruthy
 
@@ -218,7 +218,7 @@ assert(actual, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#assert-truthy](https://github.com/rubocop-hq/minitest-style-guide#assert-truthy)
+* [https://github.com/rubocop/minitest-style-guide#assert-truthy](https://github.com/rubocop/minitest-style-guide#assert-truthy)
 
 ## Minitest/GlobalExpectations
 
@@ -266,7 +266,7 @@ refute_empty(object, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-empty](https://github.com/rubocop-hq/minitest-style-guide#refute-empty)
+* [https://github.com/rubocop/minitest-style-guide#refute-empty](https://github.com/rubocop/minitest-style-guide#refute-empty)
 
 ## Minitest/RefuteEqual
 
@@ -290,7 +290,7 @@ refute_equal("rubocop-minitest", actual)
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-equal](https://github.com/rubocop-hq/minitest-style-guide#refute-equal)
+* [https://github.com/rubocop/minitest-style-guide#refute-equal](https://github.com/rubocop/minitest-style-guide#refute-equal)
 
 ## Minitest/RefuteFalse
 
@@ -318,7 +318,7 @@ refute(actual, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-false](https://github.com/rubocop-hq/minitest-style-guide#refute-false)
+* [https://github.com/rubocop/minitest-style-guide#refute-false](https://github.com/rubocop/minitest-style-guide#refute-false)
 
 ## Minitest/RefuteIncludes
 
@@ -343,7 +343,7 @@ refute_includes(collection, object, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-includes](https://github.com/rubocop-hq/minitest-style-guide#refute-includes)
+* [https://github.com/rubocop/minitest-style-guide#refute-includes](https://github.com/rubocop/minitest-style-guide#refute-includes)
 
 ## Minitest/RefuteInstanceOf
 
@@ -368,7 +368,7 @@ refute_instance_of(Class, object, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-instance-of](https://github.com/rubocop-hq/minitest-style-guide#refute-instance-of)
+* [https://github.com/rubocop/minitest-style-guide#refute-instance-of](https://github.com/rubocop/minitest-style-guide#refute-instance-of)
 
 ## Minitest/RefuteMatch
 
@@ -393,7 +393,7 @@ refute_match(matcher, string, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-match](https://github.com/rubocop-hq/minitest-style-guide#refute-match)
+* [https://github.com/rubocop/minitest-style-guide#refute-match](https://github.com/rubocop/minitest-style-guide#refute-match)
 
 ## Minitest/RefuteNil
 
@@ -418,7 +418,7 @@ refute_nil(actual, 'message')
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-nil](https://github.com/rubocop-hq/minitest-style-guide#refute-nil)
+* [https://github.com/rubocop/minitest-style-guide#refute-nil](https://github.com/rubocop/minitest-style-guide#refute-nil)
 
 ## Minitest/RefuteRespondTo
 
@@ -445,4 +445,4 @@ refute_respond_to(self, :do_something)
 
 ### References
 
-* [https://github.com/rubocop-hq/minitest-style-guide#refute-respond-to](https://github.com/rubocop-hq/minitest-style-guide#refute-respond-to)
+* [https://github.com/rubocop/minitest-style-guide#refute-respond-to](https://github.com/rubocop/minitest-style-guide#refute-respond-to)

data/legacy-docs/index.md

@@ -1 +1 @@
-A [RuboCop](https://github.com/rubocop-hq/rubocop) extension focused on enforcing Minitest best practices and coding conventions.
+A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing Minitest best practices and coding conventions.

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

@@ -4,12 +4,12 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the test to use `assert_empty`
-      # instead of using `assert([], object)`.
+      # instead of using `assert_equal([], object)`.
       #
       # @example
       #   # bad
-      #   assert([], object)
-      #   assert({}, object)
+      #   assert_equal([], object)
+      #   assert_equal({}, object)
       #
       #   # good
       #   assert_empty(object)
@@ -18,14 +18,15 @@ module RuboCop
         include ArgumentRangeHelper
 
         MSG = 'Prefer using `assert_empty(%<arguments>s)` over ' \
-              '`assert(%<literal>s, %<arguments>s)`.'
+              '`assert_equal(%<literal>s, %<arguments>s)`.'
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
 
-        def_node_matcher :assert_with_empty_literal, <<~PATTERN
-          (send nil? :assert ${hash array} $...)
+        def_node_matcher :assert_equal_with_empty_literal, <<~PATTERN
+          (send nil? :assert_equal ${hash array} $...)
         PATTERN
 
         def on_send(node)
-          assert_with_empty_literal(node) do |literal, matchers|
+          assert_equal_with_empty_literal(node) do |literal, matchers|
             return unless literal.values.empty?
 
             args = matchers.map(&:source).join(', ')
@@ -36,7 +37,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          assert_with_empty_literal(node) do |_literal, matchers|
+          assert_equal_with_empty_literal(node) do |_literal, matchers|
             object = matchers.first
 
             lambda do |corrector|

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

@@ -18,6 +18,8 @@ module RuboCop
       class AssertInDelta < Cop
         include InDeltaMixin
 
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
+
         def_node_matcher :equal_floats_call, <<~PATTERN
           (send nil? :assert_equal $_ $_ $...)
         PATTERN

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

@@ -20,6 +20,7 @@ module RuboCop
 
         MSG = 'Prefer using `assert_nil(%<arguments>s)` over ' \
               '`assert_equal(nil, %<arguments>s)`.'
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
 
         def_node_matcher :assert_equal_with_nil, <<~PATTERN
           (send nil? :assert_equal nil $_ $...)

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

@@ -17,6 +17,7 @@ module RuboCop
       #
       class AssertPathExists < Cop
         MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
+        RESTRICT_ON_SEND = %i[assert].freeze
 
         def_node_matcher :assert_file_exists, <<~PATTERN
           (send nil? :assert

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

@@ -20,6 +20,7 @@ module RuboCop
 
         MSG = 'Prefer using `assert(%<arguments>s)` over ' \
               '`assert_equal(true, %<arguments>s)`.'
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
 
         def_node_matcher :assert_equal_with_truthy, <<~PATTERN
           (send nil? :assert_equal true $_ $...)

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # 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.
+      #
+      # @example
+      #   # bad
+      #   assert(3, my_list.length)
+      #   assert(expected, actual)
+      #
+      #   # good
+      #   assert_equal(3, my_list.length)
+      #   assert_equal(expected, actual)
+      #   assert(foo, 'message')
+      #
+      class AssertWithExpectedArgument < Cop
+        MSG = 'Did you mean to use `assert_equal(%<arguments>s)`?'
+        RESTRICT_ON_SEND = %i[assert].freeze
+
+        def_node_matcher :assert_with_two_arguments?, <<~PATTERN
+          (send nil? :assert $_ $_)
+        PATTERN
+
+        def on_send(node)
+          assert_with_two_arguments?(node) do |_expected, message|
+            return if message.str_type? || message.dstr_type?
+
+            arguments = node.arguments.map(&:source).join(', ')
+            add_offense(node, message: format(MSG, arguments: arguments))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -30,6 +30,8 @@ module RuboCop
 
         BLOCK_MATCHERS = %i[must_output must_raise must_be_silent must_throw].freeze
 
+        RESTRICT_ON_SEND = VALUE_MATCHERS + BLOCK_MATCHERS
+
         VALUE_MATCHERS_STR = VALUE_MATCHERS.map do |m|
           ":#{m}"
         end.join(' ').freeze

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

@@ -21,6 +21,7 @@ module RuboCop
         include ArgumentRangeHelper
 
         MSG = 'Replace the literal with the first argument.'
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
 
         def on_send(node)
           return unless node.method?(:assert_equal)

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the use of `refute_equal(expected, object)`
-      # over `assert_equal(expected != actual)` or `assert(! expected == actual)`.
+      # over `assert(expected != actual)` or `assert(! expected == actual)`.
       #
       # @example
       #   # bad
@@ -19,6 +19,7 @@ module RuboCop
 
         MSG = 'Prefer using `refute_equal(%<preferred>s)` over ' \
               '`assert(%<over>s)`.'
+        RESTRICT_ON_SEND = %i[assert].freeze
 
         def_node_matcher :assert_not_equal, <<~PATTERN
           (send nil? :assert ${(send $_ :!= $_) (send (send $_ :! ) :== $_) } $... )