rubocop-minitest 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e4abf180bb13a43bdb76c4c4e376c9d156dc4e48f3bce9b4171a2432bceda9b
-  data.tar.gz: '083ae2d51b7dafed513e7372eab667f9deea384676e0748af92d49c629ca9efe'
+  metadata.gz: 938714064905717403a5e63e0cfcca49356b3240c85f2fc26247faefa08ff65f
+  data.tar.gz: 2db37113c89cc16952a020d3a42f4cf3b94ee067b85b3460c0ef9786c69fe338
 SHA512:
-  metadata.gz: 562f5efee32059aa022c9a742745a89a752ad7d74f136f17b54f84a21f9d6a0030e905c8a00ab09782274f1c1544134bc6d8d6cb0d03e7e2de70b65dcb9309a3
-  data.tar.gz: 32d58f40bb69b87ed83ff3c342e255de7afaba760330f345d09b987ce352161577a9ee8f16677a2172cc59b48006efecb6272e71e90318281143fffe3155654b
+  metadata.gz: c9322ed01a4e6598b65742584421c1e92609d8340e6e077df7eb4126abdf842e646ff33a7ae6577ab1649bc2a9ab212645d607fe3db467596a0e8d61517f823e
+  data.tar.gz: bd62a8d102301b4898ab9c23696b8159bb0ba4c3257d37c7e91ba70263d72bf887cfb257e6e0fa060101305f011cf707d47fa69c82e9b1ce4701a47252ab7b35

data/config/default.yml

@@ -158,6 +158,12 @@ Minitest/GlobalExpectations:
   VersionAdded: '0.7'
   VersionChanged: '0.26'
 
+Minitest/LifecycleHooksOrder:
+  Description: 'Checks that lifecycle hooks are declared in the order in which they will be executed.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#hooks-ordering'
+  Enabled: pending
+  VersionAdded: '0.28'
+
 Minitest/LiteralAsActualArgument:
   Description: 'This cop enforces correct order of `expected` and `actual` arguments for `assert_equal`.'
   StyleGuide: 'https://minitest.rubystyle.guide/#assert-equal-arguments-order'

data/lib/rubocop/cop/generator.rb

@@ -10,7 +10,7 @@ module RuboCop
       TEST_TEMPLATE = <<~TEST
         # frozen_string_literal: true
 
-        require 'test_helper'
+        require_relative '../../../test_helper'
 
         class %<cop_name>sTest < Minitest::Test
           def test_registers_offense_when_using_bad_method

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

@@ -9,6 +9,8 @@ module RuboCop
       # @example
       #   # bad
       #   assert(matcher.match(string))
+      #   assert(matcher.match?(string))
+      #   assert(matcher =~ string)
       #   assert(matcher.match(string), 'message')
       #
       #   # good
@@ -18,7 +20,8 @@ module RuboCop
       class AssertMatch < Base
         extend MinitestCopRule
 
-        define_rule :assert, target_method: :match, inverse: 'regexp_type?'
+        define_rule :assert, target_method: %i[match match? =~],
+                             preferred_method: :assert_match, inverse: 'regexp_type?'
       end
     end
   end

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

@@ -36,8 +36,7 @@ module RuboCop
         private
 
         def find_test_case(node)
