Deprecate InternalClassCasingFixer (#742)

Author: kubawerlos

CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## v3.8.0
 - Update minimum PHP version to 7.4
+- Update minimum PHP CS Fixer version to 3.6.0
 - DataProviderStaticFixer - add option "force"
+- Deprecate InternalClassCasingFixer
 
 ## v3.7.0
 - Add NoTrailingCommaInSinglelineFixer

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3373-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3374-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -132,6 +132,7 @@ Declare statement for strict types must be placed in the same line, after openin
 
 #### InternalClassCasingFixer
 Classes defined internally by extension or core must be referenced with the correct case.
+  DEPRECATED: use `class_reference_name_casing` instead.
 ```diff
  <?php
 -$foo = new STDClass();

composer.json

@@ -13,7 +13,7 @@
         "php": "^7.4 || ^8.0",
         "ext-filter": "*",
         "ext-tokenizer": "*",
-        "friendsofphp/php-cs-fixer": "^3.1.0",
+        "friendsofphp/php-cs-fixer": "^3.6.0",
         "symfony/finder": "^4.0 || ^5.0 || ^6.0"
     },
     "require-dev": {

src/Fixer/InternalClassCasingFixer.php

@@ -11,16 +11,26 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
+use PhpCsFixer\Fixer\Casing\ClassReferenceNameCasingFixer;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Tokenizer\Analyzer\NamespacesAnalyzer;
-use PhpCsFixer\Tokenizer\CT;
-use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class InternalClassCasingFixer extends AbstractFixer
+/**
+ * @deprecated
+ */
+final class InternalClassCasingFixer extends AbstractFixer implements DeprecatedFixerInterface
 {
+    /** @var ClassReferenceNameCasingFixer */
+    private $classReferenceNameCasingFixer;
+
+    public function __construct()
+    {
+        $this->classReferenceNameCasingFixer = new ClassReferenceNameCasingFixer();
+    }
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(
@@ -31,99 +41,26 @@ public function getDefinition(): FixerDefinitionInterface
 
     public function getPriority(): int
     {
-        return 0;
+        return $this->classReferenceNameCasingFixer->getPriority();
     }
 
     public function isCandidate(Tokens $tokens): bool
     {
-        return $tokens->isTokenKindFound(\T_STRING);
+        return $this->classReferenceNameCasingFixer->isCandidate($tokens);
     }
 
     public function isRisky(): bool
     {
-        return false;
+        return $this->classReferenceNameCasingFixer->isRisky();
     }
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        $namespaces = (new NamespacesAnalyzer())->getDeclarations($tokens);
-
-        foreach ($namespaces as $namespace) {
-            $this->fixCasing($tokens, $namespace->getScopeStartIndex(), $namespace->getScopeEndIndex(), $namespace->getFullName() === '');
-        }
-    }
-
-    private function fixCasing(Tokens $tokens, int $startIndex, int $endIndex, bool $isInGlobalNamespace): void
-    {
-        for ($index = $startIndex; $index < $endIndex; $index++) {
-            if (!$tokens[$index]->isGivenKind(\T_STRING)) {
-                continue;
-            }
-
-            if (!$this->isGlobalClassUsage($tokens, $index, $isInGlobalNamespace)) {
-                continue;
-            }
-
-            $correctCase = $this->getCorrectCase($tokens[$index]->getContent());
-
-            if ($correctCase === $tokens[$index]->getContent()) {
-                continue;
-            }
-
-            $tokens[$index] = new Token([\T_STRING, $correctCase]);
-        }
-    }
-
-    private function isGlobalClassUsage(Tokens $tokens, int $index, bool $isInGlobalNamespace): bool
-    {
-        $prevIndex = $tokens->getPrevMeaningfulToken($index);
-        \assert(\is_int($prevIndex));
-
-        if ($tokens[$prevIndex]->isGivenKind(\T_NS_SEPARATOR)) {
-            $prevIndex = $tokens->getPrevMeaningfulToken($prevIndex);
-            \assert(\is_int($prevIndex));
-
-            if ($tokens[$prevIndex]->isGivenKind(\T_STRING)) {
-                return false;
-            }
-        } elseif (!$isInGlobalNamespace) {
-            return false;
-        }
-
-        if ($tokens[$prevIndex]->isGivenKind([\T_AS, \T_CLASS, \T_CONST, \T_DOUBLE_COLON, \T_OBJECT_OPERATOR, CT::T_USE_TRAIT])) {
-            return false;
-        }
-
-        $nextIndex = $tokens->getNextMeaningfulToken($index);
-        \assert(\is_int($nextIndex));
-
-        if ($tokens[$nextIndex]->isGivenKind(\T_NS_SEPARATOR)) {
-            return false;
-        }
-
-        return $tokens[$prevIndex]->isGivenKind([\T_NEW]) || !$tokens[$nextIndex]->equals('(');
+        $this->classReferenceNameCasingFixer->fix($file, $tokens);
     }
 
-    private function getCorrectCase(string $className): string
+    public function getSuccessorsNames(): array
     {
-        /** @var null|array<string, string> $classes */
-        static $classes;
-
-        if ($classes === null) {
-            $classes = [];
-            foreach (\get_declared_classes() as $class) {
-                if ((new \ReflectionClass($class))->isInternal()) {
-                    $classes[\strtolower($class)] = $class;
-                }
-            }
-        }
-
-        $lowercaseClassName = \strtolower($className);
-
-        if (!\array_key_exists($lowercaseClassName, $classes)) {
-            return $className;
-        }
-
-        return $classes[$lowercaseClassName];
+        return [$this->classReferenceNameCasingFixer->getName()];
     }
 }

src/Fixer/PhpdocVarAnnotationToAssertFixer.php

@@ -120,9 +120,6 @@ private function getAssertTokens(Tokens $tokens, int $docCommentIndex, string $v
         }
 
         $types = $annotation->getTypeExpression()->getTypes();
-        if ($types === []) {
-            return null;
-        }
 
         $assertCode = '<?php assert(';
 

tests/Fixer/InternalClassCasingFixerTest.php

@@ -23,6 +23,11 @@ public function testIsRisky(): void
         self::assertFalse($this->fixer->isRisky());
     }
 
+    public function testSuccessorName(): void
+    {
+        self::assertContains('class_reference_name_casing', $this->fixer->getSuccessorsNames());
+    }
+
     /**
      * @dataProvider provideFixCases
      */