Skip to content

Commit 2a48a69

Browse files
zacharylundzacharylund
committed
Add Twig usage provider
1 parent 33cf2c2 commit 2a48a69

File tree

6 files changed

+363
-3
lines changed

6 files changed

+363
-3
lines changed

‎composer.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@
3939
"symfony/event-dispatcher": "^5.4 || ^6.0 || ^7.0",
4040
"symfony/http-kernel": "^5.4 || ^6.0 || ^7.0",
4141
"symfony/routing": "^5.4 || ^6.0 || ^7.0",
42-
"symfony/validator": "^5.4 || ^6.0 || ^7.0"
42+
"symfony/validator": "^5.4 || ^6.0 || ^7.0",
43+
"twig/twig": "^3.0"
4344
},
4445
"autoload": {
4546
"psr-4": {

‎composer.lock

+81-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rules.neon

+12
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ services:
4444
arguments:
4545
enabled: %shipmonkDeadCode.usageProviders.symfony.enabled%
4646

47+
-
48+
class: ShipMonk\PHPStan\DeadCode\Provider\TwigUsageProvider
49+
tags:
50+
- shipmonk.deadCode.memberUsageProvider
51+
arguments:
52+
enabled: %shipmonkDeadCode.usageProviders.twig.enabled%
53+
4754
-
4855
class: ShipMonk\PHPStan\DeadCode\Provider\DoctrineUsageProvider
4956
tags:
@@ -142,6 +149,8 @@ parameters:
142149
symfony:
143150
enabled: null
144151
configDir: null
152+
twig:
153+
enabled: null
145154
doctrine:
146155
enabled: null
147156
nette:
@@ -176,6 +185,9 @@ parametersSchema:
176185
enabled: schema(bool(), nullable())
177186
configDir: schema(string(), nullable())
178187
])
188+
twig: structure([
189+
enabled: schema(bool(), nullable())
190+
])
179191
doctrine: structure([
180192
enabled: schema(bool(), nullable())
181193
])

‎src/Provider/TwigUsageProvider.php

