rubocop-minitest 0.22.2 → 0.32.2

data/lib/rubocop/cop/minitest_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative 'mixin/argument_range_helper'
 require_relative 'mixin/in_delta_mixin'
+require_relative 'mixin/instance_of_assertion_handleable'
 require_relative 'mixin/minitest_cop_rule'
 require_relative 'mixin/minitest_exploration_helpers'
 require_relative 'mixin/nil_assertion_handleable'
@@ -10,6 +11,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_operator'
 require_relative 'minitest/assert_predicate'
 require_relative 'minitest/assert_raises_compound_body'
 require_relative 'minitest/assert_raises_with_regexp_argument'
@@ -23,26 +25,37 @@ require_relative 'minitest/assert_match'
 require_relative 'minitest/assert_output'
 require_relative 'minitest/assert_path_exists'
 require_relative 'minitest/assert_respond_to'
+require_relative 'minitest/assert_same'
 require_relative 'minitest/assert_silent'
 require_relative 'minitest/assert_truthy'
 require_relative 'minitest/duplicate_test_run'
+require_relative 'minitest/empty_line_before_assertion_methods'
+require_relative 'minitest/return_in_test_method'
+require_relative 'minitest/test_file_name'
 require_relative 'minitest/global_expectations'
+require_relative 'minitest/lifecycle_hooks_order'
 require_relative 'minitest/literal_as_actual_argument'
 require_relative 'minitest/multiple_assertions'
 require_relative 'minitest/no_assertions'
+require_relative 'minitest/no_test_cases'
+require_relative 'minitest/non_public_test_method'
 require_relative 'minitest/refute_empty'
 require_relative 'minitest/refute_false'
 require_relative 'minitest/refute_equal'
 require_relative 'minitest/refute_in_delta'
-require_relative 'minitest/refute_kind_of'
-require_relative 'minitest/refute_nil'
 require_relative 'minitest/refute_includes'
-require_relative 'minitest/refute_match'
 require_relative 'minitest/refute_instance_of'
+require_relative 'minitest/refute_kind_of'
+require_relative 'minitest/refute_match'
+require_relative 'minitest/refute_nil'
+require_relative 'minitest/refute_operator'
 require_relative 'minitest/refute_path_exists'
 require_relative 'minitest/refute_predicate'
 require_relative 'minitest/refute_respond_to'
+require_relative 'minitest/refute_same'
 require_relative 'minitest/skip_ensure'
+require_relative 'minitest/skip_without_reason'
 require_relative 'minitest/test_method_name'
 require_relative 'minitest/unreachable_assertion'
 require_relative 'minitest/unspecified_exception'
+require_relative 'minitest/useless_assertion'

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

@@ -9,12 +9,6 @@ module RuboCop
 
       private
 
