[doctrine] Add RequiredDoctrineServiceRepositoryParentRule (#208)

Author: TomasVotruba

README.md

@@ -1782,6 +1782,46 @@ class SomeListener
 
 <br>
 
+### RequiredDoctrineServiceRepositoryParentRule
+
+Repository must extend *, so it can be injected as a service
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Doctrine\RequiredDoctrineServiceRepositoryParentRule
+```
+
+```php
+final class SomeRepository
+{
+    public function __construct(EntityManagerInterface $entityManager)
+    {
+        // ...
+    }
+}
+```
+
+:x:
+
+<br>
+
+```php
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+
+final class SomeRepository extends ServiceEntityRepository
+{
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, SomeEntity::class);
+    }
+}
+```
+
+:+1:
+
+<br>
+
 ### NoDoctrineListenerWithoutContractRule
 
 There should be no Doctrine listeners modified in config. Implement  "Document\Event\EventSubscriber" to provide events in the class itself

src/Enum/DoctrineClass.php

@@ -14,7 +14,7 @@ final class DoctrineClass
     /**
      * @var string
      */
-    public const ODM_SERVICE_DOCUMENT_REPOSITORY_INTERFACE = 'Doctrine\Bundle\MongoDBBundle\Repository\ServiceDocumentRepositoryInterface';
+    public const ODM_SERVICE_REPOSITORY_INTERFACE = 'Doctrine\Bundle\MongoDBBundle\Repository\ServiceDocumentRepositoryInterface';
 
     /**
      * @var string

src/Enum/DoctrineRuleIdentifier.php

@@ -19,4 +19,6 @@ final class DoctrineRuleIdentifier
     public const INJECT_SERVICE_REPOSITORY = 'doctrine.injectServiceRepository';
 
     public const NO_LISTENER_WITHOUT_CONTRACT = 'doctrine.noListenerWithoutContract';
+
+    public const REQUIRE_SERVICE_PARENT_REPOSITORY = 'doctrine.requireServiceParentRepository';
 }

src/Rules/Doctrine/NoGetRepositoryOnServiceRepositoryEntityRule.php

@@ -134,7 +134,7 @@ private function isServiceRepositoryClassReflection(string $repositoryClassName)
             return true;
         }
 
-        if ($repositoryClassReflection->is(DoctrineClass::ODM_SERVICE_DOCUMENT_REPOSITORY_INTERFACE)) {
+        if ($repositoryClassReflection->is(DoctrineClass::ODM_SERVICE_REPOSITORY_INTERFACE)) {
             return true;
         }
 

src/Rules/Doctrine/RequireServiceRepositoryParentRule.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Rules\Doctrine;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\DoctrineClass;
+use Symplify\PHPStanRules\Enum\DoctrineRuleIdentifier;
+
+/**
+ * @implements Rule<InClassNode>
+ *
+ * @see \Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\RequireServiceRepositoryParentRuleTest
+ */
+final class RequireServiceRepositoryParentRule implements Rule
+{
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'Repository must extend "%s", "%s" or implement "%s", so it can be injected as a service';
+
+    public function getNodeType(): string
+    {
+        return InClassNode::class;
+    }
+
+    /**
+     * @param InClassNode $node
+     * @return RuleError[]
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $classReflection = $node->getClassReflection();
+
+        // no parent? probably not a repository service yet
+        if (! $this->isDoctrineRepositoryClass($classReflection)) {
+            return [];
+        }
+
+        if ($this->isExtendingServiceRepository($classReflection)) {
+            return [];
+        }
+
+        $errorMessage = sprintf(self::ERROR_MESSAGE, DoctrineClass::ODM_SERVICE_REPOSITORY, DoctrineClass::ORM_SERVICE_REPOSITORY, DoctrineClass::ODM_SERVICE_REPOSITORY_INTERFACE);
+
+        $identifierRuleError = RuleErrorBuilder::message($errorMessage)
+            ->identifier(DoctrineRuleIdentifier::REQUIRE_SERVICE_PARENT_REPOSITORY)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+
+    private function isExtendingServiceRepository(ClassReflection $classReflection): bool
+    {
+        if ($classReflection->is(DoctrineClass::ODM_SERVICE_REPOSITORY)) {
+            return true;
+        }
+
+        if ($classReflection->is(DoctrineClass::ORM_SERVICE_REPOSITORY)) {
+            return true;
+        }
+
+        return $classReflection->is(DoctrineClass::ODM_SERVICE_REPOSITORY_INTERFACE);
+    }
+
+    private function isDoctrineRepositoryClass(ClassReflection $classReflection): bool
+    {
+        if (! $classReflection->isClass()) {
+            return false;
+        }
+
+        // simple check
+        return str_ends_with($classReflection->getName(), 'Repository');
+    }
+}

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/Fixture/SkipContractImplementingRepository.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\Fixture;
+
+use Doctrine\Bundle\MongoDBBundle\Repository\ServiceDocumentRepositoryInterface;
+
+final class SkipContractImplementingRepository implements ServiceDocumentRepositoryInterface
+{
+}

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/Fixture/SkipServiceRepository.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\Fixture;
+
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+
+final class SkipServiceRepository extends ServiceEntityRepository
+{
+}

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/Fixture/SomeRepository.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\Fixture;
+
+final class SomeRepository
+{
+}

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/RequireServiceRepositoryParentRuleTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Enum\DoctrineClass;
+use Symplify\PHPStanRules\Rules\Doctrine\RequireServiceRepositoryParentRule;
+
+final class RequireServiceRepositoryParentRuleTest extends RuleTestCase
+{
+    #[DataProvider('provideData')]
+    public function testRule(string $filePath, array $expectedErrorsWithLines): void
+    {
+        $this->analyse([$filePath], $expectedErrorsWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        $errorMessage = sprintf(RequireServiceRepositoryParentRule::ERROR_MESSAGE, DoctrineClass::ODM_SERVICE_REPOSITORY, DoctrineClass::ORM_SERVICE_REPOSITORY, DoctrineClass::ODM_SERVICE_REPOSITORY_INTERFACE);
+
+        yield [__DIR__ . '/Fixture/SomeRepository.php', [[$errorMessage, 7]]];
+
+        yield [__DIR__ . '/Fixture/SkipServiceRepository.php', []];
+        yield [__DIR__ . '/Fixture/SkipContractImplementingRepository.php', []];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new RequireServiceRepositoryParentRule();
+    }
+}