rubocop-minitest 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75689600fc3dd6dc4fe96f80dc7c7e8a3b26e59978a15334f58c12421279873f
-  data.tar.gz: afad72a5c22682e4c79fffae91c7f49d25f08d925ed001bec887f8624ad1a391
+  metadata.gz: 6c35365ef5838d4a75f01181865e860ecb774a73288a310ffe2bfec21b6c6001
+  data.tar.gz: ccbdb0bb831bcebec0cde35263bf90063e400a25d97bccb9facf3edbc0bbd23a
 SHA512:
-  metadata.gz: 7c3c53d4f3e5915a39babb33862bc7ee9a1aef01e76fa680581723631c6a101a04af01f15fa33047c01f2dd57b99d44ac3da99f66bf5f06b8923e07f5c03f986
-  data.tar.gz: 649292ccae1c3a021f9c72399b03f3b38bf223c78e492e7ec93a5c030a73c920c3e1b7cae305d21b3942a68fe57d5451105e184fd20166f9820878bf077decc1
+  metadata.gz: 0a85bb1c4f0226eb025cdf18ae72757403ea71b422b19291e80bf696c95735cb2ddd3f61f921ad01c04c88ef731aa3e39d68141ac8971315e5933575cab6ec8c
+  data.tar.gz: b449004eb3a26c8996490d5e5008e784f10660edba75e99a7b3d5ef317d6c4585757aee59e7c95fb7100d892a2769c88bf26f42ac96684488945a5e9ee775155

data/.circleci/config.yml

@@ -35,9 +35,6 @@ workflows:
   build:
     jobs:
       - documentation-checks
-      - rake_default:
-          name: Ruby 2.5
-          image: cimg/ruby:2.5
       - rake_default:
           name: Ruby 2.6
           image: cimg/ruby:2.6

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
 name: Feature Request
-about: Suggest new RuboCop Rails features or improvements to existing features.
+about: Suggest new RuboCop Minitest features or improvements to existing features.
 ---
 
 ## Is your feature request related to a problem? Please describe.

data/.github/workflows/spell_checking.yml

@@ -28,6 +28,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Install
-        run: wget -O - -q https://git.io/misspell | sh -s -- -b .
+        run: wget -O - -q https://raw.githubusercontent.com/client9/misspell/master/install-misspell.sh | sh -s -- -b .
       - name: Misspell
         run: git ls-files --empty-directory | xargs ./misspell -error

data/.rubocop.yml

@@ -9,7 +9,7 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   SuggestExtensions: false
 
 InternalAffairs/NodeMatcherDirective:
@@ -28,7 +28,12 @@ Naming/PredicateName:
     - def_node_search
 
 Naming/InclusiveLanguage:
+  Enabled: true
+  CheckStrings: true
   FlaggedTerms:
+    behaviour:
+      Suggestions:
+        - behavior
     offence:
       Suggestions:
         - offense

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master (unreleased)
 
