Add line number tracking to CognitiveMetrics (#51)

Author: floriankraemer

src/Business/Cognitive/CognitiveMetrics.php

@@ -31,6 +31,7 @@ class CognitiveMetrics implements JsonSerializable
     private string $class;
     private string $method;
     private string $file;
+    private int $line;
     private ?int $timesChanged = null;
 
     private int $lineCount = 0;
@@ -75,6 +76,7 @@ public function __construct(array $metrics)
         $this->method = $metrics['method'];
         $this->class = $metrics['class'];
         $this->file = $metrics['file'] ?? null;
+        $this->line = $metrics['line'] ?? 0;
 
         $this->setRequiredMetricProperties($metrics);
         $this->setOptionalMetricProperties($metrics);
@@ -388,6 +390,11 @@ public function getFileName(): string
         return $this->file;
     }
 
+    public function getLine(): int
+    {
+        return $this->line;
+    }
+
     public function equals(self $metrics): bool
     {
         return $metrics->getClass() === $this->class
@@ -403,6 +410,7 @@ public function toArray(): array
             'class' => $this->class,
             'method' => $this->method,
             'file' => $this->file,
+            'line' => $this->line,
             'lineCount' => $this->lineCount,
             'argCount' => $this->argCount,
             'returnCount' => $this->returnCount,

src/PhpParser/CognitiveMetricsVisitor.php

@@ -97,6 +97,7 @@ public function resetAll(): void
     private function createMetricsArray(Node\Stmt\ClassMethod $node): array
     {
         return [
+            'line' => $node->getStartLine(),
             'lineCount' => $this->calculateLineCount($node),
             'argCount' => $this->countMethodArguments($node),
             'returnCount' => 0,

tests/Unit/Business/Cognitive/CognitiveMetricsTest.php

@@ -24,6 +24,7 @@ protected function setUp(): void
             'class' => 'TestClass',
             'method' => 'testMethod',
             'file' => 'TestClass.php',
+            'line' => 42,
             'lineCount' => 10,
             'argCount' => 2,
             'returnCount' => 1,
@@ -42,6 +43,7 @@ public function testConstructor(): void
 
         $this->assertSame('TestClass', $metrics->getClass());
         $this->assertSame('testMethod', $metrics->getMethod());
+        $this->assertSame(42, $metrics->getLine());
         $this->assertSame(10, $metrics->getLineCount());
         $this->assertSame(2, $metrics->getArgCount());
         $this->assertSame(1, $metrics->getReturnCount());
@@ -67,6 +69,7 @@ public function testFromArray(): void
 
         $this->assertSame('TestClass', $metrics->getClass());
         $this->assertSame('testMethod', $metrics->getMethod());
+        $this->assertSame(42, $metrics->getLine());
         $this->assertSame(10, $metrics->getLineCount());
         $this->assertSame(2, $metrics->getArgCount());
         $this->assertSame(1, $metrics->getReturnCount());
@@ -94,6 +97,7 @@ public function testToArray(): void
             'class' => 'TestClass',
             'method' => 'testMethod',
             'file' => 'TestClass.php',
+            'line' => 42,
             'lineCount' => 10,
             'argCount' => 2,
             'returnCount' => 1,
@@ -132,6 +136,7 @@ public function testJsonSerialize(): void
             'class' => 'TestClass',
             'method' => 'testMethod',
             'file' => 'TestClass.php',
+            'line' => 42,
             'lineCount' => 10,
             'argCount' => 2,
             'returnCount' => 1,
@@ -169,6 +174,7 @@ public function testCalculateDeltas(): void
             'class' => 'TestClass',
             'method' => 'testMethod',
             'file' => 'TestClass.php',
+            'line' => 42,
             'lineCount' => 10,
             'argCount' => 2,
             'returnCount' => 1,
@@ -194,6 +200,7 @@ public function testCalculateDeltas(): void
             'class' => 'TestClass',
             'method' => 'testMethod',
             'file' => 'TestClass.php',
+            'line' => 42,
             'lineCount' => 10,
             'argCount' => 2,
             'returnCount' => 1,

tests/Unit/PhpParser/CognitiveMetricsVisitorTest.php

@@ -55,6 +55,7 @@ public function testMethodMetricsCalculation(): void
         $this->assertArrayHasKey('\\MyNamespace\\MyClass::myMethod', $methodMetrics);
 
         $metrics = $methodMetrics['\\MyNamespace\\MyClass::myMethod'];
+        $this->assertEquals(8, $metrics['line']);
         $this->assertEquals(12, $metrics['lineCount']);
         $this->assertEquals(2, $metrics['argCount']);
         $this->assertEquals(3, $metrics['returnCount']);
@@ -150,7 +151,7 @@ public function normalMethod() {
         // Verify that all metrics have the required keys
         foreach ($methodMetrics as $methodKey => $metrics) {
             $requiredKeys = [
-                'lineCount', 'argCount', 'returnCount', 'variableCount',
+                'line', 'lineCount', 'argCount', 'returnCount', 'variableCount',
                 'propertyCallCount', 'ifCount', 'ifNestingLevel', 'elseCount'
             ];
 
@@ -228,7 +229,7 @@ public function __construct(private int $value) {
         // Verify that the metrics have all required keys
         $metrics = $methodMetrics['\\TestNamespace\\TestClass::methodWithMultipleAnonymousClasses'];
         $requiredKeys = [
-            'lineCount', 'argCount', 'returnCount', 'variableCount',
+            'line', 'lineCount', 'argCount', 'returnCount', 'variableCount',
             'propertyCallCount', 'ifCount', 'ifNestingLevel', 'elseCount'
         ];