rubocop-minitest 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d404efc9a07a82ed435c474b1c4370afa1d36e92f11ec1176911dbe677577c
-  data.tar.gz: '079e6fe08096eae97e74790ffda49a120fd5d1b06d15968666d83e046ec821a7'
+  metadata.gz: a6ade83745f0a777cea6d2e37dfc8f00e7bc0857be549dd5b2d9544df4a201eb
+  data.tar.gz: 2afc383a877712b659efc1771fa6d44093ce4d11618ff37b23aa561dd1a986f6
 SHA512:
-  metadata.gz: adf9211bbf6d285987b8bea806bafd15961a8307ea8f6baec4b7ab8d248a571782883ba619bb3542fb440a7ed218daf73b8166e09c33537b52042bcd306aa81e
-  data.tar.gz: 94b7021203ca9992df0278ca2d753a7e6c03a54b8a5f49ca3231caf7b8f9b1dd40db791d3504f08bce49bee9e84e1a658cf741785ad74daa03df661dd68ac704
+  metadata.gz: fb1ecc48cb4f9563903aefa53ff3667f5509aa4f785bdb6fb1ab6ddfa240e5f034f0eae80ce991bde1ff19a925e426fdb19f78d3c41928c426da0068ad686d78
+  data.tar.gz: 16fbf8fe16331074e1ed953c96b45a327986701fd62a78d8b14325ffeaea96a619a2773f37665c5231fcf5fb90c40ca145fe1d24ae78924199dbb9b223ecab68

data/config/default.yml

@@ -272,6 +272,12 @@ Minitest/RefuteSame:
   Enabled: pending
   VersionAdded: '0.26'
 
+Minitest/ReturnInTestMethod:
+  Description: 'Enforces the use of `skip` instead of `return` in test methods.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#skipping-runnable-methods'
+  Enabled: pending
+  VersionAdded: '0.31'
+
 Minitest/SkipEnsure:
   Description: 'Checks that `ensure` call even if `skip`.'
   Enabled: pending

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

@@ -3,7 +3,8 @@
 module RuboCop
   module Cop
     module Minitest
-      # Checks if test cases contain too many assertion calls.
+      # Checks if test cases contain too many assertion calls. If conditional code with assertions
+      # is used, the branch with maximum assertions is counted.
       # The maximum allowed assertion calls is configurable.
       #
       # @example Max: 1
@@ -36,7 +37,7 @@ module RuboCop
           return unless test_class?(class_node)
 
           test_cases(class_node).each do |node|
-            assertions_count = assertions_count(node)
+            assertions_count = assertions_count(node.body)
 
             next unless assertions_count > max_assertions
 
@@ -49,6 +50,29 @@ module RuboCop
 
         private
 
+        def assertions_count(node)
+          return 0 unless node.is_a?(RuboCop::AST::Node)
+
+          assertions =
+            case node.type
+            when :if, :case, :case_match
+              assertions_count_in_branches(node.branches)
+            when :rescue
+              assertions_count(node.body) + assertions_count_in_branches(node.branches)
+            when :block, :numblock
+              assertions_count(node.body)
+            else
+              node.each_child_node.sum { |child| assertions_count(child) }
+            end
+
+          assertions += 1 if assertion_method?(node)
+          assertions
+        end
+
+        def assertions_count_in_branches(branches)
+          branches.map { |branch| assertions_count(branch) }.max
+        end
+
         def max_assertions
           Integer(cop_config.fetch('Max', 3))
         end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Enforces the use of `skip` instead of `return` in test methods.
+      #
+      # @example
+      #   # bad
+      #   def test_something
+      #     return if condition?
+      #     assert_equal(42, something)
+      #   end
+      #
+      #   # good
+      #   def test_something
+      #     skip if condition?
+      #     assert_equal(42, something)
+      #   end
+      #
+      class ReturnInTestMethod < Base
+        include MinitestExplorationHelpers
+        extend AutoCorrector
+
+        MSG = 'Use `skip` instead of `return`.'
+
+        def on_return(node)
+          return unless node.ancestors.any? { |parent| test_case?(parent) }
+          return if inside_block?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, 'skip')
+          end
+        end
+
+        private
+
+        def inside_block?(node)
+          node.ancestors.any?(&:block_type?) || node.ancestors.any?(&:numblock_type?)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest_cops.rb

@@ -29,6 +29,7 @@ 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'

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

@@ -34,7 +34,7 @@ module RuboCop
                             (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, visibility_check: true)
@@ -100,7 +100,7 @@ module RuboCop
       end
 
       def assertion_method?(node)
-        return false if !node.send_type? && !node.block_type?
+        return false if !node.send_type? && !node.block_type? && !node.numblock_type?
 
         ASSERTION_PREFIXES.any? do |prefix|
           method_name = node.method_name

data/lib/rubocop/minitest/assert_offense.rb

@@ -216,7 +216,7 @@ module RuboCop
       end
 
       def ruby_version
-        2.6
+        RuboCop::TargetRuby::DEFAULT_VERSION
       end
     end
     # rubocop:enable Metrics/ModuleLength

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.30.0'
+      STRING = '0.31.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.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -87,6 +87,7 @@ files:
 - 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
@@ -114,7 +115,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.30
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.31
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -125,7 +126,7 @@ 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:
   - - ">="