improve add generics annotation to repository to code quality doctrine set (#380)

* improve add generics annotation to repository to code quality doctrine set

* [rector] Rector fixes

---------

Co-authored-by: GitHub Action <actions@github.com>

Author: TomasVotruba

composer.json

@@ -17,7 +17,7 @@
         "phpunit/phpunit": "^11.5",
         "rector/rector-src": "dev-main",
         "rector/type-perfect": "^2.0",
-        "symplify/easy-coding-standard": "^12.5",
+        "phpecs/phpecs": "^2.1",
         "symplify/phpstan-rules": "^14.0",
         "symplify/vendor-patches": "^11.3",
         "tomasvotruba/class-leak": "^2.0",

config/sets/doctrine-code-quality.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Doctrine\Bundle230\Rector\Class_\AddAnnotationToRepositoryRector;
 use Rector\Doctrine\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector;
 use Rector\Doctrine\CodeQuality\Rector\Class_\MoveCurrentDateTimeDefaultInEntityToConstructorRector;
 use Rector\Doctrine\CodeQuality\Rector\Class_\RemoveEmptyTableAttributeRector;
@@ -28,6 +29,9 @@
         TypedPropertyFromColumnTypeRector::class,
         TypedPropertyFromToOneRelationTypeRector::class,
         TypedPropertyFromToManyRelationTypeRector::class,
+
+        // annotations generics
+        AddAnnotationToRepositoryRector::class,
     ]);
 
     $rectorConfig->ruleWithConfiguration(AttributeKeyToClassConstFetchRector::class, [

config/sets/doctrine-collection-22.php

@@ -3,7 +3,8 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Doctrine\Collection22\Rector\CriteriaOrderingConstantsDeprecationRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([\Rector\Doctrine\Collection22\Rector\CriteriaOrderingConstantsDeprecationRector::class]);
+    $rectorConfig->rules([CriteriaOrderingConstantsDeprecationRector::class]);
 };

rector.php

@@ -7,7 +7,7 @@
 
 return RectorConfig::configure()
     ->withImportNames(removeUnusedImports: true)
-    ->withPaths([__DIR__ . '/src', __DIR__ . '/rules', __DIR__ . '/tests'])
+    ->withPaths([__DIR__ . '/config', __DIR__ . '/src', __DIR__ . '/rules', __DIR__ . '/tests'])
     ->withSkip(['*/Source/*', '*/Fixture/*'])
     ->withRootFiles()
     ->withPhpSets()

rules/Bundle230/Rector/Class_/AddAnnotationToRepositoryRector.php

@@ -4,38 +4,44 @@
 
 namespace Rector\Doctrine\Bundle230\Rector\Class_;
 
-use PhpParser\Node\Name;
-use PhpParser\Node\Stmt\ClassMethod;
-use PhpParser\Node\Stmt\Expression;
-use PhpParser\Node\Expr\StaticCall;
-use PhpParser\Node\Identifier;
-use PhpParser\Node\Arg;
 use PhpParser\Node;
+use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
 use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\Doctrine\CodeQuality\Enum\DoctrineClass;
 use Rector\Rector\AbstractRector;
 use Rector\ValueObject\MethodName;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @see https://github.com/doctrine/DoctrineBundle/commit/2f12b5302bafac39c70b024e1686119be28b79ab
+ *
+ * @see \Rector\Doctrine\Tests\Bundle230\Rector\Class_\AddAnnotationToRepositoryRector\AddAnnotationToRepositoryRectorTest
  */
 final class AddAnnotationToRepositoryRector extends AbstractRector
 {
-    public function __construct(private readonly DocBlockUpdater $docBlockUpdater, private readonly PhpDocInfoFactory $phpDocInfoFactory)
-    {
+    public function __construct(
+        private readonly DocBlockUpdater $docBlockUpdater,
+        private readonly PhpDocInfoFactory $phpDocInfoFactory
+    ) {
     }
 
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition('Add @extends ServiceEntityRepository<T> annotation to repository classes', [
             new CodeSample(
                 <<<'CODE_SAMPLE'
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+
 final class SomeRepository extends ServiceEntityRepository
 {
     public function __construct(ManagerRegistry $registry)
@@ -46,7 +52,11 @@ public function __construct(ManagerRegistry $registry)
 CODE_SAMPLE
                 ,
                 <<<'CODE_SAMPLE'
-/** @extends \Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository<\SomeEntity> */
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+
+/**
+ * @extends ServiceEntityRepository<\SomeEntity>
+ */
 final class SomeRepository extends ServiceEntityRepository
 {
     public function __construct(ManagerRegistry $registry)
@@ -88,23 +98,21 @@ public function refactor(Node $node): ?Node
 
     private function isRepositoryClass(Class_ $class): bool
     {
-        if ($class->extends instanceof Name) {
-            return $this->getName(
-                $class->extends
-            ) === 'Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository';
+        if (! $class->extends instanceof Name) {
+            return false;
         }
 
-        return false;
+        return $this->isName($class->extends, DoctrineClass::SERVICE_ENTITY_REPOSITORY);
     }
 
     private function getEntityClassFromConstructor(Class_ $class): ?string
     {
-        $method = $class->getMethod(MethodName::CONSTRUCT);
-        if (!$method instanceof ClassMethod || $method->stmts === null) {
+        $classMethod = $class->getMethod(MethodName::CONSTRUCT);
+        if (! $classMethod instanceof ClassMethod || $classMethod->stmts === null) {
             return null;
         }
 
-        foreach ($method->stmts as $stmt) {
+        foreach ($classMethod->stmts as $stmt) {
             if (! $stmt instanceof Expression) {
                 continue;
             }
@@ -136,8 +144,9 @@ private function getEntityClassFromConstructor(Class_ $class): ?string
     private function addAnnotationToNode(Class_ $class, string $entityClass): void
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($class);
-        $annotation = sprintf('\Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository<\%s>', $entityClass);
-        $phpDocInfo->addPhpDocTagNode(new PhpDocTagNode('@extends', new GenericTagValueNode($annotation)));
+
+        $genericsAnnotation = sprintf('\%s<\%s>', DoctrineClass::SERVICE_ENTITY_REPOSITORY, $entityClass);
+        $phpDocInfo->addPhpDocTagNode(new PhpDocTagNode('@extends', new GenericTagValueNode($genericsAnnotation)));
 
         $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($class);
     }
@@ -150,12 +159,10 @@ private function hasExtendsAnnotation(Class_ $class): bool
 
     private function isParentConstructorCall(StaticCall $staticCall): bool
     {
-        return $staticCall->class instanceof Name
-            && $staticCall->class->toString() === 'parent'
-            && $staticCall->name instanceof Identifier
-            && $staticCall->name->toString() === '__construct'
+        return $this->isName($staticCall->class, 'parent')
+            && $this->isName($staticCall->name, '__construct')
             && isset($staticCall->args[1])
-            && $staticCall->args[1] instanceof Arg  // Controleer of args[1] een Node\Arg is
+            && $staticCall->args[1] instanceof Arg  // Controller of args[1] een Node\Arg is
             && $staticCall->args[1]->value instanceof ClassConstFetch;
     }
 }

rules/CodeQuality/AttributeTransformer/ClassAttributeTransformer/InheritanceClassAttributeTransformer.php

@@ -45,6 +45,7 @@ public function transform(EntityMapping $entityMapping, Class_ $class): bool
         if (isset($classMapping['discriminatorMap'])) {
             $this->addDiscriminatorMap($classMapping['discriminatorMap'], $class);
         }
+
         return true;
     }
 

rules/CodeQuality/AttributeTransformer/PropertyAttributeTransformer/InverseJoinColumnAttributeTransformer.php

@@ -35,6 +35,7 @@ public function transform(EntityMapping $entityMapping, Property|Param $property
         foreach ($joinColumns as $columnName => $joinColumn) {
             $property->attrGroups[] = $this->createInverseJoinColumnAttrGroup($columnName, $joinColumn);
         }
+
         return true;
     }
 

rules/CodeQuality/AttributeTransformer/PropertyAttributeTransformer/JoinColumnAttributeTransformer.php

@@ -64,6 +64,7 @@ private function transformMapping(Property|Param $property, ?array $mapping): bo
             $hasChanged = true;
             $property->attrGroups[] = $this->createJoinColumnAttrGroup($columnName, $joinColumn);
         }
+
         return $hasChanged;
     }
 

rules/CodeQuality/AttributeTransformer/YamlToAttributeTransformer.php

@@ -45,6 +45,7 @@ private function transformClass(Class_ $class, EntityMapping $entityMapping): bo
                 $hasChanged = true;
             }
         }
+
         return $hasChanged;
     }
 
@@ -87,6 +88,7 @@ private function transformProperties(Class_ $class, EntityMapping $entityMapping
                 }
             }
         }
+
         return $hasChanged;
     }
 

rules/CodeQuality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector.php

@@ -268,8 +268,8 @@ private function refactorAttribute(Expr $expr, PhpDocInfo $phpDocInfo, Property
             $this->collectionTypeResolver->hasIndexBy($property),
             $property
         );
-        $hasChanged = $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $genericObjectType);
 
+        $hasChanged = $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $genericObjectType);
         if (! $hasChanged) {
             return null;
         }