feat: support PHPUnit v9.1 naming for some asserts

doc/ruleSets/PHPUnit100MigrationRisky.rst

@@ -15,7 +15,7 @@ Using this rule set may lead to changes in your code's logic and behaviour. Use
 Rules
 -----
 
-- `@PHPUnit84Migration:risky <./PHPUnit84MigrationRisky.rst>`_
+- `@PHPUnit91Migration:risky <./PHPUnit91MigrationRisky.rst>`_
 - `php_unit_data_provider_static <./../rules/php_unit/php_unit_data_provider_static.rst>`_ with config:
 
   ``['force' => true]``

doc/ruleSets/PHPUnit91MigrationRisky.rst

@@ -0,0 +1,22 @@
+======================================
+Rule set ``@PHPUnit91Migration:risky``
+======================================
+
+Rules to improve tests code for PHPUnit 9.1 compatibility.
+
+Warning
+-------
+
+This set contains rules that are risky
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Using this rule set may lead to changes in your code's logic and behaviour. Use it with caution and review changes before incorporating them into your code base.
+
+Rules
+-----
+
+- `@PHPUnit84Migration:risky <./PHPUnit84MigrationRisky.rst>`_
+- `php_unit_dedicate_assert <./../rules/php_unit/php_unit_dedicate_assert.rst>`_ with config:
+
+  ``['target' => '9.1']``
+

doc/ruleSets/index.rst

@@ -39,6 +39,7 @@ List of Available Rule sets
 - `@PHPUnit60Migration:risky <./PHPUnit60MigrationRisky.rst>`_
 - `@PHPUnit75Migration:risky <./PHPUnit75MigrationRisky.rst>`_
 - `@PHPUnit84Migration:risky <./PHPUnit84MigrationRisky.rst>`_
+- `@PHPUnit91Migration:risky <./PHPUnit91MigrationRisky.rst>`_
 - `@PHPUnit100Migration:risky <./PHPUnit100MigrationRisky.rst>`_
 - `@PSR1 <./PSR1.rst>`_
 - `@PSR2 <./PSR2.rst>`_

doc/rules/php_unit/php_unit_dedicate_assert.rst

@@ -21,7 +21,7 @@ Configuration
 
 Target version of PHPUnit.
 
-Allowed values: ``'3.0'``, ``'3.5'``, ``'5.0'``, ``'5.6'`` and ``'newest'``
+Allowed values: ``'3.0'``, ``'3.5'``, ``'5.0'``, ``'5.6'``, ``'9.1'`` and ``'newest'``
 
 Default value: ``'newest'``
 
@@ -133,9 +133,13 @@ The rule is part of the following rule sets:
 
   ``['target' => '5.6']``
 
+- `@PHPUnit91Migration:risky <./../../ruleSets/PHPUnit91MigrationRisky.rst>`_ with config:
+
+  ``['target' => '9.1']``
+
 - `@PHPUnit100Migration:risky <./../../ruleSets/PHPUnit100MigrationRisky.rst>`_ with config:
 
-  ``['target' => '5.6']``
+  ``['target' => '9.1']``
 
 
 References

doc/rules/php_unit/php_unit_dedicate_assert_internal_type.rst

@@ -84,6 +84,10 @@ The rule is part of the following rule sets:
 
   ``['target' => '7.5']``
 
+- `@PHPUnit91Migration:risky <./../../ruleSets/PHPUnit91MigrationRisky.rst>`_ with config:
+
+  ``['target' => '7.5']``
+
 - `@PHPUnit100Migration:risky <./../../ruleSets/PHPUnit100MigrationRisky.rst>`_ with config:
 
   ``['target' => '7.5']``

doc/rules/php_unit/php_unit_expectation.rst

@@ -185,6 +185,10 @@ The rule is part of the following rule sets:
 
   ``['target' => '8.4']``
 
