rubocop-minitest 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30d74ad78ccdb578c6cc6e19c201f1b14869fea35d42f20c951e2a3ccd9da72d
-  data.tar.gz: 4ebac2d4e8a5efc3b0238388769986db1ab0625812cc378f0acd907428a180df
+  metadata.gz: 7e4abf180bb13a43bdb76c4c4e376c9d156dc4e48f3bce9b4171a2432bceda9b
+  data.tar.gz: '083ae2d51b7dafed513e7372eab667f9deea384676e0748af92d49c629ca9efe'
 SHA512:
-  metadata.gz: a6b65afa72586fd58d096ce07858b0373cb65d9ba637807d557e7043347856e3ad69bd0fba61e1ef80fb69fb2928a4f6234200e40454ac068b85ec6579f03c36
-  data.tar.gz: c5d62abb9019d7b89c7c4e5b2e50cbf696e1ef6fd31323c2674648faa1f535f50e96f45778f3b17078126a74a4e324125f3ec34b054a3f44ec91288d9046e221
+  metadata.gz: 562f5efee32059aa022c9a742745a89a752ad7d74f136f17b54f84a21f9d6a0030e905c8a00ab09782274f1c1544134bc6d8d6cb0d03e7e2de70b65dcb9309a3
+  data.tar.gz: 32d58f40bb69b87ed83ff3c342e255de7afaba760330f345d09b987ce352161577a9ee8f16677a2172cc59b48006efecb6272e71e90318281143fffe3155654b

data/config/default.yml

@@ -111,9 +111,9 @@ Minitest/AssertTruthy:
   Description: 'This cop enforces the test to use `assert(actual)` instead of using `assert_equal(true, actual)`.'
   StyleGuide: 'https://minitest.rubystyle.guide#assert-truthy'
   Enabled: true
-  SafeAutoCorrect: false
+  Safe: false
   VersionAdded: '0.2'
-  VersionChanged: '0.26'
+  VersionChanged: '0.27'
 
 Minitest/AssertWithExpectedArgument:
   Description: 'This cop tries to detect when a user accidentally used `assert` when they meant to use `assert_equal`.'
@@ -175,6 +175,12 @@ Minitest/NoAssertions:
   Enabled: false
   VersionAdded: '0.12'
 
+Minitest/NonPublicTestMethod:
+  Description: 'Detects non `public` (marked as `private` or `protected`) test methods.'
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '0.27'
+
 Minitest/RefuteEmpty:
   Description: 'This cop enforces to use `refute_empty` instead of using `refute(object.empty?)`.'
   StyleGuide: 'https://minitest.rubystyle.guide#refute-empty'
@@ -191,7 +197,9 @@ Minitest/RefuteFalse:
   Description: 'Check if your test uses `refute(actual)` instead of `assert_equal(false, actual)`.'
   StyleGuide: 'https://minitest.rubystyle.guide#refute-false'
   Enabled: true
+  Safe: false
   VersionAdded: '0.3'
+  VersionChanged: '0.27'
 
 Minitest/RefuteInDelta:
   Description: 'This cop enforces the test to use `refute_in_delta` instead of using `refute_equal` to compare floats.'

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

@@ -6,7 +6,14 @@ module RuboCop
       # Enforces the test to use `assert(actual)` instead of using `assert_equal(true, actual)`.
       #
       # @safety
-      #   This cop's autocorrection is unsafe because true might be expected instead of truthy.
+      #   This cop is unsafe because true might be expected instead of truthy.
+      #   False positives cannot be prevented when this is a variable or method return value.
+      #
+      #   [source,ruby]
+      #   ----
+      #   assert_equal(true, 'truthy') # failure
+      #   assert('truthy')             # success
+      #   ----
       #
       # @example
       #   # bad

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

@@ -49,12 +49,6 @@ module RuboCop
 
         private
 
-        def assertions_count(node)
-          node.each_descendant(:send).count do |send_node|
-            assertion_method?(send_node)
-          end
-        end
-
         def max_assertions
           Integer(cop_config.fetch('Max', 3))
         end

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

@@ -35,13 +35,6 @@ module RuboCop
             add_offense(node.block_type? ? node.loc.expression : node.loc.name)
           end
         end
