fix empty method with comment

Author: mvorisek

src/StaticAnalysis/ExecutableLinesFindingVisitor.php

@@ -64,7 +64,7 @@ final class ExecutableLinesFindingVisitor extends NodeVisitorAbstract
     private $propertyLines = [];
 
     /**
-     * @psalm-var array<int, Return_|Expression|Assign|Array_>
+     * @psalm-var array<int, Function_|ClassMethod|Return_|Expression|Assign|Array_>
      */
     private $returns = [];
 
@@ -115,7 +115,7 @@ private function savePropertyLines(Node $node): void
 
     private function computeReturns(): void
     {
-        foreach ($this->returns as $node) {
+        foreach (array_reverse($this->returns) as $node) {
             foreach (range($node->getStartLine(), $node->getEndLine()) as $index) {
                 if (isset($this->executableLines[$index])) {
                     continue;
@@ -133,14 +133,34 @@ private function computeReturns(): void
      */
     private function getLines(NodeAbstract $node, bool $fromReturns): array
     {
-        if ($node instanceof Return_ ||
+        if ($node instanceof Function_ ||
+            $node instanceof ClassMethod ||
+            $node instanceof Return_ ||
             $node instanceof Expression ||
             $node instanceof Assign ||
             $node instanceof Array_
         ) {
             if (!$fromReturns) {
                 $this->returns[] = $node;
 
+                if ($node instanceof ClassMethod && $node->name->name === '__construct') {
+                    $existsAPromotedProperty = false;
+
+                    foreach ($node->getParams() as $param) {
+                        if (0 !== ($param->flags & Class_::VISIBILITY_MODIFIER_MASK)) {
+                            $existsAPromotedProperty = true;
+
+                            break;
+                        }
+                    }
+
+                    if ($existsAPromotedProperty) {
+                        // Only the line with `function` keyword should be listed here
+                        // but `nikic/php-parser` doesn't provide a way to fetch it
+                        return range($node->getStartLine(), $node->name->getEndLine());
+                    }
+                }
+
                 return [];
             }
 
@@ -151,6 +171,20 @@ private function getLines(NodeAbstract $node, bool $fromReturns): array
                     return [];
                 }
             }
+
+            // empty function
+            if ($node instanceof Function_) {
+                return [$node->getEndLine()];
+            }
+
+            // empty method
+            if ($node instanceof ClassMethod) {
+                if (null === $node->stmts) { // method without body (interface prototype)
+                    return [];
+                }
+
+                return [$node->getEndLine()];
+            }
         }
 
         if ($node instanceof Return_) {
@@ -183,34 +217,6 @@ private function getLines(NodeAbstract $node, bool $fromReturns): array
             return [$this->getNodeStartLine($node->dim)];
         }
 
-        if ($node instanceof ClassMethod) {
-            if ($node->name->name !== '__construct') {
-                if ($node->stmts === []) {
-                    return [$node->getEndLine()];
-                }
-
-                return [];
-            }
-
-            $existsAPromotedProperty = false;
-
-            foreach ($node->getParams() as $param) {
-                if (0 !== ($param->flags & Class_::VISIBILITY_MODIFIER_MASK)) {
-                    $existsAPromotedProperty = true;
-
-                    break;
-                }
-            }
-
-            if ($existsAPromotedProperty) {
-                // Only the line with `function` keyword should be listed here
-                // but `nikic/php-parser` doesn't provide a way to fetch it
-                return range($node->getStartLine(), $node->name->getEndLine());
-            }
-
-            return [];
-        }
-
         if ($node instanceof MethodCall) {
             return [$this->getNodeStartLine($node->name)];
         }
@@ -255,14 +261,6 @@ private function getLines(NodeAbstract $node, bool $fromReturns): array
             return [$this->getNodeStartLine($node->types[0])];
         }
 
-        if ($node instanceof Function_) {
-            if ($node->stmts === []) {
-                return [$node->getEndLine()];
-            }
-
-            return [];
-        }
-
         return [$this->getNodeStartLine($node)];
     }
 

tests/_files/source_with_multiline_constant_return.php

@@ -499,10 +499,14 @@ public function unaryMinusNowdoc(): float
     function
     emptyMethod
     (
-        // empty method with comment
     )
     :
     void
     {
     }
+
+    public function emptyMethodWithComment(): void
+    {
+        // empty method with comment
+    }
 }

tests/tests/Data/RawCodeCoverageDataTest.php

@@ -531,7 +531,8 @@ public function testReturnStatementWithConstantExprOnlyReturnTheLineOfLast(): vo
                 469,
                 481,
                 492,
-                507,
+                506,
+                511,
             ],
             array_keys(RawCodeCoverageData::fromUncoveredFile($file, new ParsingFileAnalyser(true, true))->lineCoverage()[$file])
         );