rubocop-minitest 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add241b07281db4494e25119722057177e5eb15056360b0907d4b58819b6f371
-  data.tar.gz: 0dbe3916ea796caa3c59e04df1b13ade8a11c25b7613187308b3ea90348380fa
+  metadata.gz: 95cf5254c67b24f10e4739b82656ebcd96fba6924832abaaf3045aacbb33708f
+  data.tar.gz: 7aa03cd9becf56e2c2f27c59e0757d2e451a8866c212c713e1370bcc69e04c83
 SHA512:
-  metadata.gz: 4ab3dd3b82e55154731f600b942f2ef3dd48e85bf55d8d5d09c94bcb5227e409ea201c45be221cfde00cdb434d4877508bfad26cc7d3d3427c531c0babf146c1
-  data.tar.gz: 261d27488e8ee453f9307bb4367a7072dddb544c0dd73c5ac4e70e033875be7916519cf346ede3c5956023d81e5cf0f22b6ab284c85650a8987b0fa95c77f18d
+  metadata.gz: cd2b68e25392718c159b1d43dfabe0529f00a11230322d14a3c8b987e16b177a976ffacb37f97015c062a22e3f3c195e82f7ebd897b97c374682f909a0fe8805
+  data.tar.gz: 29a54d7e19f8ad4b06c9bf443adf13c0920e5ab55413618a3268fb81253c6e96d16540a733677ab5b9e6340a172d58164d0f01f3f7c2725bfd90cbcbaf04e515

data/.github/workflows/linting.yml

@@ -6,7 +6,7 @@ jobs:
     name: Yamllint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Yamllint
         uses: karancode/yamllint-github-action@master
         with:

data/.github/workflows/spell_checking.yml

@@ -10,7 +10,7 @@ jobs:
       matrix:
         python-version: [3.8]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