+224
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace ShipMonk\PHPStan\DeadCode\Provider;
4+
5+
use Composer\InstalledVersions;
6+
use PhpParser\Node;
7+
use PhpParser\Node\Expr\New_;
8+
use PhpParser\Node\Name;
9+
use PHPStan\Analyser\ArgumentsNormalizer;
10+
use PHPStan\Analyser\Scope;
11+
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionMethod;
12+
use PHPStan\Node\InClassNode;
13+
use PHPStan\Reflection\ExtendedMethodReflection;
14+
use PHPStan\Reflection\ParametersAcceptorSelector;
15+
use PHPStan\Type\UnionType;
16+
use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodRef;
17+
use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodUsage;
18+
use ShipMonk\PHPStan\DeadCode\Graph\UsageOrigin;
19+
use function array_map;
20+
use function count;
21+
use function explode;
22+
use function in_array;
23+
24+
class TwigUsageProvider implements MemberUsageProvider
25+
{
26+
27+
private bool $enabled;
28+
29+
public function __construct(?bool $enabled)
30+
{
31+
$this->enabled = $enabled ?? $this->isTwigInstalled();
32+
}
33+
34+
private function isTwigInstalled(): bool
35+
{
36+
return InstalledVersions::isInstalled('twig/twig');
37+
}
38+
39+
public function getUsages(Node $node, Scope $scope): array
40+
{
41+
if (!$this->enabled) {
42+
return [];
43+
}
44+
45+
$usages = [];
46+
47+
if ($node instanceof InClassNode) { // @phpstan-ignore phpstanApi.instanceofAssumption
48+
$usages = [
49+
...$usages,
50+
...$this->getMethodUsagesFromReflection($node),
51+
];
52+
}
53+
54+
if ($node instanceof New_) {
55+
$usages = [
56+
...$usages,
57+
...$this->getMethodUsageFromNew($node, $scope),
58+
];
59+
}
60+
61+
return $usages;
62+
}
63+
64+
/**
65+
* @return list<ClassMethodUsage>
66+
*/
67+
private function getMethodUsageFromNew(New_ $node, Scope $scope): array
68+
{
69+
if (!$node->class instanceof Name) {
70+
return [];
71+
}
72+
73+
if (!in_array($node->class->toString(), [
74+
'Twig\TwigFilter',
75+
'Twig\TwigFunction',
76+
'Twig\TwigTest',
77+
], true)) {
78+
return [];
79+
}
80+
81+
$callerType = $scope->resolveTypeByName($node->class);
82+
$methodReflection = $scope->getMethodReflection($callerType, '__construct');
83+
84+
if ($methodReflection === null) {
85+
return [];
86+
}
87+
88+
$parametersAcceptor = ParametersAcceptorSelector::selectFromArgs(
89+
$scope,
90+
$node->getArgs(),
91+
$methodReflection->getVariants(),
92+
$methodReflection->getNamedArgumentsVariants(),
93+
);
94+
$arg = (ArgumentsNormalizer::reorderNewArguments($parametersAcceptor, $node) ?? $node)->getArgs()[1] ?? null;
95+
96+
if ($arg === null) {
97+
return [];
98+
}
99+
100+
$argType = $scope->getType($arg->value);
101+
102+
$argTypes = $argType instanceof UnionType ? $argType->getTypes() : [$argType];
103+
104+
$callables = [];
105+
106+
foreach ($argTypes as $callableType) {
107+
foreach ($callableType->getConstantArrays() as $arrayType) {
108+
$callable = [];
109+
110+
foreach ($arrayType->getValueTypes() as $valueType) {
111+
$callable[] = array_map(static function ($stringType): string {
112+
return $stringType->getValue();
113+
}, $valueType->getConstantStrings());
114+
}
115+
116+
if (count($callable) === 2) {
117+
foreach ($callable[0] as $className) {
118+
foreach ($callable[1] as $methodName) {
119+
$callables[] = [$className, $methodName];
120+
}
121+
}
122+
}
123+
}
124+
125+
foreach ($callableType->getConstantStrings() as $stringType) {
126+
$callable = explode('::', $stringType->getValue());
127+
128+
if (count($callable) === 2) {
129+
$callables[] = $callable;
130+
}
131+
}
132+
}
133+
134+
$usages = [];
135+
136+
foreach ($callables as $callable) {
137+
$usages[] = new ClassMethodUsage(
138+
UsageOrigin::createRegular($node, $scope),
139+
new ClassMethodRef(
140+
$callable[0],
141+
$callable[1],
142+
false,
143+
),
144+
);
145+
}
146+
147+
return $usages;
148+
}
149+
150+
/**
151+
* @return list<ClassMethodUsage>
152+
*/
153+
private function getMethodUsagesFromReflection(InClassNode $node): array
154+
{
155+
$classReflection = $node->getClassReflection();
156+
$nativeReflection = $classReflection->getNativeReflection();
157+
158+
$usages = [];
159+
160+
foreach ($nativeReflection->getMethods() as $method) {
161+
if ($method->getDeclaringClass()->getName() !== $nativeReflection->getName()) {
162+
continue;
163+
}
164+
165+
$usageNote = $this->shouldMarkAsUsed($method);
166+
167+
if ($usageNote !== null) {
168+
$usages[] = $this->createUsage($classReflection->getNativeMethod($method->getName()), $usageNote);
169+
}
170+
}
171+
172+
return $usages;
173+
}
174+
175+
protected function shouldMarkAsUsed(ReflectionMethod $method): ?string
176+
{
177+
if ($this->isMethodWithAsTwigFilterAttribute($method)) {
178+
return 'Twig filter method via #[AsTwigFilter] attribute';
179+
}
180+
181+
if ($this->isMethodWithAsTwigFunctionAttribute($method)) {
182+
return 'Twig function method via #[AsTwigFunction] attribute';
183+
}
184+
185+
if ($this->isMethodWithAsTwigTestAttribute($method)) {
186+
return 'Twig test method via #[AsTwigTest] attribute';
187+
}
188+
189+
return null;
190+
}
191+
192+
protected function isMethodWithAsTwigFilterAttribute(ReflectionMethod $method): bool
193+
{
194+
return $this->hasAttribute($method, 'Twig\Attribute\AsTwigFilter');
195+
}
196+
197+
protected function isMethodWithAsTwigFunctionAttribute(ReflectionMethod $method): bool
198+
{
199+
return $this->hasAttribute($method, 'Twig\Attribute\AsTwigFunction');
200+
}
201+
202+
protected function isMethodWithAsTwigTestAttribute(ReflectionMethod $method): bool
203+
{
204+
return $this->hasAttribute($method, 'Twig\Attribute\AsTwigTest');
205+
}
206+
207+
protected function hasAttribute(ReflectionMethod $method, string $attributeClass): bool
208+
{
209+
return $method->getAttributes($attributeClass) !== [];
210+
}
211+
212+
private function createUsage(ExtendedMethodReflection $methodReflection, string $reason): ClassMethodUsage
213+
{
214+
return new ClassMethodUsage(
215+
UsageOrigin::createVirtual($this, VirtualUsageData::withNote($reason)),
216+
new ClassMethodRef(
217+
$methodReflection->getDeclaringClass()->getName(),
218+
$methodReflection->getName(),
219+
false,
220+
),
221+
);
222+
}
223+
224+
}

