rubocop-minitest 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcdc752936f6002cc925a5ca82039770b2977685a53f182250b0cc75fffbb412
-  data.tar.gz: a634c0d0fa393ef7f00b07ebb8c17063df18c8e4d92643eb361699c1fa327097
+  metadata.gz: fa7a9c739cc54955a9c7647d8d5442c18f7888acb54212da90598fbec357717b
+  data.tar.gz: 784f7adfaeb34d54fedeaedcadd528cdffb6c888569a1314082b2c93217b5f3f
 SHA512:
-  metadata.gz: 1879892d3bb7d99c4e2e1c483f1c9f93b990f55fecc71f5ae37b0193bfde0ae7167588d21fbf3a62abdfa26f4e88efc2655d0ddc4e0f078f23fe5f05843e95ca
-  data.tar.gz: c411392994e053920757c682c793defae132d9fd4e556c131f6c4a74fef3d93dca05fab0f3bd91a3081e038a943dd41a00b88626966b0c74928e97afa0cec65f
+  metadata.gz: b7bf8ad7fa1be35b461ab54c2097ccd4c6fd320f1b15341c253f527099afeebee139feb33007f6b471309aaad6bb0f6f4534a52e32b2e3bc0f45344a4e5588ef
+  data.tar.gz: a73427443b2f4cb050f5e7893809f8026dbb41c4dc77461e6aa07fc13228e60f36a6bec7e893745eb14d911f143556003166028eb5abfcfea8f49b676ae50dbb

data/.rubocop.yml

@@ -25,16 +25,9 @@ Naming/PredicateName:
 
 Naming/InclusiveLanguage:
   FlaggedTerms:
-    whitelist:
+    offence:
       Suggestions:
