Skip date time unless entity (#256)

* Skip date time unless entity * [rector] Rector fixes --------- Co-authored-by: GitHub Action <actions@github.com>
rectorphp · Jan 31, 2024 · f6b9b1d · f6b9b1d
1 parent b419ce7
commit f6b9b1d
Show file tree

Hide file tree

Showing 20 changed files with 80 additions and 32 deletions.
diff --git a/...eQuality/Rector/Class_/InitializeDefaultEntityCollectionRector/config/configured_rule.php b/...eQuality/Rector/Class_/InitializeDefaultEntityCollectionRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Class_\InitializeDefaultEntityCollectionRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...r/Class_/MoveCurrentDateTimeDefaultInEntityToConstructorRector/config/configured_rule.php b/...r/Class_/MoveCurrentDateTimeDefaultInEntityToConstructorRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Class_\MoveCurrentDateTimeDefaultInEntityToConstructorRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...ests/CodeQuality/Rector/Class_/RemoveEmptyTableAttributeRector/config/configured_rule.php b/...ests/CodeQuality/Rector/Class_/RemoveEmptyTableAttributeRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Class_\RemoveEmptyTableAttributeRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...lity/Rector/Property/CorrectDefaultTypesOnEntityPropertyRector/config/configured_rule.php b/...lity/Rector/Property/CorrectDefaultTypesOnEntityPropertyRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\CorrectDefaultTypesOnEntityPropertyRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector/config/configured_rule.php b/...Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...Property/MakeEntityDateTimePropertyDateTimeInterfaceRector/Fixture/skip_no_entity.php.inc b/...Property/MakeEntityDateTimePropertyDateTimeInterfaceRector/Fixture/skip_no_entity.php.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Doctrine\Tests\CodeQuality\Rector\Property\MakeEntityDateTimePropertyDateTimeInterfaceRector\Fixture;
+
+use DateTime;
+
+class SkipNoEntity
+{
+    /**
+     * @var DateTime|null
+     */
+    protected $bornAt;
+}
diff --git a/...tor/Property/MakeEntityDateTimePropertyDateTimeInterfaceRector/config/configured_rule.php b/...tor/Property/MakeEntityDateTimePropertyDateTimeInterfaceRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\MakeEntityDateTimePropertyDateTimeInterfaceRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/.../CodeQuality/Rector/Property/TypedPropertyFromColumnTypeRector/config/configured_rule.php b/.../CodeQuality/Rector/Property/TypedPropertyFromColumnTypeRector/config/configured_rule.php
@@ -3,9 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromColumnTypeRector;
-
 use Rector\ValueObject\PhpVersionFeature;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...lity/Rector/Property/TypedPropertyFromDoctrineCollectionRector/config/configured_rule.php b/...lity/Rector/Property/TypedPropertyFromDoctrineCollectionRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromDoctrineCollectionRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...lity/Rector/Property/TypedPropertyFromToManyRelationTypeRector/config/configured_rule.php b/...lity/Rector/Property/TypedPropertyFromToManyRelationTypeRector/config/configured_rule.php
@@ -3,9 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromToManyRelationTypeRector;
-
 use Rector\ValueObject\PhpVersionFeature;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/...ality/Rector/Property/TypedPropertyFromToOneRelationTypeRector/config/configured_rule.php b/...ality/Rector/Property/TypedPropertyFromToOneRelationTypeRector/config/configured_rule.php
@@ -3,9 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\CodeQuality\Rector\Property\TypedPropertyFromToOneRelationTypeRector;
-
 use Rector\ValueObject\PhpVersionFeature;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/.../MethodCall/ChangeCompositeExpressionAddMultipleWithWithRector/config/configured_rule.php b/.../MethodCall/ChangeCompositeExpressionAddMultipleWithWithRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\Dbal40\Rector\MethodCall\ChangeCompositeExpressionAddMultipleWithWithRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/rules-tests/Orm28/Rector/MethodCall/IterateToToIterableRector/config/configured_rule.php b/rules-tests/Orm28/Rector/MethodCall/IterateToToIterableRector/config/configured_rule.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\Orm28\Rector\MethodCall\IterateToToIterableRector;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/rules/CodeQuality/Enum/ToManyMappings.php b/rules/CodeQuality/Enum/ToManyMappings.php
@@ -9,5 +9,5 @@ class ToManyMappings
     /**
      * @var class-string[]
      */
-    public const TO_MANY_CLASSES = ['Doctrine\\ORM\\Mapping\\OneToMany', 'Doctrine\\ORM\\Mapping\\ManyToMany'];
+    final public const TO_MANY_CLASSES = ['Doctrine\\ORM\\Mapping\\OneToMany', 'Doctrine\\ORM\\Mapping\\ManyToMany'];
 }