+- `@PHPUnit91Migration:risky <./../../ruleSets/PHPUnit91MigrationRisky.rst>`_ with config:
+
+  ``['target' => '8.4']``
+
 - `@PHPUnit100Migration:risky <./../../ruleSets/PHPUnit100MigrationRisky.rst>`_ with config:
 
   ``['target' => '8.4']``

doc/rules/php_unit/php_unit_mock.rst

@@ -106,6 +106,10 @@ The rule is part of the following rule sets:
 
   ``['target' => '5.5']``
 
+- `@PHPUnit91Migration:risky <./../../ruleSets/PHPUnit91MigrationRisky.rst>`_ with config:
+
+  ``['target' => '5.5']``
+
 - `@PHPUnit100Migration:risky <./../../ruleSets/PHPUnit100MigrationRisky.rst>`_ with config:
 
   ``['target' => '5.5']``

doc/rules/php_unit/php_unit_namespaced.rst

@@ -126,6 +126,10 @@ The rule is part of the following rule sets:
 
   ``['target' => '6.0']``
 
+- `@PHPUnit91Migration:risky <./../../ruleSets/PHPUnit91MigrationRisky.rst>`_ with config:
+
+  ``['target' => '6.0']``
+
 - `@PHPUnit100Migration:risky <./../../ruleSets/PHPUnit100MigrationRisky.rst>`_ with config:
 
   ``['target' => '6.0']``

doc/rules/php_unit/php_unit_no_expectation_annotation.rst

@@ -153,6 +153,10 @@ The rule is part of the following rule sets:
 
   ``['target' => '4.3']``
 
+- `@PHPUnit91Migration:risky <./../../ruleSets/PHPUnit91MigrationRisky.rst>`_ with config:
+
+  ``['target' => '4.3']``
+
 - `@PHPUnit100Migration:risky <./../../ruleSets/PHPUnit100MigrationRisky.rst>`_ with config:
 
   ``['target' => '4.3']``

src/Fixer/PhpUnit/PhpUnitDedicateAssertFixer.php

