rubocop-minitest 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c318725a3a6fe8afca027a338421a451831204768bfbd0a36ad80beb28d64c2
-  data.tar.gz: cd62f5d9c99d4451f12ab079e5593da29d4a5e154d7654c36df4cc65e2b9d618
+  metadata.gz: 90dad8a03c65bc80912012a2dacd5e8f6dd89485c72930a6348d16f489d2a8a9
+  data.tar.gz: 5465e2ad38af5358f9942cf47fbeffc00abbee76dec902835d3fa67be2a678fd
 SHA512:
-  metadata.gz: e93c50c17543b7618acfb1b78566d0be02b476469a32b74855b8393917286695ff0414975b71ede3c749bf7d2191550a3ae2cdb4a98cd481bfd528d510b2eca2
-  data.tar.gz: c2b106af9e68a77ace2c9eb44a49fbf2afea7d854cd3985c0d845dfa16ab39e9dcd50700d1e16f093d44014444a1946fe34641988033bab4988361c5e7ea06ed
+  metadata.gz: 6d330efbe33b77b6bc18263644316525831433ef9f9a6e911fc2262ae698c7a90f0cc32a5a3f0ef021cea89f96cca3c355c9573f65a0a7479fceae61db7c3bbf
+  data.tar.gz: 3f3487a2714c447d9b6cc97f28d8e1767835b25f2feb160bf967b86f90f77242de8d0ce07d50fc6992786112ac06ade62870e4d83887fb4c964a8cfcd9a40248

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2022 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
+Copyright (c) 2019-2023 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/config/default.yml

@@ -85,7 +85,9 @@ Minitest/AssertRaisesCompoundBody:
 Minitest/AssertRaisesWithRegexpArgument:
   Description: 'This cop enforces checks for regular expression literals passed to `assert_raises`.'
   Enabled: pending
+  Severity: warning
   VersionAdded: '0.22'
+  VersionChanged: '0.26'
 
 Minitest/AssertRespondTo:
   Description: 'This cop enforces the test to use `assert_respond_to(object, :do_something)` over `assert(object.respond_to?(:do_something))`.'
@@ -93,6 +95,12 @@ Minitest/AssertRespondTo:
   Enabled: true
   VersionAdded: '0.3'
 
+Minitest/AssertSame:
+  Description: 'Enforces the use of `assert_same(expected, actual)` over `assert(expected.equal?(actual))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-same'
+  Enabled: pending
+  VersionAdded: '0.26'
+
 Minitest/AssertSilent:
   Description: "This cop enforces the test to use `assert_silent { ... }` instead of using `assert_output('', '') { ... }`."
   StyleGuide: 'https://github.com/rubocop/minitest-style-guide#assert-silent'
@@ -103,13 +111,17 @@ 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
   VersionAdded: '0.2'
+  VersionChanged: '0.26'
 
 Minitest/AssertWithExpectedArgument:
   Description: 'This cop tries to detect when a user accidentally used `assert` when they meant to use `assert_equal`.'
   Enabled: pending
+  Severity: warning
   Safe: false
   VersionAdded: '0.11'
+  VersionChanged: '0.26'
 
 Minitest/AssertionInLifecycleHook:
   Description: 'This cop checks for usage of assertions in lifecycle hooks.'
@@ -131,6 +143,7 @@ Minitest/GlobalExpectations:
   Description: 'This cop checks for deprecated global expectations.'
   StyleGuide: 'https://minitest.rubystyle.guide#global-expectations'
   Enabled: true
+  Severity: warning
   EnforcedStyle: any
   Include:
     - '**/test/**/*'
@@ -143,7 +156,7 @@ Minitest/GlobalExpectations:
     - expect
     - value
   VersionAdded: '0.7'
-  VersionChanged: '0.16'
+  VersionChanged: '0.26'
 
 Minitest/LiteralAsActualArgument:
   Description: 'This cop enforces correct order of `expected` and `actual` arguments for `assert_equal`.'
@@ -234,16 +247,30 @@ Minitest/RefuteRespondTo:
   Enabled: true
   VersionAdded: '0.4'
 
+Minitest/RefuteSame:
+  Description: 'Enforces the use of `refute_same(expected, actual)` over `refute(expected.equal?(actual))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-same'
+  Enabled: pending
+  VersionAdded: '0.26'
+
 Minitest/SkipEnsure:
   Description: 'Checks that `ensure` call even if `skip`.'
   Enabled: pending
+  Severity: warning
   VersionAdded: '0.20'
+  VersionChanged: '0.26'
 
 Minitest/SkipWithoutReason:
   Description: 'Checks for skipped tests missing the skipping reason.'
   Enabled: pending
   VersionAdded: '0.24'
 
+Minitest/TestFileName:
+  Description: 'Checks if test file names start with `test_` or end with `_test.rb`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#file-naming'
+  Enabled: pending
+  VersionAdded: '0.26'
+
 Minitest/TestMethodName:
   Description: 'This cop enforces that test method names start with `test_` prefix.'
   Enabled: 'pending'
@@ -252,10 +279,17 @@ Minitest/TestMethodName:
 Minitest/UnreachableAssertion:
   Description: 'This cop checks for an `assert_raises` block containing any unreachable assertions.'
   Enabled: pending
+  Severity: warning
   VersionAdded: '0.14'
+  VersionChanged: '0.26'
 
 Minitest/UnspecifiedException:
   Description: 'This cop checks for a specified error in `assert_raises`.'
   StyleGuide: 'https://minitest.rubystyle.guide#unspecified-exception'
   Enabled: 'pending'
   VersionAdded: '0.10'
+
+Minitest/UselessAssertion:
+  Description: 'Detects useless assertions (assertions that either always pass or always fail).'
+  Enabled: pending
+  VersionAdded: '0.26'

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Enforces the use of `assert_same(expected, actual)`
+      # over `assert(expected.equal?(actual))`.
+      #
+      # NOTE: Use `assert_same` only when there is a need to compare by identity.
+      #       Otherwise, use `assert_equal`.
+      #
+      # @example
+      #   # bad
+      #   assert(expected.equal?(actual))
+      #
+      #   # good
+      #   assert_same(expected, actual)
+      #
+      class AssertSame < Base
+        extend MinitestCopRule
+
+        define_rule :assert, target_method: :equal?, preferred_method: :assert_same
+      end
+    end
+  end
+end

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

@@ -5,6 +5,9 @@ module RuboCop
     module Minitest
       # 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.
+      #
       # @example
       #   # bad
       #   assert_equal(true, actual)

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

@@ -53,7 +53,7 @@ module RuboCop
           return true if !previous_line_node.is_a?(RuboCop::AST::Node) ||
                          previous_line_node.args_type? || node.parent.basic_conditional?
 
-          previous_line_node.send_type? && assertion_method?(previous_line_node)
+          assertion_method?(previous_line_node)
         end
 
         def use_heredoc_argument?(node)

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Enforces the use of `refute_same(expected, object)`
+      # over `refute(expected.equal?(actual))`.
+      #
+      # NOTE: Use `refute_same` only when there is a need to compare by identity.
+      #       Otherwise, use `refute_equal`.
+      #
+      # @example
+      #   # bad
+      #   refute(expected.equal?(actual))
+      #
+      #   # good
+      #   refute_same(expected, actual)
+      #
+      class RefuteSame < Base
+        extend MinitestCopRule
+
+        define_rule :refute, target_method: :equal?, preferred_method: :refute_same
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Checks if test file names start with `test_` or end with `_test.rb`.
+      # Files which define classes having names ending with `Test` are checked.
+      # Not following this convention may result in tests not being run.
+      #
+      # @example
+      #   # bad
+      #   my_class.rb
+      #
+      #   # good
+      #   my_class_test.rb
+      #   test_my_class.rb
+      #
+      class TestFileName < Base
+        include MinitestExplorationHelpers
+
+        MSG = 'Test file path should start with `test_` or end with `_test.rb`.'
+
+        def on_new_investigation
+          return unless test_file?(processed_source.ast)
+
+          add_global_offense(MSG) unless valid_file_name?
+        end
+
+        private
+
+        def test_file?(node)
+          return true if node.class_type? && test_class?(node)
+
+          node.each_descendant(:class).any? { |class_node| test_class?(class_node) }
+        end
+
+        def valid_file_name?
+          basename = File.basename(processed_source.file_path)
+
+          basename.start_with?('test_') || basename.end_with?('_test.rb')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Detects useless assertions (assertions that either always pass or always fail).
+      #
+      # @example
+      #   # bad
+      #   assert true
+      #   assert_equal @foo, @foo
+      #   assert_nil [foo, bar]
+      #
+      #   # good
+      #   assert something
+      #   assert_equal foo, bar
+      #   assert_nil foo
+      #   assert false, "My message"
+      #
+      class UselessAssertion < Base
+        MSG = 'Useless assertion detected.'
+
+        SINGLE_ASSERTION_ARGUMENT_METHODS = %i[
+          assert refute assert_nil refute_nil assert_not assert_empty refute_empty
+        ].freeze
+        TWO_ASSERTION_ARGUMENTS_METHODS = %i[
+          assert_equal refute_equal assert_in_delta refute_in_delta
+          assert_in_epsilon refute_in_epsilon assert_same refute_same
+        ].freeze
+
+        RESTRICT_ON_SEND = SINGLE_ASSERTION_ARGUMENT_METHODS +
+                           TWO_ASSERTION_ARGUMENTS_METHODS +
+                           %i[assert_includes refute_includes assert_silent]
+
+        def on_send(node)
+          return if node.receiver
+
+          add_offense(node) if offense?(node)
+        end
+
+        private
+
+        # rubocop:disable Metrics
+        def offense?(node)
+          expected, actual, = node.arguments
+
+          case node.method_name
+          when *SINGLE_ASSERTION_ARGUMENT_METHODS
+            actual.nil? && expected&.literal?
+          when *TWO_ASSERTION_ARGUMENTS_METHODS
+            return false unless expected || actual
+            return false if expected.source != actual.source
+
+            (expected.variable? && actual.variable?) ||
+              (empty_composite?(expected) && empty_composite?(actual))
+          when :assert_includes, :refute_includes
+            expected && empty_composite?(expected)
+          when :assert_silent
+            block_node = node.parent
+            block_node&.body.nil?
+          else
+            false
+          end
+        end
+        # rubocop:enable Metrics
+
+        def empty_composite?(node)
+          return true if node.str_type? && node.value.empty?
+
+          (node.array_type? || node.hash_type?) && node.children.empty?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest_cops.rb

@@ -23,10 +23,12 @@ 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/test_file_name'
 require_relative 'minitest/global_expectations'
 require_relative 'minitest/literal_as_actual_argument'
 require_relative 'minitest/multiple_assertions'
@@ -43,8 +45,10 @@ require_relative 'minitest/refute_instance_of'
 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/minitest_exploration_helpers.rb

@@ -78,7 +78,7 @@ module RuboCop
       end
 
       def assertion_method?(node)
-        return false unless node.send_type?
+        return false if !node.send_type? && !node.block_type?
 
         ASSERTION_PREFIXES.any? do |prefix|
           method_name = node.method_name

data/lib/rubocop/minitest/assert_offense.rb

@@ -70,6 +70,8 @@ module RuboCop
     #   RUBY
     #
     #   assert_no_corrections
+    #
+    # rubocop:disable Metrics/ModuleLength
     module AssertOffense
       private
 
@@ -79,6 +81,16 @@ module RuboCop
         @cop = RuboCop::Cop::Minitest.const_get(cop_name).new
       end
 
+      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)
         setup_assertion
 
@@ -90,11 +102,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'
@@ -205,5 +218,6 @@ module RuboCop
         2.6
       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.25.1'
+      STRING = '0.26.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.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -74,6 +74,7 @@ files:
 - 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
@@ -96,11 +97,14 @@ files:
 - 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/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
@@ -120,7 +124,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.25
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.26
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message: