rubocop-minitest 0.15.0 → 0.17.0

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

@@ -3,7 +3,7 @@
 == Minitest/AssertEmpty
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -35,17 +35,17 @@ assert_empty(object, 'message')
 == Minitest/AssertEmptyLiteral
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
-| Yes (Unsafe)
+| Yes
 | 0.5
 | 0.11
 |===
 
 This cop enforces the test to use `assert_empty`
-instead of using `assert_equal([], object)`.
+instead of using `assert_equal([], object)` or `assert_equal({}, object)`.
 
 === Examples
 
@@ -62,7 +62,7 @@ assert_empty(object)
 == Minitest/AssertEqual
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -92,7 +92,7 @@ assert_equal("rubocop-minitest", actual)
 == Minitest/AssertInDelta
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -124,7 +124,7 @@ assert_in_delta(0.2, actual, 0.001, 'message')
 == Minitest/AssertIncludes
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -156,7 +156,7 @@ assert_includes(collection, object, 'message')
 == Minitest/AssertInstanceOf
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -188,7 +188,7 @@ assert_instance_of(Class, object, 'message')
 == Minitest/AssertKindOf
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -220,7 +220,7 @@ assert_kind_of(Class, object, 'message')
 == Minitest/AssertMatch
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -252,7 +252,7 @@ assert_match(matcher, string, 'message')
 == Minitest/AssertNil
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -286,7 +286,7 @@ assert_nil(actual, 'message')
 == Minitest/AssertOutput
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -318,7 +318,7 @@ assert_output(expected) { puts object.method }
 == Minitest/AssertPathExists
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -350,7 +350,7 @@ assert_path_exists(path, 'message')
 == Minitest/AssertRespondTo
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -384,7 +384,7 @@ assert_respond_to(self, :do_something)
 == Minitest/AssertSilent
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -414,7 +414,7 @@ assert_silent { puts object.do_something }
 == Minitest/AssertTruthy
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -446,7 +446,7 @@ assert(actual, 'message')
 == Minitest/AssertWithExpectedArgument
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | No
@@ -458,7 +458,9 @@ assert(actual, 'message')
 This cop tries to detect when a user accidentally used
 `assert` when they meant to use `assert_equal`.
 
-It is marked as unsafe because it is not possible to determine
+=== Safety
+
+This cop is unsafe because it is not possible to determine
 whether the second argument of `assert` is a message or not.
 
 === Examples
@@ -478,7 +480,7 @@ assert(foo, 'message')
 == Minitest/AssertionInLifecycleHook
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -511,13 +513,13 @@ end
 == Minitest/GlobalExpectations
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
 | Yes
 | 0.7
-| -
+| 0.16
 |===
 
 This cop checks for deprecated global expectations
@@ -525,6 +527,54 @@ and autocorrects them to use expect format.
 
 === Examples
 
+==== EnforcedStyle: _
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+
+# good
+_(musts).must_equal expected_musts
+_(wonts).wont_match expected_wonts
+_ { musts }.must_raise TypeError
+----
+
+==== EnforcedStyle: any (default)
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
+# good
+_(musts).must_equal expected_musts
+_(wonts).wont_match expected_wonts
+_ { musts }.must_raise TypeError
+
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+----
+
+==== EnforcedStyle: expect
+
 [source,ruby]
 ----
 # bad
@@ -532,12 +582,57 @@ musts.must_equal expected_musts
 wonts.wont_match expected_wonts
 musts.must_raise TypeError
 
+_(musts).must_equal expected_musts
+_(wonts).wont_match expected_wonts
+_ { musts }.must_raise TypeError
+
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+
 # good
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+----
+
+==== EnforcedStyle: value
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
 _(musts).must_equal expected_musts
 _(wonts).wont_match expected_wonts
 _ { musts }.must_raise TypeError