‎tests/Rule/DeadCodeRuleTest.php

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
use ShipMonk\PHPStan\DeadCode\Provider\ReflectionBasedMemberUsageProvider;
4040
use ShipMonk\PHPStan\DeadCode\Provider\ReflectionUsageProvider;
4141
use ShipMonk\PHPStan\DeadCode\Provider\SymfonyUsageProvider;
42+
use ShipMonk\PHPStan\DeadCode\Provider\TwigUsageProvider;
4243
use ShipMonk\PHPStan\DeadCode\Provider\VendorUsageProvider;
4344
use ShipMonk\PHPStan\DeadCode\Provider\VirtualUsageData;
4445
use ShipMonk\PHPStan\DeadCode\Transformer\FileSystem;
@@ -680,6 +681,7 @@ public static function provideFiles(): Traversable
680681
yield 'provider-reflection' => [__DIR__ . '/data/providers/reflection.php', self::requiresPhp(8_01_00)];
681682
yield 'provider-symfony' => [__DIR__ . '/data/providers/symfony.php', self::requiresPhp(8_00_00)];
682683
yield 'provider-symfony-7.1' => [__DIR__ . '/data/providers/symfony-gte71.php', self::requiresPhp(8_00_00) && self::requiresPackage('symfony/dependency-injection', '>= 7.1')];
684+
yield 'provider-twig' => [__DIR__ . '/data/providers/twig.php', self::requiresPhp(8_00_00)];
683685
yield 'provider-phpunit' => [__DIR__ . '/data/providers/phpunit.php', self::requiresPhp(8_00_00)];
684686
yield 'provider-doctrine' => [__DIR__ . '/data/providers/doctrine.php', self::requiresPhp(8_00_00)];
685687
yield 'provider-phpstan' => [__DIR__ . '/data/providers/phpstan.php'];
@@ -831,6 +833,9 @@ public function shouldMarkMethodAsUsed(ReflectionMethod $method): ?VirtualUsageD
831833
true,
832834
__DIR__ . '/data/providers/symfony/',
833835
),
836+
new TwigUsageProvider(
837+
true,
838+
),
834839
];
835840
}
836841

0 commit comments

Comments
 (0)