Skip to content

Commit e278570

Browse files
authored
[internal] Streamline use imports management to FileNode (#8040)
* move use import to file * remove adder, hadnle in FileNode * remove use imrpots remover * instead of service collector, use FileNode directly as source of truth for imports * remove currentFileProvider from NestedAnnotationToAttributeRector as internal * add PendingUsedImports value object, to separate from existing UsedImprts * renaem PendingUsedIMprots to PendignIMports * add BC layer for removed UseNodesToAddCollector, delegating to FileNode with deprecation warnings
1 parent 5dfb29c commit e278570

22 files changed

Lines changed: 978 additions & 634 deletions

File tree

‎rector.php‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Rector\CodingStyle\Rector\String_\UseClassKeywordForClassNameResolutionRector;
66
use Rector\Config\RectorConfig;
7+
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPublicMethodParameterRector;
78
use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
89
use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
910
use Rector\PHPUnit\CodeQuality\Rector\Class_\AddSeeTestAnnotationRector;
@@ -50,6 +51,11 @@
5051
// keep configs untouched, as the classes are just strings
5152
UseClassKeywordForClassNameResolutionRector::class => [__DIR__ . '/config', '*/config/*'],
5253

54+
// BC layer
55+
RemoveUnusedPublicMethodParameterRector::class => [
56+
__DIR__ . '/src/PostRector/Collector/UseNodesToAddCollector.php',
57+
],
58+
5359
RemovePhpVersionIdCheckRector::class => [
5460
__DIR__ . '/src/Util/FileHasher.php',
5561
__DIR__ . '/src/Configuration/RectorConfigBuilder.php',
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Fixture;
4+
5+
final class NoImports
6+
{
7+
public function run(): void
8+
{
9+
}
10+
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
use Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\FirstType;
4+
use function Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\someFunction;
5+
6+
final class NoNamespace
7+
{
8+
public function run(FirstType $firstType): void
9+
{
10+
someFunction();
11+
}
12+
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Fixture;
4+
5+
use Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\FirstType;
6+
use Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\SecondType as AliasedType;
7+
use function Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\someFunction;
8+
use const Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\SOME_CONSTANT;
9+
10+
final class WithImports
11+
{
12+
public function run(FirstType $firstType, AliasedType $aliasedType): void
13+
{
14+
someFunction();
15+
echo SOME_CONSTANT;
16+
}
17+
}
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver;
6+
7+
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
8+
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
9+
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
10+
use Rector\Testing\PHPUnit\AbstractLazyTestCase;
11+
use Rector\Testing\TestingParser\TestingParser;
12+
13+
final class UsedImportsResolverTest extends AbstractLazyTestCase
14+
{
15+
private UsedImportsResolver $usedImportsResolver;
16+
17+
private TestingParser $testingParser;
18+
19+
protected function setUp(): void
20+
{
21+
parent::setUp();
22+
23+
$this->usedImportsResolver = $this->make(UsedImportsResolver::class);
24+
$this->testingParser = $this->make(TestingParser::class);
25+
}
26+
27+
public function testResolvesUseFunctionAndConstantImports(): void
28+
{
29+
$stmts = $this->testingParser->parseFileToDecoratedNodes(__DIR__ . '/Fixture/with_imports.php.inc');
30+
31+
$usedImports = $this->usedImportsResolver->resolveForStmts($stmts);
32+
33+
// the class itself, the normal use and the aliased use
34+
$useImportNames = array_map(
35+
static fn (AliasedObjectType|FullyQualifiedObjectType $objectType): string => $objectType->getClassName(),
36+
$usedImports->getUseImports()
37+
);
38+
39+
$this->assertSame([
40+
'Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Fixture\WithImports',
41+
'Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\FirstType',
42+
'AliasedType',
43+
], $useImportNames);
44+
45+
$aliasedType = $usedImports->getUseImports()[2];
46+
$this->assertInstanceOf(AliasedObjectType::class, $aliasedType);
47+
$this->assertSame(
48+
'Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\SecondType',
49+
$aliasedType->getFullyQualifiedName()
50+
);
51+
52+
$functionImportNames = array_map(
53+
static fn (FullyQualifiedObjectType $fullyQualifiedObjectType): string => $fullyQualifiedObjectType->getClassName(),
54+
$usedImports->getFunctionImports()
55+
);
56+
$this->assertSame(
57+
['Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\someFunction'],
58+
$functionImportNames
59+
);
60+
61+
$constantImportNames = array_map(
62+
static fn (FullyQualifiedObjectType $fullyQualifiedObjectType): string => $fullyQualifiedObjectType->getClassName(),
63+
$usedImports->getConstantImports()
64+
);
65+
$this->assertSame(
66+
['Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\SOME_CONSTANT'],
67+
$constantImportNames
68+
);
69+
}
70+
71+
public function testResolvesClassOnlyWhenNoImports(): void
72+
{
73+
$stmts = $this->testingParser->parseFileToDecoratedNodes(__DIR__ . '/Fixture/no_imports.php.inc');
74+
75+
$usedImports = $this->usedImportsResolver->resolveForStmts($stmts);
76+
77+
$useImportNames = array_map(
78+
static fn (AliasedObjectType|FullyQualifiedObjectType $objectType): string => $objectType->getClassName(),
79+
$usedImports->getUseImports()
80+
);
81+
82+
$this->assertSame([
83+
'Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Fixture\NoImports',
84+
], $useImportNames);
85+
86+
$this->assertSame([], $usedImports->getFunctionImports());
87+
$this->assertSame([], $usedImports->getConstantImports());
88+
}
89+
90+
public function testResolvesImportsInNonNamespacedFile(): void
91+
{
92+
$stmts = $this->testingParser->parseFileToDecoratedNodes(__DIR__ . '/Fixture/no_namespace.php.inc');
93+
94+
$usedImports = $this->usedImportsResolver->resolveForStmts($stmts);
95+
96+
$useImportNames = array_map(
97+
static fn (AliasedObjectType|FullyQualifiedObjectType $objectType): string => $objectType->getClassName(),
98+
$usedImports->getUseImports()
99+
);
100+
101+
$this->assertSame([
102+
'NoNamespace',
103+
'Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\FirstType',
104+
], $useImportNames);
105+
106+
$functionImportNames = array_map(
107+
static fn (FullyQualifiedObjectType $fullyQualifiedObjectType): string => $fullyQualifiedObjectType->getClassName(),
108+
$usedImports->getFunctionImports()
109+
);
110+
$this->assertSame(
111+
['Rector\Tests\CodingStyle\ClassNameImport\UsedImportsResolver\Source\someFunction'],
112+
$functionImportNames
113+
);
114+
}
115+
}

0 commit comments

Comments
 (0)