-        - allowlist
-    blacklist:
-      Suggestions:
-        - denylist
-    master:
-      AllowedRegex:
-        - 'blob/master/'
-        - 'master \(unreleased\)'
+        - offense
 
 Style/FormatStringToken:
   # Because we parse a lot of source codes from strings. Percent arrays

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.15.0 (2021-08-09)
+
+### New features
+
+* [#140](https://github.com/rubocop/rubocop-minitest/issues/140): Make `Minitest/AssertNil` and `Minitest/RefuteNil` aware of `assert(obj.nil?)` and `refute(obj.nil?)`. ([@koic][])
+
 ## 0.14.0 (2021-07-03)
 
 ### New features

data/bin/console

@@ -2,16 +2,10 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'pathname'
-require 'yaml'
-require 'rubocop/minitest'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+require 'irb'
+require 'rubocop'
+require 'rubocop-minitest'
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+ARGV.clear
 
-require 'irb'
 IRB.start(__FILE__)

data/config/default.yml

@@ -59,7 +59,7 @@ Minitest/AssertKindOf:
   VersionAdded: '0.10'
 
 Minitest/AssertNil:
-  Description: 'This cop enforces the test to use `assert_nil` instead of using `assert_equal(nil, something)`.'
+  Description: 'This cop enforces the test to use `assert_nil` instead of using `assert_equal(nil, something)` or `assert(something.nil?)`.'
   StyleGuide: 'https://minitest.rubystyle.guide#assert-nil'
   Enabled: true
   VersionAdded: '0.1'
@@ -172,7 +172,7 @@ Minitest/RefuteKindOf:
   VersionAdded: '0.10'
 
 Minitest/RefuteNil:
-  Description: 'This cop enforces the test to use `refute_nil` instead of using `refute_equal(nil, something)`.'
+  Description: 'This cop enforces the test to use `refute_nil` instead of using `refute_equal(nil, something)` or `refute(something.nil?)`.'
   StyleGuide: 'https://minitest.rubystyle.guide#refute-nil'
   Enabled: true
   VersionAdded: '0.2'

data/docs/antora.yml

@@ -2,6 +2,6 @@ name: rubocop-minitest
 title: RuboCop Minitest
 # We always provide version without patch here (e.g. 1.1),
 # as patch versions should not appear in the docs.
-version: '0.14'
+version: '0.15'
 nav:
 - modules/ROOT/nav.adoc

data/docs/modules/ROOT/pages/cops_minitest.adoc

@@ -261,8 +261,8 @@ assert_match(matcher, string, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_nil`
-instead of using `assert_equal(nil, something)`.
+This cop enforces the test to use `assert_nil` instead of using
+`assert_equal(nil, something)` or `assert(something.nil?)`.
 
 === Examples
 
@@ -271,6 +271,8 @@ instead of using `assert_equal(nil, something)`.
 # bad
 assert_equal(nil, actual)
 assert_equal(nil, actual, 'message')
+assert(object.nil?)
+assert(object.nil?, 'message')
 
 # good
 assert_nil(actual)
@@ -927,8 +929,8 @@ refute_match(matcher, string, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_nil`
-instead of using `refute_equal(nil, something)`.
+This cop enforces the test to use `refute_nil` instead of using
+`refute_equal(nil, something)` or `refute(something.nil?)`.
 
 === Examples
 
@@ -937,6 +939,8 @@ instead of using `refute_equal(nil, something)`.
 # bad
 refute_equal(nil, actual)
 refute_equal(nil, actual, 'message')
+refute(actual.nil?)
+refute(actual.nil?, 'message')
 
 # good
 refute_nil(actual)

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

@@ -3,13 +3,15 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_nil`
-      # instead of using `assert_equal(nil, something)`.
+      # This cop enforces the test to use `assert_nil` instead of using
+      # `assert_equal(nil, something)` or `assert(something.nil?)`.
       #
       # @example
       #   # bad
       #   assert_equal(nil, actual)
       #   assert_equal(nil, actual, 'message')
+      #   assert(object.nil?)
+      #   assert(object.nil?, 'message')
       #
       #   # good
       #   assert_nil(actual)
@@ -17,27 +19,29 @@ module RuboCop
       #
       class AssertNil < Base
         include ArgumentRangeHelper
+        include NilAssertionHandleable
         extend AutoCorrector
 
-        MSG = 'Prefer using `assert_nil(%<arguments>s)` over ' \
-              '`assert_equal(nil, %<arguments>s)`.'
-        RESTRICT_ON_SEND = %i[assert_equal].freeze
+        ASSERTION_TYPE = 'assert'
+        RESTRICT_ON_SEND = %i[assert_equal assert].freeze
 
-        def_node_matcher :assert_equal_with_nil, <<~PATTERN
-          (send nil? :assert_equal nil $_ $...)
+        def_node_matcher :nil_assertion, <<~PATTERN
+          {
+            (send nil? :assert_equal nil $_ $...)
+            (send nil? :assert (send $_ :nil?) $...)
+          }
         PATTERN
 
         def on_send(node)
-          assert_equal_with_nil(node) do |actual, message|
-            message = message.first
+          nil_assertion(node) do |actual, message|
+            register_offense(node, actual, message)
+          end
+        end
 
-            arguments = [actual.source, message&.source].compact.join(', ')
+        private
 
-            add_offense(node, message: format(MSG, arguments: arguments)) do |corrector|
-              corrector.replace(node.loc.selector, 'assert_nil')
-              corrector.replace(first_and_second_arguments_range(node), actual.source)
-            end
-          end
+        def assertion_type
+          ASSERTION_TYPE
         end
       end
     end

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

@@ -3,13 +3,15 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `refute_nil`
-      # instead of using `refute_equal(nil, something)`.
+      # This cop enforces the test to use `refute_nil` instead of using
+      # `refute_equal(nil, something)` or `refute(something.nil?)`.
       #
       # @example
       #   # bad
       #   refute_equal(nil, actual)
       #   refute_equal(nil, actual, 'message')
+      #   refute(actual.nil?)
+      #   refute(actual.nil?, 'message')
       #
       #   # good
       #   refute_nil(actual)
@@ -17,29 +19,29 @@ module RuboCop
       #
       class RefuteNil < Base
         include ArgumentRangeHelper
+        include NilAssertionHandleable
         extend AutoCorrector
 
-        MSG = 'Prefer using `refute_nil(%<arguments>s)` over ' \
-              '`refute_equal(nil, %<arguments>s)`.'
-        RESTRICT_ON_SEND = %i[refute_equal].freeze
+        ASSERTION_TYPE = 'refute'
+        RESTRICT_ON_SEND = %i[refute_equal refute].freeze
 
-        def_node_matcher :refute_equal_with_nil, <<~PATTERN
-          (send nil? :refute_equal nil $_ $...)
+        def_node_matcher :nil_refutation, <<~PATTERN
+          {
+            (send nil? :refute_equal nil $_ $...)
+            (send nil? :refute (send $_ :nil?) $...)
+          }
         PATTERN
 
         def on_send(node)
-          refute_equal_with_nil(node) do |actual, message|
-            message = message.first
+          nil_refutation(node) do |actual, message|
+            register_offense(node, actual, message)
+          end
+        end
 
-            arguments = [actual.source, message&.source].compact.join(', ')
+        private
 
-            add_offense(node, message: format(MSG, arguments: arguments)) do |corrector|
-              corrector.replace(node.loc.selector, 'refute_nil')
-              corrector.replace(
-                first_and_second_arguments_range(node), actual.source
-              )
-            end
-          end
+        def assertion_type
+          ASSERTION_TYPE
         end
       end
     end

data/lib/rubocop/cop/minitest_cops.rb

@@ -4,6 +4,7 @@ require_relative 'mixin/argument_range_helper'
 require_relative 'mixin/in_delta_mixin'
 require_relative 'mixin/minitest_cop_rule'
 require_relative 'mixin/minitest_exploration_helpers'
+require_relative 'mixin/nil_assertion_handleable'
 require_relative 'minitest/assert_empty'
 require_relative 'minitest/assert_empty_literal'
 require_relative 'minitest/assert_equal'

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Common functionality for `AssertNil` and `RefuteNil` cops.
+      module NilAssertionHandleable
+        MSG = 'Prefer using `%<assertion_type>s_nil(%<preferred_args>s)` over `%<method>s(%<current_args>s)`.'
+
+        private
+
+        def register_offense(node, actual, message)
+          message = build_message(node, actual, message)
+
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node, actual)
+          end
+        end
+
+        def build_message(node, actual, message)
+          message = message.first
+          message_source = message&.source
+
+          preferred_args = [actual.source, message_source].compact
+          current_args = if comparison_assertion_method?(node)
+                           ['nil', preferred_args].join(', ')
+                         else
+                           ["#{actual.source}.nil?", message_source].compact.join(', ')
+                         end
+
+          format(
+            MSG,
+            assertion_type: assertion_type,
+            preferred_args: preferred_args.join(', '),
+            method: node.method_name, current_args: current_args
+          )
+        end
+
+        def autocorrect(corrector, node, actual)
+          corrector.replace(node.loc.selector, :"#{assertion_type}_nil")
+          if comparison_assertion_method?(node)
+            corrector.replace(first_and_second_arguments_range(node), actual.source)
+          else
+            corrector.remove(node.first_argument.loc.dot)
+            corrector.remove(node.first_argument.loc.selector)
+          end
+        end
+
+        def comparison_assertion_method?(node)
+          node.method?(:"#{assertion_type}_equal")
+        end
+      end
+    end
+  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.14.0'
+      STRING = '0.15.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/relnotes/v0.15.0.md

@@ -0,0 +1,5 @@
+### New features
+
+* [#140](https://github.com/rubocop/rubocop-minitest/issues/140): Make `Minitest/AssertNil` and `Minitest/RefuteNil` aware of `assert(obj.nil?)` and `refute(obj.nil?)`. ([@koic][])
+
+[@koic]: https://github.com/koic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -125,6 +125,7 @@ files:
 - lib/rubocop/cop/mixin/in_delta_mixin.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
 - lib/rubocop/minitest.rb
 - lib/rubocop/minitest/inject.rb
 - lib/rubocop/minitest/version.rb
@@ -141,6 +142,7 @@ files:
 - relnotes/v0.12.1.md
 - relnotes/v0.13.0.md
 - relnotes/v0.14.0.md
+- relnotes/v0.15.0.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -165,7 +167,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.14
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.15
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
 post_install_message:
 rdoc_options: []