[doctrine] Add NoGetRepositoryOnServiceRepositoryEntityRule (#182)

Author: TomasVotruba

README.md

@@ -1221,6 +1221,71 @@ final class SomeRepository
 
 <br>
 
+### NoGetRepositoryOnServiceRepositoryEntityRule
+
+Instead of calling "->getRepository(...::class)" service locator, inject service repository via constructor and use it directly
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Doctrine\NoGetRepositoryOnServiceRepositoryEntityRule
+```
+
+<br>
+
+```php
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity(repositoryClass=SomeRepository::class)
+ */
+class SomeEntity
+{
+}
+```
+
+<br>
+
+```php
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+
+final class SomeEntityRepository extends ServiceEntityRepository
+{
+}
+```
+
+<br>
+
+```php
+use Doctrine\ORM\EntityManagerInterface;
+
+final class SomeService
+{
+    public function run(EntityManagerInterface $entityManager)
+    {
+        return $this->entityManager->getRepository(SomeEntity::class);
+    }
+}
+```
+
+:x:
+
+<br>
+
+```php
+use Doctrine\ORM\EntityManagerInterface;
+
+final class SomeService
+{
+    public function __construct(private SomeEntityRepository $someEntityRepository)
+    {
+    }
+}
+```
+
+:+1:
+
+<br>
+
 ### NoRepositoryCallInDataFixtureRule
 
 Repository should not be called in data fixtures, as it can lead to tight coupling

config/doctrine-rules.neon

@@ -2,6 +2,7 @@ rules:
     - Symplify\PHPStanRules\Rules\Doctrine\NoGetRepositoryOutsideServiceRule
     - Symplify\PHPStanRules\Rules\Doctrine\NoParentRepositoryRule
     - Symplify\PHPStanRules\Rules\Doctrine\NoRepositoryCallInDataFixtureRule
+    - Symplify\PHPStanRules\Rules\Doctrine\NoGetRepositoryOnServiceRepositoryEntityRule
 
     # test fixtures
     - Symplify\PHPStanRules\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule

src/Doctrine/RepositoryClassResolver.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Doctrine;
+
+use Nette\Utils\FileSystem;
+use Nette\Utils\Strings;
+use PHPStan\Reflection\ReflectionProvider;
+use Rector\Exception\ShouldNotHappenException;
+
+final readonly class RepositoryClassResolver
+{
+    /**
+     * @var string
+     */
+    private const QUOTED_REPOSITORY_CLASS_REGEX = '#repositoryClass=\"(?<repositoryClass>.*?)\"#';
+
+    /**
+     * @var string
+     */
+    private const USE_REPOSITORY_REGEX = '#use (?<repositoryClass>.*?Repository);#';
+
+    public function __construct(
+        private ReflectionProvider $reflectionProvider
+    ) {
+    }
+
+    public function resolveFromEntityClass(string $entityClassName): ?string
+    {
+        if (! $this->reflectionProvider->hasClass($entityClassName)) {
+            throw new ShouldNotHappenException();
+        }
+
+        $classReflection = $this->reflectionProvider->getClass($entityClassName);
+
+        $entityClassFileName = $classReflection->getFileName();
+        if ($entityClassFileName === null) {
+            return null;
+        }
+
+        $entityFileContents = FileSystem::read($entityClassFileName);
+
+        // match repositoryClass="..." in entity
+        $match = Strings::match($entityFileContents, self::QUOTED_REPOSITORY_CLASS_REGEX);
+
+        if (! isset($match['repositoryClass'])) {
+            // try fallback to repository ::class + use import
+
+            $repositoryUseMatch = Strings::match($entityFileContents, self::USE_REPOSITORY_REGEX);
+            if (isset($repositoryUseMatch['repositoryClass'])) {
+                $repositoryClass = $repositoryUseMatch['repositoryClass'];
+            } else {
+                // unable to resolve
+                return null;
+            }
+        } else {
+            $repositoryClass = $match['repositoryClass'];
+        }
+
+        if (! $this->reflectionProvider->hasClass($repositoryClass)) {
+            throw new ShouldNotHappenException(
+                sprintf('Repository class "%s" for entity "%s" does not exist', $repositoryClass, $entityClassName)
+            );
+        }
+
+        return $repositoryClass;
+    }
+}

src/Enum/ClassName.php

@@ -6,11 +6,6 @@
 
 final class ClassName
 {
-    /**
-     * @var string
-     */
-    public const PHPUNIT_TEST_CASE = 'PHPUnit\Framework\TestCase';
-
     /**
      * @var string
      */
@@ -36,16 +31,6 @@ final class ClassName
      */
     public const RECTOR_ATTRIBUTE_KEY = 'Rector\NodeTypeResolver\Node\AttributeKey';
 
-    /**
-     * @var string
-     */
-    public const DOCTRINE_FIXTURE_INTERFACE = 'Doctrine\Common\DataFixtures\FixtureInterface';
-
-    /**
-     * @var string
-     */
-    public const ENTITY_REPOSITORY_CLASS = 'Doctrine\ORM\EntityRepository';
-
     /**
      * @var string
      */

src/Enum/DoctrineClass.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class DoctrineClass
+{
+    /**
+     * @var string
+     */
+    public const ODM_SERVICE_REPOSITORY = 'Doctrine\Bundle\MongoDBBundle\Repository\ServiceDocumentRepository';
+
+    /**
+     * @var string
+     */
+    public const ORM_SERVICE_REPOSITORY = 'Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository';
+
+    /**
+     * @var string
+     */
+    public const FIXTURE_INTERFACE = 'Doctrine\Common\DataFixtures\FixtureInterface';
+
+    /**
+     * @var string
+     */
+    public const ENTITY_REPOSITORY = 'Doctrine\ORM\EntityRepository';
+}

src/Enum/DoctrineRuleIdentifier.php

@@ -6,13 +6,15 @@
 
 final class DoctrineRuleIdentifier
 {
-    public const DOCTRINE_NO_GET_REPOSITORY_OUTSIDE_SERVICE = 'doctrine.noGetRepositoryOutsideService';
+    public const NO_GET_REPOSITORY_OUTSIDE_SERVICE = 'doctrine.noGetRepositoryOutsideService';
 
-    public const DOCTRINE_NO_REPOSITORY_CALL_IN_DATA_FIXTURES = 'doctrine.noRepositoryCallInDataFixtures';
+    public const NO_REPOSITORY_CALL_IN_DATA_FIXTURES = 'doctrine.noRepositoryCallInDataFixtures';
 
-    public const DOCTRINE_NO_PARENT_REPOSITORY = 'doctrine.noParentRepository';
+    public const NO_PARENT_REPOSITORY = 'doctrine.noParentRepository';
 
     public const NO_ENTITY_MOCKING = 'doctrine.noEntityMocking';
 
     public const REQUIRE_QUERY_BUILDER_ON_REPOSITORY = 'doctrine.requireQueryBuilderOnRepository';
+
+    public const INJECT_SERVICE_REPOSITORY = 'doctrine.injectServiceRepository';
 }

src/Enum/TestClassName.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class TestClassName
+{
+    /**
+     * @var string
+     */
+    public const PHPUNIT_TEST_CASE = 'PHPUnit\Framework\TestCase';
+
+    /**
+     * @var string
+     */
+    public const BEHAT_CONTEXT = 'Behat\Behat\Context\Context';
+}

src/Rules/ClassNameRespectsParentSuffixRule.php

@@ -16,6 +16,7 @@
 use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\Enum\SymfonyClass;
+use Symplify\PHPStanRules\Enum\TestClassName;
 use Symplify\PHPStanRules\Naming\ClassToSuffixResolver;
 
 /**
@@ -37,7 +38,7 @@ final class ClassNameRespectsParentSuffixRule implements Rule
         SymfonyClass::EVENT_SUBSCRIBER_INTERFACE,
         SymfonyClass::SYMFONY_ABSTRACT_CONTROLLER,
         ClassName::SNIFF,
-        ClassName::PHPUNIT_TEST_CASE,
+        TestClassName::PHPUNIT_TEST_CASE,
         Exception::class,
         'PhpCsFixer\Fixer\FixerInterface',
         Rule::class,