Handle comments and empty lines

Author: Slamdunk

src/StaticAnalysis/ExecutableLinesFindingVisitor.php

@@ -13,7 +13,9 @@
 use function count;
 use function current;
 use function end;
+use function explode;
 use function max;
+use function preg_match;
 use function range;
 use function reset;
 use PhpParser\Node;
@@ -27,16 +29,27 @@ final class ExecutableLinesFindingVisitor extends NodeVisitorAbstract
     private $nextBranch = 1;
 
     /**
-     * @var array
+     * @var string
+     */
+    private $source;
+
+    /**
+     * @var array<int, int>
      */
     private $executableLinesGroupedByBranch = [];
 
+    public function __construct(string $source)
+    {
+        $this->source = $source;
+    }
+
     public function enterNode(Node $node): void
     {
         if ($node instanceof Node\Stmt\Declare_ ||
             $node instanceof Node\Stmt\DeclareDeclare ||
             $node instanceof Node\Stmt\Class_ ||
             $node instanceof Node\Stmt\ClassConst ||
+            $node instanceof Node\Stmt\Nop ||
             $node instanceof Node\Stmt\Property ||
             $node instanceof Node\Stmt\PropertyProperty ||
             $node instanceof Node\Expr\Variable ||
@@ -76,26 +89,30 @@ public function enterNode(Node $node): void
                 );
 
             if ($hasEmptyBody) {
-                $startLine = $node->getEndLine();
-
-                if ($startLine === $node->getStartLine()) {
+                if ($node->getEndLine() === $node->getStartLine()) {
                     return;
                 }
-            } else {
-                $startLine = $node->stmts[0]->getStartLine();
-            }
 
-            $endLine = $node->getEndLine() - 1;
+                $this->setLineBranch($node->getEndLine(), $node->getEndLine(), ++$this->nextBranch);
 
-            if ($hasEmptyBody) {
-                $endLine++;
+                return;
             }
 
-            if ($endLine < $startLine) {
+            if ($node instanceof Node\Expr\Closure &&
+                $node->getEndLine() === $node->getStartLine()
+            ) {
                 return;
             }
 
-            $this->setLineBranch($startLine, $endLine, ++$this->nextBranch);
+            $branch = ++$this->nextBranch;
+
+            foreach ($node->stmts as $stmt) {
+                if ($stmt instanceof Node\Stmt\Nop) {
+                    continue;
+                }
+
+                $this->setLineBranch($stmt->getStartLine(), $stmt->getEndLine(), $branch);
+            }
 
             return;
         }
@@ -246,6 +263,19 @@ public function enterNode(Node $node): void
         $this->setLineBranch($node->getStartLine(), $node->getEndLine(), 1);
     }
 
+    public function afterTraverse(array $nodes): void
+    {
+        $lines = explode("\n", $this->source);
+
+        foreach ($lines as $lineNumber => $line) {
+            if (1 !== preg_match('/^\s*$/', $line)) {
+                continue;
+            }
+
+            unset($this->executableLinesGroupedByBranch[1 + $lineNumber]);
+        }
+    }
+
     public function executableLinesGroupedByBranch(): array
     {
         return $this->executableLinesGroupedByBranch;

src/StaticAnalysis/ParsingFileAnalyser.php

@@ -155,7 +155,7 @@ private function analyse(string $filename): void
             $codeUnitFindingVisitor        = new CodeUnitFindingVisitor;
             $lineCountingVisitor           = new LineCountingVisitor($linesOfCode);
             $ignoredLinesFindingVisitor    = new IgnoredLinesFindingVisitor($this->useAnnotationsForIgnoringCode, $this->ignoreDeprecatedCode);
-            $executableLinesFindingVisitor = new ExecutableLinesFindingVisitor;
+            $executableLinesFindingVisitor = new ExecutableLinesFindingVisitor($source);
 
             $traverser->addVisitor(new NameResolver);
             $traverser->addVisitor(new ParentConnectingVisitor);

tests/_files/source_for_branched_exec_lines.php

@@ -42,6 +42,9 @@ function withIf()
     return $var;    // 0
 }
 
+/**
+ * @internal
+ */
 class MyClass
 {
     public const C1 = 1;
@@ -57,6 +60,7 @@ function
     )
     {
         $var = 1;       // +2
+
         if (false) {    // 0
             $var += 2;  // +1
         }               // -1
@@ -416,4 +420,24 @@ public function withArrowFn()
         $fn1 = fn($x) =>                    // 0
             $x + $y;                        // +1
     }
+    public function withComments()
+    {
+        /** @var int $var */
+        $var = 1;                           // +1
+        /** @var int $var */
+        $var = 2;                           // 0
+        // C3
+        $var = 3;                           // 0
+        # C4
+        $var = 3;                           // 0
+        /* @var int $var */
+        $var = 5;                           // 0
+        // Comment2
+    }
+    public function withCommentsOnly()
+    {
+        /**
+         $var = 1;
+         */
+    }                                       // +1
 }

tests/tests/StaticAnalysis/ExecutableLinesFindingVisitorTest.php

@@ -30,7 +30,7 @@ public function testExecutableLinesAreGroupedByBranch(): void
             new Lexer
         );
         $nodes                         = $parser->parse($source);
-        $executableLinesFindingVisitor = new ExecutableLinesFindingVisitor;
+        $executableLinesFindingVisitor = new ExecutableLinesFindingVisitor($source);
 
         $traverser = new NodeTraverser;
         $traverser->addVisitor($executableLinesFindingVisitor);