Autoremove: fix removal of transitively dead constants (#183)

Author: janedbal

src/Formatter/RemoveDeadCodeFormatter.php

@@ -5,6 +5,7 @@
 use PHPStan\Command\AnalysisResult;
 use PHPStan\Command\ErrorFormatter\ErrorFormatter;
 use PHPStan\Command\Output;
+use ShipMonk\PHPStan\DeadCode\Enum\MemberType;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMemberUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\UsageOrigin;
 use ShipMonk\PHPStan\DeadCode\Output\OutputEnhancer;
@@ -58,12 +59,13 @@ public function formatErrors(
                 continue;
             }
 
-            /** @var array<string, array{file: string, excludedUsages: list<ClassMemberUsage>}> $metadata */
+            /** @var array<string, array{file: string, type: MemberType::*, excludedUsages: list<ClassMemberUsage>}> $metadata */
             $metadata = $fileSpecificError->getMetadata();
-            $type = $fileSpecificError->getIdentifier();
 
             foreach ($metadata as $memberKey => $data) {
-                $deadMembersByFiles[$data['file']][$type][$memberKey] = $data['excludedUsages'];
+                $file = $data['file'];
+                $type = $data['type'];
+                $deadMembersByFiles[$file][$type][$memberKey] = $data['excludedUsages'];
             }
         }
 
@@ -72,9 +74,9 @@ public function formatErrors(
 
         foreach ($deadMembersByFiles as $file => $deadMembersByType) {
             /** @var array<string, list<ClassMemberUsage>> $deadConstants */
-            $deadConstants = $deadMembersByType[DeadCodeRule::IDENTIFIER_CONSTANT] ?? [];
+            $deadConstants = $deadMembersByType[MemberType::CONSTANT] ?? [];
             /** @var array<string, list<ClassMemberUsage>> $deadMethods */
-            $deadMethods = $deadMembersByType[DeadCodeRule::IDENTIFIER_METHOD] ?? [];
+            $deadMethods = $deadMembersByType[MemberType::METHOD] ?? [];
 
             $membersCount += count($deadConstants) + count($deadMethods);
 

src/Rule/DeadCodeRule.php

@@ -608,6 +608,7 @@ private function buildError(array $blackMembersGroup): IdentifierRuleError
         $metadata[$humanMemberString] = [
             'file' => $representative->getFile(),
             'line' => $representative->getLine(),
+            'type' => $representative->getMember()->getMemberType(),
             'transitive' => false,
             'excludedUsages' => $excludedUsages,
         ];
@@ -623,6 +624,7 @@ private function buildError(array $blackMembersGroup): IdentifierRuleError
             $metadata[$transitiveDeadMemberRef] = [
                 'file' => $transitivelyDeadMember->getFile(),
                 'line' => $transitivelyDeadMember->getLine(),
+                'type' => $transitivelyDeadMember->getMember()->getMemberType(),
                 'transitive' => true,
                 'excludedUsages' => $excludedUsages,
             ];

tests/Rule/DeadCodeRuleTest.php

@@ -395,7 +395,7 @@ function (string $file, string $content): void {
 
         $expectedOutputFile = $this->getAutoremoveOutputFilePath($file);
         self::assertFileExists($expectedOutputFile);
-        self::assertSame(file_get_contents($expectedOutputFile), $this->trimFgColors($writtenOutput));
+        self::assertSame(file_get_contents($expectedOutputFile), $this->trimFgColors($writtenOutput), "Output does not match expected: $expectedOutputFile");
     }
 
     /**

tests/Rule/data/removing/sample.output.txt

@@ -2,11 +2,12 @@
  • Removed constant Removal\Interface1::DEAD_IFACE_CONST2
  • Removed constant Removal\Interface1::DEAD_IFACE_CONST3
  • Removed constant Removal\Child2::DEAD_CONST
+ • Removed constant Removal\Child2::TRANSITIVE_DEAD
  • Removed method Removal\Interface1::foo
  • Removed method Removal\Interface2::foo
  • Removed method Removal\AbstractClass::foo
  • Removed method Removal\Child1::foo
  • Removed method Removal\Child2::mixedExcludedUsage
-   ! Excluded usage at data/removing/sample.php:48 left intact
+   ! Excluded usage at data/removing/sample.php:49 left intact
 
-Removed 9 dead members in 1 file.
+Removed 10 dead members in 1 file.

tests/Rule/data/removing/sample.php

@@ -31,14 +31,15 @@ public function foo(): void
 class Child2 extends AbstractClass
 {
     const USED_CONST = 1, DEAD_CONST = 2;
+    const TRANSITIVE_DEAD = 3;
 
     public function foo(): void
     {
         echo self::USED_CONST;
     }
 
     public function mixedExcludedUsage(): void {
-
+        echo self::TRANSITIVE_DEAD;
     }
 }