Decouple annotation to own PhpDocNodeFactory to allow extension without change

composer.json

@@ -55,7 +55,6 @@
             "Rector\\ConsoleDiffer\\": "packages/ConsoleDiffer/src",
             "Rector\\DeadCode\\": "packages/DeadCode/src",
             "Rector\\Doctrine\\": "packages/Doctrine/src",
-            "Rector\\DoctrinePhpDocParser\\": "packages/DoctrinePhpDocParser/src",
             "Rector\\ElasticSearchDSL\\": "packages/ElasticSearchDSL/src",
             "Rector\\FileSystemRector\\": "packages/FileSystemRector/src",
             "Rector\\Guzzle\\": "packages/Guzzle/src",
@@ -112,7 +111,6 @@
             "Rector\\CodingStyle\\Tests\\": "packages/CodingStyle/tests",
             "Rector\\DeadCode\\Tests\\": "packages/DeadCode/tests",
             "Rector\\Doctrine\\Tests\\": "packages/Doctrine/tests",
-            "Rector\\DoctrinePhpDocParser\\Tests\\": "packages/DoctrinePhpDocParser/tests",
             "Rector\\ElasticSearchDSL\\Tests\\": "packages/ElasticSearchDSL/tests",
             "Rector\\Guzzle\\Tests\\": "packages/Guzzle/tests",
             "Rector\\Laravel\\Tests\\": "packages/Laravel/tests",

docs/AllRectorsOverview.md

@@ -3041,7 +3041,7 @@ services:
 +    /**
 +     * @return int[]
 +     */
-+    public function provideDataForTest(): iterable
++    public function provideDataForTest(): \Iterator
 +    {
 +        yield [1];
 +        yield [2];

ecs.yaml

@@ -116,15 +116,14 @@ parameters:
 
         Symplify\CodingStandard\Sniffs\CleanCode\CognitiveComplexitySniff:
             - 'packages/Doctrine/src/Rector/ClassMethod/AddMethodCallBasedParamTypeRector.php'
-            - 'packages/DoctrinePhpDocParser/src/PhpDocParser/OrmTagParser.php'
             - 'packages/TypeDeclaration/src/TypeInferer/ReturnTypeInferer/ReturnedNodesReturnTypeInferer.php'
             - 'packages/NodeTypeResolver/src/NodeTypeResolver.php'
             - 'packages/NodeTypeResolver/src/PerNodeTypeResolver/VariableTypeResolver.php'
             - 'packages/Php71/src/Rector/FuncCall/RemoveExtraParametersRector.php'
             - 'packages/SOLID/src/Analyzer/ClassConstantFetchAnalyzer.php'
             # tough logic
             - 'packages/PHPUnit/src/Rector/Class_/ArrayArgumentInTestToDataProviderRector.php'
-            - 'packages/DoctrinePhpDocParser/src/Ast/PhpDoc/*/*TagValueNode.php'
+            - 'packages/BetterPhpDocParser/src/Ast/PhpDoc/*/*TagValueNode.php'
             - 'packages/NodeTypeResolver/src/PhpDoc/NodeAnalyzer/FqnNamePhpDocNodeDecorator.php'
             - 'packages/NodeTypeResolver/src/PHPStan/Type/StaticTypeAnalyzer.php'
             - 'src/NodeContainer/ParsedNodesByType.php'

packages/Architecture/src/Rector/Class_/RemoveRepositoryFromEntityAnnotationRector.php

@@ -5,7 +5,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use Rector\Architecture\Tests\Rector\Class_\RemoveRepositoryFromEntityAnnotationRector\RemoveRepositoryFromEntityAnnotationRectorTest;
-use Rector\DoctrinePhpDocParser\Ast\PhpDoc\Class_\EntityTagValueNode;
+use Rector\BetterPhpDocParser\PhpDocNode\Doctrine\Class_\EntityTagValueNode;
 use Rector\Rector\AbstractRector;
 use Rector\RectorDefinition\CodeSample;
 use Rector\RectorDefinition\RectorDefinition;

packages/Architecture/tests/Rector/Class_/ConstructorInjectionToActionInjectionRector/ConstructorInjectionToActionInjectionRectorTest.php

@@ -2,6 +2,7 @@
 
 namespace Rector\Architecture\Tests\Rector\Class_\ConstructorInjectionToActionInjectionRector;
 
+use Iterator;
 use Rector\Architecture\Rector\Class_\ConstructorInjectionToActionInjectionRector;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 
@@ -15,10 +16,7 @@ public function test(string $file): void
         $this->doTestFile($file);
     }
 
