rubocop-minitest 0.18.0 → 0.20.0

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

@@ -12,8 +12,7 @@
 | -
 |===
 
-This cop enforces the test to use `assert_empty`
-instead of using `assert(object.empty?)`.
+Enforces the test to use `assert_empty` instead of using `assert(object.empty?)`.
 
 === Examples
 
@@ -44,7 +43,7 @@ assert_empty(object, 'message')
 | 0.11
 |===
 
-This cop enforces the test to use `assert_empty`
+Enforces the test to use `assert_empty`
 instead of using `assert_equal([], object)` or `assert_equal({}, object)`.
 
 === Examples
@@ -71,7 +70,7 @@ assert_empty(object)
 | -
 |===
 
-This cop enforces the use of `assert_equal(expected, actual)`
+Enforces the use of `assert_equal(expected, actual)`
 over `assert(expected == actual)`.
 
 === Examples
@@ -101,7 +100,7 @@ assert_equal("rubocop-minitest", actual)
 | -
 |===
 
-This cop enforces the test to use `assert_in_delta`
+Enforces the test to use `assert_in_delta`
 instead of using `assert_equal` to compare floats.
 
 === Examples
@@ -133,7 +132,7 @@ assert_in_delta(0.2, actual, 0.001, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_includes`
+Enforces the test to use `assert_includes`
 instead of using `assert(collection.include?(object))`.
 
 === Examples
@@ -165,7 +164,7 @@ assert_includes(collection, object, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_instance_of(Class, object)`
+Enforces the test to use `assert_instance_of(Class, object)`
 over `assert(object.instance_of?(Class))`.
 
 === Examples
@@ -197,7 +196,7 @@ assert_instance_of(Class, object, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_kind_of(Class, object)`
+Enforces the test to use `assert_kind_of(Class, object)`
 over `assert(object.kind_of?(Class))`.
 
 === Examples
@@ -229,7 +228,7 @@ assert_kind_of(Class, object, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_match`
+Enforces the test to use `assert_match`
 instead of using `assert(matcher.match(string))`.
 
 === Examples
@@ -261,7 +260,7 @@ assert_match(matcher, string, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_nil` instead of using
+Enforces the test to use `assert_nil` instead of using
 `assert_equal(nil, something)`, `assert(something.nil?)`, or `assert_predicate(something, :nil?)`.
 
 === Examples
@@ -297,7 +296,7 @@ assert_nil(actual, 'message')
 | -
 |===
 
-This cop checks for opportunities to use `assert_output`.
+Checks for opportunities to use `assert_output`.
 
 === Examples
 
@@ -329,8 +328,7 @@ assert_output(expected) { puts object.method }
 | -
 |===
 
-This cop enforces the test to use `assert_path_exists`
-instead of using `assert(File.exist?(path))`.
+Enforces the test to use `assert_path_exists` instead of using `assert(File.exist?(path))`.
 
 === Examples
 
@@ -361,7 +359,7 @@ assert_path_exists(path, 'message')
 | -
 |===
 
-This cop enforces the test to use `assert_predicate`
+Enforces the test to use `assert_predicate`
 instead of using `assert(obj.a_predicate_method?)`.
 
 === Examples
@@ -393,7 +391,7 @@ assert_predicate(obj, :one?, 'message')
 | -
 |===
 
-This cop enforces the use of `assert_respond_to(object, :do_something)`
+Enforces the use of `assert_respond_to(object, :do_something)`
 over `assert(object.respond_to?(:do_something))`.
 
 === Examples
@@ -427,7 +425,7 @@ assert_respond_to(self, :do_something)
 | -
 |===
 
-This cop enforces the test to use `assert_silent { ... }`
+Enforces the test to use `assert_silent { ... }`
 instead of using `assert_output('', '') { ... }`.
 
 === Examples
@@ -457,8 +455,7 @@ assert_silent { puts object.do_something }
 | -
 |===
 
-This cop enforces the test to use `assert(actual)`
-instead of using `assert_equal(true, actual)`.
+Enforces the test to use `assert(actual)` instead of using `assert_equal(true, actual)`.
 
 === Examples
 
@@ -489,7 +486,7 @@ assert(actual, 'message')
 | -
 |===
 
-This cop tries to detect when a user accidentally used
+Tries to detect when a user accidentally used
 `assert` when they meant to use `assert_equal`.
 
 === Safety
@@ -523,7 +520,7 @@ assert(foo, 'message')
 | -
 |===
 
-This cop checks for usage of assertions in lifecycle hooks.
+Checks for usage of assertions in lifecycle hooks.
 
 === Examples
 
@@ -544,6 +541,67 @@ class FooTest < Minitest::Test
 end
 ----
 
+== Minitest/DuplicateTestRun
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| No
+| 0.19
+| -
+|===
+
+If a Minitest class inherits from another class,
+it will also inherit its methods causing Minitest to run the parent's tests methods twice.
+
+This cop detects when there are two tests classes, one inherits from the other, and both have tests methods.
+This cop will add an offense to the Child class in such a case.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+class ParentTest < Minitest::Test
+  def test_parent # it will run this test twice.
+  end
+end
+
+class ChildTest < ParentTest
+  def test_child
+  end
+end
+
+# good
+class ParentTest < Minitest::Test
+  def test_parent
+  end
+end
+
+class ChildTest < Minitest::Test
+  def test_child
+  end
+end
+
+# good
+class ParentTest < Minitest::Test
+end
+
+class ChildTest
+  def test_child
+  end
+
+  def test_parent
+  end
+end
+----
+
+=== References
+
+* https://minitest.rubystyle.guide/#subclassing-test-cases
+
 == Minitest/GlobalExpectations
 
 |===
@@ -556,7 +614,7 @@ end
 | 0.16
 |===
 
-This cop checks for deprecated global expectations
+Checks for deprecated global expectations
 and autocorrects them to use expect format.
 
 === Examples
@@ -683,7 +741,7 @@ value { musts }.must_raise TypeError
 | -
 |===
 
-This cop enforces correct order of expected and
+Enforces correct order of expected and
 actual arguments for `assert_equal`.
 
 === Examples
@@ -717,7 +775,7 @@ assert_equal [1, 2], foo, 'message'
 | -
 |===
 
-This cop checks if test cases contain too many assertion calls.
+Checks if test cases contain too many assertion calls.
 The maximum allowed assertion calls is configurable.
 
 === Examples
@@ -768,7 +826,7 @@ end
 | -
 |===
 
-This cop checks if test cases contain any assertion calls.
+Checks if test cases contain any assertion calls.
 
 === Examples
 
@@ -800,8 +858,7 @@ end
 | -
 |===
 
-This cop enforces to use `refute_empty` instead of
-using `refute(object.empty?)`.
+Enforces to use `refute_empty` instead of using `refute(object.empty?)`.
 
 === Examples
 
@@ -832,7 +889,7 @@ refute_empty(object, 'message')
 | -
 |===
 
-This cop enforces the use of `refute_equal(expected, object)`
+Enforces the use of `refute_equal(expected, object)`
 over `assert(expected != actual)` or `assert(! expected == actual)`.
 
 === Examples
@@ -863,8 +920,7 @@ refute_equal("rubocop-minitest", actual)
 | -
 |===
 
-This cop enforces the use of `refute(object)`
-over `assert_equal(false, object)`.
+Enforces the use of `refute(object)` over `assert_equal(false, object)`.
 
 === Examples
 
@@ -898,7 +954,7 @@ refute(actual, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_in_delta`
+Enforces the test to use `refute_in_delta`
 instead of using `refute_equal` to compare floats.
 
 === Examples
@@ -930,7 +986,7 @@ refute_in_delta(0.2, actual, 0.001, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_includes`
+Enforces the test to use `refute_includes`
 instead of using `refute(collection.include?(object))`.
 
 === Examples
@@ -962,7 +1018,7 @@ refute_includes(collection, object, 'message')
 | -
 |===
 
-This cop enforces the use of `refute_instance_of(Class, object)`
+Enforces the use of `refute_instance_of(Class, object)`
 over `refute(object.instance_of?(Class))`.
 
 === Examples
@@ -994,7 +1050,7 @@ refute_instance_of(Class, object, 'message')
 | -
 |===
 
-This cop enforces the use of `refute_kind_of(Class, object)`
+Enforces the use of `refute_kind_of(Class, object)`
 over `refute(object.kind_of?(Class))`.
 
 === Examples
@@ -1026,7 +1082,7 @@ refute_kind_of(Class, object, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_match`
+Enforces the test to use `refute_match`
 instead of using `refute(matcher.match(string))`.
 
 === Examples
@@ -1058,7 +1114,7 @@ refute_match(matcher, string, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_nil` instead of using
+Enforces the test to use `refute_nil` instead of using
 `refute_equal(nil, something)`, `refute(something.nil?)`, or `refute_predicate(something, :nil?)`.
 
 === Examples
@@ -1094,8 +1150,7 @@ refute_nil(actual, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_path_exists`
-instead of using `refute(File.exist?(path))`.
+Enforces the test to use `refute_path_exists` instead of using `refute(File.exist?(path))`.
 
 === Examples
 
@@ -1126,7 +1181,7 @@ refute_path_exists(path, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_predicate`
+Enforces the test to use `refute_predicate`
 instead of using `refute(obj.a_predicate_method?)`.
 
 === Examples
@@ -1158,7 +1213,7 @@ refute_predicate(obj, :one?, 'message')
 | -
 |===
 
-This cop enforces the test to use `refute_respond_to(object, :do_something)`
+Enforces the test to use `refute_respond_to(object, :do_something)`
 over `refute(object.respond_to?(:do_something))`.
 
 === Examples
@@ -1180,6 +1235,79 @@ refute_respond_to(self, :do_something)
 
 * https://minitest.rubystyle.guide#refute-respond-to
 
+== Minitest/SkipEnsure
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| No
+| 0.20
+| -
+|===
+
+Checks that `ensure` call even if `skip`. It is unexpected that `ensure` will be called when skipping test.
+If conditional `skip` is used, it checks that `ensure` is also called conditionally.
+
+On the other hand, it accepts `skip` used in `rescue` because `ensure` may be teardown process to `begin`
+setup process.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+def test_skip
+  skip 'This test is skipped.'
+
+  assert 'foo'.present?
+ensure
+  do_something
+end
+
+# bad
+def test_conditional_skip
+  skip 'This test is skipped.' if condition
+
+  assert do_something
+ensure
+  do_teardown
+end
+
+# good
+def test_skip
+  skip 'This test is skipped.'
+
+  begin
+    assert 'foo'.present?
+  ensure
+    do_something
+  end
+end
+
+# good
+def test_conditional_skip
+  skip 'This test is skipped.' if condition
+
+  assert do_something
+ensure
+  if condition
+    do_teardown
+  end
+end
+
+# good
+def test_skip_is_used_in_rescue
+  do_setup
+  assert do_something
+rescue
+  skip 'This test is skipped.'
+ensure
+  do_teardown
+end
+----
+
 == Minitest/TestMethodName
 
 |===
@@ -1192,7 +1320,7 @@ refute_respond_to(self, :do_something)
 | -
 |===
 
-This cop enforces that test method names start with `test_` prefix.
+Enforces that test method names start with `test_` prefix.
 It aims to prevent tests that aren't executed by forgetting to start test method name with `test_`.
 
 === Examples
@@ -1232,7 +1360,7 @@ end
 | -
 |===
 
-This cop checks for `assert_raises` has an assertion method at
+Checks for `assert_raises` has an assertion method at
 the bottom of block because the assertion will be never reached.
 
 === Examples
@@ -1264,7 +1392,7 @@ assert_equal('foo', obj.bar)
 | -
 |===
 
-This cop checks for a specified error in `assert_raises`.
+Checks for a specified error in `assert_raises`.
 
 === Examples
 

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

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_empty`
-      # instead of using `assert(object.empty?)`.
+      # Enforces the test to use `assert_empty` instead of using `assert(object.empty?)`.
       #
       # @example
       #   # bad

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

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

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the use of `assert_equal(expected, actual)`
+      # Enforces the use of `assert_equal(expected, actual)`
       # over `assert(expected == actual)`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_in_delta`
+      # Enforces the test to use `assert_in_delta`
       # instead of using `assert_equal` to compare floats.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_includes`
+      # Enforces the test to use `assert_includes`
       # instead of using `assert(collection.include?(object))`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_instance_of(Class, object)`
+      # Enforces the test to use `assert_instance_of(Class, object)`
       # over `assert(object.instance_of?(Class))`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_kind_of(Class, object)`
+      # Enforces the test to use `assert_kind_of(Class, object)`
       # over `assert(object.kind_of?(Class))`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_match`
+      # Enforces the test to use `assert_match`
       # instead of using `assert(matcher.match(string))`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_nil` instead of using
+      # Enforces the test to use `assert_nil` instead of using
       # `assert_equal(nil, something)`, `assert(something.nil?)`, or `assert_predicate(something, :nil?)`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop checks for opportunities to use `assert_output`.
+      # Checks for opportunities to use `assert_output`.
       #
       # @example
       #   # bad

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

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_path_exists`
-      # instead of using `assert(File.exist?(path))`.
+      # Enforces the test to use `assert_path_exists` instead of using `assert(File.exist?(path))`.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_predicate`
+      # Enforces the test to use `assert_predicate`
       # instead of using `assert(obj.a_predicate_method?)`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the use of `assert_respond_to(object, :do_something)`
+      # Enforces the use of `assert_respond_to(object, :do_something)`
       # over `assert(object.respond_to?(:do_something))`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert_silent { ... }`
+      # Enforces the test to use `assert_silent { ... }`
       # instead of using `assert_output('', '') { ... }`.
       #
       # @example

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

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop enforces the test to use `assert(actual)`
-      # instead of using `assert_equal(true, actual)`.
+      # Enforces the test to use `assert(actual)` instead of using `assert_equal(true, actual)`.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop tries to detect when a user accidentally used
+      # Tries to detect when a user accidentally used
       # `assert` when they meant to use `assert_equal`.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Minitest
-      # This cop checks for usage of assertions in lifecycle hooks.
+      # Checks for usage of assertions in lifecycle hooks.
       #
       # @example
       #   # bad