Skip comments within nodes already marked as exec

Author: Slamdunk

src/StaticAnalysis/ExecutableLinesFindingVisitor.php

@@ -17,8 +17,10 @@
 use function explode;
 use function max;
 use function preg_match;
+use function preg_quote;
 use function range;
 use function reset;
+use function sprintf;
 use PhpParser\Node;
 use PhpParser\NodeVisitorAbstract;
 
@@ -47,13 +49,31 @@ final class ExecutableLinesFindingVisitor extends NodeVisitorAbstract
      */
     private $unsets = [];
 
+    /**
+     * @var array<int, string>
+     */
+    private $commentsToCheckForUnset = [];
+
     public function __construct(string $source)
     {
         $this->source = $source;
     }
 
     public function enterNode(Node $node): void
     {
+        foreach ($node->getComments() as $comment) {
+            $commentLine = $comment->getStartLine();
+
+            if (!isset($this->executableLinesGroupedByBranch[$commentLine])) {
+                continue;
+            }
+
+            foreach (explode("\n", $comment->getText()) as $text) {
+                $this->commentsToCheckForUnset[$commentLine] = $text;
+                $commentLine++;
+            }
+        }
+
         if ($node instanceof Node\Scalar\String_ ||
             $node instanceof Node\Scalar\EncapsedStringPart
         ) {
@@ -302,11 +322,16 @@ public function afterTraverse(array $nodes): void
         $lines = explode("\n", $this->source);
 
         foreach ($lines as $lineNumber => $line) {
-            if (1 !== preg_match('/^\s*$/', $line)) {
-                continue;
-            }
+            $lineNumber++;
 
-            unset($this->executableLinesGroupedByBranch[1 + $lineNumber]);
+            if (1 === preg_match('/^\s*$/', $line) ||
+                (
+                    isset($this->commentsToCheckForUnset[$lineNumber]) &&
+                    1 === preg_match(sprintf('/^\s*%s\s*$/', preg_quote($this->commentsToCheckForUnset[$lineNumber], '/')), $line)
+                )
+            ) {
+                unset($this->executableLinesGroupedByBranch[$lineNumber]);
+            }
         }
 
         $this->executableLinesGroupedByBranch = array_diff_key(

tests/_files/source_for_branched_exec_lines.php

@@ -454,7 +454,6 @@ public function myMethod()
     }
     public function withComments()
     {
-        /** @var int $var */
         $var = 1;                           // +4
         /** @var int $var */
         $var = 2;                           // +1
@@ -464,6 +463,20 @@ public function withComments()
         $var = 3;                           // +1
         /* @var int $var */
         $var = 5;                           // +1
+        $var = [                            // +1
+            // within nodes
+            new \DateTimeImmutable(),       // 0
+            # within nodes
+            new \DateTimeImmutable(),       // 0
+            /*
+             * within nodes
+             */
+            new \DateTimeImmutable(),       // 0
+            /*
+             * within nodes
+             */
+            new \DateTimeImmutable(),       // 0
+        ];                                  // 0
         // Comment2
     }
     public function withCommentsOnly()