[symfony] Make NoListenerWithoutContractRule skip doctrine (#166)

Author: TomasVotruba

src/Rules/Symfony/NoListenerWithoutContractRule.php

@@ -17,6 +17,8 @@
  * Subscribers have much better PHP support - IDE, PHPStan + Rector - than simple yaml files
  *
  * @implements Rule<InClassNode>
+ *
+ * @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoListenerWithoutContractRule\NoListenerWithoutContractRuleTest
  */
 final class NoListenerWithoutContractRule implements Rule
 {
@@ -25,6 +27,25 @@ final class NoListenerWithoutContractRule implements Rule
      */
     public const ERROR_MESSAGE = 'There should be no listeners modified in config. Use EventSubscriberInterface contract and 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',
+    ];
+
     public function getNodeType(): string
     {
         return InClassNode::class;
@@ -53,10 +74,26 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        if ($this->isDoctrineListener($classLike)) {
+            return [];
+        }
+
         $identifierRuleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
             ->identifier(SymfonyRuleIdentifier::NO_LISTENER_WITHOUT_CONTRACT)
             ->build();
 
         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;
+    }
 }

tests/Rules/Symfony/NoListenerWithoutContractRule/Fixture/SkipDoctrineListener.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoListenerWithoutContractRule\Fixture;
+
+final class SkipDoctrineListener
+{
+    public function onFlush(\Doctrine\ODM\MongoDB\Event\OnFlushEventArgs $onFlushEventArgs)
+    {
+    }
+}

tests/Rules/Symfony/NoListenerWithoutContractRule/Fixture/SomeBareListener.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoListenerWithoutContractRule\Fixture;
+
+final class SomeBareListener
+{
+}

tests/Rules/Symfony/NoListenerWithoutContractRule/Fixture/SomeContractedListener.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoListenerWithoutContractRule\Fixture;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class SomeContractedListener implements EventSubscriberInterface
+{
+}

tests/Rules/Symfony/NoListenerWithoutContractRule/NoListenerWithoutContractRuleTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoListenerWithoutContractRule;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Rules\Symfony\NoListenerWithoutContractRule;
+
+final class NoListenerWithoutContractRuleTest extends RuleTestCase
+{
+    /**
+     * @param string[] $filePaths
+     */
+    #[DataProvider('provideData')]
+    public function testRule(array $filePaths, array $expectedErrorsWithLines): void
+    {
+        $this->analyse($filePaths, $expectedErrorsWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        yield [[__DIR__ . '/Fixture/SomeContractedListener.php'], []];
+        yield [[__DIR__ . '/Fixture/SkipDoctrineListener.php'], []];
+
+        yield [[__DIR__ . '/Fixture/SomeBareListener.php'], [[
+            NoListenerWithoutContractRule::ERROR_MESSAGE,
+            5,
+        ]]];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new NoListenerWithoutContractRule();
+    }
+}