[PHP 8.1] Add MyCLabs enum to native Enum

composer.json

@@ -19,7 +19,7 @@
         "jean85/pretty-package-versions": "^1.6",
         "nette/caching": "^3.1",
         "nette/utils": "^3.2",
-        "nikic/php-parser": "4.10.4",
+        "nikic/php-parser": "4.10.5",
         "phpstan/phpdoc-parser": "^0.5.4",
         "phpstan/phpstan": "0.12.85",
         "phpstan/phpstan-phpunit": "^0.12.18",
@@ -87,6 +87,7 @@
         "classmap": [
             "stubs/Annotations",
             "stubs/Nette",
+            "stubs/MyClabs",
             "rules-tests/Autodiscovery/Rector/Class_/MoveServicesBySuffixToDirectoryRector/Expected",
             "rules-tests/Autodiscovery/Rector/Interface_/MoveInterfacesToContractNamespaceDirectoryRector/Expected",
             "rules-tests/CodingStyle/Rector/Namespace_/ImportFullyQualifiedNamesRector/Source",
@@ -134,5 +135,7 @@
     "config": {
         "sort-packages": true,
         "platform-check": false
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

config/set/php81.php

@@ -2,10 +2,14 @@
 
 declare(strict_types=1);
 
+use Rector\Php81\Rector\Class_\MyCLabsClassToEnumRector;
+use Rector\Php81\Rector\MethodCall\MyCLabsMethodCallToEnumConstRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     $services = $containerConfigurator->services();
     $services->set(ReturnNeverTypeRector::class);
+    $services->set(MyCLabsClassToEnumRector::class);
+    $services->set(MyCLabsMethodCallToEnumConstRector::class);
 };

preload.php

@@ -12,6 +12,7 @@
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Lexer/TokenEmulator/KeywordEmulator.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Lexer/TokenEmulator/CoaleseEqualTokenEmulator.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Lexer/TokenEmulator/NullsafeTokenEmulator.php';
+require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Lexer/TokenEmulator/EnumTokenEmulator.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Lexer/TokenEmulator/AttributeEmulator.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Lexer/Emulative.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder.php';
@@ -166,6 +167,7 @@
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Namespace_.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Do_.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Const_.php';
+require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Enum_.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/ClassLike.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/ClassConst.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Finally_.php';
@@ -222,6 +224,7 @@
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/Trait_.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/Property.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/Namespace_.php';
+require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/ClassConst.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/Use_.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/Class_.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Builder/Interface_.php';

rules-tests/Php81/Rector/Class_/MyCLabsClassToEnumRector/Fixture/private_const_with_static_method.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\Php81\Rector\Class_\MyCLabsClassToEnumRector\Fixture;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * @method static PrivateConstWithStaticMethod VIDEO()
+ */
+final class PrivateConstWithStaticMethod extends Enum
+{
+    /**
+     * Some comment
+     */
+    private const VIDEO = 'video';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php81\Rector\Class_\MyCLabsClassToEnumRector\Fixture;
+
+use MyCLabs\Enum\Enum;
+
+enum PrivateConstWithStaticMethod
+{
+    /**
+     * Some comment
+     */
+    case VIDEO = 'video';
+}
+
+?>

rules-tests/Php81/Rector/Class_/MyCLabsClassToEnumRector/Fixture/some_class.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\Php81\Rector\Class_\MyCLabsClassToEnumRector\Fixture;
+
+use MyCLabs\Enum\Enum;
+
+final class SomeClass extends Enum
+{
+    /**
+     * Some comment
+     */
+    private const VIEW = 'view';
+
+    private const EDIT = 'edit';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php81\Rector\Class_\MyCLabsClassToEnumRector\Fixture;
+
+use MyCLabs\Enum\Enum;
+
+enum SomeClass
+{
+    /**
+     * Some comment
+     */
+    case VIEW = 'view';
+    case EDIT = 'edit';
+}
+
+?>

rules-tests/Php81/Rector/Class_/MyCLabsClassToEnumRector/MyCLabsClassToEnumRectorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php81\Rector\Class_\MyCLabsClassToEnumRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class MyCLabsClassToEnumRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/Php81/Rector/Class_/MyCLabsClassToEnumRector/config/configured_rule.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Php81\Rector\Class_\MyCLabsClassToEnumRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->set(MyCLabsClassToEnumRector::class);
+};

rules-tests/Php81/Rector/MethodCall/MyCLabsClassToEnumRector/Fixture/usage_of_constant.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector\Fixture;
+
+use Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector\Source\SomeEnum;
+
+final class UsageOfConstant
+{
+    public function run($value)
+    {
+        $compare = SomeEnum::VALUE()->getKey();
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector\Fixture;
+
+use Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector\Source\SomeEnum;
+
+final class UsageOfConstant
+{
+    public function run($value)
+    {
+        $compare = \Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector\Source\SomeEnum::VALUE;
+    }
+}
+
+?>

rules-tests/Php81/Rector/MethodCall/MyCLabsClassToEnumRector/MyCLabsClassToEnumRectorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class MyCLabsClassToEnumRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/Php81/Rector/MethodCall/MyCLabsClassToEnumRector/Source/SomeEnum.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php81\Rector\MethodCall\MyCLabsClassToEnumRector\Source;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * @method SomeEnum VALUE()
+ */
+final class SomeEnum extends Enum
+{
+    const VALUE = 'value';
+}

rules-tests/Php81/Rector/MethodCall/MyCLabsClassToEnumRector/config/configured_rule.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Php81\Rector\MethodCall\MyCLabsMethodCallToEnumConstRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->set(MyCLabsMethodCallToEnumConstRector::class);
+};

rules/Php81/NodeFactory/EnumFactory.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php81\NodeFactory;
+
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\Node\Stmt\Enum_;
+use PhpParser\Node\Stmt\EnumCase;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+
+final class EnumFactory
+{
+    /**
+     * @var NodeNameResolver
+     */
+    private $nodeNameResolver;
+
+    public function __construct(NodeNameResolver $nodeNameResolver)
+    {
+        $this->nodeNameResolver = $nodeNameResolver;
+    }
+
+    public function createFromClass(Class_ $class): Enum_
+    {
+        $shortClassName = $this->nodeNameResolver->getShortName($class);
+        $enum = new Enum_($shortClassName);
+
+        // constant to cases
+        foreach ($class->getConstants() as $classConst) {
+            $enum->stmts[] = $this->createEnumCase($classConst);
+        }
+
+        return $enum;
+    }
+
+    private function createEnumCase(ClassConst $classConst): EnumCase
+    {
+        $constConst = $classConst->consts[0];
+        $enumCase = new EnumCase($constConst->name, $constConst->value);
+
+        // mirrow comments
+        $enumCase->setAttribute(AttributeKey::PHP_DOC_INFO, $classConst->getAttribute(AttributeKey::PHP_DOC_INFO));
+        $enumCase->setAttribute(AttributeKey::COMMENTS, $classConst->getAttribute(AttributeKey::COMMENTS));
+
+        return $enumCase;
+    }
+}