diff --git a/rules/CodeQuality/Rector/Property/MakeEntityDateTimePropertyDateTimeInterfaceRector.php b/rules/CodeQuality/Rector/Property/MakeEntityDateTimePropertyDateTimeInterfaceRector.php
@@ -5,13 +5,15 @@
 namespace Rector\Doctrine\CodeQuality\Rector\Property;
 
 use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\Doctrine\NodeAnalyzer\DoctrineEntityDetector;
 use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockClassRenamer;
 use Rector\NodeTypeResolver\ValueObject\OldToNewType;
 use Rector\Rector\AbstractRector;
@@ -30,6 +32,7 @@ public function __construct(
         private readonly DocBlockClassRenamer $docBlockClassRenamer,
         private readonly DocBlockUpdater $docBlockUpdater,
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
+        private readonly DoctrineEntityDetector $doctrineEntityDetector,
     ) {
     }
 
@@ -89,31 +92,44 @@ public function setBornAt(DateTimeInterface $bornAt)
      */
     public function getNodeTypes(): array
     {
-        return [Property::class];
+        return [Class_::class];
     }
 
     /**
-     * @param Property $node
+     * @param Class_ $node
      */
     public function refactor(Node $node): ?Node
     {
-        $phpDocInfo = $this->phpDocInfoFactory->createFromNode($node);
-        if (! $phpDocInfo instanceof PhpDocInfo) {
+        if (! $this->doctrineEntityDetector->detect($node)) {
             return null;
         }
 
-        $varType = $phpDocInfo->getVarType();
-        if ($varType instanceof UnionType) {
-            $varType = TypeCombinator::removeNull($varType);
-        }
+        $hasChanged = false;
 
-        if (! $varType->equals(new ObjectType('DateTime'))) {
-            return null;
+        foreach ($node->getProperties() as $property) {
+            $phpDocInfo = $this->phpDocInfoFactory->createFromNode($property);
+            if (! $phpDocInfo instanceof PhpDocInfo) {
+                continue;
+            }
+
+            $varType = $phpDocInfo->getVarType();
+            if ($varType instanceof UnionType) {
+                $varType = TypeCombinator::removeNull($varType);
+            }
+
+            if (! $varType->equals(new ObjectType('DateTime'))) {
+                continue;
+            }
+
+            $this->changePropertyType($property, 'DateTime', 'DateTimeInterface');
+            $hasChanged = true;
         }
 
-        $this->changePropertyType($node, 'DateTime', 'DateTimeInterface');
+        if ($hasChanged) {
+            return $node;
+        }
 
-        return $node;
+        return null;
     }
 
     private function changePropertyType(Property $property, string $oldClass, string $newClass): void

diff --git a/src/NodeAnalyzer/DoctrineEntityDetector.php b/src/NodeAnalyzer/DoctrineEntityDetector.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\NodeAnalyzer;
+
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Reflection\ReflectionProvider;
+use Rector\NodeAnalyzer\DoctrineEntityAnalyzer;
+
+final class DoctrineEntityDetector
+{
+    public function __construct(
+        private readonly DoctrineEntityAnalyzer $doctrineEntityAnalyzer,
+        private readonly ReflectionProvider $reflectionProvider,
+    ) {
+    }
+
+    public function detect(Class_ $class): bool
+    {
+        // A. check annotations
+        if ($this->doctrineEntityAnalyzer->hasClassAnnotation($class)) {
+            return true;
+        }
+
+        if (! $class->namespacedName instanceof Name) {
+            return false;
+        }
+
+        $className = $class->namespacedName->toString();
+
+        // B. check attributes
+        $classReflection = $this->reflectionProvider->getClass($className);
+
+        return $this->doctrineEntityAnalyzer->hasClassReflectionAttribute($classReflection);
+    }
+}
diff --git a/tests/Set/DoctrineBUNDLE210Set/config/configured_set.php b/tests/Set/DoctrineBUNDLE210Set/config/configured_set.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\Set\DoctrineSetList;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/tests/Set/DoctrineDBAL211Set/config/configured_set.php b/tests/Set/DoctrineDBAL211Set/config/configured_set.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\Set\DoctrineSetList;
 
 return static function (RectorConfig $rectorConfig): void {

diff --git a/tests/Set/DoctrineORM29Set/config/configured_set.php b/tests/Set/DoctrineORM29Set/config/configured_set.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\Set\DoctrineSetList;
 use Rector\ValueObject\PhpVersionFeature;
 

diff --git a/tests/Set/DoctrineORM29Set/config/php81_nested_attributes.php b/tests/Set/DoctrineORM29Set/config/php81_nested_attributes.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-
 use Rector\Doctrine\Set\DoctrineSetList;
 use Rector\ValueObject\PhpVersionFeature;