-      def first_argument_range(node)
-        first_argument = node.first_argument
-
-        range_between(first_argument.source_range.begin_pos, first_argument.source_range.end_pos)
-      end
-
       def first_and_second_arguments_range(node)
         first_argument = node.first_argument
         second_argument = node.arguments[1]

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Common functionality for `Minitest/AssertInstanceOf` and `Minitest/RefuteInstanceOf` cops.
+      # @api private
+      module InstanceOfAssertionHandleable
+        include ArgumentRangeHelper
+
+        MSG = 'Prefer using `%<prefer>s`.'
+
+        private
+
+        def investigate(node, assertion_type)
+          return unless (first_capture, second_capture, message = instance_of_assertion?(node))
+
+          required_arguments = build_required_arguments(node, assertion_type, first_capture, second_capture)
+          full_arguments = [required_arguments, message.first&.source].compact.join(', ')
+          prefer = "#{assertion_type}_instance_of(#{full_arguments})"
+
+          add_offense(node, message: format(MSG, prefer: prefer)) do |corrector|
+            range = replacement_range(node, assertion_type)
+
+            corrector.replace(node.loc.selector, "#{assertion_type}_instance_of")
+            corrector.replace(range, required_arguments)
+          end
+        end
+
+        def build_required_arguments(node, method_name, first_capture, second_capture)
+          if node.method?(method_name)
+            [second_capture, first_capture]
+          else
+            [first_capture, second_capture]
+          end.map(&:source).join(', ')
+        end
+
+        def replacement_range(node, method_name)
+          if node.method?(method_name)
+            node.first_argument
+          else
+            first_and_second_arguments_range(node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,9 +13,14 @@ module RuboCop
       #   define_rule :assert, target_method: :include?, preferred_method: :assert_includes
       #   define_rule :assert, target_method: :instance_of?, inverse: true
       #
+      # @example Multiple target methods
+      #   # `preferred_method` is required
+      #   define_rule :assert, target_method: %i[match match? =~],
+      #               preferred_method: :assert_match, inverse: 'regexp_type?'
+      #
       # @param assertion_method [Symbol] Assertion method like `assert` or `refute`.
-      # @param target_method [Symbol] Method name offensed by assertion method arguments.
-      # @param preferred_method [Symbol] An optional param. Custom method name replaced by
+      # @param target_method [Symbol, Array<Symbol>] Method name(s) offensed by assertion method arguments.
+      # @param preferred_method [Symbol] Is required if passing multiple target methods. Custom method name replaced by
       #                                  autocorrection. The preferred method name that connects
       #                                  `assertion_method` and `target_method` with `_` is
       #                                  the default name.
@@ -24,7 +29,12 @@ module RuboCop
       # @api private
       #
       def define_rule(assertion_method, target_method:, preferred_method: nil, inverse: false)
-        preferred_method = "#{assertion_method}_#{target_method.to_s.delete('?')}" if preferred_method.nil?
+        target_methods = Array(target_method)
+        if target_methods.size > 1 && preferred_method.nil?
+          raise ArgumentError, '`:preferred_method` keyword argument must be used if using more than one target method.'
+        end
+
+        preferred_method = "#{assertion_method}_#{target_methods.first.to_s.delete('?')}" if preferred_method.nil?
 
         class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           include ArgumentRangeHelper
@@ -37,7 +47,8 @@ module RuboCop
             return unless node.method?(:#{assertion_method})
             return unless (arguments = peel_redundant_parentheses_from(node.arguments))
             return unless arguments.first&.call_type?
-            return if arguments.first.arguments.empty? || !arguments.first.method?(:#{target_method})
+            return if arguments.first.arguments.empty? ||
+                      #{target_methods}.none? { |target_method| arguments.first.method?(target_method) }
 
             add_offense(node, message: offense_message(arguments)) do |corrector|
               autocorrect(corrector, node, arguments)
@@ -53,7 +64,7 @@ module RuboCop
               new_arguments = '(' + new_arguments + ')'
             end
 
-            corrector.replace(first_argument_range(node), new_arguments)
+            corrector.replace(node.first_argument, new_arguments)
           end
 
           private

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

@@ -7,18 +7,21 @@ module RuboCop
     # Helper methods for different explorations against test files and test cases.
     # @api private
     module MinitestExplorationHelpers
+      include DefNode
       extend NodePattern::Macros
 
       ASSERTION_PREFIXES = %w[assert refute].freeze
 
-      LIFECYCLE_HOOK_METHODS = %i[
+      LIFECYCLE_HOOK_METHODS_IN_ORDER = %i[
         before_setup
         setup
         after_setup
         before_teardown
         teardown
         after_teardown
-      ].to_set.freeze
+      ].freeze
+
+      LIFECYCLE_HOOK_METHODS = LIFECYCLE_HOOK_METHODS_IN_ORDER.to_set.freeze
 
       private
 
@@ -27,20 +30,33 @@ module RuboCop
       end
 
       def test_case?(node)
-        return false unless node&.def_type? && test_case_name?(node.method_name)
+        return false unless (node&.def_type? && test_method?(node)) ||
+                            (node&.block_type? && test_block?(node))
 
         class_ancestor = node.each_ancestor(:class).first
-        test_class?(class_ancestor)
+        class_ancestor && test_class?(class_ancestor)
       end
 
-      def test_cases(class_node)
-        test_cases = class_def_nodes(class_node).select { |def_node| test_case_name?(def_node.method_name) }
+      def test_cases(class_node, visibility_check: true)
+        test_methods = class_def_nodes(class_node).select do |def_node|
+          test_method?(def_node, visibility_check: visibility_check)
+        end
 
         # Support Active Support's `test 'example' { ... }` method.
         # https://api.rubyonrails.org/classes/ActiveSupport/Testing/Declarative.html
-        test_blocks = class_node.each_descendant(:block).select { |block_node| block_node.method?(:test) }
+        test_blocks = class_node.each_descendant(:block).select { |block_node| test_block?(block_node) }
+
+        test_methods + test_blocks
+      end
+
+      def test_method?(def_node, visibility_check: true)
+        return false if visibility_check && non_public?(def_node)
 
-        test_cases + test_blocks
+        test_case_name?(def_node.method_name) && !def_node.arguments?
+      end
+
+      def test_block?(block_node)
+        block_node.method?(:test) || block_node.method?(:it)
       end
 
       def lifecycle_hooks(class_node)
@@ -77,14 +93,19 @@ module RuboCop
         send_nodes.select { |send_node| assertion_method?(send_node) }
       end
 
+      def assertions_count(node)
+        node.each_descendant(:send).count do |send_node|
+          assertion_method?(send_node)
+        end
+      end
+
       def assertion_method?(node)
-        return false unless node.send_type?
+        return false if !node.send_type? && !node.block_type? && !node.numblock_type?
 
         ASSERTION_PREFIXES.any? do |prefix|
           method_name = node.method_name
 
-          # TODO: Remove the fllowing `to_s` since Ruby 2.7 that supports `Symbol#start_with?`.
-          method_name.to_s.start_with?(prefix) || node.method?(:flunk)
+          method_name.start_with?(prefix) || node.method?(:flunk)
         end
       end
 

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

@@ -28,7 +28,7 @@ module RuboCop
 
           new_arguments = new_arguments(arguments).join(', ')
 
-          corrector.replace(first_argument_range(node), new_arguments)
+          corrector.replace(node.first_argument, new_arguments)
         end
 
         private

data/lib/rubocop/minitest/assert_offense.rb

@@ -10,7 +10,7 @@ module RuboCop
     #
     # This mixin makes it easier to specify strict offense assertions
     # in a declarative and visual fashion. Just type out the code that
-    # should generate a offense, annotate code by writing '^'s
+    # should generate an offense, annotate code by writing '^'s
     # underneath each character that should be highlighted, and follow
     # the carets with a string (separated by a space) that is the
     # message of the offense. You can include multiple offenses in
@@ -70,13 +70,26 @@ module RuboCop
     #   RUBY
     #
     #   assert_no_corrections
+    #
+    # rubocop:disable Metrics/ModuleLength
     module AssertOffense
       private
 
       def setup
         cop_name = self.class.to_s.delete_suffix('Test')
+        return unless RuboCop::Cop::Minitest.const_defined?(cop_name)
+
+        @cop = RuboCop::Cop::Minitest.const_get(cop_name).new(configuration)
+      end
 
-        @cop = RuboCop::Cop::Minitest.const_get(cop_name).new
+      def format_offense(source, **replacements)
+        replacements.each do |keyword, value|
+          value = value.to_s
+          source = source.gsub("%{#{keyword}}", value)
+                         .gsub("^{#{keyword}}", '^' * value.size)
+                         .gsub("_{#{keyword}}", ' ' * value.size)
+        end
+        source
       end
 
       def assert_no_offenses(source, file = nil)
@@ -90,11 +103,12 @@ module RuboCop
         assert_equal(source, actual_annotations.to_s)
       end
 
-      def assert_offense(source, file = nil)
+      def assert_offense(source, file = nil, **replacements)
         setup_assertion
 
         @cop.instance_variable_get(:@options)[:autocorrect] = true
 
+        source = format_offense(source, **replacements)
         expected_annotations = RuboCop::RSpec::ExpectOffense::AnnotatedSource.parse(source)
         if expected_annotations.plain_source == source
           raise 'Use `assert_no_offenses` to assert that no offenses are found'
@@ -110,7 +124,7 @@ module RuboCop
       end
 
       def _investigate(cop, processed_source)
-        team = RuboCop::Cop::Team.new([cop], nil, raise_error: true)
+        team = RuboCop::Cop::Team.new([cop], configuration, raise_error: true)
         report = team.investigate(processed_source)
         @last_corrector = report.correctors.first || RuboCop::Cop::Corrector.new(processed_source)
         report.offenses
@@ -172,12 +186,39 @@ module RuboCop
           file = file.path
         end
 
-        RuboCop::ProcessedSource.new(source, ruby_version, file)
+        processed_source = RuboCop::ProcessedSource.new(source, ruby_version, file)
+
+        # Follow up https://github.com/rubocop/rubocop/pull/10987.
+        # When support for RuboCop 1.37.1 ends, this condition can be removed.
+        if processed_source.respond_to?(:config) && processed_source.respond_to?(:registry)
+          processed_source.config = configuration
+          processed_source.registry = registry
+        end
+
+        processed_source
+      end
+
+      def configuration
+        @configuration ||= if defined?(config)
+                             config
+                           else
+                             RuboCop::Config.new({}, "#{Dir.pwd}/.rubocop.yml")
+                           end
+      end
+
+      def registry
+        @registry ||= begin
+          cops = configuration.keys.map { |cop| RuboCop::Cop::Registry.global.find_by_cop_name(cop) }
+          cops << cop_class if defined?(cop_class) && !cops.include?(cop_class)
+          cops.compact!
+          RuboCop::Cop::Registry.new(cops)
+        end
       end
 
       def ruby_version
-        2.6
+        RuboCop::TargetRuby::DEFAULT_VERSION
       end
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.22.2
+  version: 0.32.2
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.90'
+        version: '1.39'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -28,24 +28,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.90'
+        version: '1.39'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
 description: |
   Automatic Minitest code style checking tool.
   A RuboCop extension focused on enforcing Minitest best practices and coding conventions.
@@ -68,21 +54,27 @@ files:
 - lib/rubocop/cop/minitest/assert_kind_of.rb
 - lib/rubocop/cop/minitest/assert_match.rb
 - lib/rubocop/cop/minitest/assert_nil.rb
+- lib/rubocop/cop/minitest/assert_operator.rb
 - lib/rubocop/cop/minitest/assert_output.rb
 - lib/rubocop/cop/minitest/assert_path_exists.rb
 - lib/rubocop/cop/minitest/assert_predicate.rb
 - lib/rubocop/cop/minitest/assert_raises_compound_body.rb
 - lib/rubocop/cop/minitest/assert_raises_with_regexp_argument.rb
 - lib/rubocop/cop/minitest/assert_respond_to.rb
+- lib/rubocop/cop/minitest/assert_same.rb
 - lib/rubocop/cop/minitest/assert_silent.rb
 - lib/rubocop/cop/minitest/assert_truthy.rb
 - lib/rubocop/cop/minitest/assert_with_expected_argument.rb
 - lib/rubocop/cop/minitest/assertion_in_lifecycle_hook.rb
 - lib/rubocop/cop/minitest/duplicate_test_run.rb
+- lib/rubocop/cop/minitest/empty_line_before_assertion_methods.rb
 - lib/rubocop/cop/minitest/global_expectations.rb
+- lib/rubocop/cop/minitest/lifecycle_hooks_order.rb
 - lib/rubocop/cop/minitest/literal_as_actual_argument.rb
 - lib/rubocop/cop/minitest/multiple_assertions.rb
 - lib/rubocop/cop/minitest/no_assertions.rb
+- lib/rubocop/cop/minitest/no_test_cases.rb
+- lib/rubocop/cop/minitest/non_public_test_method.rb
 - lib/rubocop/cop/minitest/refute_empty.rb
 - lib/rubocop/cop/minitest/refute_equal.rb
 - lib/rubocop/cop/minitest/refute_false.rb
@@ -92,16 +84,23 @@ files:
 - lib/rubocop/cop/minitest/refute_kind_of.rb
 - lib/rubocop/cop/minitest/refute_match.rb
 - lib/rubocop/cop/minitest/refute_nil.rb
+- lib/rubocop/cop/minitest/refute_operator.rb
 - lib/rubocop/cop/minitest/refute_path_exists.rb
 - lib/rubocop/cop/minitest/refute_predicate.rb
 - lib/rubocop/cop/minitest/refute_respond_to.rb
+- lib/rubocop/cop/minitest/refute_same.rb
+- lib/rubocop/cop/minitest/return_in_test_method.rb
 - lib/rubocop/cop/minitest/skip_ensure.rb
+- lib/rubocop/cop/minitest/skip_without_reason.rb
+- lib/rubocop/cop/minitest/test_file_name.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/useless_assertion.rb
 - lib/rubocop/cop/minitest_cops.rb
 - lib/rubocop/cop/mixin/argument_range_helper.rb
 - lib/rubocop/cop/mixin/in_delta_mixin.rb
+- lib/rubocop/cop/mixin/instance_of_assertion_handleable.rb
 - lib/rubocop/cop/mixin/minitest_cop_rule.rb
 - lib/rubocop/cop/mixin/minitest_exploration_helpers.rb
 - lib/rubocop/cop/mixin/nil_assertion_handleable.rb
@@ -118,7 +117,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.22
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.32
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -129,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Automatic Minitest code style checking tool.