[Doctrine] Add AlwaysInitializeUuidInEntityRector

packages/Doctrine/src/Rector/Class_/AlwaysInitializeUuidInEntityRector.php

@@ -0,0 +1,135 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Doctrine\Rector\Class_;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Property;
+use PHPStan\Type\ObjectType;
+use Rector\Doctrine\NodeFactory\EntityUuidNodeFactory;
+use Rector\Rector\AbstractRector;
+use Rector\RectorDefinition\RectorDefinition;
+
+/**
+ * @sponsor Thanks https://spaceflow.io/ for sponsoring this rule - visit them on https://github.com/SpaceFlow-app
+ */
+final class AlwaysInitializeUuidInEntityRector extends AbstractRector
+{
+    /**
+     * @var EntityUuidNodeFactory
+     */
+    private $entityUuidNodeFactory;
+
+    public function __construct(EntityUuidNodeFactory $entityUuidNodeFactory)
+    {
+        $this->entityUuidNodeFactory = $entityUuidNodeFactory;
+    }
+
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition('Add uuid initializion to all entities that misses it');
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isDoctrineEntityClass($node)) {
+            return null;
+        }
+
+        $uuidProperty = $this->resolveUuidPropertyFromClass($node);
+        if ($uuidProperty === null) {
+            return null;
+        }
+
+        $uuidPropertyName = $this->getName($uuidProperty);
+        if ($this->hasUuidInitAlreadyAdded($node, $uuidPropertyName)) {
+            return null;
+        }
+
+        $constructClassMethod = $node->getMethod('__construct');
+        if ($constructClassMethod === null) {
+            $constructClassMethod = $this->entityUuidNodeFactory->createConstructorWithUuidInitialization(
+                $node,
+                $uuidPropertyName
+            );
+            $node->stmts = array_merge((array) $node->stmts, [$constructClassMethod]);
+        } else {
+            $assignExpression = $this->entityUuidNodeFactory->createUuidPropertyDefaultValueAssign($uuidPropertyName);
+            $constructClassMethod->stmts = array_merge([$assignExpression], (array) $constructClassMethod->stmts);
+        }
+
+        return $node;
+    }
+
+    private function resolveUuidPropertyFromClass(Class_ $class): ?Property
+    {
+        foreach ($class->getProperties() as $property) {
+            $propertyPhpDoc = $this->getPhpDocInfo($property);
+            if ($propertyPhpDoc === null) {
+                continue;
+            }
+
+            $varType = $propertyPhpDoc->getVarType();
+            if (! $varType instanceof ObjectType) {
+                continue;
+            }
+
+            if (! Strings::contains($varType->getClassName(), 'UuidInterface')) {
+                continue;
+            }
+
+            return $property;
+        }
+
+        return null;
+    }
+
+    private function hasUuidInitAlreadyAdded(Class_ $class, string $uuidPropertyName): bool
+    {
+        $constructClassMethod = $class->getMethod('__construct');
+        if ($constructClassMethod === null) {
+            return false;
+        }
+
+        return (bool) $this->betterNodeFinder->findFirst((array) $class->stmts, function (Node $node) use (
+            $uuidPropertyName
+        ): bool {
+            if (! $node instanceof Assign) {
+                return false;
+            }
+
+            if (! $node->expr instanceof StaticCall) {
+                return false;
+            }
+
+            $staticCall = $node->expr;
+            if (! $this->isObjectType($staticCall->class, 'Ramsey\Uuid\Uuid')) {
+                return false;
+            }
+
+            if (! $this->isName($staticCall->name, 'uuid4')) {
+                return false;
+            }
+
+            if (! $this->isName($node->var, $uuidPropertyName)) {
+                return false;
+            }
+
+            return true;
+        });
+    }
+}

packages/Doctrine/tests/Rector/Class_/AlwaysInitializeUuidInEntityRector/AlwaysInitializeUuidInEntityRectorTest.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector;
+
+use Rector\Doctrine\Rector\Class_\AlwaysInitializeUuidInEntityRector;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AlwaysInitializeUuidInEntityRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideDataForTest()
+     */
+    public function test(string $file): void
+    {
+        $this->doTestFile($file);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function provideDataForTest(): iterable
+    {
+        yield [__DIR__ . '/Fixture/add_uuid_init.php.inc'];
+        yield [__DIR__ . '/Fixture/add_uuid_init_to_construct.php.inc'];
+        yield [__DIR__ . '/Fixture/skip_already_added.php.inc'];
+    }
+
+    protected function getRectorClass(): string
+    {
+        return AlwaysInitializeUuidInEntityRector::class;
+    }
+}

packages/Doctrine/tests/Rector/Class_/AlwaysInitializeUuidInEntityRector/Fixture/add_uuid_init.php.inc

@@ -0,0 +1,45 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Source\UuidInterface;
+
+/**
+ * @ORM\Entity
+ */
+class AddUuidInit
+{
+    /**
+     * @ORM\Id
+     * @var UuidInterface
+     */
+    private $superUuid;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Source\UuidInterface;
+
+/**
+ * @ORM\Entity
+ */
+class AddUuidInit
+{
+    /**
+     * @ORM\Id
+     * @var UuidInterface
+     */
+    private $superUuid;
+    public function __construct()
+    {
+        $this->superUuid = \Ramsey\Uuid\Uuid::uuid4();
+    }
+}
+
+?>

packages/Doctrine/tests/Rector/Class_/AlwaysInitializeUuidInEntityRector/Fixture/add_uuid_init_to_construct.php.inc

@@ -0,0 +1,52 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Source\UuidInterface;
+
+/**
+ * @ORM\Entity
+ */
+class AddUuidInitToConstruct
+{
+    /**
+     * @ORM\Id
+     * @var UuidInterface
+     */
+    private $superUuid;
+
+    public function __construct()
+    {
+        $one = 2;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Source\UuidInterface;
+
+/**
+ * @ORM\Entity
+ */
+class AddUuidInitToConstruct
+{
+    /**
+     * @ORM\Id
+     * @var UuidInterface
+     */
+    private $superUuid;
+
+    public function __construct()
+    {
+        $this->superUuid = \Ramsey\Uuid\Uuid::uuid4();
+        $one = 2;
+    }
+}
+
+?>

packages/Doctrine/tests/Rector/Class_/AlwaysInitializeUuidInEntityRector/Fixture/skip_already_added.php.inc

@@ -0,0 +1,26 @@
+<?php
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+use Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Source\UuidInterface;
+
+/**
+ * @ORM\Entity
+ */
+class SkipAlreadyAdded
+{
+    /**
+     * @ORM\Id
+     * @var UuidInterface
+     */
+    private $superUuid;
+
+    public function __construct()
+    {
+        $this->superUuid = \Ramsey\Uuid\Uuid::uuid4();
+        $one = 2;
+    }
+}
+
+?>

packages/Doctrine/tests/Rector/Class_/AlwaysInitializeUuidInEntityRector/Source/UuidInterface.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\Rector\Class_\AlwaysInitializeUuidInEntityRector\Source;
+
+interface UuidInterface
+{
+
+}