Only use LinesOfCode object inside ParsingFileAnalyser

Author: sebastianbergmann

src/Node/AbstractNode.php

@@ -15,7 +15,6 @@
 use function substr;
 use Countable;
 use SebastianBergmann\CodeCoverage\Percentage;
-use SebastianBergmann\LinesOfCode\LinesOfCode;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -219,7 +218,10 @@ abstract public function traits(): array;
 
     abstract public function functions(): array;
 
-    abstract public function linesOfCode(): LinesOfCode;
+    /**
+     * @psalm-return array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
+     */
+    abstract public function linesOfCode(): array;
 
     abstract public function numberOfExecutableLines(): int;
 

src/Node/Directory.php

@@ -13,7 +13,6 @@
 use function count;
 use IteratorAggregate;
 use RecursiveIteratorIterator;
-use SebastianBergmann\LinesOfCode\LinesOfCode;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -51,7 +50,7 @@ final class Directory extends AbstractNode implements IteratorAggregate
     private $functions;
 
     /**
-     * @var LinesOfCode
+     * @psalm-var null|array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
      */
     private $linesOfCode;
 
@@ -233,13 +232,24 @@ public function functions(): array
         return $this->functions;
     }
 
-    public function linesOfCode(): LinesOfCode
+    /**
+     * @psalm-return array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
+     */
+    public function linesOfCode(): array
     {
         if ($this->linesOfCode === null) {
-            $this->linesOfCode = new LinesOfCode(0, 0, 0, 0);
+            $this->linesOfCode = [
+                'linesOfCode'           => 0,
+                'commentLinesOfCode'    => 0,
+                'nonCommentLinesOfCode' => 0,
+            ];
 
             foreach ($this->children as $child) {
-                $this->linesOfCode = $this->linesOfCode->plus($child->linesOfCode());
+                $childLinesOfCode = $child->linesOfCode();
+
+                $this->linesOfCode['linesOfCode'] += $childLinesOfCode['linesOfCode'];
+                $this->linesOfCode['commentLinesOfCode'] += $childLinesOfCode['commentLinesOfCode'];
+                $this->linesOfCode['nonCommentLinesOfCode'] += $childLinesOfCode['nonCommentLinesOfCode'];
             }
         }
 

src/Node/File.php

@@ -13,7 +13,6 @@
 use function count;
 use function range;
 use SebastianBergmann\CodeCoverage\CrapIndex;
-use SebastianBergmann\LinesOfCode\LinesOfCode;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -81,7 +80,7 @@ final class File extends AbstractNode
     private $functions = [];
 
     /**
-     * @var LinesOfCode
+     * @psalm-var array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
      */
     private $linesOfCode;
 
@@ -125,7 +124,10 @@ final class File extends AbstractNode
      */
     private $codeUnitsByLine = [];
 
-    public function __construct(string $name, AbstractNode $parent, array $lineCoverageData, array $functionCoverageData, array $testData, array $classes, array $traits, array $functions, LinesOfCode $linesOfCode)
+    /**
+     * @psalm-param array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int} $linesOfCode
+     */
+    public function __construct(string $name, AbstractNode $parent, array $lineCoverageData, array $functionCoverageData, array $testData, array $classes, array $traits, array $functions, array $linesOfCode)
     {
         parent::__construct($name, $parent);
 
@@ -172,7 +174,10 @@ public function functions(): array
         return $this->functions;
     }
 
-    public function linesOfCode(): LinesOfCode
+    /**
+     * @psalm-return array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
+     */
+    public function linesOfCode(): array
     {
         return $this->linesOfCode;
     }
@@ -330,15 +335,15 @@ public function numberOfTestedFunctions(): int
 
     private function calculateStatistics(array $classes, array $traits, array $functions): void
     {
-        foreach (range(1, $this->linesOfCode->linesOfCode()) as $lineNumber) {
+        foreach (range(1, $this->linesOfCode['linesOfCode']) as $lineNumber) {
             $this->codeUnitsByLine[$lineNumber] = [];
         }
 
         $this->processClasses($classes);
         $this->processTraits($traits);
         $this->processFunctions($functions);
 
-        foreach (range(1, $this->linesOfCode->linesOfCode()) as $lineNumber) {
+        foreach (range(1, $this->linesOfCode['linesOfCode']) as $lineNumber) {
             if (isset($this->lineCoverageData[$lineNumber])) {
                 foreach ($this->codeUnitsByLine[$lineNumber] as &$codeUnit) {
                     $codeUnit['executableLines']++;

src/Report/Clover.php

@@ -194,8 +194,8 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string
             $linesOfCode = $item->linesOfCode();
 
             $xmlMetrics = $xmlDocument->createElement('metrics');
-            $xmlMetrics->setAttribute('loc', (string) $linesOfCode->linesOfCode());
-            $xmlMetrics->setAttribute('ncloc', (string) $linesOfCode->nonCommentLinesOfCode());
+            $xmlMetrics->setAttribute('loc', (string) $linesOfCode['linesOfCode']);
+            $xmlMetrics->setAttribute('ncloc', (string) $linesOfCode['nonCommentLinesOfCode']);
             $xmlMetrics->setAttribute('classes', (string) $item->numberOfClassesAndTraits());
             $xmlMetrics->setAttribute('methods', (string) $item->numberOfMethods());
             $xmlMetrics->setAttribute('coveredmethods', (string) $item->numberOfTestedMethods());
@@ -227,8 +227,8 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string
 
         $xmlMetrics = $xmlDocument->createElement('metrics');
         $xmlMetrics->setAttribute('files', (string) count($report));
-        $xmlMetrics->setAttribute('loc', (string) $linesOfCode->linesOfCode());
-        $xmlMetrics->setAttribute('ncloc', (string) $linesOfCode->nonCommentLinesOfCode());
+        $xmlMetrics->setAttribute('loc', (string) $linesOfCode['linesOfCode']);
+        $xmlMetrics->setAttribute('ncloc', (string) $linesOfCode['nonCommentLinesOfCode']);
         $xmlMetrics->setAttribute('classes', (string) $report->numberOfClassesAndTraits());
         $xmlMetrics->setAttribute('methods', (string) $report->numberOfMethods());
         $xmlMetrics->setAttribute('coveredmethods', (string) $report->numberOfTestedMethods());

src/Report/Xml/Facade.php

@@ -240,9 +240,9 @@ private function setTotals(AbstractNode $node, Totals $totals): void
         $loc = $node->linesOfCode();
 
         $totals->setNumLines(
-            $loc->linesOfCode(),
-            $loc->commentLinesOfCode(),
-            $loc->nonCommentLinesOfCode(),
+            $loc['linesOfCode'],
+            $loc['commentLinesOfCode'],
+            $loc['nonCommentLinesOfCode'],
             $node->numberOfExecutableLines(),
             $node->numberOfExecutedLines()
         );

src/StaticAnalysis/CachingFileAnalyser.php

@@ -10,7 +10,6 @@
 namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
 
 use SebastianBergmann\CodeCoverage\Directory;
-use SebastianBergmann\LinesOfCode\LinesOfCode;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -69,7 +68,10 @@ public function functionsIn(string $filename): array
         return $this->cache[$filename]['functionsIn'];
     }
 
-    public function linesOfCodeFor(string $filename): LinesOfCode
+    /**
+     * @psalm-return array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
+     */
+    public function linesOfCodeFor(string $filename): array
     {
         if (!isset($this->cache[$filename])) {
             $this->process($filename);
@@ -140,7 +142,7 @@ private function read(string $filename)
             file_get_contents(
                 $this->cacheFile($filename)
             ),
-            ['allowed_classes' => [LinesOfCode::class]]
+            ['allowed_classes' => false]
         );
     }
 

src/StaticAnalysis/FileAnalyser.php

@@ -9,8 +9,6 @@
  */
 namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
 
-use SebastianBergmann\LinesOfCode\LinesOfCode;
-
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
  */
@@ -22,7 +20,10 @@ public function traitsIn(string $filename): array;
 
     public function functionsIn(string $filename): array;
 
-    public function linesOfCodeFor(string $filename): LinesOfCode;
+    /**
+     * @psalm-return array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
+     */
+    public function linesOfCodeFor(string $filename): array;
 
     public function executableLinesIn(string $filename): array;
 

src/StaticAnalysis/ParsingFileAnalyser.php

@@ -25,7 +25,6 @@
 use PhpParser\ParserFactory;
 use SebastianBergmann\CodeCoverage\ParserException;
 use SebastianBergmann\LinesOfCode\LineCountingVisitor;
-use SebastianBergmann\LinesOfCode\LinesOfCode;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -48,7 +47,7 @@ final class ParsingFileAnalyser implements FileAnalyser
     private $functions = [];
 
     /**
-     * @var LinesOfCode[]
+     * @var array<string,array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}>
      */
     private $linesOfCode = [];
 
@@ -99,7 +98,10 @@ public function functionsIn(string $filename): array
         return $this->functions[$filename];
     }
 
-    public function linesOfCodeFor(string $filename): LinesOfCode
+    /**
+     * @psalm-return array{linesOfCode: int, commentLinesOfCode: int, nonCommentLinesOfCode: int}
+     */
+    public function linesOfCodeFor(string $filename): array
     {
         $this->analyse($filename);
 
@@ -178,7 +180,6 @@ private function analyse(string $filename): void
         $this->classes[$filename]         = $codeUnitFindingVisitor->classes();
         $this->traits[$filename]          = $codeUnitFindingVisitor->traits();
         $this->functions[$filename]       = $codeUnitFindingVisitor->functions();
-        $this->linesOfCode[$filename]     = $lineCountingVisitor->result();
         $this->executableLines[$filename] = $executableLinesFindingVisitor->executableLines();
         $this->ignoredLines[$filename]    = [];
 
@@ -192,6 +193,14 @@ private function analyse(string $filename): void
         );
 
         sort($this->ignoredLines[$filename]);
+
+        $result = $lineCountingVisitor->result();
+
+        $this->linesOfCode[$filename] = [
+            'linesOfCode'           => $result->linesOfCode(),
+            'commentLinesOfCode'    => $result->commentLinesOfCode(),
+            'nonCommentLinesOfCode' => $result->nonCommentLinesOfCode(),
+        ];
     }
 
     private function findLinesIgnoredByLineBasedAnnotations(string $filename, string $source, bool $useAnnotationsForIgnoringCode): void

tests/tests/StaticAnalysis/ParsingFileAnalyserTest.php

@@ -119,7 +119,7 @@ public function testGetLinesOfCodeForFileWithoutNewline(): void
             1,
             (new ParsingFileAnalyser(false, false))->linesOfCodeFor(
                 TEST_FILES_PATH . 'source_without_newline.php'
-            )->linesOfCode()
+            )['linesOfCode']
         );
     }
 }