[Fix rubocop#147] Minitest/GlobalExpectations: add PreferredMethod co…

…nfig value Add a new configuration value for Minitest/GlobalExpectations: PreferredMethod. This value sets the preferred method with which to correct errors. Note: This does not alter the set of correct methods, only the replacement for offenses. Fixes rubocop#147
gi · Oct 18, 2021 · c1699b9 · c1699b9
1 parent d0101f6
commit c1699b9
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+### New features
+
+* [#148](https://github.com/rubocop/rubocop-minitest/pull/148): `Minitest/GlobalExpectations`: add `PreferredMethod` config value. ([@gi][])
+
 ## 0.15.2 (2021-10-11)
 
 ### Bug fixes

diff --git a/config/default.yml b/config/default.yml
@@ -1,7 +1,9 @@
 Minitest:
   Enabled: true
   Include:
+    - '**/spec/**/*'
     - '**/test/**/*'
+    - '**/*_spec.rb'
     - '**/*_test.rb'
 
 Minitest/AssertEmpty:
@@ -103,6 +105,7 @@ Minitest/GlobalExpectations:
   Description: 'This cop checks for deprecated global expectations.'
   StyleGuide: 'https://minitest.rubystyle.guide#global-expectations'
   Enabled: true
+  PreferredMethod: _
   VersionAdded: '0.7'
 
 Minitest/LiteralAsActualArgument:

diff --git a/docs/modules/ROOT/pages/cops_minitest.adoc b/docs/modules/ROOT/pages/cops_minitest.adoc
@@ -527,6 +527,8 @@ and autocorrects them to use expect format.
 
 === Examples
 
+==== PreferredMethod: _ (default)
+
 [source,ruby]
 ----
 # bad
@@ -540,6 +542,46 @@ _(wonts).wont_match expected_wonts
 _ { musts }.must_raise TypeError
 ----
 
+==== PreferredMethod: expect
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
+# good
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+----
+
+==== PreferredMethod: value
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
+# good
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+----
+
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| PreferredMethod
+| `_`
+| String
+|===
+
 === References
 
 * https://minitest.rubystyle.guide#global-expectations

diff --git a/lib/rubocop/cop/minitest/global_expectations.rb b/lib/rubocop/cop/minitest/global_expectations.rb
@@ -6,7 +6,7 @@ module Minitest
       # This cop checks for deprecated global expectations
       # and autocorrects them to use expect format.
       #
-      # @example
+      # @example PreferredMethod: _ (default)
       #   # bad
       #   musts.must_equal expected_musts
       #   wonts.wont_match expected_wonts
@@ -16,6 +16,28 @@ module Minitest
       #   _(musts).must_equal expected_musts
       #   _(wonts).wont_match expected_wonts
       #   _ { musts }.must_raise TypeError
+      #
+      # @example PreferredMethod: expect
+      #   # bad
+      #   musts.must_equal expected_musts
+      #   wonts.wont_match expected_wonts
+      #   musts.must_raise TypeError
+      #
+      #   # good
+      #   expect(musts).must_equal expected_musts
+      #   expect(wonts).wont_match expected_wonts
+      #   expect { musts }.must_raise TypeError
+      #
+      # @example PreferredMethod: value
+      #   # bad
+      #   musts.must_equal expected_musts
+      #   wonts.wont_match expected_wonts
+      #   musts.must_raise TypeError
+      #
+      #   # good
+      #   value(musts).must_equal expected_musts
+      #   value(wonts).wont_match expected_wonts
+      #   value { musts }.must_raise TypeError
       class GlobalExpectations < Base
         extend AutoCorrector
 
@@ -71,21 +93,25 @@ def on_send(node)
             receiver = node.receiver.source_range
 
             if BLOCK_MATCHERS.include?(node.method_name)
-              corrector.wrap(receiver, '_ { ', ' }')
+              corrector.wrap(receiver, "#{preferred_method} { ", ' }')
             else
-              corrector.wrap(receiver, '_(', ')')
+              corrector.wrap(receiver, "#{preferred_method}(", ')')
             end
           end
         end
 
         private
 
+        def preferred_method
+          cop_config['PreferredMethod'] || '_'
+        end
+
         def preferred_receiver(node)
           source = node.receiver.source
           if BLOCK_MATCHERS.include?(node.method_name)
-            "_ { #{source} }"
+            "#{preferred_method} { #{source} }"
           else
-            "_(#{source})"
+            "#{preferred_method}(#{source})"
           end
         end
       end