@@ -34,79 +34,9 @@
 final class PhpUnitDedicateAssertFixer extends AbstractPhpUnitFixer implements ConfigurableFixerInterface
 {
     /**
-     * @var array<string, array{positive: string, negative: false|string, argument_count?: int, swap_arguments?: true}|true>
+     * @var array|array<string, array{positive: string, negative: false|string, argument_count?: int, swap_arguments?: true}|true>
      */
-    private static array $fixMap = [
-        'array_key_exists' => [
-            'positive' => 'assertArrayHasKey',
-            'negative' => 'assertArrayNotHasKey',
-            'argument_count' => 2,
-        ],
-        'empty' => [
-            'positive' => 'assertEmpty',
-            'negative' => 'assertNotEmpty',
-        ],
-        'file_exists' => [
-            'positive' => 'assertFileExists',
-            'negative' => 'assertFileNotExists',
-        ],
-        'is_array' => true,
-        'is_bool' => true,
-        'is_callable' => true,
-        'is_dir' => [
-            'positive' => 'assertDirectoryExists',
-            'negative' => 'assertDirectoryNotExists',
-        ],
-        'is_double' => true,
-        'is_float' => true,
-        'is_infinite' => [
-            'positive' => 'assertInfinite',
-            'negative' => 'assertFinite',
-        ],
-        'is_int' => true,
-        'is_integer' => true,
-        'is_long' => true,
-        'is_nan' => [
-            'positive' => 'assertNan',
-            'negative' => false,
-        ],
-        'is_null' => [
-            'positive' => 'assertNull',
-            'negative' => 'assertNotNull',
-        ],
-        'is_numeric' => true,
-        'is_object' => true,
-        'is_readable' => [
-            'positive' => 'assertIsReadable',
-            'negative' => 'assertNotIsReadable',
-        ],
-        'is_real' => true,
-        'is_resource' => true,
-        'is_scalar' => true,
-        'is_string' => true,
-        'is_writable' => [
-            'positive' => 'assertIsWritable',
-            'negative' => 'assertNotIsWritable',
-        ],
-        'str_contains' => [ // since 7.5
-            'positive' => 'assertStringContainsString',
-            'negative' => 'assertStringNotContainsString',
-            'argument_count' => 2,
-            'swap_arguments' => true,
-        ],
-        'str_ends_with' => [ // since 3.4
-            'positive' => 'assertStringEndsWith',
-            'negative' => 'assertStringEndsNotWith',
-            'argument_count' => 2,
-            'swap_arguments' => true,
-        ],
-        'str_starts_with' => [ // since 3.4
-            'positive' => 'assertStringStartsWith',
-            'negative' => 'assertStringStartsNotWith',
-            'argument_count' => 2,
-            'swap_arguments' => true,
-        ],
-    ];
+    private array $fixMap = [];
 
     /**
      * @var list<string>
@@ -117,6 +47,8 @@
     {
         parent::configure($configuration);
 
+        $this->fixMap = $this->getFixMap();
+
         // assertions added in 3.0: assertArrayNotHasKey assertArrayHasKey assertFileNotExists assertFileExists assertNotNull, assertNull
         $this->functions = [
             'array_key_exists',
@@ -169,6 +101,35 @@
                 'str_contains',
             ]);
         }
+
+        if (PhpUnitTargetVersion::fulfills($this->configuration['target'], PhpUnitTargetVersion::VERSION_9_1)) {
+            $this->fixMap = array_merge($this->fixMap, [
+                'is_readable' => array_merge(
+                    $this->fixMap['is_readable'] ?? [],
+                    [
+                        'negative' => 'assertIsNotReadable',
+                    ]
+                ),
+                'is_writable' => array_merge(
+                    $this->fixMap['is_writable'] ?? [],
+                    [
+                        'negative' => 'assertIsNotWritable',
+                    ]
+                ),
+                'file_exists' => array_merge(
+                    $this->fixMap['file_exists'] ?? [],
+                    [
+                        'negative' => 'assertFileDoesNotExist',
+                    ]
+                ),
+                'is_dir' => array_merge(
+                    $this->fixMap['is_dir'] ?? [],
+                    [
+                        'negative' => 'assertDirectoryDoesNotExist',
+                    ]
+                ),
+            ]);
+        }
     }
 
     public function isRisky(): bool
@@ -243,8 +204,6 @@
                 || 'assertnotequals' === $assertCall['loweredName']
             ) {
                 $this->fixAssertSameEquals($tokens, $assertCall);
-
-                continue;
             }
         }
     }
@@ -259,6 +218,7 @@
                     PhpUnitTargetVersion::VERSION_3_5,
                     PhpUnitTargetVersion::VERSION_5_0,
                     PhpUnitTargetVersion::VERSION_5_6,
+                    PhpUnitTargetVersion::VERSION_9_1,
                     PhpUnitTargetVersion::VERSION_NEWEST,
                 ])
                 ->setDefault(PhpUnitTargetVersion::VERSION_NEWEST)
@@ -314,23 +274,23 @@
         $arguments = $argumentsAnalyzer->getArguments($tokens, $testOpenIndex, $testCloseIndex);
         $isPositive = 'asserttrue' === $assertCall['loweredName'];
 
-        if (\is_array(self::$fixMap[$content])) {
-            $expectedCount = self::$fixMap[$content]['argument_count'] ?? 1;
+        if (\is_array($this->fixMap[$content])) {
+            $expectedCount = $this->fixMap[$content]['argument_count'] ?? 1;
 
             if ($expectedCount !== \count($arguments)) {
                 return;
             }
 
             $isPositive = $isPositive ? 'positive' : 'negative';
 
-            if (false === self::$fixMap[$content][$isPositive]) {
+            if (false === $this->fixMap[$content][$isPositive]) {
                 return;
             }
 
-            $tokens[$assertCall['index']] = new Token([T_STRING, self::$fixMap[$content][$isPositive]]);
+            $tokens[$assertCall['index']] = new Token([T_STRING, $this->fixMap[$content][$isPositive]]);
             $this->removeFunctionCall($tokens, $testDefaultNamespaceTokenIndex, $testIndex, $testOpenIndex, $testCloseIndex);
 
-            if (self::$fixMap[$content]['swap_arguments'] ?? false) {
+            if ($this->fixMap[$content]['swap_arguments'] ?? false) {
                 if (2 !== $expectedCount) {
                     throw new \RuntimeException('Can only swap two arguments, please update map or logic.');
                 }
@@ -625,4 +585,82 @@
 
         return $clone;
     }
+
+    /**
+     * @return array|array<string, array{positive: string, negative: false|string, argument_count?: int, swap_arguments?: true}|true>
+     */
+    private function getFixMap(): array
+    {
+        return [
+            'array_key_exists' => [
+                'positive' => 'assertArrayHasKey',
+                'negative' => 'assertArrayNotHasKey',
+                'argument_count' => 2,
+            ],
+            'empty' => [
+                'positive' => 'assertEmpty',
+                'negative' => 'assertNotEmpty',
+            ],
+            'file_exists' => [
+                'positive' => 'assertFileExists',
+                'negative' => 'assertFileNotExists',
+            ],
+            'is_array' => true,
+            'is_bool' => true,
+            'is_callable' => true,
+            'is_dir' => [
+                'positive' => 'assertDirectoryExists',
+                'negative' => 'assertDirectoryNotExists',
+            ],
+            'is_double' => true,
+            'is_float' => true,
+            'is_infinite' => [
+                'positive' => 'assertInfinite',
+                'negative' => 'assertFinite',
+            ],
+            'is_int' => true,
+            'is_integer' => true,
+            'is_long' => true,
+            'is_nan' => [
+                'positive' => 'assertNan',
+                'negative' => false,
+            ],
+            'is_null' => [
+                'positive' => 'assertNull',
+                'negative' => 'assertNotNull',
+            ],
+            'is_numeric' => true,
+            'is_object' => true,
+            'is_readable' => [
+                'positive' => 'assertIsReadable',
+                'negative' => 'assertNotIsReadable',
+            ],
+            'is_real' => true,
+            'is_resource' => true,
+            'is_scalar' => true,
+            'is_string' => true,
+            'is_writable' => [
+                'positive' => 'assertIsWritable',
+                'negative' => 'assertNotIsWritable',
+            ],
+            'str_contains' => [ // since 7.5
+                'positive' => 'assertStringContainsString',
+                'negative' => 'assertStringNotContainsString',
+                'argument_count' => 2,
+                'swap_arguments' => true,
+            ],
+            'str_ends_with' => [ // since 3.4
+                'positive' => 'assertStringEndsWith',
+                'negative' => 'assertStringEndsNotWith',
+                'argument_count' => 2,
+                'swap_arguments' => true,
+            ],
+            'str_starts_with' => [ // since 3.4
+                'positive' => 'assertStringStartsWith',
+                'negative' => 'assertStringStartsNotWith',
+                'argument_count' => 2,
+                'swap_arguments' => true,
+            ],
+        ];
+    }
 }

src/Fixer/PhpUnit/PhpUnitTargetVersion.php

@@ -37,6 +37,7 @@ final class PhpUnitTargetVersion
     public const VERSION_6_0 = '6.0';
     public const VERSION_7_5 = '7.5';
     public const VERSION_8_4 = '8.4';
+    public const VERSION_9_1 = '9.1';
     public const VERSION_NEWEST = 'newest';
 
     private function __construct() {}

src/RuleSet/Sets/PHPUnit100MigrationRiskySet.php

@@ -24,7 +24,7 @@ final class PHPUnit100MigrationRiskySet extends AbstractMigrationSetDescription
     public function getRules(): array
     {
         return [
-            '@PHPUnit84Migration:risky' => true,
+            '@PHPUnit91Migration:risky' => true,
             'php_unit_data_provider_static' => ['force' => true],
         ];
     }