rubocop-minitest 0.10.1 → 0.12.0

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

@@ -18,13 +18,15 @@ module RuboCop
       #   refute(actual)
       #   refute(actual, 'message')
       #
-      class RefuteFalse < Cop
+      class RefuteFalse < Base
         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)`.'
+        RESTRICT_ON_SEND = %i[assert_equal assert].freeze
 
         def_node_matcher :assert_equal_with_false, <<~PATTERN
           (send nil? :assert_equal false $_ $...)
@@ -35,38 +37,29 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          actual, rest_receiver_arg = assert_equal_with_false(node) ||
-                                      assert_with_bang_argument(node)
+          actual, rest_receiver_arg = assert_equal_with_false(node) || assert_with_bang_argument(node)
           return unless actual
 
           message_argument = rest_receiver_arg.first
 
           arguments = [actual.source, message_argument&.source].compact.join(', ')
 
-          message = if node.method?(:assert_equal)
-                      MSG_FOR_ASSERT_EQUAL
-                    else
-                      MSG_FOR_ASSERT
-                    end
+          message = node.method?(:assert_equal) ? MSG_FOR_ASSERT_EQUAL : MSG_FOR_ASSERT
 
-          add_offense(node, message: format(message, arguments: arguments))
+          add_offense(node, message: format(message, arguments: arguments)) do |corrector|
+            autocorrect(corrector, node, actual)
+          end
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, 'refute')
+        private
 
-            assert_equal_with_false(node) do |actual|
-              corrector.replace(
-                first_and_second_arguments_range(node), actual.source
-              )
-            end
+        def autocorrect(corrector, node, actual)
+          corrector.replace(node.loc.selector, 'refute')
 
-            assert_with_bang_argument(node) do |actual|
-              corrector.replace(
-                first_argument_range(node), actual.source
-              )
-            end
+          if node.method?(:assert_equal)
+            corrector.replace(first_and_second_arguments_range(node), actual.source)
+          else
+            corrector.replace(first_argument_range(node), actual.source)
           end
         end
       end

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

@@ -15,8 +15,11 @@ module RuboCop
       #   refute_in_delta(0.2, actual)
       #   refute_in_delta(0.2, actual, 0.001, 'message')
       #
-      class RefuteInDelta < Cop
+      class RefuteInDelta < Base
         include InDeltaMixin
+        extend AutoCorrector
+
+        RESTRICT_ON_SEND = %i[refute_equal].freeze
 
         def_node_matcher :equal_floats_call, <<~PATTERN
           (send nil? :refute_equal $_ $_ $...)

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

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

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

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

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

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

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

@@ -15,7 +15,7 @@ module RuboCop
       #   refute_match(matcher, string)
       #   refute_match(matcher, string, 'message')
       #
-      class RefuteMatch < Cop
+      class RefuteMatch < Base
         extend MinitestCopRule
 
         define_rule :refute, target_method: :match

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

@@ -15,11 +15,13 @@ module RuboCop
       #   refute_nil(actual)
       #   refute_nil(actual, 'message')
       #
-      class RefuteNil < Cop
+      class RefuteNil < Base
         include ArgumentRangeHelper
+        extend AutoCorrector
 
         MSG = 'Prefer using `refute_nil(%<arguments>s)` over ' \
               '`refute_equal(nil, %<arguments>s)`.'
+        RESTRICT_ON_SEND = %i[refute_equal].freeze
 
         def_node_matcher :refute_equal_with_nil, <<~PATTERN
           (send nil? :refute_equal nil $_ $...)
@@ -31,13 +33,7 @@ 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|
-            refute_equal_with_nil(node) do |actual|
+            add_offense(node, message: format(MSG, arguments: arguments)) do |corrector|
               corrector.replace(node.loc.selector, 'refute_nil')
               corrector.replace(
                 first_and_second_arguments_range(node), actual.source

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

@@ -15,8 +15,11 @@ module RuboCop
       #   refute_path_exists(path)
       #   refute_path_exists(path, 'message')
       #
-      class RefutePathExists < Cop
+      class RefutePathExists < Base
+        extend AutoCorrector
+
         MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
+        RESTRICT_ON_SEND = %i[refute].freeze
 
         def_node_matcher :refute_file_exists, <<~PATTERN
           (send nil? :refute
@@ -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)
-          refute_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/refute_respond_to.rb

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

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

@@ -4,6 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # 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_`.
       #
       # @example
       #   # bad
@@ -20,9 +21,16 @@ module RuboCop
       #     end
       #   end
       #
-      class TestMethodName < Cop
+      #   # good
+      #   class FooTest < Minitest::Test
+      #     def helper_method(argument)
+      #     end
+      #   end
+      #
+      class TestMethodName < Base
         include MinitestExplorationHelpers
         include DefNode
+        extend AutoCorrector
 
         MSG = 'Test method name should start with `test_` prefix.'
 
@@ -30,13 +38,13 @@ module RuboCop
           return unless test_class?(class_node)
 
           class_elements(class_node).each do |node|
-            add_offense(node, location: :name) if offense?(node)
-          end
-        end
+            next unless offense?(node)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.name, "test_#{node.method_name}")
+            test_method_name = node.loc.name
+
+            add_offense(test_method_name) do |corrector|
+              corrector.replace(test_method_name, "test_#{node.method_name}")
+            end
           end
         end
 
@@ -54,7 +62,9 @@ module RuboCop
         end
 
         def offense?(node)
-          public?(node) && !test_method_name?(node) && !lifecycle_hook_method?(node)
+          return false if assertions(node).none?
+
+          public?(node) && node.arguments.empty? && !test_method_name?(node) && !lifecycle_hook_method?(node)
         end
 
         def public?(node)

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

@@ -14,7 +14,7 @@ module RuboCop
       #   assert_raises(FooException) { raise FooException }
       #   assert_raises(FooException, 'This should have raised') { raise FooException }
       #
-      class UnspecifiedException < Cop
+      class UnspecifiedException < Base
         MSG = 'Specify the exception being captured.'
 
         def on_block(block_node)

data/lib/rubocop/cop/minitest_cops.rb

@@ -8,6 +8,7 @@ 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_with_expected_argument'
 require_relative 'minitest/assertion_in_lifecycle_hook'
 require_relative 'minitest/assert_kind_of'
 require_relative 'minitest/assert_nil'
@@ -22,6 +23,7 @@ require_relative 'minitest/assert_truthy'
 require_relative 'minitest/global_expectations'
 require_relative 'minitest/literal_as_actual_argument'
 require_relative 'minitest/multiple_assertions'
+require_relative 'minitest/no_assertions'
 require_relative 'minitest/refute_empty'
 require_relative 'minitest/refute_false'
 require_relative 'minitest/refute_equal'

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

@@ -9,24 +9,14 @@ module RuboCop
       def on_send(node)
         equal_floats_call(node) do |expected, actual, message|
           message = message.first
+          good_method = build_good_method(expected, actual, message)
 
           if expected.float_type? || actual.float_type?
-            message = format(MSG,
-                             good_method: build_good_method(expected, actual, message),
-                             bad_method: node.source)
+            message = format(MSG, good_method: good_method, bad_method: node.source)
 
-            add_offense(node, message: message)
-          end
-        end
-      end
-
-      def autocorrect(node)
-        equal_floats_call(node) do |expected, actual, message|
-          message = message.first
-          replacement = build_good_method(expected, actual, message)
-
-          lambda do |corrector|
-            corrector.replace(node, replacement)
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(node, good_method)
+            end
           end
         end
       end

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

@@ -26,38 +26,38 @@ module RuboCop
 
         class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           include ArgumentRangeHelper