+## 0.20.0 (2022-05-29)
+
+### New features
+
+* [#169](https://github.com/rubocop/rubocop-minitest/issues/169): Add new `Minitest/SkipEnsure` cop. ([@koic][])
+
+### Bug fixes
+
+* [#172](https://github.com/rubocop/rubocop-minitest/issues/172): Fix a false positive for `Minitest/AssertPredicate` and `Minitest/RefutePredicate` when using numbered parameters. ([@koic][])
+
+### Changes
+
+* [#168](https://github.com/rubocop/rubocop-minitest/pull/168): **(Compatibility)** Drop Ruby 2.5 support. ([@koic][])
+
 ## 0.19.1 (2022-04-10)
 
 ### Bug fixes
@@ -57,7 +71,7 @@
 
 ### Bug fixes
 
-* [#145](https://github.com/rubocop/rubocop-minitest/pull/145): Mark `Minitest/AssertEmptyLiteral` as safe auto-correction. ([@koic][])
+* [#145](https://github.com/rubocop/rubocop-minitest/pull/145): Mark `Minitest/AssertEmptyLiteral` as safe autocorrection. ([@koic][])
 
 ## 0.15.1 (2021-09-26)
 
@@ -97,7 +111,7 @@
 
 ### Changes
 
-* [#129](https://github.com/rubocop/rubocop-minitest/pull/129): Drop Ruby 2.4 support. ([@koic][])
+* [#129](https://github.com/rubocop/rubocop-minitest/pull/129): **(Compatibility)** Drop Ruby 2.4 support. ([@koic][])
 
 ## 0.11.1 (2021-03-31)
 
@@ -167,7 +181,7 @@
 ### Changes
 
 * [#73](https://github.com/rubocop/rubocop-minitest/issues/73): The Minitest department works on file names end with `_test.rb` by default. ([@koic][])
-* [#77](https://github.com/rubocop/rubocop-minitest/pull/77): **(BREAKING)** Drop support for Ruby 2.3. ([@koic][])
+* [#77](https://github.com/rubocop/rubocop-minitest/pull/77): **(Compatibility)** Drop support for Ruby 2.3. ([@koic][])
 
 ## 0.8.1 (2020-04-06)
 

data/CONTRIBUTING.md

@@ -49,7 +49,7 @@ $ rubocop -V
 Here are a few examples:
 
 ```
-* [#716](https://github.com/rubocop/rubocop-minitest/issues/716): Fixed a regression in the auto-correction logic of `MethodDefParentheses`. ([@bbatsov][])
+* [#716](https://github.com/rubocop/rubocop-minitest/issues/716): Fixed a regression in the autocorrection logic of `MethodDefParentheses`. ([@bbatsov][])
 * New cop `ElseLayout` checks for odd arrangement of code in the `else` branch of a conditional expression. ([@bbatsov][])
 ```
 

data/Gemfile

@@ -9,7 +9,7 @@ gemspec
 gem 'bump', require: false
 gem 'rake'
 gem 'rubocop', github: 'rubocop/rubocop'
-gem 'rubocop-performance', '~> 1.12.0'
+gem 'rubocop-performance', '~> 1.13.0'
 gem 'yard', '~> 0.9'
 
 local_gemfile = File.expand_path('Gemfile.local', __dir__)

data/config/default.yml

@@ -107,6 +107,7 @@ Minitest/AssertionInLifecycleHook:
 
 Minitest/DuplicateTestRun:
   Description: 'This cop detects duplicate test runs caused by one test class inheriting from another.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#subclassing-test-cases'
   Enabled: pending
   VersionAdded: '0.19'
 
@@ -217,6 +218,11 @@ Minitest/RefuteRespondTo:
   Enabled: true
   VersionAdded: '0.4'
 
+Minitest/SkipEnsure:
+  Description: 'Checks that `ensure` call even if `skip`.'
+  Enabled: pending
+  VersionAdded: '0.20'
+
 Minitest/TestMethodName:
   Description: 'This cop enforces that test method names start with `test_` prefix.'
   Enabled: 'pending'

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.19'
+version: '0.20'
 nav:
   - modules/ROOT/nav.adoc

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

@@ -47,6 +47,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestrefutepathexists[Minitest/RefutePathExists]
 * xref:cops_minitest.adoc#minitestrefutepredicate[Minitest/RefutePredicate]
 * xref:cops_minitest.adoc#minitestrefuterespondto[Minitest/RefuteRespondTo]
+* xref:cops_minitest.adoc#minitestskipensure[Minitest/SkipEnsure]
 * xref:cops_minitest.adoc#minitesttestmethodname[Minitest/TestMethodName]
 * xref:cops_minitest.adoc#minitestunreachableassertion[Minitest/UnreachableAssertion]
 * xref:cops_minitest.adoc#minitestunspecifiedexception[Minitest/UnspecifiedException]

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
 
@@ -560,7 +557,7 @@ 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 offence to the Child class in such a case.
+This cop will add an offense to the Child class in such a case.
 
 === Examples
 
@@ -601,6 +598,10 @@ class ChildTest
 end
 ----
 
+=== References
+
+* https://minitest.rubystyle.guide/#subclassing-test-cases
+
 == Minitest/GlobalExpectations
 
 |===
@@ -613,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
@@ -740,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
@@ -774,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
@@ -825,7 +826,7 @@ end
 | -
 |===
 
-This cop checks if test cases contain any assertion calls.
+Checks if test cases contain any assertion calls.
 
 === Examples
 
@@ -857,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
 
@@ -889,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
@@ -920,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
 
@@ -955,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
@@ -987,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
@@ -1019,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
@@ -1051,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
@@ -1083,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
@@ -1115,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
@@ -1151,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
 
@@ -1183,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
@@ -1215,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
@@ -1237,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
 
 |===
@@ -1249,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
@@ -1289,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
@@ -1321,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