feat(EXPERIMENTAL): ClassKeywordFixer, part 2 (PHP-CS-Fixer#7550)

maxhelias · Dec 12, 2023 · 698a909 · 698a909
1 parent 386a2b8
commit 698a909
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 13 deletions.
diff --git a/doc/rules/index.rst b/doc/rules/index.rst
@@ -460,7 +460,7 @@ Import
 Language Construct
 ------------------
 
-- `class_keyword <./language_construct/class_keyword.rst>`_
+- `class_keyword <./language_construct/class_keyword.rst>`_ *(risky)*
 
   EXPERIMENTAL: Converts FQCN strings to ``*::class`` keywords. Do not use it, unless you know what you are doing.
 - `class_keyword_remove <./language_construct/class_keyword_remove.rst>`_ *(deprecated)*

diff --git a/doc/rules/language_construct/class_keyword.rst b/doc/rules/language_construct/class_keyword.rst
@@ -5,6 +5,22 @@ Rule ``class_keyword``
 EXPERIMENTAL: Converts FQCN strings to ``*::class`` keywords. Do not use it,
 unless you know what you are doing.
 
+Description
+-----------
+
+This rule does not have an understanding of whether a class exists in the scope
+of the codebase or not, relying on run-time and autoloaded classes to determine
+it, which makes the rule useless when running on a single file out of codebase
+context.
+
+Warning
+-------
+
+Using this rule is risky
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Risky as EXPERIMENTAL.
+
 Examples
 --------
 

diff --git a/src/Fixer/LanguageConstruct/ClassKeywordFixer.php b/src/Fixer/LanguageConstruct/ClassKeywordFixer.php
@@ -37,7 +37,9 @@ public function getDefinition(): FixerDefinitionInterface
 $bar = "\PhpCsFixer\Tokenizer\Tokens";
 '
                 ),
-            ]
+            ],
+            'This rule does not have an understanding of whether a class exists in the scope of the codebase or not, relying on run-time and autoloaded classes to determine it, which makes the rule useless when running on a single file out of codebase context.',
+            'Risky as EXPERIMENTAL.'
         );
     }
 
@@ -46,6 +48,11 @@ public function isCandidate(Tokens $tokens): bool
         return true;
     }
 
+    public function isRisky(): bool
+    {
+        return true;
+    }
+
     protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
     {
         for ($index = $tokens->count() - 1; $index >= 0; --$index) {
@@ -57,18 +64,13 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
                 $name = str_replace('\\\\', '\\', $name);
 
                 if ($this->exists($name)) {
-                    try {
-                        $substitution = Tokens::fromCode("<?php echo \\{$name}::class;");
-                        $substitution->clearRange(0, 2);
-                        $substitution->clearAt($substitution->getSize() - 1);
-                        $substitution->clearEmptyTokens();
+                    $substitution = Tokens::fromCode("<?php echo \\{$name}::class;");
+                    $substitution->clearRange(0, 2);
+                    $substitution->clearAt($substitution->getSize() - 1);
+                    $substitution->clearEmptyTokens();
 
-                        $tokens->clearAt($index);
-                        $tokens->insertAt($index, $substitution);
-                    } catch (\Error $e) {
-                        var_dump('error with parsing class', $name);
-                        var_dump($e->getMessage());
-                    }
+                    $tokens->clearAt($index);
+                    $tokens->insertAt($index, $substitution);
                 }
             }
         }