-    /**
-     * @return string[]
-     */
-    public function provideDataForTest(): iterable
+    public function provideDataForTest(): Iterator
     {
         yield [__DIR__ . '/Fixture/fixture.php.inc'];
         yield [__DIR__ . '/Fixture/duplicate.php.inc'];

packages/Architecture/tests/Rector/Class_/RemoveRepositoryFromEntityAnnotationRector/RemoveRepositoryFromEntityAnnotationRectorTest.php

@@ -2,6 +2,7 @@
 
 namespace Rector\Architecture\Tests\Rector\Class_\RemoveRepositoryFromEntityAnnotationRector;
 
+use Iterator;
 use Rector\Architecture\Rector\Class_\RemoveRepositoryFromEntityAnnotationRector;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 
@@ -15,10 +16,7 @@ public function test(string $file): void
         $this->doTestFile($file);
     }
 
-    /**
-     * @return string[]
-     */
-    public function provideDataForTest(): iterable
+    public function provideDataForTest(): Iterator
     {
         yield [__DIR__ . '/Fixture/fixture.php.inc'];
         yield [__DIR__ . '/Fixture/skip_done.php.inc'];

packages/Autodiscovery/src/Rector/FileSystem/MoveEntitiesToEntityDirectoryRector.php

@@ -6,7 +6,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use Rector\Autodiscovery\FileMover\FileMover;
-use Rector\DoctrinePhpDocParser\Ast\PhpDoc\Class_\EntityTagValueNode;
+use Rector\BetterPhpDocParser\PhpDocNode\Doctrine\Class_\EntityTagValueNode;
 use Rector\FileSystemRector\Rector\AbstractFileSystemRector;
 use Rector\RectorDefinition\CodeSample;
 use Rector\RectorDefinition\RectorDefinition;

packages/Autodiscovery/tests/Rector/FileSystem/MoveEntitiesToEntityDirectoryRector/MoveEntitiesToEntityDirectoryRectorTest.php

@@ -19,9 +19,6 @@ public function test(string $originalFile, string $expectedFileLocation, string
         $this->assertFileEquals($expectedFileContent, $expectedFileLocation);
     }
 
-    /**
-     * @return string[]
-     */
     public function provideDataForTest(): Iterator
     {
         yield [

packages/Autodiscovery/tests/Rector/FileSystem/MoveInterfacesToContractNamespaceDirectoryRector/MoveInterfacesToContractNamespaceDirectoryRectorTest.php

@@ -19,9 +19,6 @@ public function test(string $originalFile, string $expectedFileLocation, string
         $this->assertFileEquals($expectedFileContent, $expectedFileLocation);
     }
 
-    /**
-     * @return string[]
-     */
     public function provideDataForTest(): Iterator
     {
         yield [

packages/Autodiscovery/tests/Rector/FileSystem/MoveServicesBySuffixToDirectoryRector/MoveServicesBySuffixToDirectoryRectorTest.php

@@ -19,9 +19,6 @@ public function test(string $originalFile, string $expectedFileLocation, string
         $this->assertFileEquals($expectedFileContent, $expectedFileLocation);
     }
 
-    /**
-     * @return string[]
-     */
     public function provideDataForTest(): Iterator
     {
         yield [

packages/BetterPhpDocParser/config/config.yaml

@@ -5,7 +5,7 @@ services:
 
     Rector\BetterPhpDocParser\:
         resource: '../src'
-        exclude: '../src/{HttpKernel,ValueObject/*,*/*Info.php,*Info.php,Attributes/Ast/PhpDoc/*,Ast/PhpDoc/*}'
+        exclude: '../src/{HttpKernel,ValueObject/*,*/*Info.php,*Info.php,Attributes/Ast/PhpDoc/*,Ast/PhpDoc/*,PhpDocNode/*}'
 
     PHPStan\PhpDocParser\Lexer\Lexer: ~
     PHPStan\PhpDocParser\Parser\TypeParser: ~

packages/DoctrinePhpDocParser/src/AnnotationReader/AnnotationReaderFactory.php → packages/BetterPhpDocParser/src/AnnotationReader/AnnotationReaderFactory.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\AnnotationReader;
+namespace Rector\BetterPhpDocParser\AnnotationReader;
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
@@ -17,10 +17,22 @@ public function create(): AnnotationReader
         // don't forget to add it to "stubs/Doctrine/Empty" directory, because the class needs to exists
         // and run "composer dump-autoload", because the directory is loaded by classmap
         $annotationReader::addGlobalIgnoredName('ORM\GeneratedValue');
+        $annotationReader::addGlobalIgnoredName('GeneratedValue');
+
         $annotationReader::addGlobalIgnoredName('ORM\InheritanceType');
+        $annotationReader::addGlobalIgnoredName('InheritanceType');
+
         $annotationReader::addGlobalIgnoredName('ORM\OrderBy');
+        $annotationReader::addGlobalIgnoredName('OrderBy');
+
         $annotationReader::addGlobalIgnoredName('ORM\DiscriminatorMap');
+        $annotationReader::addGlobalIgnoredName('DiscriminatorMap');
+
+        $annotationReader::addGlobalIgnoredName('ORM\UniqueEntity');
+        $annotationReader::addGlobalIgnoredName('UniqueEntity');
+
         $annotationReader::addGlobalIgnoredName('Gedmo\SoftDeleteable');
+        $annotationReader::addGlobalIgnoredName('SoftDeleteable');
 
         // warning: nested tags must be parse-able, e.g. @ORM\Table must include @ORM\UniqueConstraint!
 

packages/DoctrinePhpDocParser/src/AnnotationReader/NodeAnnotationReader.php → packages/BetterPhpDocParser/src/AnnotationReader/NodeAnnotationReader.php

@@ -1,13 +1,13 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\AnnotationReader;
+namespace Rector\BetterPhpDocParser\AnnotationReader;
 
+use Doctrine\Common\Annotations\AnnotationException;
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\ORM\Mapping\Annotation;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Property;
-use Rector\Exception\ShouldNotHappenException;
 use Rector\NodeTypeResolver\ClassExistenceStaticHelper;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\PhpParser\Node\Resolver\NameResolver;
@@ -51,20 +51,22 @@ public function readMethodAnnotation(ClassMethod $classMethod, string $annotatio
 
         $reflectionMethod = new ReflectionMethod($className, $methodName);
 
-        return $this->annotationReader->getMethodAnnotation($reflectionMethod, $annotationClassName);
+        try {
+            return $this->annotationReader->getMethodAnnotation($reflectionMethod, $annotationClassName);
+        } catch (AnnotationException $annotationException) {
+            // unable to laod
+            return null;
+        }
     }
 
-    public function readClassAnnotation(Class_ $class, string $annotationClassName): Annotation
+    /**
+     * @return object|null
+     */
+    public function readClassAnnotation(Class_ $class, string $annotationClassName)
     {
         $classReflection = $this->createClassReflectionFromNode($class);
 
-        /** @var Annotation|null $classAnnotation */
-        $classAnnotation = $this->annotationReader->getClassAnnotation($classReflection, $annotationClassName);
-        if ($classAnnotation === null) {
-            throw new ShouldNotHappenException();
-        }
-
-        return $classAnnotation;
+        return $this->annotationReader->getClassAnnotation($classReflection, $annotationClassName);
     }
 
     /**
@@ -80,7 +82,7 @@ public function readPropertyAnnotation(Property $property, string $annotationCla
         /** @var Annotation|null $propertyAnnotation */
         $propertyAnnotation = $this->annotationReader->getPropertyAnnotation($propertyReflection, $annotationClassName);
         if ($propertyAnnotation === null) {
-            throw new ShouldNotHappenException();
+            return null;
         }
 
         return $propertyAnnotation;
@@ -91,15 +93,12 @@ private function createPropertyReflectionFromPropertyNode(Property $property): ?
         /** @var string $propertyName */
         $propertyName = $this->nameResolver->getName($property);
 
-        /** @var string $className */
+        /** @var string|null $className */
         $className = $property->getAttribute(AttributeKey::CLASS_NAME);
 
         if ($className === null || ! ClassExistenceStaticHelper::doesClassLikeExist($className)) {
-            throw new ShouldNotHappenException(sprintf(
-                'Class "%s" for property "%s" was not found.',
-                (string) $className,
-                $propertyName
-            ));
+            // probably fresh node
+            return null;
         }
 
         try {

packages/DoctrinePhpDocParser/src/Contract/Ast/PhpDoc/DoctrineRelationTagValueNodeInterface.php → packages/BetterPhpDocParser/src/Contract/Doctrine/DoctrineRelationTagValueNodeInterface.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\Contract\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
 
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
 

packages/DoctrinePhpDocParser/src/Contract/Ast/PhpDoc/DoctrineTagNodeInterface.php → packages/BetterPhpDocParser/src/Contract/Doctrine/DoctrineTagNodeInterface.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\Contract\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
 
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
 

packages/DoctrinePhpDocParser/src/Contract/Ast/PhpDoc/InversedByNodeInterface.php → packages/BetterPhpDocParser/src/Contract/Doctrine/InversedByNodeInterface.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\Contract\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
 
 interface InversedByNodeInterface
 {

packages/DoctrinePhpDocParser/src/Contract/Ast/PhpDoc/MappedByNodeInterface.php → packages/BetterPhpDocParser/src/Contract/Doctrine/MappedByNodeInterface.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\Contract\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
 
 interface MappedByNodeInterface
 {

packages/BetterPhpDocParser/src/Contract/Doctrine/OriginalTagAwareInterface.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
+
+interface OriginalTagAwareInterface
+{
+    public function getOriginalTag(): ?string;
+}

packages/DoctrinePhpDocParser/src/Contract/Ast/PhpDoc/ToManyTagNodeInterface.php → packages/BetterPhpDocParser/src/Contract/Doctrine/ToManyTagNodeInterface.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\Contract\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
 
 interface ToManyTagNodeInterface extends DoctrineRelationTagValueNodeInterface
 {

packages/DoctrinePhpDocParser/src/Contract/Ast/PhpDoc/ToOneTagNodeInterface.php → packages/BetterPhpDocParser/src/Contract/Doctrine/ToOneTagNodeInterface.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Rector\DoctrinePhpDocParser\Contract\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\Contract\Doctrine;
 
 interface ToOneTagNodeInterface extends DoctrineRelationTagValueNodeInterface
 {

packages/BetterPhpDocParser/src/Contract/PhpDocNodeFactoryInterface.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Rector\BetterPhpDocParser\Contract;
+
+use PhpParser\Node;
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
+use PHPStan\PhpDocParser\Parser\TokenIterator;
+
+interface PhpDocNodeFactoryInterface
+{
+    public function getName(): string;
+
+    public function createFromNodeAndTokens(Node $node, TokenIterator $tokenIterator): ?PhpDocTagValueNode;
+}

packages/BetterPhpDocParser/src/Contract/PhpDocParserAwareInterface.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace Rector\BetterPhpDocParser\Contract;
+
+use PHPStan\PhpDocParser\Parser\PhpDocParser;
+
+interface PhpDocParserAwareInterface
+{
+    public function setPhpDocParser(PhpDocParser $phpDocParser): void;
+}

packages/BetterPhpDocParser/src/PhpDocInfo/PhpDocInfoFactory.php

@@ -9,8 +9,8 @@
 use Rector\BetterPhpDocParser\Attributes\Ast\PhpDoc\AttributeAwarePhpDocNode;
 use Rector\BetterPhpDocParser\Attributes\Attribute\Attribute;
 use Rector\BetterPhpDocParser\Attributes\Contract\Ast\AttributeAwareNodeInterface;
+use Rector\BetterPhpDocParser\PhpDocParser\OrmTagParser;
 use Rector\Configuration\CurrentNodeProvider;
-use Rector\DoctrinePhpDocParser\PhpDocParser\OrmTagParser;
 use Rector\Exception\ShouldNotHappenException;
 use Rector\NodeTypeResolver\StaticTypeMapper;