[CodingStandard] ClassStringToClassCosntantFixer init

easy-coding-standard.neon

@@ -1,4 +1,5 @@
 checkers:
+    - Symplify\CodingStandard\Fixer\Php\ClassStringToClassConstantFixer
     - Symplify\CodingStandard\Fixer\Property\ArrayPropertyDefaultValueFixer
 
     # Classes
@@ -80,6 +81,9 @@ checkers:
     - Symplify\CodingStandard\Sniffs\Namespaces\ClassNamesWithoutPreSlashSniff
     - PhpCsFixer\Fixer\NamespaceNotation\SingleBlankLineBeforeNamespaceFixer
     - PhpCsFixer\Fixer\NamespaceNotation\BlankLineAfterNamespaceFixer
+    - PhpCsFixer\Fixer\Import\OrderedImportsFixer
+    - PhpCsFixer\Fixer\Import\SingleImportPerStatementFixer
+    - PhpCsFixer\Fixer\Import\SingleLineAfterImportsFixer
 
     # Naming
     - Symplify\CodingStandard\Sniffs\Naming\AbstractClassNameSniff
@@ -129,7 +133,6 @@ checkers:
     - PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer
     - PhpCsFixer\Fixer\ControlStructure\NoUselessElseFixer
     - PhpCsFixer\Fixer\ReturnNotation\NoUselessReturnFixer
-    - PhpCsFixer\Fixer\Import\OrderedImportsFixer
     - PhpCsFixer\Fixer\LanguageConstruct\CombineConsecutiveUnsetsFixer
     - PhpCsFixer\Fixer\Strict\StrictComparisonFixer
     - PhpCsFixer\Fixer\Alias\EregToPregFixer
@@ -158,8 +161,6 @@ checkers:
     - PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer
     PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer:
         - property
-    - PhpCsFixer\Fixer\Import\SingleImportPerStatementFixer
-    - PhpCsFixer\Fixer\Import\SingleLineAfterImportsFixer
     - PhpCsFixer\Fixer\ControlStructure\SwitchCaseSemicolonToColonFixer
     - PhpCsFixer\Fixer\ControlStructure\SwitchCaseSpaceFixer
 

packages/CodingStandard/README.md

