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,7 +34,77 @@
 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_key_exists: array{
+ * positive: string,
+ * negative: string,
+ * argument_count: int
+ * },
+ * empty: array{
+ * positive: string,
+ * negative: string
+ * },
+ * file_exists: array{
+ * positive: string,
+ * negative: string
+ * },
+ * is_array: bool,
+ * is_bool: bool,
+ * is_callable: bool,
+ * is_dir: array{
+ * positive: string,
+ * negative: string
+ * },
+ * is_double: bool,
+ * is_float: bool,
+ * is_infinite: array{
+ * positive: string,
+ * negative: string
+ * },
+ * is_int: bool,
+ * is_integer: bool,
+ * is_long: bool,
+ * is_nan: array{
+ * positive: string,
+ * negative: bool
+ * },
+ * is_null: array{
+ * positive: string,
+ * negative: string
+ * },
+ * is_numeric: bool,
+ * is_object: bool,
+ * is_readable: array{
+ * positive: string,
+ * negative: string
+ * },
+ * is_real: bool,
+ * is_resource: bool,
+ * is_scalar: bool,
+ * is_string: bool,
+ * is_writable: array{
+ * positive: string,
+ * negative: string
+ * },
+ * str_contains: array{
+ * positive: string,
+ * negative: string,
+ * argument_count: int,
+ * swap_arguments: bool
+ * },
+ * str_ends_with: array{
+ * positive: string,
+ * negative: string,
+ * argument_count: int,
+ * swap_arguments: bool
+ * },
+ * str_starts_with: array{
+ * positive: string,
+ * negative: string,
+ * argument_count: int,
+ * swap_arguments: bool
+ * }
+ * }
  */
  private static array $fixMap = [
  'array_key_exists' => [
@@ -106,6 +176,7 @@
  'argument_count' => 2,
  'swap_arguments' => true,
  ],
+ 'assertNotIsReadable' => true,
  ];
 
  /**
@@ -169,6 +240,15 @@
  'str_contains',
  ]);
  }
+
+ if (PhpUnitTargetVersion::fulfills($this->configuration['target'], PhpUnitTargetVersion::VERSION_9_1)) {
+ $this->functions = array_merge($this->functions, [
+ 'assertdirectorynotexists',
+ 'assertnotisreadable',
+ 'assertnotiswritable',
+ 'assertfilenotexists',
+ ]);
+ }
  }
 
  public function isRisky(): bool
@@ -230,23 +310,24 @@
 
  foreach ($this->getPreviousAssertCall($tokens, $startIndex, $endIndex) as $assertCall) {
  // test and fix for assertTrue/False to dedicated asserts
- if ('asserttrue' === $assertCall['loweredName'] || 'assertfalse' === $assertCall['loweredName']) {
+ if (\in_array($assertCall['loweredName'], ['asserttrue', 'assertfalse'], true)) {
  $this->fixAssertTrueFalse($tokens, $argumentsAnalyzer, $assertCall);
 
  continue;
  }
 
- if (
- 'assertsame' === $assertCall['loweredName']
- || 'assertnotsame' === $assertCall['loweredName']
- || 'assertequals' === $assertCall['loweredName']
- || 'assertnotequals' === $assertCall['loweredName']
- ) {
+ if (\in_array(
+ $assertCall['loweredName'],
+ ['assertsame', 'assertnotsame', 'assertequals', 'assertnotequals'],
+ true
+ )) {
  $this->fixAssertSameEquals($tokens, $assertCall);
-
- continue;
  }
  }
+
+ foreach ($this->getPreviousAssertCall($tokens, $startIndex, $endIndex) as $assertCall) {
+ $this->fixAssertNewNames($tokens, $assertCall);
+ }
  }
 
  protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
@@ -259,6 +340,7 @@
  PhpUnitTargetVersion::VERSION_3_5,
  PhpUnitTargetVersion::VERSION_5_0,
  PhpUnitTargetVersion::VERSION_5_6,
+ PhpUnitTargetVersion::VERSION_9_1,
  PhpUnitTargetVersion::VERSION_NEWEST,
  ])
  ->setDefault(PhpUnitTargetVersion::VERSION_NEWEST)
@@ -323,11 +405,12 @@
 
  $isPositive = $isPositive ? 'positive' : 'negative';
 
- if (false === self::$fixMap[$content][$isPositive]) {
+ $replace = self::$fixMap[$content][$isPositive];
+ if (false === $replace) {
  return;
  }
 
- $tokens[$assertCall['index']] = new Token([T_STRING, self::$fixMap[$content][$isPositive]]);
+ $tokens[$assertCall['index']] = new Token([T_STRING, (string) $replace]);
  $this->removeFunctionCall($tokens, $testDefaultNamespaceTokenIndex, $testIndex, $testOpenIndex, $testCloseIndex);
 
  if (self::$fixMap[$content]['swap_arguments'] ?? false) {
@@ -484,7 +567,7 @@
 
  $lowerContent = strtolower($tokens[$countCallIndex]->getContent());
 
- if ('count' !== $lowerContent && 'sizeof' !== $lowerContent) {
+ if (!\in_array($lowerContent, ['count', 'sizeof'], true)) {
  return; // not a call to "count" or "sizeOf"
  }
 
@@ -625,4 +708,39 @@
 
  return $clone;
  }
+
+ /**
+ * @param array{
+ * index: int,
+ * loweredName: string,
+ * openBraceIndex: int,
+ * closeBraceIndex: int,
+ * } $assertCall
+ */
+ private function fixAssertNewNames(Tokens $tokens, array $assertCall): void
+ {
+ if (!\in_array($assertCall['loweredName'], $this->functions, true)) {
+ return;
+ }
+
+ $replacement = null;
+ if ('assertnotisreadable' === $assertCall['loweredName']) {
+ $replacement = 'assertIsNotReadable';
+ } elseif ('assertnotiswritable' === $assertCall['loweredName']) {
+ $replacement = 'assertIsNotWritable';
+ } elseif ('assertdirectorynotexists' === $assertCall['loweredName']) {
+ $replacement = 'assertDirectoryDoesNotExist';
+ } elseif ('assertfilenotexists' === $assertCall['loweredName']) {
+ $replacement = 'assertFileDoesNotExist';
+ }
+
+ if (null === $replacement) {
+ return;
+ }
+
+ $tokens[$assertCall['index']] = new Token([
+ T_STRING,
+ $replacement,
+ ]);
+ }
 }

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

@@ -23,8 +23,8 @@
 {
  public function getRules(): array
  {
  return [
- '@PHPUnit84Migration:risky' => true,
+ '@PHPUnit91Migration:risky' => true,
  'php_unit_data_provider_static' => ['force' => true],
  ];
  }

src/RuleSet/Sets/PHPUnit91MigrationRiskySet.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ * Dariusz Rumiński <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\RuleSet\Sets;
+
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitTargetVersion;
+use PhpCsFixer\RuleSet\AbstractMigrationSetDescription;
+
+/**
+ * @internal
+ */
+final class PHPUnit91MigrationRiskySet extends AbstractMigrationSetDescription
+{
+ public function getRules(): array
+ {
+ return [
+ '@PHPUnit84Migration:risky' => true,
+ 'php_unit_dedicate_assert' => [
+ 'target' => PhpUnitTargetVersion::VERSION_9_1,
+ ],
+ ];
+ }
+}