add promoted property support

rectorphp · Feb 15, 2024 · 11ed994 · 11ed994
1 parent 001b5fa
commit 11ed994
Show file tree

Hide file tree

Showing 15 changed files with 74 additions and 20 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -54,3 +54,8 @@ parameters:
             paths:
                 - src/NodeManipulator/ColumnPropertyTypeResolver.php
                 - src/NodeManipulator/NullabilityColumnPropertyTypeResolver.php
+
+        # false positive
+        -
+            message: '#PHPDoc tag @return contains unresolvable type#'
+            path: rules/CodeQuality/Contract/PropertyAttributeTransformerInterface.php
diff --git a/...eQuality/AttributeTransformer/PropertyAttributeTransformer/ColumnAttributeTransformer.php b/...eQuality/AttributeTransformer/PropertyAttributeTransformer/ColumnAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
@@ -19,7 +20,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $propertyMapping = $entityMapping->matchFieldPropertyMapping($property);
         if ($propertyMapping === null) {

diff --git a/...ttributeTransformer/PropertyAttributeTransformer/EmbeddedPropertyAttributeTransformer.php b/...ttributeTransformer/PropertyAttributeTransformer/EmbeddedPropertyAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Helper\NodeValueNormalizer;
@@ -19,7 +20,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $propertyMapping = $entityMapping->matchEmbeddedPropertyMapping($property);
         if ($propertyMapping === null) {

diff --git a/...ributeTransformer/PropertyAttributeTransformer/GedmoTimestampableAttributeTransformer.php b/...ributeTransformer/PropertyAttributeTransformer/GedmoTimestampableAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\NodeFactory\AttributeFactory;
@@ -18,7 +19,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $fieldPropertyMapping = $entityMapping->matchFieldPropertyMapping($property);
 

diff --git a/.../CodeQuality/AttributeTransformer/PropertyAttributeTransformer/IdAttributeTransformer.php b/.../CodeQuality/AttributeTransformer/PropertyAttributeTransformer/IdAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\NodeFactory\AttributeFactory;
@@ -12,7 +13,7 @@
 
 final class IdAttributeTransformer implements PropertyAttributeTransformerInterface
 {
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $idMapping = $entityMapping->matchIdPropertyMapping($property);
         if (! is_array($idMapping)) {

diff --git a/...uality/AttributeTransformer/PropertyAttributeTransformer/IdColumnAttributeTransformer.php b/...uality/AttributeTransformer/PropertyAttributeTransformer/IdColumnAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\NodeFactory\AttributeFactory;
@@ -12,7 +13,7 @@
 
 final class IdColumnAttributeTransformer implements PropertyAttributeTransformerInterface
 {
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $idMapping = $entityMapping->matchIdPropertyMapping($property);
         if (! is_array($idMapping)) {

diff --git a/...ity/AttributeTransformer/PropertyAttributeTransformer/IdGeneratorAttributeTransformer.php b/...ity/AttributeTransformer/PropertyAttributeTransformer/IdGeneratorAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
@@ -26,7 +27,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $idMapping = $entityMapping->matchIdPropertyMapping($property);
         if (! is_array($idMapping)) {

diff --git a/...lity/AttributeTransformer/PropertyAttributeTransformer/JoinColumnAttributeTransformer.php b/...lity/AttributeTransformer/PropertyAttributeTransformer/JoinColumnAttributeTransformer.php
@@ -5,6 +5,7 @@
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
 use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\NodeFactory\AttributeFactory;
@@ -19,7 +20,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $manyToOnePropertyMapping = $entityMapping->matchManyToOnePropertyMapping($property);
         if (! is_array($manyToOnePropertyMapping)) {

diff --git a/...ality/AttributeTransformer/PropertyAttributeTransformer/ManyToOneAttributeTransformer.php b/...ality/AttributeTransformer/PropertyAttributeTransformer/ManyToOneAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
@@ -20,7 +21,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $manyToOneMapping = $entityMapping->matchManyToOnePropertyMapping($property);
         if (! is_array($manyToOneMapping)) {

diff --git a/...ality/AttributeTransformer/PropertyAttributeTransformer/OneToManyAttributeTransformer.php b/...ality/AttributeTransformer/PropertyAttributeTransformer/OneToManyAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
@@ -20,7 +21,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $oneToManyMapping = $entityMapping->matchOneToManyPropertyMapping($property);
         if (! is_array($oneToManyMapping)) {

diff --git a/...Quality/AttributeTransformer/PropertyAttributeTransformer/OrderByAttributeTransformer.php b/...Quality/AttributeTransformer/PropertyAttributeTransformer/OrderByAttributeTransformer.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer\PropertyAttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Enum\EntityMappingKey;
@@ -19,7 +20,7 @@ public function __construct(
     ) {
     }
 
-    public function transform(EntityMapping $entityMapping, Property $property): void
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void
     {
         $oneToManyMapping = $entityMapping->matchOneToManyPropertyMapping($property);
         if (! is_array($oneToManyMapping)) {

diff --git a/rules/CodeQuality/AttributeTransformer/YamlToAttributeTransformer.php b/rules/CodeQuality/AttributeTransformer/YamlToAttributeTransformer.php
@@ -4,11 +4,14 @@
 
 namespace Rector\Doctrine\CodeQuality\AttributeTransformer;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\Contract\ClassAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\Contract\PropertyAttributeTransformerInterface;
 use Rector\Doctrine\CodeQuality\ValueObject\EntityMapping;
+use Rector\ValueObject\MethodName;
 
 final readonly class YamlToAttributeTransformer
 {
@@ -50,9 +53,30 @@ private function transformProperties(Class_ $class, EntityMapping $entityMapping
                 $propertyAttributeTransformer->transform($entityMapping, $property);
             }
         }
+
+        // handle promoted properties
+        $constructorClassMethod = $class->getMethod(MethodName::CONSTRUCT);
+        if (! $constructorClassMethod instanceof ClassMethod) {
+            return;
+        }
+
+        foreach ($constructorClassMethod->getParams() as $param) {
+            // is promoted property?
+            if ($param->flags === 0) {
+                continue;
+            }
+
+            foreach ($this->propertyAttributeTransformers as $propertyAttributeTransformer) {
+                if ($this->hasAttribute($param, $propertyAttributeTransformer->getClassName())) {
+                    continue;
+                }
+
+                $propertyAttributeTransformer->transform($entityMapping, $param);
+            }
+        }
     }
 
-    private function hasAttribute(Class_|Property $stmt, string $attributeClassName): bool
+    private function hasAttribute(Class_|Property|Param $stmt, string $attributeClassName): bool
     {
         foreach ($stmt->attrGroups as $attrGroup) {
             foreach ($attrGroup->attrs as $attr) {

diff --git a/rules/CodeQuality/Contract/PropertyAttributeTransformerInterface.php b/rules/CodeQuality/Contract/PropertyAttributeTransformerInterface.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\CodeQuality\Contract;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
 use Rector\Doctrine\CodeQuality\ValueObject\EntityMapping;
 
@@ -14,5 +15,5 @@ interface PropertyAttributeTransformerInterface
      */
     public function getClassName(): string;
 
-    public function transform(EntityMapping $entityMapping, Property $property): void;
+    public function transform(EntityMapping $entityMapping, Property|Param $property): void;
 }
diff --git a/rules/CodeQuality/ValueObject/EntityMapping.php b/rules/CodeQuality/ValueObject/EntityMapping.php
@@ -4,7 +4,10 @@
 
 namespace Rector\Doctrine\CodeQuality\ValueObject;
 
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Property;
+use Rector\Exception\ShouldNotHappenException;
 use Webmozart\Assert\Assert;
 
 final class EntityMapping
@@ -33,7 +36,7 @@ public function getClassName(): string
     /**
      * @return mixed[]|null
      */
-    public function matchFieldPropertyMapping(Property $property): ?array
+    public function matchFieldPropertyMapping(Property|Param $property): ?array
     {
         $propertyName = $this->getPropertyName($property);
 
@@ -43,7 +46,7 @@ public function matchFieldPropertyMapping(Property $property): ?array
     /**
      * @return mixed[]|null
      */
-    public function matchEmbeddedPropertyMapping(Property $property): ?array
+    public function matchEmbeddedPropertyMapping(Property|Param $property): ?array
     {
         $propertyName = $this->getPropertyName($property);
 
@@ -53,7 +56,7 @@ public function matchEmbeddedPropertyMapping(Property $property): ?array
     /**
      * @return array<string, mixed>|null
      */
-    public function matchManyToOnePropertyMapping(Property $property): ?array
+    public function matchManyToOnePropertyMapping(Property|Param $property): ?array
     {
         $propertyName = $this->getPropertyName($property);
         return $this->entityMapping['manyToOne'][$propertyName] ?? null;
@@ -62,7 +65,7 @@ public function matchManyToOnePropertyMapping(Property $property): ?array
     /**
      * @return array<string, mixed>|null
      */
-    public function matchOneToManyPropertyMapping(Property $property): ?array
+    public function matchOneToManyPropertyMapping(Property|Param $property): ?array
     {
         $propertyName = $this->getPropertyName($property);
         return $this->entityMapping['oneToMany'][$propertyName] ?? null;
@@ -83,15 +86,25 @@ public function getClassMapping(): array
     /**
      * @return array<string, mixed>|null
      */
-    public function matchIdPropertyMapping(Property $property): ?array
+    public function matchIdPropertyMapping(Property|Param $property): ?array
     {
         $propertyName = $this->getPropertyName($property);
 
         return $this->entityMapping['id'][$propertyName] ?? null;
     }
 
-    private function getPropertyName(Property $property): string
+    private function getPropertyName(Property|Param $property): string
     {
-        return $property->props[0]->name->toString();
+        if ($property instanceof Property) {
+            return $property->props[0]->name->toString();
+        }
+
+        if ($property->var instanceof Variable) {
+            $paramName = $property->var->name;
+            Assert::string($paramName);
+            return $paramName;
+        }
+
+        throw new ShouldNotHappenException();
     }
 }
diff --git a/src/NodeManipulator/ToManyRelationPropertyTypeResolver.php b/src/NodeManipulator/ToManyRelationPropertyTypeResolver.php
@@ -4,6 +4,7 @@
 
 namespace Rector\Doctrine\NodeManipulator;
 
+use PhpParser\Node\Param;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\Type\Type;
@@ -87,7 +88,7 @@ private function processToManyRelation(
 
     private function resolveTypeFromTargetEntity(
         Expr|string $targetEntity,
-        Property|\PhpParser\Node\Param $property
+        Property|Param $property
     ): Type {
         if ($targetEntity instanceof Expr) {
             $targetEntity = $this->valueResolver->getValue($targetEntity);