-
-        private
-
-        def assertions_count(node)
-          base = assertion_method?(node) ? 1 : 0
-          base + node.each_child_node.sum { |c| assertions_count(c) }
-        end
       end
     end
   end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Detects non `public` (marked as `private` or `protected`) test methods.
+      # Minitest runs only test methods which are `public`.
+      #
+      # @example
+      #   # bad
+      #   class FooTest
+      #     private # or protected
+      #     def test_does_something
+      #       assert_equal 42, do_something
+      #     end
+      #   end
+      #
+      #   # good
+      #   class FooTest
+      #     def test_does_something
+      #       assert_equal 42, do_something
+      #     end
+      #   end
+      #
+      #   # good (not a test case name)
+      #   class FooTest
+      #     private # or protected
+      #     def does_something
+      #       assert_equal 42, do_something
+      #     end
+      #   end
+      #
+      #   # good (no assertions)
+      #   class FooTest
+      #     private # or protected
+      #     def test_does_something
+      #       do_something
+      #     end
+      #   end
+      #
+      class NonPublicTestMethod < Base
+        include MinitestExplorationHelpers
+        include DefNode
+
+        MSG = 'Non `public` test method detected. Make it `public` for it to run.'
+
+        def on_class(node)
+          test_cases(node, visibility_check: false).each do |test_case|
+            add_offense(test_case) if non_public?(test_case) && assertions(test_case).any?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,16 @@ module RuboCop
     module Minitest
       # Enforces the use of `refute(object)` over `assert_equal(false, object)`.
       #
+      # @safety
+      #   This cop is unsafe because it cannot detect failure when second argument is `nil`.
+      #   False positives cannot be prevented when this is a variable or method return value.
+      #
+      #   [source,ruby]
+      #   ----
+      #   assert_equal(false, nil) # failure
+      #   refute(nil)              # success
+      #   ----
+      #
       # @example
       #   # bad
       #   assert_equal(false, actual)

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

@@ -37,7 +37,7 @@ module RuboCop
         def on_class(class_node)
           return unless test_class?(class_node)
 
-          class_elements(class_node).each do |node|
+          class_def_nodes(class_node).each do |node|
             next unless offense?(node)
 
             test_method_name = node.loc.name
@@ -50,17 +50,6 @@ module RuboCop
 
         private
 
-        def class_elements(class_node)
-          class_def = class_node.body
-          return [] unless class_def
-
-          if class_def.def_type?
-            [class_def]
-          else
-            class_def.each_child_node(:def).to_a
-          end
-        end
-
         def offense?(node)
           return false if assertions(node).none?
 

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

@@ -46,7 +46,7 @@ module RuboCop
 
           case node.method_name
           when *SINGLE_ASSERTION_ARGUMENT_METHODS
-            actual.nil? && expected&.literal?
+            actual.nil? && expected&.literal? && !expected.xstr_type?
           when *TWO_ASSERTION_ARGUMENTS_METHODS
             return false unless expected || actual
             return false if expected.source != actual.source

data/lib/rubocop/cop/minitest_cops.rb

@@ -33,6 +33,7 @@ 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/non_public_test_method'
 require_relative 'minitest/refute_empty'
 require_relative 'minitest/refute_false'
 require_relative 'minitest/refute_equal'

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

@@ -7,6 +7,7 @@ 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
@@ -27,14 +28,16 @@ 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)
 
         class_ancestor = node.each_ancestor(:class).first
         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_cases = 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
@@ -43,6 +46,12 @@ module RuboCop
         test_cases + test_blocks
       end
 
+      def test_method?(def_node, visibility_check: true)
+        return false if visibility_check && non_public?(def_node)
+
+        test_case_name?(def_node.method_name) && !def_node.arguments?
+      end
+
       def lifecycle_hooks(class_node)
         class_def_nodes(class_node)
           .select { |def_node| lifecycle_hook_method?(def_node) }
@@ -77,6 +86,12 @@ 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 if !node.send_type? && !node.block_type?
 

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
@@ -77,6 +77,7 @@ module RuboCop
 
       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
       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.26.1'
+      STRING = '0.27.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.26.1
+  version: 0.27.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -85,6 +85,7 @@ files:
 - 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/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
@@ -124,7 +125,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.26
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.27
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Automatic Minitest code style checking tool.