+
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { 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
+
+| EnforcedStyle
+| `any`
+| `_`, `any`, `expect`, `value`
+
+| Include
+| `+**/test/**/*+`, `+**/*_test.rb+`, `+**/spec/**/*+`, `+**/*_spec.rb+`
+| Array
+|===
+
 === References
 
 * https://minitest.rubystyle.guide#global-expectations
@@ -545,7 +640,7 @@ _ { musts }.must_raise TypeError
 == Minitest/LiteralAsActualArgument
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -579,7 +674,7 @@ assert_equal [1, 2], foo, 'message'
 == Minitest/MultipleAssertions
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -630,7 +725,7 @@ end
 == Minitest/NoAssertions
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Disabled
 | Yes
@@ -662,7 +757,7 @@ end
 == Minitest/RefuteEmpty
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -694,7 +789,7 @@ refute_empty(object, 'message')
 == Minitest/RefuteEqual
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -725,7 +820,7 @@ refute_equal("rubocop-minitest", actual)
 == Minitest/RefuteFalse
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -760,7 +855,7 @@ refute(actual, 'message')
 == Minitest/RefuteInDelta
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -792,7 +887,7 @@ refute_in_delta(0.2, actual, 0.001, 'message')
 == Minitest/RefuteIncludes
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -824,7 +919,7 @@ refute_includes(collection, object, 'message')
 == Minitest/RefuteInstanceOf
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -856,7 +951,7 @@ refute_instance_of(Class, object, 'message')
 == Minitest/RefuteKindOf
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -888,7 +983,7 @@ refute_kind_of(Class, object, 'message')
 == Minitest/RefuteMatch
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -920,7 +1015,7 @@ refute_match(matcher, string, 'message')
 == Minitest/RefuteNil
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -954,7 +1049,7 @@ refute_nil(actual, 'message')
 == Minitest/RefutePathExists
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -986,7 +1081,7 @@ refute_path_exists(path, 'message')
 == Minitest/RefuteRespondTo
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
 | Yes
@@ -1020,7 +1115,7 @@ refute_respond_to(self, :do_something)
 == Minitest/TestMethodName
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -1060,7 +1155,7 @@ end
 == Minitest/UnreachableAssertion
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes
@@ -1092,7 +1187,7 @@ assert_equal('foo', obj.bar)
 == Minitest/UnspecifiedException
 
 |===
-| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
 | Yes

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

@@ -19,6 +19,18 @@ module RuboCop
         extend MinitestCopRule
 
         define_rule :assert, target_method: :empty?
+
+        remove_method :on_send
+        def on_send(node)
+          return unless node.method?(:assert)
+          return unless (arguments = peel_redundant_parentheses_from(node.arguments))
+          return unless arguments.first.respond_to?(:method?) && arguments.first.method?(:empty?)
+          return unless arguments.first.arguments.empty?
+
+          add_offense(node, message: offense_message(arguments)) do |corrector|
+            autocorrect(corrector, node, arguments)
+          end
+        end
       end
     end
   end

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the test to use `assert_empty`
-      # instead of using `assert_equal([], object)`.
+      # instead of using `assert_equal([], object)` or `assert_equal({}, object)`.
       #
       # @example
       #   # bad

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

@@ -6,8 +6,9 @@ module RuboCop
       # This cop tries to detect when a user accidentally used
       # `assert` when they meant to use `assert_equal`.
       #
-      # It is marked as unsafe because it is not possible to determine
-      # whether the second argument of `assert` is a message or not.
+      # @safety
+      #   This cop is unsafe because it is not possible to determine
+      #   whether the second argument of `assert` is a message or not.
       #
       # @example
       #   # bad

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

@@ -6,17 +6,83 @@ module RuboCop
       # This cop checks for deprecated global expectations
       # and autocorrects them to use expect format.
       #
-      # @example
+      # @example EnforcedStyle: _
       #   # bad
       #   musts.must_equal expected_musts
       #   wonts.wont_match expected_wonts
       #   musts.must_raise TypeError
       #
+      #   expect(musts).must_equal expected_musts
+      #   expect(wonts).wont_match expected_wonts
+      #   expect { musts }.must_raise TypeError
+      #
+      #   value(musts).must_equal expected_musts
+      #   value(wonts).wont_match expected_wonts
+      #   value { musts }.must_raise TypeError
+      #
       #   # good
       #   _(musts).must_equal expected_musts
       #   _(wonts).wont_match expected_wonts
       #   _ { musts }.must_raise TypeError
+      #
+      # @example EnforcedStyle: any (default)
+      #   # bad
+      #   musts.must_equal expected_musts
+      #   wonts.wont_match expected_wonts
+      #   musts.must_raise TypeError
+      #
+      #   # good
+      #   _(musts).must_equal expected_musts
+      #   _(wonts).wont_match expected_wonts
+      #   _ { musts }.must_raise TypeError
+      #
+      #   expect(musts).must_equal expected_musts
+      #   expect(wonts).wont_match expected_wonts
+      #   expect { musts }.must_raise TypeError
+      #
+      #   value(musts).must_equal expected_musts
+      #   value(wonts).wont_match expected_wonts
+      #   value { musts }.must_raise TypeError
+      #
+      # @example EnforcedStyle: expect
+      #   # bad
+      #   musts.must_equal expected_musts
+      #   wonts.wont_match expected_wonts
+      #   musts.must_raise TypeError
+      #
+      #   _(musts).must_equal expected_musts
+      #   _(wonts).wont_match expected_wonts
+      #   _ { musts }.must_raise TypeError
+      #
+      #   value(musts).must_equal expected_musts
+      #   value(wonts).wont_match expected_wonts
+      #   value { musts }.must_raise TypeError
+      #
+      #   # good
+      #   expect(musts).must_equal expected_musts
+      #   expect(wonts).wont_match expected_wonts
+      #   expect { musts }.must_raise TypeError
+      #
+      # @example EnforcedStyle: value
+      #   # bad
+      #   musts.must_equal expected_musts
+      #   wonts.wont_match expected_wonts
+      #   musts.must_raise TypeError
+      #
+      #   _(musts).must_equal expected_musts
+      #   _(wonts).wont_match expected_wonts
+      #   _ { musts }.must_raise TypeError
+      #
+      #   expect(musts).must_equal expected_musts
+      #   expect(wonts).wont_match expected_wonts
+      #   expect { 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
+        include ConfigurableEnforcedStyle
         extend AutoCorrector
 
         MSG = 'Use `%<preferred>s` instead.'
@@ -34,58 +100,63 @@ module RuboCop
 
         RESTRICT_ON_SEND = VALUE_MATCHERS + BLOCK_MATCHERS
 
-        VALUE_MATCHERS_STR = VALUE_MATCHERS.map do |m|
-          ":#{m}"
-        end.join(' ').freeze
+        # There are aliases for the `_` method - `expect` and `value`
+        DSL_METHODS = %i[_ expect value].freeze
 
-        BLOCK_MATCHERS_STR = BLOCK_MATCHERS.map do |m|
-          ":#{m}"
-        end.join(' ').freeze
+        def on_send(node)
+          receiver = node.receiver
+          return unless receiver
 
-        # There are aliases for the `_` method - `expect` and `value`
-        DSL_METHODS_LIST = %w[_ value expect].map do |n|
-          ":#{n}"
-        end.join(' ').freeze
+          method = block_receiver?(receiver) || value_receiver?(receiver)
+          return if method == preferred_method || (method && style == :any)
+
+          register_offense(node, method)
+        end
 
-        def_node_matcher :value_global_expectation?, <<~PATTERN
-          (send !(send nil? {#{DSL_METHODS_LIST}} _) {#{VALUE_MATCHERS_STR}} ...)
+        private
+
+        def_node_matcher :block_receiver?, <<~PATTERN
+          (block (send nil? $#method_allowed?) _ _)
         PATTERN
 
-        def_node_matcher :block_global_expectation?, <<~PATTERN
-          (send
-            [
-              !(send nil? {#{DSL_METHODS_LIST}} _)
-              !(block (send nil? {#{DSL_METHODS_LIST}}) _ _)
-            ]
-            {#{BLOCK_MATCHERS_STR}}
-            _
-          )
+        def_node_matcher :value_receiver?, <<~PATTERN
+          (send nil? $#method_allowed? _)
         PATTERN
 
-        def on_send(node)
-          return unless value_global_expectation?(node) || block_global_expectation?(node)
+        def method_allowed?(method)
+          DSL_METHODS.include?(method)
+        end
 
-          message = format(MSG, preferred: preferred_receiver(node))
+        def preferred_method
+          style == :any ? :_ : style
+        end
 
-          add_offense(node.receiver.source_range, message: message) do |corrector|
-            receiver = node.receiver.source_range
+        def preferred_receiver(node)
+          receiver = node.receiver
 
-            if BLOCK_MATCHERS.include?(node.method_name)
-              corrector.wrap(receiver, '_ { ', ' }')
-            else
-              corrector.wrap(receiver, '_(', ')')
-            end
+          if BLOCK_MATCHERS.include?(node.method_name)
+            body = receiver.lambda? ? receiver.body : receiver
+            "#{preferred_method} { #{body.source} }"
+          else
+            "#{preferred_method}(#{receiver.source})"
           end
         end
 
-        private
+        def register_offense(node, method)
+          receiver = node.receiver
 
-        def preferred_receiver(node)
-          source = node.receiver.source
-          if BLOCK_MATCHERS.include?(node.method_name)
-            "_ { #{source} }"
+          if method
+            preferred = preferred_method
+            replacement = receiver.source.sub(method.to_s, preferred_method.to_s)
           else
-            "_(#{source})"
+            preferred = preferred_receiver(node)
+            replacement = preferred
+          end
+
+          message = format(MSG, preferred: preferred)
+
+          add_offense(receiver, message: message) do |corrector|
+            corrector.replace(receiver, replacement)
           end
         end
       end

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

@@ -27,17 +27,16 @@ module RuboCop
         def on_send(node)
           return unless node.method?(:assert_equal)
 
-          actual = node.arguments[1]
+          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)
+            autocorrect(corrector, node, expected, actual, message)
           end
         end
 
-        def autocorrect(corrector, node)
-          expected, actual, message = *node.arguments
-
+        def autocorrect(corrector, node, expected, actual, message)
           new_actual_source = if actual.hash_type? && !actual.braces?
                                 "{#{actual.source}}"
                               else