+          extend AutoCorrector
 
           MSG = 'Prefer using `#{preferred_method}(%<new_arguments>s)` over ' \
                 '`#{assertion_method}(%<original_arguments>s)`.'
+          RESTRICT_ON_SEND = %i[#{assertion_method}].freeze
 
           def on_send(node)
             return unless node.method?(:#{assertion_method})
             return unless (arguments = peel_redundant_parentheses_from(node.arguments))
             return unless arguments.first.respond_to?(:method?) && arguments.first.method?(:#{target_method})
 
-            add_offense(node, message: offense_message(arguments))
+            add_offense(node, message: offense_message(arguments)) do |corrector|
+              autocorrect(corrector, node, arguments)
+            end
           end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, '#{preferred_method}')
-
-              arguments = peel_redundant_parentheses_from(node.arguments)
+          def autocorrect(corrector, node, arguments)
+            corrector.replace(node.loc.selector, '#{preferred_method}')
 
-              new_arguments = new_arguments(arguments).join(', ')
+            new_arguments = new_arguments(arguments).join(', ')
 
-              if enclosed_in_redundant_parentheses?(node)
-                new_arguments = '(' + new_arguments + ')'
-              end
-
-              corrector.replace(first_argument_range(node), new_arguments)
+            if enclosed_in_redundant_parentheses?(node)
+              new_arguments = '(' + new_arguments + ')'
             end
+
+            corrector.replace(first_argument_range(node), new_arguments)
           end
 
           private
 
           def peel_redundant_parentheses_from(arguments)
-            return arguments unless arguments.first.begin_type?
+            return arguments unless arguments.first&.begin_type?
 
             peel_redundant_parentheses_from(arguments.first.children)
           end

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

@@ -10,6 +10,17 @@ 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
@@ -33,8 +44,8 @@ module RuboCop
       end
 
       def test_cases(class_node)
-        class_def_nodes(class_node)
-          .select { |def_node| test_case_name?(def_node.method_name) }
+        (class_def_nodes(class_node).select { |def_node| test_case_name?(def_node.method_name) }) +
+          test_method_calls(class_node)
       end
 
       def lifecycle_hooks(class_node)
@@ -53,6 +64,12 @@ module RuboCop
         end
       end
 
+      # support https://api.rubyonrails.org/classes/ActiveSupport/Testing/Declarative.html
+      def test_method_calls(class_node)
+        block_nodes = class_node.each_descendant(:block)
+        block_nodes.select { |block_node| block_node.method?(:test) }
+      end
+
       def test_case_name?(name)
         name.to_s.start_with?('test_')
       end
@@ -73,7 +90,14 @@ module RuboCop
 
       def assertion?(node)
         node.send_type? &&
-          ASSERTION_PREFIXES.any? { |prefix| node.method_name.to_s.start_with?(prefix) }
+          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?(method_name)
+        method_name == FLUNK || ASSERTION_METHODS.include?(method_name)
       end
 
       def lifecycle_hook_method?(node)

data/lib/rubocop/minitest/version.rb

@@ -2,6 +2,13 @@
 
 module RuboCop
   module Minitest
-    VERSION = '0.10.1'
+    # This module holds the RuboCop Minitest version information.
+    module Version
+      STRING = '0.12.0'
+
+      def self.document_version
+        STRING.match('\d+\.\d+').to_s
+      end
+    end
   end
 end

data/mkdocs.yml

@@ -1,7 +1,7 @@
 site_name: "A RuboCop extension focused on enforcing Minitest best practices and coding conventions."
-repo_url: https://github.com/rubocop-hq/rubocop-minitest
+repo_url: https://github.com/rubocop/rubocop-minitest
 edit_uri: edit/master/legacy-docs/
-copyright: "Copyright © 2019 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO, and RuboCop contributors"
+copyright: "Copyright © 2021 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO, and RuboCop contributors"
 docs_dir: legacy-docs
 pages:
 - Home: index.md