Skip to content

Commit 5b3e005

Browse files
janedbaljanedbal
committed
Detect dead enum cases
1 parent 295d04a commit 5b3e005

24 files changed

+331
-29
lines changed

‎src/Collector/ClassDefinitionCollector.php

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use PhpParser\Node\Stmt\Class_;
88
use PhpParser\Node\Stmt\ClassLike;
99
use PhpParser\Node\Stmt\Enum_;
10+
use PhpParser\Node\Stmt\EnumCase;
1011
use PhpParser\Node\Stmt\Interface_;
1112
use PhpParser\Node\Stmt\Trait_;
1213
use PhpParser\Node\Stmt\TraitUseAdaptation\Alias;
@@ -25,6 +26,7 @@
2526
* @implements Collector<ClassLike, array{
2627
* kind: string,
2728
* name: string,
29+
* cases: array<string, array{line: int}>,
2830
* constants: array<string, array{line: int}>,
2931
* methods: array<string, array{line: int, params: int, abstract: bool, visibility: int-mask-of<Visibility::*>}>,
3032
* parents: array<string, null>,
@@ -52,6 +54,7 @@ public function getNodeType(): string
5254
* @return array{
5355
* kind: string,
5456
* name: string,
57+
* cases: array<string, array{line: int}>,
5558
* constants: array<string, array{line: int}>,
5659
* methods: array<string, array{line: int, params: int, abstract: bool, visibility: int-mask-of<Visibility::*>}>,
5760
* parents: array<string, null>,
@@ -73,6 +76,8 @@ public function processNode(
7376
$reflection = $this->reflectionProvider->getClass($typeName);
7477

7578
$methods = [];
79+
$constants = [];
80+
$cases = [];
7681

7782
foreach ($node->getMethods() as $method) {
7883
$methods[$method->name->toString()] = [
@@ -83,8 +88,6 @@ public function processNode(
8388
];
8489
}
8590

86-
$constants = [];
87-
8891
foreach ($node->getConstants() as $constant) {
8992
foreach ($constant->consts as $const) {
9093
$constants[$const->name->toString()] = [
@@ -93,10 +96,18 @@ public function processNode(
9396
}
9497
}
9598

99+
foreach ($this->getEnumCases($node) as $case) {
100+
$cases[$case->name->toString()] = [
101+
'line' => $case->name->getStartLine(),
102+
];
103+
104+
}
105+
96106
return [
97107
'kind' => $kind,
98108
'name' => $typeName,
99109
'methods' => $methods,
110+
'cases' => $cases,
100111
'constants' => $constants,
101112
'parents' => $this->getParents($reflection),
102113
'traits' => $this->getTraits($node),
@@ -182,4 +193,24 @@ private function getKind(ClassLike $node): string
182193
throw new LogicException('Unknown class-like node');
183194
}
184195

196+
/**
197+
* @return list<EnumCase>
198+
*/
199+
private function getEnumCases(ClassLike $node): array
200+
{
201+
if (!$node instanceof Enum_) {
202+
return [];
203+
}
204+
205+
$result = [];
206+
207+
foreach ($node->stmts as $stmt) {
208+
if ($stmt instanceof EnumCase) {
209+
$result[] = $stmt;
210+
}
211+
}
212+
213+
return $result;
214+
}
215+
185216
}

‎src/Collector/ConstantFetchCollector.php

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@
1717
use ShipMonk\PHPStan\DeadCode\Excluder\MemberUsageExcluder;
1818
use ShipMonk\PHPStan\DeadCode\Graph\ClassConstantRef;
1919
use ShipMonk\PHPStan\DeadCode\Graph\ClassConstantUsage;
20+
use ShipMonk\PHPStan\DeadCode\Graph\ClassMemberUsage;
2021
use ShipMonk\PHPStan\DeadCode\Graph\CollectedUsage;
22+
use ShipMonk\PHPStan\DeadCode\Graph\EnumCaseRef;
23+
use ShipMonk\PHPStan\DeadCode\Graph\EnumCaseUsage;
2124
use ShipMonk\PHPStan\DeadCode\Graph\UsageOrigin;
2225
use function array_map;
2326
use function count;
@@ -151,14 +154,13 @@ private function registerFetch(
151154
}
152155

153156
foreach ($this->getDeclaringTypesWithConstant($ownerType, $constantName, $possibleDescendantFetch) as $constantRef) {
154-
$this->registerUsage(
155-
new ClassConstantUsage(
156-
UsageOrigin::createRegular($node, $scope),
157-
$constantRef,
158-
),
159-
$node,
160-
$scope,
161-
);
157+
$origin = UsageOrigin::createRegular($node, $scope);
158+
159+
$usage = $constantRef instanceof EnumCaseRef
160+
? new EnumCaseUsage($origin, $constantRef)
161+
: new ClassConstantUsage($origin, $constantRef);
162+
163+
$this->registerUsage($usage, $node, $scope);
162164
}
163165
}
164166
}
@@ -187,7 +189,7 @@ private function getConstantNames(
187189
}
188190

189191
/**
190-
* @return list<ClassConstantRef>
192+
* @return list<ClassConstantRef|EnumCaseRef>
191193
*/
192194
private function getDeclaringTypesWithConstant(
193195
Type $type,
@@ -199,21 +201,31 @@ private function getDeclaringTypesWithConstant(
199201
$classReflections = $typeNormalized->getObjectTypeOrClassStringObjectType()->getObjectClassReflections();
200202

201203
$result = [];
204+
$mayBeEnum = !$typeNormalized->isEnum()->no();
202205

203206
foreach ($classReflections as $classReflection) {
204207
$possibleDescendant = $isPossibleDescendant ?? !$classReflection->isFinal();
208+
209+
if ($mayBeEnum) {
210+
$result[] = new EnumCaseRef($classReflection->getName(), $constantName);
211+
}
212+
205213
$result[] = new ClassConstantRef($classReflection->getName(), $constantName, $possibleDescendant);
206214
}
207215

208-
if ($result === []) {
209-
$result[] = new ClassConstantRef(null, $constantName, true); // call over unknown type
216+
if ($result === []) { // call over unknown type
217+
$result[] = new ClassConstantRef(null, $constantName, true);
218+
$result[] = new EnumCaseRef(null, $constantName);
210219
}
211220

212221
return $result;
213222
}
214223

224+
/**
225+
* @param ClassConstantUsage|EnumCaseUsage $usage
226+
*/
215227
private function registerUsage(
216-
ClassConstantUsage $usage,
228+
ClassMemberUsage $usage,
217229
Node $node,
218230
Scope $scope
219231
): void

‎src/Debug/DebugUsagePrinter.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ private function printMixedEverythingUsages(
150150
}
151151

152152
foreach ($fullyMixedUsages as $memberType => $collectedUsages) {
153+
if ($memberType === MemberType::ENUM_CASE) {
154+
continue; // any fully mixed fetch is emitted twice (once as enum, once as const); report only once here
155+
}
156+
153157
$fullyMixedCount = count($collectedUsages);
154158

155159
$memberTypeString = $memberType === MemberType::METHOD ? 'method' : 'constant';

‎src/Enum/MemberType.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ interface MemberType
77

88
public const METHOD = 1;
99
public const CONSTANT = 2;
10+
public const ENUM_CASE = 3;
1011

1112
}

‎src/Formatter/RemoveDeadCodeFormatter.php

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ public function formatErrors(
5555
if (
5656
$fileSpecificError->getIdentifier() !== DeadCodeRule::IDENTIFIER_METHOD
5757
&& $fileSpecificError->getIdentifier() !== DeadCodeRule::IDENTIFIER_CONSTANT
58+
&& $fileSpecificError->getIdentifier() !== DeadCodeRule::IDENTIFIER_ENUM_CASE
5859
) {
5960
continue;
6061
}
@@ -77,10 +78,12 @@ public function formatErrors(
7778
$deadConstants = $deadMembersByType[MemberType::CONSTANT] ?? [];
7879
/** @var array<string, list<ClassMemberUsage>> $deadMethods */
7980
$deadMethods = $deadMembersByType[MemberType::METHOD] ?? [];
81+
/** @var array<string, list<ClassMemberUsage>> $deadEnumCases */
82+
$deadEnumCases = $deadMembersByType[MemberType::ENUM_CASE] ?? [];
8083

81-
$membersCount += count($deadConstants) + count($deadMethods);
84+
$membersCount += count($deadConstants) + count($deadMethods) + count($deadEnumCases);
8285

83-
$transformer = new RemoveDeadCodeTransformer(array_keys($deadMethods), array_keys($deadConstants));
86+
$transformer = new RemoveDeadCodeTransformer(array_keys($deadMethods), array_keys($deadConstants), array_keys($deadEnumCases));
8487
$oldCode = $this->fileSystem->read($file);
8588
$newCode = $transformer->transformCode($oldCode);
8689
$this->fileSystem->write($file, $newCode);
@@ -94,6 +97,11 @@ public function formatErrors(
9497
$output->writeLineFormatted(" • Removed method <fg=white>$method</>");
9598
$this->printExcludedUsages($output, $excludedUsages);
9699
}
100+
101+
foreach ($deadEnumCases as $case => $excludedUsages) {
102+
$output->writeLineFormatted(" • Removed enum case <fg=white>$case</>");
103+
$this->printExcludedUsages($output, $excludedUsages);
104+
}
97105
}
98106

99107
$memberPlural = $membersCount === 1 ? '' : 's';

‎src/Graph/ClassConstantRef.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ final class ClassConstantRef extends ClassMemberRef
1212

1313
public function __construct(
1414
?string $className,
15-
?string $constantName,
15+
?string $enumCaseName,
1616
bool $possibleDescendant
1717
)
1818
{
19-
parent::__construct($className, $constantName, $possibleDescendant);
19+
parent::__construct($className, $enumCaseName, $possibleDescendant);
2020
}
2121

2222
public static function buildKey(

‎src/Graph/CollectedUsage.php

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,24 @@ public static function deserialize(
112112
);
113113
$exclusionReason = $result['e'];
114114

115-
$usage = $memberType === MemberType::CONSTANT
116-
? new ClassConstantUsage(
115+
if ($memberType === MemberType::CONSTANT) {
116+
$usage = new ClassConstantUsage(
117117
$origin,
118118
new ClassConstantRef($result['m']['c'], $result['m']['m'], $result['m']['d']),
119-
)
120-
: new ClassMethodUsage(
119+
);
120+
} elseif ($memberType === MemberType::METHOD) {
121+
$usage = new ClassMethodUsage(
121122
$origin,
122123
new ClassMethodRef($result['m']['c'], $result['m']['m'], $result['m']['d']),
123124
);
125+
} elseif ($memberType === MemberType::ENUM_CASE) {
126+
$usage = new EnumCaseUsage(
127+
$origin,
128+
new EnumCaseRef($result['m']['c'], $result['m']['m']),
129+
);
130+
} else {
131+
throw new LogicException('Unknown member type: ' . $memberType);
132+
}
124133

125134
return new self($usage, $exclusionReason);
126135
}

‎src/Graph/EnumCaseRef.php

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace ShipMonk\PHPStan\DeadCode\Graph;
4+
5+
use ShipMonk\PHPStan\DeadCode\Enum\MemberType;
6+
7+
/**
8+
* @immutable
9+
*/
10+
final class EnumCaseRef extends ClassMemberRef
11+
{
12+
13+
public function __construct(
14+
?string $className,
15+
?string $enumCaseName
16+
)
17+
{
18+
parent::__construct($className, $enumCaseName, false);
19+
}
20+
21+
public static function buildKey(string $typeName, string $memberName): string
22+
{
23+
return 'e/' . $typeName . '::' . $memberName;
24+
}
25+
26+
/**
27+
* @return MemberType::ENUM_CASE
28+
*/
29+
public function getMemberType(): int
30+
{
31+
return MemberType::ENUM_CASE;
32+
}
33+
34+
}

‎src/Graph/EnumCaseUsage.php

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace ShipMonk\PHPStan\DeadCode\Graph;
4+
5+
use LogicException;
6+
use ShipMonk\PHPStan\DeadCode\Enum\MemberType;
7+
8+
/**
9+
* @immutable
10+
*/
11+
final class EnumCaseUsage extends ClassMemberUsage
12+
{
13+
14+
private EnumCaseRef $enumCase;
15+
16+
/**
17+
* @param UsageOrigin $origin The method where the fetch occurs
18+
* @param EnumCaseRef $enumCase The case being fetched
19+
*/
20+
public function __construct(
21+
UsageOrigin $origin,
22+
EnumCaseRef $enumCase
23+
)
24+
{
25+
parent::__construct($origin);
26+
27+
$this->enumCase = $enumCase;
28+
}
29+
30+
/**
31+
* @return MemberType::ENUM_CASE
32+
*/
33+
public function getMemberType(): int
34+
{
35+
return MemberType::ENUM_CASE;
36+
}
37+
38+
public function getMemberRef(): EnumCaseRef
39+
{
40+
return $this->enumCase;
41+
}
42+
43+
public function concretizeMixedClassNameUsage(string $className): self
44+
{
45+
if ($this->enumCase->getClassName() !== null) {
46+
throw new LogicException('Usage is not mixed, thus it cannot be concretized');
47+
}
48+
49+
return new self(
50+
$this->getOrigin(),
51+
new EnumCaseRef(
52+
$className,
53+
$this->enumCase->getMemberName(),
54+
),
55+
);
56+
}
57+
58+
}

0 commit comments

Comments
 (0)