Skip circular note in RequiredOnlyInAbstractRule (#167)

Author: TomasVotruba

src/Rules/Symfony/RequiredOnlyInAbstractRule.php

@@ -4,6 +4,7 @@
 
 namespace Symplify\PHPStanRules\Rules\Symfony;
 
+use PhpParser\Comment\Doc;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PHPStan\Analyser\Scope;
@@ -61,6 +62,10 @@ public function processNode(Node $node, Scope $scope): array
                 continue;
             }
 
+            if ($this->hasCircularDocNote($classMethod)) {
+                continue;
+            }
+
             if ($class->isAbstract()) {
                 continue;
             }
@@ -95,4 +100,14 @@ private function shouldSkipClass(Scope $scope): bool
 
         return false;
     }
+
+    private function hasCircularDocNote(Node $node): bool
+    {
+        $docComment = $node->getDocComment();
+        if (! $docComment instanceof Doc) {
+            return false;
+        }
+
+        return str_contains($docComment->getText(), 'circular');
+    }
 }

tests/Rules/Symfony/RequiredOnlyInAbstractRule/Fixture/SkipCircularNote.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\RequiredOnlyInAbstractRule\Fixture;
+
+final class SkipCircularNote
+{
+    /**
+     * Avoid circular dependency
+     * @required
+     */
+    public function someMethod()
+    {
+    }
+}

tests/Rules/Symfony/RequiredOnlyInAbstractRule/RequiredOnlyInAbstractRuleTest.php

@@ -25,6 +25,7 @@ public static function provideData(): Iterator
             12,
         ]]];
 
+        yield [__DIR__ . '/Fixture/SkipCircularNote.php', []];
         yield [__DIR__ . '/Fixture/SkipAbstractClass.php', []];
         yield [__DIR__ . '/Fixture/SkipParentDocumentRepository.php', []];
     }