@@ -26,7 +26,7 @@ jobs:
     name: Check spelling of all files in commit with misspell
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install
         run: wget -O - -q https://git.io/misspell | sh -s -- -b .
       - name: Misspell

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.19.0 (2022-04-05)
+
+### New features
+
+* [#164](https://github.com/rubocop/rubocop-minitest/pull/164): Add new `Minitest/DuplicateTestRun cop. ([@ignacio-chiazzo][])
+
 ## 0.18.0 (2022-03-13)
 
 ### New features
@@ -286,3 +292,4 @@
 [@cstyles]: https://github.com/cstyles
 [@ghiculescu]: https://github.com/ghiculescu
 [@gi]: https://github.com/gi
+[@ignacio-chiazzo]: https://github.com/ignacio-chiazzo

data/config/default.yml

@@ -28,17 +28,6 @@ Minitest/AssertInDelta:
   Enabled: 'pending'
   VersionAdded: '0.10'
 
-Minitest/AssertionInLifecycleHook:
-  Description: 'This cop checks for usage of assertions in lifecycle hooks.'
-  Enabled: 'pending'
-  VersionAdded: '0.10'
-
-Minitest/AssertMatch:
-  Description: 'This cop enforces the test to use `assert_match` instead of using `assert(matcher.match(object))`.'
-  StyleGuide: 'https://minitest.rubystyle.guide#assert-match'
-  Enabled: true
-  VersionAdded: '0.6'
-
 Minitest/AssertIncludes:
   Description: 'This cop enforces the test to use `assert_includes` instead of using `assert(collection.include?(object))`.'
   StyleGuide: 'https://minitest.rubystyle.guide#assert-includes'
@@ -57,6 +46,12 @@ Minitest/AssertKindOf:
   Enabled: 'pending'
   VersionAdded: '0.10'
 
+Minitest/AssertMatch:
+  Description: 'This cop enforces the test to use `assert_match` instead of using `assert(matcher.match(object))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-match'
+  Enabled: true
+  VersionAdded: '0.6'
+
 Minitest/AssertNil:
   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'
@@ -75,18 +70,18 @@ Minitest/AssertPathExists:
   Enabled: 'pending'
   VersionAdded: '0.10'
 
-Minitest/AssertRespondTo:
-  Description: 'This cop enforces the test to use `assert_respond_to(object, :do_something)` over `assert(object.respond_to?(:do_something))`.'
-  StyleGuide: 'https://minitest.rubystyle.guide#assert-responds-to-method'
-  Enabled: true
-  VersionAdded: '0.3'
-
 Minitest/AssertPredicate:
   Description: 'This cop enforces the test to use `assert_predicate` instead of using `assert(obj.a_predicate_method?)`.'
   StyleGuide: 'https://minitest.rubystyle.guide/#assert-predicate'
   Enabled: pending
   VersionAdded: '0.18'
 
+Minitest/AssertRespondTo:
+  Description: 'This cop enforces the test to use `assert_respond_to(object, :do_something)` over `assert(object.respond_to?(:do_something))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-responds-to-method'
+  Enabled: true
+  VersionAdded: '0.3'
+
 Minitest/AssertSilent:
   Description: "This cop enforces the test to use `assert_silent { ... }` instead of using `assert_output('', '') { ... }`."
   StyleGuide: 'https://github.com/rubocop/minitest-style-guide#assert-silent'
@@ -105,6 +100,16 @@ Minitest/AssertWithExpectedArgument:
   Safe: false
   VersionAdded: '0.11'
 
+Minitest/AssertionInLifecycleHook:
+  Description: 'This cop checks for usage of assertions in lifecycle hooks.'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
+Minitest/DuplicateTestRun:
+  Description: 'This cop detects duplicate test runs caused by one test class inheriting from another.'
+  Enabled: pending
+  VersionAdded: '0.19'
+
 Minitest/GlobalExpectations:
   Description: 'This cop checks for deprecated global expectations.'
   StyleGuide: 'https://minitest.rubystyle.guide#global-expectations'
@@ -170,12 +175,6 @@ Minitest/RefuteIncludes:
   Enabled: true
   VersionAdded: '0.3'
 
-Minitest/RefuteMatch:
-  Description: 'This cop enforces the test to use `refute_match` instead of using `refute(matcher.match(object))`.'
-  StyleGuide: 'https://minitest.rubystyle.guide#refute-match'
-  Enabled: true
-  VersionAdded: '0.6'
-
 Minitest/RefuteInstanceOf:
   Description: 'This cop enforces the test to use `refute_instance_of(Class, object)` over `refute(object.instance_of?(Class))`.'
   StyleGuide: 'https://minitest.rubystyle.guide#refute-instance-of'
@@ -188,6 +187,12 @@ Minitest/RefuteKindOf:
   Enabled: 'pending'
   VersionAdded: '0.10'
 
+Minitest/RefuteMatch:
+  Description: 'This cop enforces the test to use `refute_match` instead of using `refute(matcher.match(object))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-match'
+  Enabled: true
+  VersionAdded: '0.6'
+
 Minitest/RefuteNil:
   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'

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

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

@@ -30,6 +30,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestasserttruthy[Minitest/AssertTruthy]
 * xref:cops_minitest.adoc#minitestassertwithexpectedargument[Minitest/AssertWithExpectedArgument]
 * xref:cops_minitest.adoc#minitestassertioninlifecyclehook[Minitest/AssertionInLifecycleHook]
+* xref:cops_minitest.adoc#minitestduplicatetestrun[Minitest/DuplicateTestRun]
 * xref:cops_minitest.adoc#minitestglobalexpectations[Minitest/GlobalExpectations]
 * xref:cops_minitest.adoc#minitestliteralasactualargument[Minitest/LiteralAsActualArgument]
 * xref:cops_minitest.adoc#minitestmultipleassertions[Minitest/MultipleAssertions]

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

@@ -544,6 +544,63 @@ 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 offence 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
+----
+
 == Minitest/GlobalExpectations
 
 |===

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # 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.
+      #
+      # @example
+      #   # 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
+      #
+      class DuplicateTestRun < Base
+        include MinitestExplorationHelpers
+
+        MSG = "Subclasses with test methods causes the parent' tests to run them twice."
+
+        def on_class(class_node)
+          return unless test_class?(class_node)
+          return unless test_methods?(class_node)
+          return unless parent_class_has_test_methods?(class_node)
+
+          message = format(MSG)
+          add_offense(class_node, message: message)
+        end
+
+        private
+
+        def parent_class_has_test_methods?(class_node)
+          parent_class = class_node.parent_class
+          parent_class_node = class_node.parent.each_child_node(:class).detect do |klass|
+            klass.identifier == parent_class
+          end
+
+          return false unless parent_class_node
+
+          test_methods?(parent_class_node)
+        end
+
+        def test_methods?(class_node)
+          test_cases(class_node).size.positive?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest_cops.rb

@@ -23,6 +23,7 @@ require_relative 'minitest/assert_path_exists'
 require_relative 'minitest/assert_respond_to'
 require_relative 'minitest/assert_silent'
 require_relative 'minitest/assert_truthy'
+require_relative 'minitest/duplicate_test_run'
 require_relative 'minitest/global_expectations'
 require_relative 'minitest/literal_as_actual_argument'
 require_relative 'minitest/multiple_assertions'

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.18.0'
+      STRING = '0.19.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/relnotes/v0.19.0.md

@@ -0,0 +1,5 @@
+### New features
+
+* [#164](https://github.com/rubocop/rubocop-minitest/pull/164): Add new `Minitest/DuplicateTestRun cop. ([@ignacio-chiazzo][])
+
+[@ignacio-chiazzo]: https://github.com/ignacio-chiazzo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -108,6 +108,7 @@ files:
 - lib/rubocop/cop/minitest/assert_truthy.rb
 - lib/rubocop/cop/minitest/assert_with_expected_argument.rb
 - lib/rubocop/cop/minitest/assertion_in_lifecycle_hook.rb
+- lib/rubocop/cop/minitest/duplicate_test_run.rb
 - lib/rubocop/cop/minitest/global_expectations.rb
 - lib/rubocop/cop/minitest/literal_as_actual_argument.rb
 - lib/rubocop/cop/minitest/multiple_assertions.rb
@@ -160,6 +161,7 @@ files:
 - relnotes/v0.17.1.md
 - relnotes/v0.17.2.md
 - relnotes/v0.18.0.md
+- relnotes/v0.19.0.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -186,7 +188,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.18
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.19
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message: