rubocop-minitest 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ade83745f0a777cea6d2e37dfc8f00e7bc0857be549dd5b2d9544df4a201eb
-  data.tar.gz: 2afc383a877712b659efc1771fa6d44093ce4d11618ff37b23aa561dd1a986f6
+  metadata.gz: 3581920acff906161f98b5af290d613af4d257834817f55d6a607088754dc4d8
+  data.tar.gz: 1d19f60506d3e2693ce52d4eaf63b8fa92b00f2a6eda4b499df7920559b29bf9
 SHA512:
-  metadata.gz: fb1ecc48cb4f9563903aefa53ff3667f5509aa4f785bdb6fb1ab6ddfa240e5f034f0eae80ce991bde1ff19a925e426fdb19f78d3c41928c426da0068ad686d78
-  data.tar.gz: 16fbf8fe16331074e1ed953c96b45a327986701fd62a78d8b14325ffeaea96a619a2773f37665c5231fcf5fb90c40ca145fe1d24ae78924199dbb9b223ecab68
+  metadata.gz: 0c297aa12f347d2fb0ee9d6fcdf52728498f7d3d148fc4b1a3ad26f1c0f9329fbaf8773601d330670a69ab7a3dae19d9702e27c7f5ffff6fa8cc7519f669a7a6
+  data.tar.gz: d69e427b9f613c07a87a83ae24fc694e3fba7322e3c44f4548771645879383a5f713cca74e56061c509c4a5229c633bc52a905af5f97fdcae6af576608be5c6a

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop-minitest.svg)](https://badge.fury.io/rb/rubocop-minitest)
 [![CircleCI](https://circleci.com/gh/rubocop/rubocop-minitest.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-minitest)
 
-A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing Minitest best practices and coding conventions.
+A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing [Minitest](https://github.com/minitest/minitest) best practices and coding conventions.
 The library is based on the guidelines outlined in the community [Minitest Style Guide](https://minitest.rubystyle.guide).
 
 ## Installation

data/config/default.yml

@@ -59,6 +59,12 @@ Minitest/AssertNil:
   Enabled: true
   VersionAdded: '0.1'
 
+Minitest/AssertOperator:
+  Description: 'This cop enforces the use of `assert_operator(expected, :<, actual)` over `assert(expected < actual)`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-operator'
+  Enabled: pending
+  VersionAdded: '0.32'
+
 Minitest/AssertOutput:
   Description: 'This cop checks for opportunities to use `assert_output`.'
   StyleGuide: 'https://minitest.rubystyle.guide/#assert-output'
@@ -248,6 +254,12 @@ Minitest/RefuteNil:
   Enabled: true
   VersionAdded: '0.2'
 
+Minitest/RefuteOperator:
+  Description: 'This cop enforces the use of `refute_operator(expected, :<, actual)` over `refute(expected < actual)`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-operator'
+  Enabled: pending
+  VersionAdded: '0.32'
+
 Minitest/RefutePathExists:
   Description: 'This cop enforces the test to use `refute_path_exists` instead of using `refute(File.exist?(path))`.'
   StyleGuide: 'https://minitest.rubystyle.guide/#refute-path-exists'

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Enforces the use of `assert_operator(expected, :<, actual)` over `assert(expected < actual)`.
+      #
+      # @example
+      #
+      #   # bad
+      #   assert(expected < actual)
+      #
+      #   # good
+      #   assert_operator(expected, :<, actual)
+      #
+      class AssertOperator < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer using `assert_operator(%<new_arguments>s)`.'
+        RESTRICT_ON_SEND = %i[assert].freeze
+
+        def on_send(node)
+          return unless node.first_argument.operator_method?
+
+          new_arguments = build_new_arguments(node)
+
+          add_offense(node, message: format(MSG, new_arguments: new_arguments)) do |corrector|
+            corrector.replace(node.loc.selector, 'assert_operator')
+
+            corrector.replace(range_of_arguments(node), new_arguments)
+          end
+        end
+
+        private
+
+        def build_new_arguments(node)
+          lhs, op, rhs = *node.first_argument
+          new_arguments = "#{lhs.source}, :#{op}, #{rhs.source}"
+
+          if node.arguments.count == 2
+            new_arguments << ", #{node.last_argument.source}"
+          else
+            new_arguments
+          end
+        end
+
+        def range_of_arguments(node)
+          node.first_argument.source_range.begin.join(node.last_argument.source_range.end)
+        end
+      end
+    end
+  end
+end

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

@@ -30,20 +30,25 @@ module RuboCop
         def on_send(node)
           assert_file_exists(node) do |path, failure_message|
             failure_message = failure_message.first
-            good_method = build_good_method(path, failure_message)
+            good_method = build_good_method(node, path, failure_message)
             message = format(MSG, good_method: good_method)
 
             add_offense(node, message: message) do |corrector|
-              corrector.replace(node, good_method)
+              corrector.replace(node.loc.selector, 'assert_path_exists')
+              corrector.replace(node.first_argument, path.source)
             end
           end
         end
 
         private
 
-        def build_good_method(path, message)
+        def build_good_method(node, path, message)
           args = [path.source, message&.source].compact.join(', ')
-          "assert_path_exists(#{args})"
+          if node.parenthesized?
+            "assert_path_exists(#{args})"
+          else
+            "assert_path_exists #{args}"
+          end
         end
       end
     end

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

@@ -27,24 +27,35 @@ module RuboCop
         def on_send(node)
           return unless node.method?(:assert_equal)
 
-          expected, actual, message = *node.arguments
+          expected, actual, _message = *node.arguments
           return unless actual&.recursive_basic_literal?
           return if expected.recursive_basic_literal?
 
           add_offense(all_arguments_range(node)) do |corrector|
-            autocorrect(corrector, node, expected, actual, message)
+            autocorrect(corrector, node, expected, actual)
           end
         end
 
-        def autocorrect(corrector, node, expected, actual, message)
+        private
+
+        def autocorrect(corrector, node, expected, actual)
           new_actual_source = if actual.hash_type? && !actual.braces?
                                 "{#{actual.source}}"
                               else
                                 actual.source
                               end
-          arguments = [new_actual_source, expected.source, message&.source].compact.join(', ')
 
-          corrector.replace(node, "assert_equal(#{arguments})")
+          corrector.replace(expected, new_actual_source)
+          corrector.replace(actual, expected.source)
+
+          wrap_with_parentheses(corrector, node) if !node.parenthesized? && actual.hash_type?
+        end
+
+        def wrap_with_parentheses(corrector, node)
+          range = node.loc.selector.end.join(node.first_argument.source_range.begin)
+
+          corrector.replace(range, '(')
+          corrector.insert_after(node, ')')
         end
       end
     end

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

@@ -9,7 +9,6 @@ module RuboCop
       # @example
       #   # bad
       #   assert("rubocop-minitest" != actual)
-      #   assert(! "rubocop-minitest" == actual)
       #
       #   # good
       #   refute_equal("rubocop-minitest", actual)
@@ -22,7 +21,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[assert].freeze
 
         def_node_matcher :assert_not_equal, <<~PATTERN
-          (send nil? :assert {(send $_ :!= $_) (send (send $_ :! ) :== $_) } $... )
+          (send nil? :assert (send $_ :!= $_) $... )
         PATTERN
 
         def on_send(node)

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Enforces the use of `refute_operator(expected, :<, actual)` over `refute(expected < actual)`.
+      #
+      # @example
+      #
+      #   # bad
+      #   refute(expected < actual)
+      #
+      #   # good
+      #   refute_operator(expected, :<, actual)
+      #
+      class RefuteOperator < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer using `refute_operator(%<new_arguments>s)`.'
+        RESTRICT_ON_SEND = %i[refute].freeze
+
+        def on_send(node)
+          return unless node.first_argument.operator_method?
+
+          new_arguments = build_new_arguments(node)
+
+          add_offense(node, message: format(MSG, new_arguments: new_arguments)) do |corrector|
+            corrector.replace(node.loc.selector, 'refute_operator')
+
+            corrector.replace(range_of_arguments(node), new_arguments)
+          end
+        end
+
+        private
+
+        def build_new_arguments(node)
+          lhs, op, rhs = *node.first_argument
+          new_arguments = "#{lhs.source}, :#{op}, #{rhs.source}"
+
+          if node.arguments.count == 2
+            new_arguments << ", #{node.last_argument.source}"
+          else
+            new_arguments
+          end
+        end
+
+        def range_of_arguments(node)
+          node.first_argument.source_range.begin.join(node.last_argument.source_range.end)
+        end
+      end
+    end
+  end
+end

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

@@ -30,20 +30,25 @@ module RuboCop
         def on_send(node)
           refute_file_exists(node) do |path, failure_message|
             failure_message = failure_message.first
-            good_method = build_good_method(path, failure_message)
+            good_method = build_good_method(node, path, failure_message)
             message = format(MSG, good_method: good_method)
 
             add_offense(node, message: message) do |corrector|
-              corrector.replace(node, good_method)
+              corrector.replace(node.loc.selector, 'refute_path_exists')
+              corrector.replace(node.first_argument, path.source)
             end
           end
         end
 
         private
 
-        def build_good_method(path, message)
+        def build_good_method(node, path, message)
           args = [path.source, message&.source].compact.join(', ')
-          "refute_path_exists(#{args})"
+          if node.parenthesized?
+            "refute_path_exists(#{args})"
+          else
+            "refute_path_exists #{args}"
+          end
         end
       end
     end

data/lib/rubocop/cop/minitest_cops.rb

@@ -11,6 +11,7 @@ require_relative 'minitest/assert_empty'
 require_relative 'minitest/assert_empty_literal'
 require_relative 'minitest/assert_equal'
 require_relative 'minitest/assert_in_delta'
+require_relative 'minitest/assert_operator'
 require_relative 'minitest/assert_predicate'
 require_relative 'minitest/assert_raises_compound_body'
 require_relative 'minitest/assert_raises_with_regexp_argument'
@@ -42,11 +43,12 @@ require_relative 'minitest/refute_empty'
 require_relative 'minitest/refute_false'
 require_relative 'minitest/refute_equal'
 require_relative 'minitest/refute_in_delta'
-require_relative 'minitest/refute_kind_of'
-require_relative 'minitest/refute_nil'
 require_relative 'minitest/refute_includes'
-require_relative 'minitest/refute_match'
 require_relative 'minitest/refute_instance_of'
+require_relative 'minitest/refute_kind_of'
+require_relative 'minitest/refute_match'
+require_relative 'minitest/refute_nil'
+require_relative 'minitest/refute_operator'
 require_relative 'minitest/refute_path_exists'
 require_relative 'minitest/refute_predicate'
 require_relative 'minitest/refute_respond_to'

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

@@ -105,8 +105,7 @@ module RuboCop
         ASSERTION_PREFIXES.any? do |prefix|
           method_name = node.method_name
 
-          # TODO: Remove the fllowing `to_s` since Ruby 2.7 that supports `Symbol#start_with?`.
-          method_name.to_s.start_with?(prefix) || node.method?(:flunk)
+          method_name.start_with?(prefix) || node.method?(:flunk)
         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.31.0'
+      STRING = '0.32.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.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -54,6 +54,7 @@ files:
 - lib/rubocop/cop/minitest/assert_kind_of.rb
 - lib/rubocop/cop/minitest/assert_match.rb
 - lib/rubocop/cop/minitest/assert_nil.rb
+- lib/rubocop/cop/minitest/assert_operator.rb
 - lib/rubocop/cop/minitest/assert_output.rb
 - lib/rubocop/cop/minitest/assert_path_exists.rb
 - lib/rubocop/cop/minitest/assert_predicate.rb
@@ -83,6 +84,7 @@ files:
 - lib/rubocop/cop/minitest/refute_kind_of.rb
 - lib/rubocop/cop/minitest/refute_match.rb
 - lib/rubocop/cop/minitest/refute_nil.rb
+- lib/rubocop/cop/minitest/refute_operator.rb
 - lib/rubocop/cop/minitest/refute_path_exists.rb
 - lib/rubocop/cop/minitest/refute_predicate.rb
 - lib/rubocop/cop/minitest/refute_respond_to.rb
@@ -115,7 +117,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.31
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.32
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -133,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Automatic Minitest code style checking tool.