Refactor common logic into CommentMatcher (#28)

Co-authored-by: staabm <staabm@users.noreply.github.com>

src/TodoByDateRule.php

@@ -8,6 +8,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
+use staabm\PHPStanTodoBy\utils\CommentMatcher;
 use staabm\PHPStanTodoBy\utils\ExpiredCommentErrorBuilder;
 use function preg_match_all;
 use function strtotime;
@@ -57,35 +58,10 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (
-            $node instanceof VirtualNode
-            || $node instanceof Node\Expr
-        ) {
-            // prevent duplicate errors
-            return [];
-        }
+        $it = CommentMatcher::matchComments($node, self::PATTERN);
 
         $errors = [];
-
-        foreach ($node->getComments() as $comment) {
-
-            $text = $comment->getText();
-
-            /**
-             * PHP doc comments have the entire multi-line comment as the text.
-             * Since this could potentially contain multiple "todo" comments, we need to check all lines.
-             * This works for single line comments as well.
-             *
-             * PREG_OFFSET_CAPTURE: Track where each "todo" comment starts within the whole comment text.
-             * PREG_SET_ORDER: Make each value of $matches be structured the same as if from preg_match().
-             */
-            if (
-                preg_match_all(self::PATTERN, $text, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER) === false
-                || count($matches) === 0
-            ) {
-                continue;
-            }
-
+        foreach($it as $comment => $matches) {
             /** @var array<int, array<array{0: string, 1: int}>> $matches */
             foreach ($matches as $match) {
 

src/TodoByVersionRule.php

@@ -8,6 +8,7 @@
 use PHPStan\Node\VirtualNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use staabm\PHPStanTodoBy\utils\CommentMatcher;
 use staabm\PHPStanTodoBy\utils\ExpiredCommentErrorBuilder;
 use staabm\PHPStanTodoBy\utils\ReferenceVersionFinder;
 use staabm\PHPStanTodoBy\utils\VersionNormalizer;
@@ -67,35 +68,10 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (
-            $node instanceof VirtualNode
-            || $node instanceof Node\Expr
-        ) {
-            // prevent duplicate errors
-            return [];
-        }
+        $it = CommentMatcher::matchComments($node, self::PATTERN);
 
         $errors = [];
-
-        foreach ($node->getComments() as $comment) {
-
-            $text = $comment->getText();
-
-            /**
-             * PHP doc comments have the entire multi-line comment as the text.
-             * Since this could potentially contain multiple "todo" comments, we need to check all lines.
-             * This works for single line comments as well.
-             *
-             * PREG_OFFSET_CAPTURE: Track where each "todo" comment starts within the whole comment text.
-             * PREG_SET_ORDER: Make each value of $matches be structured the same as if from preg_match().
-             */
-            if (
-                preg_match_all(self::PATTERN, $text, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER) === false
-                || count($matches) === 0
-            ) {
-                continue;
-            }
-
+        foreach($it as $comment => $matches) {
             $referenceVersion = $this->getReferenceVersion($scope);
 
             /** @var array<int, array<array{0: string, 1: int}>> $matches */

src/utils/CommentMatcher.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace staabm\PHPStanTodoBy\utils;
+
+use PhpParser\Comment;
+use PHPStan\Node\VirtualNode;
+use PhpParser\Node;
+
+final class CommentMatcher
+{
+    /**
+     * @return iterable<Comment, array<mixed>>
+     */
+    public static function matchComments(Node $node, string $pattern): iterable
+    {
+        if (
+            $node instanceof VirtualNode
+            || $node instanceof Node\Expr
+        ) {
+            // prevent duplicate errors
+            return [];
+        }
+
+        foreach ($node->getComments() as $comment) {
+
+            $text = $comment->getText();
+
+            /**
+             * PHP doc comments have the entire multi-line comment as the text.
+             * Since this could potentially contain multiple "todo" comments, we need to check all lines.
+             * This works for single line comments as well.
+             *
+             * PREG_OFFSET_CAPTURE: Track where each "todo" comment starts within the whole comment text.
+             * PREG_SET_ORDER: Make each value of $matches be structured the same as if from preg_match().
+             */
+            if (
+                preg_match_all($pattern, $text, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER) === false
+                || count($matches) === 0
+            ) {
+                continue;
+            }
+
+            yield $comment => $matches;
+        }
+    }
+}