feat: Add filename to report json.

smeghead · smeghead · commit 76495cbc7e23 · 2025-03-20T17:10:56.000+09:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
  * The base of deviation of local variable abuse has been changed from the average number of rows to the first number of rows.
  * AssignOp has been added to the assignment decision in addition to Assign.
-
+ * Add filename to report json.
 
 ## v0.0.2 (2025-03-19)
 
diff --git a/src/Analyze/AnalysisResult.php b/src/Analyze/AnalysisResult.php
@@ -13,6 +13,7 @@ final class AnalysisResult
      * @param list<Scope> $scopes
      */
     public function __construct(
+        public readonly string $filename,
         public readonly array $scopes
     )
     {
@@ -27,6 +28,7 @@ public function __construct(
     public function format(): string
     {
         $output = [
+            'filename' => $this->filename,
             'maxVariableHardUsage' => $this->maxVariableHardUsage,
             'avarageVariableHardUsage' => $this->avarageVariableHardUsage,
         ];
diff --git a/src/Analyze/VariableAnalyzer.php b/src/Analyze/VariableAnalyzer.php
@@ -11,22 +11,19 @@ final class VariableAnalyzer
 {
     private const ASSIGNED_VARIABLE_COEFFICIENT = 2;
 
-    /**
-     * @var list<Func>
-     */
-    private array $functions;
-
     /**
      * @param list<Func> $functions
      */
-    public function __construct(array $functions)
+    public function __construct(
+        public readonly string $filename,
+        public readonly array $functions
+    )
     {
-        $this->functions = $functions;
     }
 
     public function analyze(): AnalysisResult
     {
-        return new AnalysisResult(array_map(fn($f) => $this->analyzeFunction($f), $this->functions));
+        return new AnalysisResult($this->filename, array_map(fn($f) => $this->analyzeFunction($f), $this->functions));
     }
 
     private function analyzeFunction(Func $function): Scope
diff --git a/src/Command.php b/src/Command.php
@@ -32,7 +32,7 @@ public function run(array $argv): void
             return;
         }
         $parseResult = $parser->parse($content);
-        $analyzer = new VariableAnalyzer($parseResult->functions);
+        $analyzer = new VariableAnalyzer($filePath, $parseResult->functions);
         $result = $analyzer->analyze();
         echo $result->format();
     }
diff --git a/test/VariableAnalizerTest.php b/test/VariableAnalizerTest.php
@@ -16,8 +16,9 @@ public function testAnalyzeFunctionSimple(): void
         $func->addVariable(new VarReference('a', 2));
         $func->addVariable(new VarReference('a', 3));
 
-        $sut = new VariableAnalyzer([$func]);
+        $sut = new VariableAnalyzer('target.php', [$func]);
         $result = $sut->analyze();
+        $this->assertSame('target.php', $result->filename);
         $scopes = $result->scopes;
 
         $this->assertCount(1, $scopes);
@@ -32,8 +33,9 @@ public function testAnalyzeFunctionLong(): void
         $func->addVariable(new VarReference('a', 2));
         $func->addVariable(new VarReference('a', 100));
 
-        $sut = new VariableAnalyzer([$func]);
+        $sut = new VariableAnalyzer('target.php', [$func]);
         $result = $sut->analyze();
+        $this->assertSame('target.php', $result->filename);
         $scopes = $result->scopes;
 
         $this->assertCount(1, $scopes);
@@ -48,8 +50,9 @@ public function testAnalyzeFunctionLongAssignedVariable(): void
         $func->addVariable(new VarReference('a', 2));
         $func->addVariable(new VarReference('a', 100));
 
-        $sut = new VariableAnalyzer([$func]);
+        $sut = new VariableAnalyzer('target.php', [$func]);
         $result = $sut->analyze();
+        $this->assertSame('target.php', $result->filename);
         $scopes = $result->scopes;
 
         $this->assertCount(1, $scopes);
@@ -64,8 +67,9 @@ public function testAnalyzeFunctionLongMultipleAssignedVariable(): void
         $func->addVariable(new VarReference('a', 2));
         $func->addVariable(new VarReference('a', 100, true));
 
-        $sut = new VariableAnalyzer([$func]);
+        $sut = new VariableAnalyzer('target.php', [$func]);
         $result = $sut->analyze();
+        $this->assertSame('target.php', $result->filename);
         $scopes = $result->scopes;
 
         $this->assertCount(1, $scopes);

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ final class AnalysisResult`
`13`	`13`	`* @param list<Scope> $scopes`
`14`	`14`	`*/`
`15`	`15`	`public function __construct(`
	`16`	`+ public readonly string $filename,`
`16`	`17`	`public readonly array $scopes`
`17`	`18`	`)`
`18`	`19`	`{`
`@@ -27,6 +28,7 @@ public function __construct(`
`27`	`28`	`public function format(): string`
`28`	`29`	`{`
`29`	`30`	`$output = [`
	`31`	`+ 'filename' => $this->filename,`
`30`	`32`	`'maxVariableHardUsage' => $this->maxVariableHardUsage,`
`31`	`33`	`'avarageVariableHardUsage' => $this->avarageVariableHardUsage,`
`32`	`34`	`];`
Original file line number	Diff line number	Diff line change
`@@ -11,22 +11,19 @@ final class VariableAnalyzer`
`11`	`11`	`{`
`12`	`12`	`private const ASSIGNED_VARIABLE_COEFFICIENT = 2;`
`13`	`13`
`14`		`- /**`
`15`		`- * @var list<Func>`
`16`		`- */`
`17`		`- private array $functions;`
`18`		`-`
`19`	`14`	`/**`
`20`	`15`	`* @param list<Func> $functions`
`21`	`16`	`*/`
`22`		`- public function __construct(array $functions)`
	`17`	`+ public function __construct(`
	`18`	`+ public readonly string $filename,`
	`19`	`+ public readonly array $functions`
	`20`	`+ )`
`23`	`21`	`{`
`24`		`- $this->functions = $functions;`
`25`	`22`	`}`
`26`	`23`
`27`	`24`	`public function analyze(): AnalysisResult`
`28`	`25`	`{`
`29`		`- return new AnalysisResult(array_map(fn($f) => $this->analyzeFunction($f), $this->functions));`
	`26`	`+ return new AnalysisResult($this->filename, array_map(fn($f) => $this->analyzeFunction($f), $this->functions));`
`30`	`27`	`}`
`31`	`28`
`32`	`29`	`private function analyzeFunction(Func $function): Scope`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function run(array $argv): void`
`32`	`32`	`return;`
`33`	`33`	`}`
`34`	`34`	`$parseResult = $parser->parse($content);`
`35`		`- $analyzer = new VariableAnalyzer($parseResult->functions);`
	`35`	`+ $analyzer = new VariableAnalyzer($filePath, $parseResult->functions);`
`36`	`36`	`$result = $analyzer->analyze();`
`37`	`37`	`echo $result->format();`
`38`	`38`	`}`