[doctrine] Add NoListenerWithoutContractRule (#201)

Author: TomasVotruba

README.md

@@ -1725,6 +1725,50 @@ class SomeListener
 
 <br>
 
+### NoDoctrineListenerWithoutContractRule
+
+There should be no Doctrine listeners modified in config. Implement  "Document\Event\EventSubscriber" to provide events in the class itself
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Doctrine\NoDoctrineListenerWithoutContractRule
+```
+
+```php
+class SomeListener
+{
+    public function onFlush()
+    {
+    }
+}
+```
+
+:x:
+
+<br>
+
+```php
+use Doctrine\Common\EventSubscriber;
+use Doctrine\ODM\MongoDB\Events;
+
+class SomeListener implements EventSubscriber
+{
+    public function onFlush()
+    {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            Events::onFlush
+        ];
+    }
+}
+```
+
+:+1:
+
+
 ### NoStringInGetSubscribedEventsRule
 
 Symfony getSubscribedEvents() method must contain only event class references, no strings

config/doctrine-rules.neon

@@ -4,5 +4,7 @@ rules:
     - Symplify\PHPStanRules\Rules\Doctrine\NoRepositoryCallInDataFixtureRule
     - Symplify\PHPStanRules\Rules\Doctrine\NoGetRepositoryOnServiceRepositoryEntityRule
 
+    - Symplify\PHPStanRules\Rules\Doctrine\NoDoctrineListenerWithoutContractRule
+
     # test fixtures
     - Symplify\PHPStanRules\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule

src/Doctrine/DoctrineEventSubscriberAnalyzer.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Doctrine;
+
+use PhpParser\Node\Stmt\Class_;
+use Symplify\PHPStanRules\Enum\DoctrineEvents;
+
+final class DoctrineEventSubscriberAnalyzer
+{
+    public static function detect(Class_ $class): bool
+    {
+        // skip doctrine, as this is handling symfony only
+        foreach ($class->getMethods() as $classMethod) {
+            if (in_array($classMethod->name->toString(), DoctrineEvents::ORM_LIST)) {
+                return true;
+            }
+
+            if (in_array($classMethod->name->toString(), DoctrineEvents::ODM_LIST)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/Enum/DoctrineEvents.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class DoctrineEvents
+{
+    /**
+     * @see https://www.doctrine-project.org/projects/doctrine-orm/en/3.3/reference/events.html
+     */
+    public const ORM_LIST = [
+        'preRemove',
+        'postRemove',
+        'prePersist',
+        'postPersist',
+        'preUpdate',
+        'postUpdate',
+        'postLoad',
+        'loadClassMetadata',
+        'onClassMetadataNotFound',
+        'preFlush',
+        'onFlush',
+        'postFlush',
+        'onClear',
+    ];
+
+    /**
+     * @see https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/reference/events.html#lifecycle-events
+     */
+    public const ODM_LIST = [
+        'documentNotFound',
+        'onClear',
+        'postCollectionLoad',
+    ];
+}

src/Enum/DoctrineRuleIdentifier.php

@@ -17,4 +17,6 @@ final class DoctrineRuleIdentifier
     public const REQUIRE_QUERY_BUILDER_ON_REPOSITORY = 'doctrine.requireQueryBuilderOnRepository';
 
     public const INJECT_SERVICE_REPOSITORY = 'doctrine.injectServiceRepository';
+
+    public const NO_LISTENER_WITHOUT_CONTRACT = 'doctrine.noListenerWithoutContract';
 }

src/Rules/Doctrine/NoDoctrineListenerWithoutContractRule.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Rules\Doctrine;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Doctrine\DoctrineEventSubscriberAnalyzer;
+use Symplify\PHPStanRules\Enum\DoctrineRuleIdentifier;
+
+/**
+ * Based on https://tomasvotruba.com/blog/2019/07/22/how-to-convert-listeners-to-subscribers-and-reduce-your-configs
+ * Subscribers have much better PHP support - IDE, PHPStan + Rector - than simple yaml files
+ *
+ * @implements Rule<InClassNode>
+ *
+ * @see \Symplify\PHPStanRules\Tests\Rules\Doctrine\NoDoctrineListenerWithoutContractRule\NoDoctrineListenerWithoutContractRuleTest
+ */
+final class NoDoctrineListenerWithoutContractRule implements Rule
+{
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'There should be no Doctrine listeners modified in config. Implement  "Document\Event\EventSubscriber" to provide events in the class itself';
+
+    public function getNodeType(): string
+    {
+        return InClassNode::class;
+    }
+
+    /**
+     * @param InClassNode $node
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! $scope->isInClass()) {
+            return [];
+        }
+
+        $classReflection = $scope->getClassReflection();
+        if (! str_ends_with($classReflection->getName(), 'Listener')) {
+            return [];
+        }
+
+        $classLike = $node->getOriginalNode();
+        if (! $classLike instanceof Class_) {
+            return [];
+        }
+
+        if ($classLike->implements !== []) {
+            return [];
+        }
+
+        if (! DoctrineEventSubscriberAnalyzer::detect($classLike)) {
+            return [];
+        }
+
+        $identifierRuleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+            ->identifier(DoctrineRuleIdentifier::NO_LISTENER_WITHOUT_CONTRACT)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+}

src/Rules/Symfony/NoListenerWithoutContractRule.php

@@ -12,6 +12,7 @@
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Doctrine\DoctrineEventSubscriberAnalyzer;
 use Symplify\PHPStanRules\Enum\SymfonyClass;
 use Symplify\PHPStanRules\Enum\SymfonyRuleIdentifier;
 
@@ -30,27 +31,6 @@ final class NoListenerWithoutContractRule implements Rule
      */
     public const ERROR_MESSAGE = 'There should be no listeners modified in config. Use EventSubscriberInterface contract or #[AsEventListener] attribute and native PHP instead';
 
-    /**
-     * @see https://www.doctrine-project.org/projects/doctrine-orm/en/3.3/reference/events.html
-     */
-    private const DOCTRINE_EVENT_NAMES = [
-        'preRemove',
-        'postRemove',
-        'prePersist',
-        'postPersist',
-        'preUpdate',
-        'postUpdate',
-        'postLoad',
-        'loadClassMetadata',
-        'onClassMetadataNotFound',
-        'preFlush',
-        'onFlush',
-        'postFlush',
-        'onClear',
-        // ODM
-        'documentNotFound',
-    ];
-
     public function getNodeType(): string
     {
         return InClassNode::class;
@@ -84,7 +64,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        if ($this->isDoctrineListener($classLike)) {
+        if (DoctrineEventSubscriberAnalyzer::detect($classLike)) {
             return [];
         }
 
@@ -107,18 +87,6 @@ public function processNode(Node $node, Scope $scope): array
         return [$identifierRuleError];
     }
 
-    private function isDoctrineListener(Class_ $class): bool
-    {
-        // skip doctrine, as this is handling symfony only
-        foreach ($class->getMethods() as $classMethod) {
-            if (in_array($classMethod->name->toString(), self::DOCTRINE_EVENT_NAMES)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
     private function hasAsListenerAttribute(Class_ $class): bool
     {
         foreach ($class->attrGroups as $attrGroup) {

stubs/Doctrine/Common/EventSubscriber.php

@@ -0,0 +1,9 @@
+
+<?php
+
+namespace Doctrine\Common;
+
+interface EventSubscriber
+{
+
+}

tests/Rules/Doctrine/NoDoctrineListenerWithoutContractRule/Fixture/SimpleDoctrineListener.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\NoDoctrineListenerWithoutContractRule\Fixture;
+
+final class SimpleDoctrineListener
+{
+    public function preFlush()
+    {
+    }
+}

tests/Rules/Doctrine/NoDoctrineListenerWithoutContractRule/Fixture/SkipContractAwareListener.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\NoDoctrineListenerWithoutContractRule\Fixture;
+
+use Doctrine\Common\EventSubscriber;
+
+final class SkipContractAwareListener implements EventSubscriber
+{
+    public function preFlush()
+    {
+    }
+}