@@ -49,6 +49,25 @@ class SomeClass
 ```
 
 
+### `::class` references should be used over string for classes and interfaces
+
+
+- [Php/ClassStringToClassConstantFixer](/src/Fixer/Php/ClassStringToClassConstantFixer.php)
+- This checker uses *[PHP-CS-Fixer](https://github.com/friendsofphp/php-cs-fixer)*
+
+:x:
+
+```php
+$className = 'DateTime';
+```
+
+:+1:
+
+```php
+$className = DateTime::class;
+```
+
+
 
 ### Array property should have default value, to prevent undefined array issues
 
@@ -78,6 +97,7 @@ class SomeClass
 
 :+1:
 
+
 ``` php
 class SomeClass
 {

packages/CodingStandard/src/Fixer/Php/ClassStringToClassConstantFixer.php

@@ -0,0 +1,116 @@
+<?php declare(strict_types=1);
+
+namespace Symplify\CodingStandard\Fixer\Php;
+
+use PhpCsFixer\Fixer\DefinedFixerInterface;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\CT;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+use SplFileInfo;
+
+final class ClassStringToClassConstantFixer implements DefinedFixerInterface
+{
+    /**
+     * @var string
+     */
+    private const CLASS_OR_INTERFACE_PATTERN = '#^[A-Z]\w*[a-z]\w*(\\\\[A-Z]\w*[a-z]\w*)+\z#';
+
+    public function getDefinition(): FixerDefinitionInterface
+    {
+        return new FixerDefinition(
+            '`::class` references should be used over string for classes and interfaces.',
+            [
+                new CodeSample(
+'<?php      
+
+$className = "DateTime";  
+                '),
+                new CodeSample(
+'<?php      
+
+$interfaceName = "DateTimeInterface";  
+                '),
+                new CodeSample(
+'<?php      
+
+$interfaceName = "Nette\Utils\DateTime";  
+                '),
+            ]
+        );
+    }
+
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return $tokens->isTokenKindFound(T_CONSTANT_ENCAPSED_STRING);
+    }
+
+    public function fix(SplFileInfo $file, Tokens $tokens): void
+    {
+        /** @var Token[] $revertedTokens */
+        $revertedTokens = array_reverse($tokens->toArray(), true);
+
+        foreach ($revertedTokens as $index => $token) {
+            if (! $token->isGivenKind(T_CONSTANT_ENCAPSED_STRING)) {
+                continue;
+            }
+
+            $potentialClassOrInterface = trim($token->getContent(), "'");
+            if ($this->isClassOrInterface($potentialClassOrInterface)) {
+                $token->clear(); // overrideAt() fails on "Illegal offset type"
+
+                $classOrInterfaceTokens = $this->convertClassOrInterfaceNameToTokens($potentialClassOrInterface);
+                $tokens->insertAt($index, array_merge($classOrInterfaceTokens, [
+                    new Token([T_DOUBLE_COLON, '::']),
+                    new Token([CT::T_CLASS_CONSTANT, 'class']),
+                ]));
+            }
+        }
+    }
+
+    public function isRisky(): bool
+    {
+        return false;
+    }
+
+    public function getName(): string
+    {
+        return self::class;
+    }
+
+    public function getPriority(): int
+    {
+        // should be run before the OrderedImportsFixer, after the NoLeadingImportSlashFixer
+        return -25;
+    }
+
+    public function supports(SplFileInfo $file): bool
+    {
+        return true;
+    }
+
+    private function isClassOrInterface(string $potentialClassOrInterface): bool
+    {
+        return class_exists($potentialClassOrInterface)
+            || interface_exists($potentialClassOrInterface)
+            || (bool) preg_match(self::CLASS_OR_INTERFACE_PATTERN, $potentialClassOrInterface);
+    }
+
+    /**
+     * @return Token[]
+     */
+    private function convertClassOrInterfaceNameToTokens(string $potentialClassOrInterface): array
+    {
+        $tokens = [];
+        $nameParts = explode('\\', $potentialClassOrInterface);
+
+        foreach ($nameParts as $namePart) {
+            $tokens[] = new Token([T_NS_SEPARATOR, '\\']);
+            $tokens[] = new Token([T_STRING, $namePart]);
+        }
+
+        return $tokens;
+    }
+}

packages/CodingStandard/tests/Fixer/Php/ClassStringToClassConstantFixerTest.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+namespace Symplify\CodingStandard\Tests\Fixer\Php;
+
+use PhpCsFixer\Fixer\FixerInterface;
+use PhpCsFixer\Test\AbstractFixerTestCase;
+use Symplify\CodingStandard\Fixer\Php\ClassStringToClassConstantFixer;
+
+final class ClassStringToClassConstantFixerTest extends AbstractFixerTestCase
+{
+    /**
+     * @dataProvider provideFixCases()
+     */
+    public function testFix(string $expected, string $input): void
+    {
+        $this->doTest($expected, $input);
+    }
+
+    /**
+     * @return string[][]
+     */
+    public function provideFixCases(): array
+    {
+        return [
+            [
+                file_get_contents(__DIR__ . '/fixed/fixed.php.inc'),
+                file_get_contents(__DIR__ . '/wrong/wrong.php.inc'),
+            ],
+            [
+                file_get_contents(__DIR__ . '/fixed/fixed2.php.inc'),
+                file_get_contents(__DIR__ . '/wrong/wrong2.php.inc'),
+            ],
+            [
+                file_get_contents(__DIR__ . '/fixed/fixed3.php.inc'),
+                file_get_contents(__DIR__ . '/wrong/wrong3.php.inc'),
+            ],
+        ];
+    }
+
+    protected function createFixer(): FixerInterface
+    {
+        return new ClassStringToClassConstantFixer;
+    }
+}

packages/CodingStandard/tests/Fixer/Php/fixed/fixed.php.inc

@@ -0,0 +1,3 @@
+<?php
+
+$classType = \DateTime::class;

packages/CodingStandard/tests/Fixer/Php/fixed/fixed2.php.inc

@@ -0,0 +1,3 @@
+<?php
+
+$classType = \DateTimeInterface::class;

packages/CodingStandard/tests/Fixer/Php/fixed/fixed3.php.inc

@@ -0,0 +1,9 @@
+<?php
+
+class SomeClass
+{
+    public function getSomeData($className = \Nette\Utils\DateTime::class)
+    {
+
+    }
+}

packages/CodingStandard/tests/Fixer/Php/wrong/wrong.php.inc

@@ -0,0 +1,3 @@
+<?php
+
+$classType = 'DateTime';

packages/CodingStandard/tests/Fixer/Php/wrong/wrong2.php.inc

@@ -0,0 +1,3 @@
+<?php
+
+$classType = 'DateTimeInterface';

packages/CodingStandard/tests/Fixer/Php/wrong/wrong3.php.inc

@@ -0,0 +1,9 @@
+<?php
+
+class SomeClass
+{
+    public function getSomeData($className = 'Nette\Utils\DateTime')
+    {
+
+    }
+}

packages/EasyCodingStandard/packages/SniffRunner/tests/Error/ErrorSorterTest.php

@@ -35,11 +35,11 @@ private function getUnsortedMessages(): array
     {
         return [
             'filePath' => [
-                new Error(5, 'error', 'SomeClass', false),
+                new Error(5, 'error message', 'SomeClass', false),
             ],
             'anotherFilePath' => [
-                new Error(15, 'error', 'SomeClass', false),
-                new Error(5, 'error', 'SomeClass', false),
+                new Error(15, 'error message', 'SomeClass', false),
+                new Error(5, 'error message', 'SomeClass', false),
             ],
         ];
     }