[BUGFIX] Split migration to enums and enum values

Fixes #4473 Related: #4449
sabbelasichon · Feb 16, 2025 · eb60fe1 · eb60fe1
1 parent 87ea44a
commit eb60fe1
Show file tree

Hide file tree

Showing 13 changed files with 339 additions and 94 deletions.
diff --git a/config/v13/typo3-130.php b/config/v13/typo3-130.php
@@ -4,6 +4,7 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Renaming\ValueObject\RenameClassAndConstFetch;
+use Ssch\TYPO3Rector\General\Renaming\ConstantsToBackedEnumRector;
 use Ssch\TYPO3Rector\General\Renaming\ConstantsToBackedEnumValueRector;
 use Ssch\TYPO3Rector\General\Renaming\RenameAttributeRector;
 use Ssch\TYPO3Rector\General\Renaming\ValueObject\RenameAttribute;
@@ -26,7 +27,42 @@
     $rectorConfig->singleton(StrictTypesPersistenceManagerRector::class);
     $rectorConfig->singleton(UseStrictTypesInExtbaseActionControllerRector::class);
 
+    $rectorConfig->ruleWithConfiguration(ConstantsToBackedEnumRector::class, [
+        // See https://github.com/sabbelasichon/typo3-rector/issues/3698
+        new RenameClassAndConstFetch(
+            'TYPO3\CMS\Core\Imaging\Icon',
+            'SIZE_DEFAULT',
+            'TYPO3\CMS\Core\Imaging\IconSize',
+            'DEFAULT'
+        ),
+        new RenameClassAndConstFetch(
+            'TYPO3\CMS\Core\Imaging\Icon',
+            'SIZE_SMALL',
+            'TYPO3\CMS\Core\Imaging\IconSize',
+            'SMALL'
+        ),
+        new RenameClassAndConstFetch(
+            'TYPO3\CMS\Core\Imaging\Icon',
+            'SIZE_MEDIUM',
+            'TYPO3\CMS\Core\Imaging\IconSize',
+            'MEDIUM'
+        ),
+        new RenameClassAndConstFetch(
+            'TYPO3\CMS\Core\Imaging\Icon',
+            'SIZE_LARGE',
+            'TYPO3\CMS\Core\Imaging\IconSize',
+            'LARGE'
+        ),
+        new RenameClassAndConstFetch(
+            'TYPO3\CMS\Core\Imaging\Icon',
+            'SIZE_MEGA',
+            'TYPO3\CMS\Core\Imaging\IconSize',
+            'MEGA'
+        ),
+    ]);
+
     $rectorConfig->ruleWithConfiguration(ConstantsToBackedEnumValueRector::class, [
+        // see https://github.com/sabbelasichon/typo3-rector/issues/3704
         new RenameClassAndConstFetch(
             'TYPO3\CMS\Core\Resource\AbstractFile',
             'FILETYPE_UNKNOWN',
@@ -64,37 +100,9 @@
             'APPLICATION'
         ),
 
-        new RenameClassAndConstFetch(
-            'TYPO3\CMS\Core\Imaging\Icon',
-            'SIZE_DEFAULT',
-            'TYPO3\CMS\Core\Imaging\IconSize',
-            'DEFAULT'
-        ),
-        new RenameClassAndConstFetch(
-            'TYPO3\CMS\Core\Imaging\Icon',
-            'SIZE_SMALL',
-            'TYPO3\CMS\Core\Imaging\IconSize',
-            'SMALL'
-        ),
-        new RenameClassAndConstFetch(
-            'TYPO3\CMS\Core\Imaging\Icon',
-            'SIZE_MEDIUM',
-            'TYPO3\CMS\Core\Imaging\IconSize',
-            'MEDIUM'
-        ),
-        new RenameClassAndConstFetch(
-            'TYPO3\CMS\Core\Imaging\Icon',
-            'SIZE_LARGE',
-            'TYPO3\CMS\Core\Imaging\IconSize',
-            'LARGE'
-        ),
-        new RenameClassAndConstFetch(
-            'TYPO3\CMS\Core\Imaging\Icon',
-            'SIZE_MEGA',
-            'TYPO3\CMS\Core\Imaging\IconSize',
-            'MEGA'
-        ),
-        new RenameClassAndConstFetch(
+        // see https://github.com/sabbelasichon/typo3-rector/issues/3650
+        // FIXME: This causes an infinite loop
+        /*new RenameClassAndConstFetch(
             'TYPO3\CMS\Core\Authentication\LoginType',
             'LOGIN',
             'TYPO3\CMS\Core\Authentication\LoginType',
@@ -105,7 +113,7 @@
             'LOGOUT',
             'TYPO3\CMS\Core\Authentication\LoginType',
             'LOGOUT'
-        ),
+        ),*/
     ]);
     $rectorConfig->ruleWithConfiguration(RenameAttributeRector::class, [
         new RenameAttribute('TYPO3\CMS\Backend\Attribute\Controller', 'TYPO3\CMS\Backend\Attribute\AsController'),

diff --git a/rules/General/Renaming/ConstantsToBackedEnumRector.php b/rules/General/Renaming/ConstantsToBackedEnumRector.php
@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\General\Renaming;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\ClassConstFetch;
+use Rector\Contract\Rector\ConfigurableRectorInterface;
+use Rector\Rector\AbstractRector;
+use Rector\Renaming\ValueObject\RenameClassAndConstFetch;
+use Rector\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Ssch\TYPO3Rector\Contract\NoChangelogRequiredInterface;
+use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
+
+/**
+ * @see \Ssch\TYPO3Rector\Tests\Rector\General\Renaming\ConstantsToBackedEnumRector\ConstantsToBackedEnumRectorTest
+ */
+final class ConstantsToBackedEnumRector extends AbstractRector implements ConfigurableRectorInterface, MinPhpVersionInterface, NoChangelogRequiredInterface, DocumentedRuleInterface
+{
+    /**
+     * @var RenameClassAndConstFetch[]
+     */
+    private array $renameClassConstFetches = [];
+
+    /**
+     * @param array<int, RenameClassAndConstFetch> $configuration
+     */
+    public function configure(array $configuration): void
+    {
+        Assert::allIsAOf($configuration, RenameClassAndConstFetch::class);
+        $this->renameClassConstFetches = $configuration;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Migrate constants to enum class', [
+            new ConfiguredCodeSample(
+                <<<'CODE_SAMPLE'
+\TYPO3\CMS\Core\Imaging\Icon::SIZE_DEFAULT
+\TYPO3\CMS\Core\Imaging\Icon::SIZE_SMALL
+\TYPO3\CMS\Core\Imaging\Icon::SIZE_MEDIUM
+\TYPO3\CMS\Core\Imaging\Icon::SIZE_LARGE
+\TYPO3\CMS\Core\Imaging\Icon::SIZE_MEGA
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+TYPO3\CMS\Core\Imaging\IconSize::DEFAULT
+TYPO3\CMS\Core\Imaging\IconSize::SMALL
+TYPO3\CMS\Core\Imaging\IconSize::MEDIUM
+TYPO3\CMS\Core\Imaging\IconSize::LARGE
+TYPO3\CMS\Core\Imaging\IconSize::MEGA
+CODE_SAMPLE
+                ,
+                [
+                    new RenameClassAndConstFetch(
+                        'TYPO3\CMS\Core\Imaging\Icon',
+                        'SIZE_MEDIUM',
+                        'TYPO3\CMS\Core\Imaging\IconSize',
+                        'MEDIUM'
+                    ),
+                ]
+            ),
+        ]);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [ClassConstFetch::class];
+    }
+
+    /**
+     * @param ClassConstFetch $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        foreach ($this->renameClassConstFetches as $renameClassConstFetch) {
+            if (! $this->isName($node->name, $renameClassConstFetch->getOldConstant())) {
+                continue;
+            }
+
+            if (! $this->isObjectType($node->class, $renameClassConstFetch->getOldObjectType())) {
+                continue;
+            }
+
+            return $this->nodeFactory->createClassConstFetch(
+                $renameClassConstFetch->getNewClass(),
+                $renameClassConstFetch->getNewConstant()
+            );
+        }
+
+        return null;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::ENUM;
+    }
+}
diff --git a/rules/General/Renaming/ConstantsToBackedEnumValueRector.php b/rules/General/Renaming/ConstantsToBackedEnumValueRector.php
@@ -6,6 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\PropertyFetch;
 use Rector\Contract\Rector\ConfigurableRectorInterface;
 use Rector\Rector\AbstractRector;
 use Rector\Renaming\ValueObject\RenameClassAndConstFetch;
@@ -38,22 +39,32 @@ public function configure(array $configuration): void
 
     public function getRuleDefinition(): RuleDefinition
     {
-        return new RuleDefinition('Migrate all FILETYPE_* constants from AbstractFile to FileType enum class', [
+        return new RuleDefinition('Migrate constants to enum class values', [
             new ConfiguredCodeSample(
                 <<<'CODE_SAMPLE'
-\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_UNKNOWN;
+\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_UNKNOWN
+\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_TEXT
+\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_IMAGE
+\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_AUDIO
+\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_VIDEO
+\TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_APPLICATION
 CODE_SAMPLE
                 ,
                 <<<'CODE_SAMPLE'
-\TYPO3\CMS\Core\Resource\FileType::UNKNOWN;
+\TYPO3\CMS\Core\Resource\FileType::UNKNOWN->value
+\TYPO3\CMS\Core\Resource\FileType::TEXT->value
+\TYPO3\CMS\Core\Resource\FileType::IMAGE->value
+\TYPO3\CMS\Core\Resource\FileType::AUDIO->value
+\TYPO3\CMS\Core\Resource\FileType::VIDEO->value
+\TYPO3\CMS\Core\Resource\FileType::APPLICATION->value
 CODE_SAMPLE
                 ,
                 [
                     new RenameClassAndConstFetch(
-                        'TYPO3\CMS\Core\Imaging\Icon',
-                        'SIZE_MEDIUM',
-                        'TYPO3\CMS\Core\Imaging\IconSize',
-                        'MEDIUM'
+                        '\TYPO3\CMS\Core\Resource\AbstractFile',
+                        'FILETYPE_UNKNOWN',
+                        '\TYPO3\CMS\Core\Resource\FileType',
+                        'UNKNOWN'
                     ),
                 ]
             ),
@@ -79,10 +90,12 @@ public function refactor(Node $node): ?Node
                 continue;
             }
 
-            return $this->nodeFactory->createClassConstFetch(
+            $enumConstFetch = $this->nodeFactory->createClassConstFetch(
                 $renameClassConstFetch->getNewClass(),
                 $renameClassConstFetch->getNewConstant()
             );
+
+            return new PropertyFetch($enumConstFetch, 'value');
         }
 
         return null;

diff --git a/stubs/TYPO3/CMS/Core/Authentication/LoginType.php b/stubs/TYPO3/CMS/Core/Authentication/LoginType.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TYPO3\CMS\Core\Authentication;
+
+use TYPO3\CMS\Core\Type\Enumeration;
+
+if (class_exists('TYPO3\CMS\Core\Authentication\LoginType')) {
+    return;
+}
+
+class LoginType extends Enumeration
+{
+    public const LOGIN = 'login';
+    public const LOGOUT = 'logout';
+}
diff --git a/stubs/TYPO3/CMS/Core/Resource/AbstractFile.php b/stubs/TYPO3/CMS/Core/Resource/AbstractFile.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace TYPO3\CMS\Core\Resource;
@@ -24,26 +25,21 @@ abstract class AbstractFile implements FileInterface
 
     public function getIdentifier(): string
     {
-        // TODO: Implement getIdentifier() method.
     }
 
     public function getName(): string
     {
-        // TODO: Implement getName() method.
     }
 
     public function getStorage(): ResourceStorage
     {
-        // TODO: Implement getStorage() method.
     }
 
     public function getHashedIdentifier(): string
     {
-        // TODO: Implement getHashedIdentifier() method.
     }
 
     public function getParentFolder(): FolderInterface
     {
-        // TODO: Implement getParentFolder() method.
     }
 }
diff --git a/stubs/TYPO3/CMS/Core/Type/Enumeration.php b/stubs/TYPO3/CMS/Core/Type/Enumeration.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TYPO3\CMS\Core\Type;
+
+if (class_exists('TYPO3\CMS\Core\Type\Enumeration')) {
+    return;
+}
+
+abstract class Enumeration
+{
+}
diff --git a/...s/Rector/General/Renaming/ConstantsToBackedEnumRector/ConstantsToBackedEnumRectorTest.php b/...s/Rector/General/Renaming/ConstantsToBackedEnumRector/ConstantsToBackedEnumRectorTest.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Tests\Rector\General\Renaming\ConstantsToBackedEnumRector;
+
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ConstantsToBackedEnumRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    /**
+     * @return \Iterator<array<string>>
+     */
+    public static function provideData(): \Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/tests/Rector/General/Renaming/ConstantsToBackedEnumRector/Fixture/icon_types.php.inc b/tests/Rector/General/Renaming/ConstantsToBackedEnumRector/Fixture/icon_types.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+use TYPO3\CMS\Core\Imaging\Icon;
+
+$icon1 = Icon::SIZE_DEFAULT;
+$icon2 = Icon::SIZE_SMALL;
+$icon3 = Icon::SIZE_MEDIUM;
+$icon4 = Icon::SIZE_LARGE;
+$icon5 = Icon::SIZE_MEGA;
+
+?>
+-----
+<?php
+
+use TYPO3\CMS\Core\Imaging\IconSize;
+use TYPO3\CMS\Core\Imaging\Icon;
+
+$icon1 = IconSize::DEFAULT;
+$icon2 = IconSize::SMALL;
+$icon3 = IconSize::MEDIUM;
+$icon4 = IconSize::LARGE;
+$icon5 = IconSize::MEGA;
+
+?>
diff --git a/tests/Rector/General/Renaming/ConstantsToBackedEnumRector/Source/MyOtherFileType.php b/tests/Rector/General/Renaming/ConstantsToBackedEnumRector/Source/MyOtherFileType.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Tests\Rector\General\Renaming\ConstantsToBackedEnumRector\Source;
+
+final class MyOtherFileType
+{
+    public const FILETYPE_UNKNOWN = 0;
+}