rubocop-minitest 0.10.1 → 0.12.0

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,11 @@ 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
 
         def_node_matcher :equal_floats_call, <<~PATTERN
           (send nil? :assert_equal $_ $_ $...)

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,11 +15,13 @@ 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)`.'
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
 
         def_node_matcher :assert_equal_with_nil, <<~PATTERN
           (send nil? :assert_equal nil $_ $...)
@@ -31,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,8 +15,11 @@ 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
 
         def_node_matcher :assert_file_exists, <<~PATTERN
           (send nil? :assert
@@ -31,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
 

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

@@ -15,11 +15,13 @@ module RuboCop
       #   assert(actual)
       #   assert(actual, 'message')
       #
-      class AssertTruthy < Cop
+      class AssertTruthy < Base
         include ArgumentRangeHelper
+        extend AutoCorrector
 
         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 $_ $...)
@@ -31,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_truthy(node) do |actual|
+            add_offense(node, message: format(MSG, arguments: arguments)) do |corrector|
               corrector.replace(node.loc.selector, 'assert')
-              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_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 < Base
+        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/assertion_in_lifecycle_hook.rb

@@ -20,7 +20,7 @@ module RuboCop
       #     end
       #   end
       #
-      class AssertionInLifecycleHook < Cop
+      class AssertionInLifecycleHook < Base
         include MinitestExplorationHelpers
 
         MSG = 'Do not use `%<assertion>s` in `%<hook>s` hook.'

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

@@ -16,7 +16,9 @@ module RuboCop
       #   _(musts).must_equal expected_musts
       #   _(wonts).wont_match expected_wonts
       #   _ { musts }.must_raise TypeError
-      class GlobalExpectations < Cop
+      class GlobalExpectations < Base
+        extend AutoCorrector
+
         MSG = 'Use `%<preferred>s` instead.'
 
         VALUE_MATCHERS = %i[
@@ -30,6 +32,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
@@ -62,13 +66,8 @@ module RuboCop
           return unless value_global_expectation?(node) || block_global_expectation?(node)
 
           message = format(MSG, preferred: preferred_receiver(node))
-          add_offense(node, location: node.receiver.source_range, message: message)
-        end
-
-        def autocorrect(node)
-          return unless value_global_expectation?(node) || block_global_expectation?(node)
 
-          lambda do |corrector|
+          add_offense(node.receiver.source_range, message: message) do |corrector|
             receiver = node.receiver.source_range
 
             if BLOCK_MATCHERS.include?(node.method_name)

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

@@ -17,34 +17,35 @@ module RuboCop
       #   assert_equal [1, 2], foo
       #   assert_equal [1, 2], foo, 'message'
       #
-      class LiteralAsActualArgument < Cop
+      class LiteralAsActualArgument < Base
         include ArgumentRangeHelper
+        extend AutoCorrector
 
         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)
 
           actual = node.arguments[1]
-          return unless actual
+          return unless actual&.recursive_basic_literal?
 
-          add_offense(node, location: all_arguments_range(node)) if actual.recursive_basic_literal?
+          add_offense(all_arguments_range(node)) do |corrector|
+            autocorrect(corrector, node)
+          end
         end
 
-        def autocorrect(node)
+        def autocorrect(corrector, node)
           expected, actual, message = *node.arguments
 
-          lambda do |corrector|
-            new_actual_source =
-              if actual.hash_type? && !actual.braces?
-                "{#{actual.source}}"
-              else
-                actual.source
-              end
-            arguments = [new_actual_source, expected.source, message&.source].compact.join(', ')
+          new_actual_source = if actual.hash_type? && !actual.braces?
+                                "{#{actual.source}}"
+                              else
+                                actual.source
+                              end
+          arguments = [new_actual_source, expected.source, message&.source].compact.join(', ')
 
-            corrector.replace(node, "assert_equal(#{arguments})")
-          end
+          corrector.replace(node, "assert_equal(#{arguments})")
         end
       end
     end

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

@@ -26,7 +26,7 @@ module RuboCop
       #     end
       #   end
       #
-      class MultipleAssertions < Cop
+      class MultipleAssertions < Base
         include ConfigurableMax
         include MinitestExplorationHelpers
 
@@ -43,7 +43,7 @@ module RuboCop
             self.max = assertions_count
 
             message = format(MSG, total: assertions_count, max: max_assertions)
-            add_offense(node, location: :name, message: message)
+            add_offense(node.loc.name, message: message)
           end
         end
 

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop checks if test cases contain any assertion calls.
+      #
+      # @example
+      #   # bad
+      #   class FooTest < Minitest::Test
+      #     def test_the_truth
+      #     end
+      #   end
+      #
+      #   # good
+      #   class FooTest < Minitest::Test
+      #     def test_the_truth
+      #       assert true
+      #     end
+      #   end
+      #
+      class NoAssertions < Base
+        include MinitestExplorationHelpers
+
+        MSG = 'Test case has no assertions.'
+
+        def on_class(class_node)
+          return unless test_class?(class_node)
+
+          test_cases(class_node).each do |node|
+            assertions_count = assertions_count(node)
+
+            next if assertions_count.positive?
+
+            add_offense(node.block_type? ? node.loc.expression : node.loc.name)
+          end
+        end
+
+        private
+
+        def assertions_count(node)
+          base = assertion?(node) ? 1 : 0
+          base + node.each_child_node.sum { |c| assertions_count(c) }
+        end
+      end
+    end
+  end
+end

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

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

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
@@ -14,11 +14,13 @@ module RuboCop
       #   # good
       #   refute_equal("rubocop-minitest", actual)
       #
-      class RefuteEqual < Cop
+      class RefuteEqual < Base
         include ArgumentRangeHelper
+        extend AutoCorrector
 
         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 $_ :! ) :== $_) } $... )
@@ -28,13 +30,10 @@ module RuboCop
           preferred, over = process_not_equal(node)
           return unless preferred && over
 
-          message = format(MSG, preferred: preferred, over: over)
-          add_offense(node, message: message)
-        end
+          assert_not_equal(node) do |_, expected, actual|
+            message = format(MSG, preferred: preferred, over: over)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            assert_not_equal(node) do |_, expected, actual|
+            add_offense(node, message: message) do |corrector|
               corrector.replace(node.loc.selector, 'refute_equal')
 
               replacement = [expected, actual].map(&:source).join(', ')