-          def_ancestor = node.each_ancestor(:def).first
-          def_ancestor if test_case?(def_ancestor)
+          node.each_ancestor.find { |ancestor| test_case?(ancestor) }
         end
 
         def references_gvar?(assertion, gvar_name)

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Checks that lifecycle hooks are declared in the order in which they will be executed.
+      #
+      # @example
+      #   # bad
+      #   class FooTest < Minitest::Test
+      #     def teardown; end
+      #     def setup; end
+      #   end
+      #
+      #   # good
+      #   class FooTest < Minitest::Test
+      #     def setup; end
+      #     def teardown; end
+      #   end
+      #
+      #   # bad (after test cases)
+      #   class FooTest < Minitest::Test
+      #     def test_something
+      #       assert foo
+      #     end
+      #     def setup; end
+      #     def teardown; end
+      #   end
+      #
+      #   # good
+      #   class FooTest < Minitest::Test
+      #     def setup; end
+      #     def teardown; end
+      #     def test_something
+      #       assert foo
+      #     end
+      #   end
+      #
+      #   # good (after non test case methods)
+      #   class FooTest < Minitest::Test
+      #     def do_something; end
+      #     def setup; end
+      #     def teardown; end
+      #   end
+      #
+      class LifecycleHooksOrder < Base
+        include MinitestExplorationHelpers
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = '`%<current>s` is supposed to appear before `%<previous>s`.'
+
+        # Regular method's position should be last.
+        REGULAR_METHOD_POSITION = LIFECYCLE_HOOK_METHODS_IN_ORDER.size + 1
+        HOOKS_ORDER_MAP = Hash.new do |hash, hook|
+          hash[hook] = LIFECYCLE_HOOK_METHODS_IN_ORDER.index(hook) || REGULAR_METHOD_POSITION
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def on_class(class_node)
+          return unless test_class?(class_node)
+
+          previous_index = -1
+          previous_hook_node = nil
+
+          hooks_and_test_cases(class_node).each do |node|
+            hook = node.method_name
+            index = HOOKS_ORDER_MAP[hook]
+
+            if index < previous_index
+              message = format(MSG, current: hook, previous: previous_hook_node.method_name)
+              add_offense(node, message: message) do |corrector|
+                autocorrect(corrector, previous_hook_node, node)
+              end
+            end
+            previous_index = index
+            previous_hook_node = node
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        def hooks_and_test_cases(class_node)
+          class_def_nodes(class_node).select do |node|
+            lifecycle_hook_method?(node) || test_case?(node)
+          end
+        end
+
+        def autocorrect(corrector, previous_node, node)
+          previous_node_range = range_with_comments_and_lines(previous_node)
+          node_range = range_with_comments_and_lines(node)
+
+          corrector.insert_before(previous_node_range, node_range.source)
+          corrector.remove(node_range)
+        end
+      end
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ module RuboCop
 
             next if assertions_count.positive?
 
-            add_offense(node.block_type? ? node.loc.expression : node.loc.name)
+            add_offense(node.block_type? ? node.source_range : node.loc.name)
           end
         end
       end

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

@@ -9,6 +9,8 @@ module RuboCop
       # @example
       #   # bad
       #   refute(matcher.match(string))
+      #   refute(matcher.match?(string))
+      #   refute(matcher =~ string)
       #   refute(matcher.match(string), 'message')
       #
       #   # good
@@ -18,7 +20,8 @@ module RuboCop
       class RefuteMatch < Base
         extend MinitestCopRule
 
-        define_rule :refute, target_method: :match, inverse: 'regexp_type?'
+        define_rule :refute, target_method: %i[match match? =~],
+                             preferred_method: :refute_match, inverse: 'regexp_type?'
       end
     end
   end

data/lib/rubocop/cop/minitest_cops.rb

@@ -30,6 +30,7 @@ require_relative 'minitest/duplicate_test_run'
 require_relative 'minitest/empty_line_before_assertion_methods'
 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'

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)

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

@@ -12,14 +12,16 @@ module RuboCop
 
       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
 
@@ -28,22 +30,23 @@ module RuboCop
       end
 
       def test_case?(node)
-        return false unless node&.def_type? && test_method?(node)
+        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)
       end
 
       def test_cases(class_node, visibility_check: true)
-        test_cases = class_def_nodes(class_node).select do |def_node|
+        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| block.method?(:test) || block.method?(:it) }
+        test_blocks = class_node.each_descendant(:block).select { |block_node| test_block?(block_node) }
 
-        test_cases + test_blocks
+        test_methods + test_blocks
       end
 
       def test_method?(def_node, visibility_check: true)
@@ -52,6 +55,10 @@ module RuboCop
         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)
         class_def_nodes(class_node)
           .select { |def_node| lifecycle_hook_method?(def_node) }

data/lib/rubocop/minitest/assert_offense.rb

@@ -124,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

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.27.0'
+      STRING = '0.29.0'
 
       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.27.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-03-06 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.
@@ -82,6 +68,7 @@ files:
 - 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
@@ -125,7 +112,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.27
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.29
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message: