rubocop-minitest 0.28.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4d321b9b8d16e6c5c3cf304835e7c48fde65c173202925d3e072c779c90bb86
-  data.tar.gz: 40856b7d83975172736776deae22bb7f62d5d9b913674bb354a6c7cbf7011882
+  metadata.gz: 04d404efc9a07a82ed435c474b1c4370afa1d36e92f11ec1176911dbe677577c
+  data.tar.gz: '079e6fe08096eae97e74790ffda49a120fd5d1b06d15968666d83e046ec821a7'
 SHA512:
-  metadata.gz: 54a62f0f9510ef6d00dedccc0f59672446f70fea23d12e63cab8915423932aff0921fde8b52e44ce6b93543a0c43a9726867aeb50a84fae1d8e79a3e0ec40f38
-  data.tar.gz: 45a933d110a001cb8ada63094fadfb918c814b85c2d68154fc7f1180488f9937a5858a8db2abca0ba7a80323be9ea11e5940df21736ce69166aaf2947388c276
+  metadata.gz: adf9211bbf6d285987b8bea806bafd15961a8307ea8f6baec4b7ab8d248a571782883ba619bb3542fb440a7ed218daf73b8166e09c33537b52042bcd306aa81e
+  data.tar.gz: 94b7021203ca9992df0278ca2d753a7e6c03a54b8a5f49ca3231caf7b8f9b1dd40db791d3504f08bce49bee9e84e1a658cf741785ad74daa03df661dd68ac704

data/README.md

@@ -10,8 +10,8 @@ The library is based on the guidelines outlined in the community [Minitest Style
 
 Just install the `rubocop-minitest` gem
 
-```bash
-gem install rubocop-minitest
+```sh
+$ gem install rubocop-minitest
 ```
 
 or if you use bundler put this in your `Gemfile`
@@ -46,8 +46,8 @@ cops together with the standard cops.
 
 ### Command line
 
-```bash
-rubocop --require rubocop-minitest
+```sh
+$ rubocop --require rubocop-minitest
 ```
 
 ### Rake task

data/config/default.yml

@@ -181,6 +181,11 @@ Minitest/NoAssertions:
   Enabled: false
   VersionAdded: '0.12'
 
+Minitest/NoTestCases:
+  Description: 'Checks if test class contains any test cases.'
+  Enabled: false
+  VersionAdded: '0.30'
+
 Minitest/NonPublicTestMethod:
   Description: 'Detects non `public` (marked as `private` or `protected`) test methods.'
   Enabled: pending

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

@@ -11,14 +11,30 @@ module RuboCop
       #   assert(object.instance_of?(Class))
       #   assert(object.instance_of?(Class), 'message')
       #
+      #   # bad
+      #   assert_equal(Class, object.class)
+      #   assert_equal(Class, object.class, 'message')
+      #
       #   # good
       #   assert_instance_of(Class, object)
       #   assert_instance_of(Class, object, 'message')
       #
       class AssertInstanceOf < Base
-        extend MinitestCopRule
+        include InstanceOfAssertionHandleable
+        extend AutoCorrector
+
+        RESTRICT_ON_SEND = %i[assert assert_equal].freeze
+
+        def_node_matcher :instance_of_assertion?, <<~PATTERN
+          {
+            (send nil? :assert (send $_ :instance_of? $const) $_?)
+            (send nil? :assert_equal $const (send $_ :class) $_?)
+          }
+        PATTERN
 
-        define_rule :assert, target_method: :instance_of?, inverse: true
+        def on_send(node)
+          investigate(node, :assert)
+        end
       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/global_expectations.rb

@@ -96,7 +96,9 @@ module RuboCop
           wont_be_kind_of wont_match wont_be_nil wont_be wont_respond_to wont_be_same_as
         ].freeze
 
-        BLOCK_MATCHERS = %i[must_output must_raise must_be_silent must_throw].freeze
+        BLOCK_MATCHERS = %i[
+          must_output must_pattern_match must_raise must_be_silent must_throw wont_pattern_match
+        ].freeze
 
         RESTRICT_ON_SEND = VALUE_MATCHERS + BLOCK_MATCHERS
 

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/no_test_cases.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Checks if test class contains any test cases.
+      #
+      # @example
+      #   # bad
+      #   class FooTest < Minitest::Test
+      #     def do_something
+      #     end
+      #   end
+      #
+      #   # good
+      #   class FooTest < Minitest::Test
+      #     def test_something
+      #       assert true
+      #     end
+      #   end
+      #
+      class NoTestCases < Base
+        include MinitestExplorationHelpers
+
+        MSG = 'Test class should have test cases.'
+
+        def on_class(node)
+          return unless test_class?(node)
+
+          add_offense(node) if test_cases(node).empty?
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,7 @@ module RuboCop
               corrector.replace(node.loc.selector, 'refute_equal')
 
               replacement = [expected, actual].map(&:source).join(', ')
-              corrector.replace(first_argument_range(node), replacement)
+              corrector.replace(node.first_argument, replacement)
             end
           end
         end

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

@@ -66,7 +66,7 @@ module RuboCop
           if node.method?(:assert_equal)
             corrector.replace(first_and_second_arguments_range(node), actual.source)
           else
-            corrector.replace(first_argument_range(node), actual.source)
+            corrector.replace(node.first_argument, actual.source)
           end
         end
       end

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

@@ -11,14 +11,30 @@ module RuboCop
       #   refute(object.instance_of?(Class))
       #   refute(object.instance_of?(Class), 'message')
       #
+      #   # bad
+      #   refute_equal(Class, object.class)
+      #   refute_equal(Class, object.class, 'message')
+      #
       #   # good
       #   refute_instance_of(Class, object)
       #   refute_instance_of(Class, object, 'message')
       #
       class RefuteInstanceOf < Base
-        extend MinitestCopRule
+        include InstanceOfAssertionHandleable
+        extend AutoCorrector
+
+        RESTRICT_ON_SEND = %i[refute refute_equal].freeze
+
+        def_node_matcher :instance_of_assertion?, <<~PATTERN
+          {
+            (send nil? :refute (send $_ :instance_of? $const) $_?)
+            (send nil? :refute_equal $const (send $_ :class) $_?)
+          }
+        PATTERN
 
-        define_rule :refute, target_method: :instance_of?, inverse: true
+        def on_send(node)
+          investigate(node, :refute)
+        end
       end
     end
   end

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

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

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

@@ -30,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)
@@ -54,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/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

@@ -79,7 +79,7 @@ module RuboCop
         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
+        @cop = RuboCop::Cop::Minitest.const_get(cop_name).new(configuration)
       end
 
       def format_offense(source, **replacements)
@@ -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.28.0'
+      STRING = '0.30.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.28.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -72,6 +72,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/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
@@ -96,6 +97,7 @@ files:
 - 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
@@ -112,7 +114,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.28
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.30
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -130,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Automatic Minitest code style checking tool.