[code-quality] Add TypeNullableEntityFromDocblockRector to add safe types to ddoctrine entities (#459)

Author: TomasVotruba

config/sets/doctrine-code-quality.php

@@ -9,6 +9,7 @@
 use Rector\Doctrine\CodeQuality\Rector\Property\CorrectDefaultTypesOnEntityPropertyRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromColumnTypeRector;
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromToOneRelationTypeRector;
+use Rector\Doctrine\TypedCollections\Rector\Class_\CompleteReturnDocblockFromToManyRector;
 use Rector\Transform\Rector\Attribute\AttributeKeyToClassConstFetchRector;
 use Rector\Transform\ValueObject\AttributeKeyToClassConstFetch;
 
@@ -22,6 +23,7 @@
         // typed properties in entities from annotations/attributes
         TypedPropertyFromColumnTypeRector::class,
         TypedPropertyFromToOneRelationTypeRector::class,
+        CompleteReturnDocblockFromToManyRector::class,
 
         // annotations generics
         AddAnnotationToRepositoryRector::class,

rules-tests/CodeQuality/Rector/Class_/TypeNullableEntityFromDocblockRector/Fixture/attribute_entity.php.inc

@@ -0,0 +1,66 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class AttributeEntity
+{
+    /**
+     * @var string
+     */
+    #[ORM\Id]
+    #[ORM\Column(type: 'string')]
+    #[ORM\GeneratedValue]
+    private $name;
+
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     */
+    public function setName($name): void
+    {
+        $this->name = $name;
+    }
+}
+
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class AttributeEntity
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'string')]
+    #[ORM\GeneratedValue]
+    private ?string $name = null;
+
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(?string $name): void
+    {
+        $this->name = $name;
+    }
+}
+
+
+?>

rules-tests/CodeQuality/Rector/Class_/TypeNullableEntityFromDocblockRector/Fixture/docblock_entity.php.inc

@@ -0,0 +1,72 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class DocblockEntity
+{
+    /**
+     * @var string
+     * @ORM\Id
+     * @ORM\Column(type="string")
+     * @ORM\GeneratedValue
+     */
+    private $name;
+
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     */
+    public function setName($name): void
+    {
+        $this->name = $name;
+    }
+}
+
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class DocblockEntity
+{
+    /**
+     * @ORM\Id
+     * @ORM\Column(type="string")
+     * @ORM\GeneratedValue
+     */
+    private ?string $name = null;
+
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(?string $name): void
+    {
+        $this->name = $name;
+    }
+}
+
+
+?>

rules-tests/CodeQuality/Rector/Class_/TypeNullableEntityFromDocblockRector/Fixture/skip_unknown_property_type.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class SkipUnknownPropertyType
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    private $name;
+
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     */
+    public function setName($name): void
+    {
+        $this->name = $name;
+    }
+}

rules-tests/CodeQuality/Rector/Class_/TypeNullableEntityFromDocblockRector/Fixture/use_column_type.php.inc

@@ -0,0 +1,63 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class UseColumnType
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'string')]
+    #[ORM\GeneratedValue]
+    private $name;
+
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     */
+    public function setName($name): void
+    {
+        $this->name = $name;
+    }
+}
+
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector\Fixture;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class UseColumnType
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'string')]
+    #[ORM\GeneratedValue]
+    private ?string $name = null;
+
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(?string $name): void
+    {
+        $this->name = $name;
+    }
+}
+
+
+?>

rules-tests/CodeQuality/Rector/Class_/TypeNullableEntityFromDocblockRector/TypeNullableEntityFromDocblockRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class TypeNullableEntityFromDocblockRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/CodeQuality/Rector/Class_/TypeNullableEntityFromDocblockRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\CodeQuality\Rector\Class_\TypeNullableEntityFromDocblockRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(TypeNullableEntityFromDocblockRector::class);
+};

rules/CodeQuality/Helper/SetterGetterFinder.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\CodeQuality\Helper;
+
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\TypeDeclaration\NodeAnalyzer\ClassMethodAndPropertyAnalyzer;
+
+final readonly class SetterGetterFinder
+{
+    public function __construct(
+        private ClassMethodAndPropertyAnalyzer $classMethodAndPropertyAnalyzer
+    ) {
+    }
+
+    public function findGetterClassMethod(Class_ $class, string $propertyName): ?ClassMethod
+    {
+        foreach ($class->getMethods() as $classMethod) {
+            if (! $this->classMethodAndPropertyAnalyzer->hasPropertyFetchReturn($classMethod, $propertyName)) {
+                continue;
+            }
+
+            return $classMethod;
+        }
+
+        return null;
+    }
+
+    public function findSetterClassMethod(Class_ $class, string $propertyName): ?ClassMethod
+    {
+        foreach ($class->getMethods() as $classMethod) {
+            if (! $this->classMethodAndPropertyAnalyzer->hasOnlyPropertyAssign($classMethod, $propertyName)) {
+                continue;
+            }
+
+            return $classMethod;
+        }
+
+        return null;
+    }
+}