octoleo/rector
1
1
Fork 0
mirror of https://github.com/rectorphp/rector.git synced 2024-06-01 17:00:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Restoration] Remove way too specific CompleteMissingDependencyInNewRector

Browse Source
This commit is contained in:
Tomas Votruba 2021-07-15 01:28:20 +02:00
parent f7ba2752e3
commit 72b34a7d76
7 changed files with 1 additions and 276 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
build/target-repository/docs/rector_rules_overview.md
View File

@ -9446,6 +9446,7 @@ return static function (ContainerConfigurator $containerConfigurator): void {
class SomeClass
{
+ public function __construct(AnotherClassFactory $anotherClassFactory)
+ {c function __construct(AnotherClassFactory $anotherClassFactory)
+ {
+ $this->anotherClassFactory = $anotherClassFactory;
+ }

33
rules-tests/Restoration/Rector/New_/CompleteMissingDependencyInNewRector/CompleteMissingDependencyInNewRectorTest.php
View File

@ -1,33 +0,0 @@
<?php
declare(strict_types=1);
namespace Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector;
use Iterator;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
use Symplify\SmartFileSystem\SmartFileInfo;
final class CompleteMissingDependencyInNewRectorTest extends AbstractRectorTestCase
{
/**
* @dataProvider provideData()
*/
public function test(SmartFileInfo $fileInfo): void
{
$this->doTestFileInfo($fileInfo);
}
/**
* @return Iterator<SmartFileInfo>
*/
public function provideData(): Iterator
{
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}
public function provideConfigFilePath(): string
{
return __DIR__ . '/config/configured_rule.php';
}
}

31
rules-tests/Restoration/Rector/New_/CompleteMissingDependencyInNewRector/Fixture/fixture.php.inc
View File

@ -1,31 +0,0 @@
<?php
namespace Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Fixture;
use Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Source\RandomValueObject;
final class SomeClass
{
public function run()
{
$valueObject = new RandomValueObject();
}
}
?>
-----
<?php
namespace Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Fixture;
use Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Source\RandomValueObject;
final class SomeClass
{
public function run()
{
$valueObject = new RandomValueObject(new \Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Source\RandomDependency());
}
}
?>

9
rules-tests/Restoration/Rector/New_/CompleteMissingDependencyInNewRector/Source/RandomDependency.php
View File

@ -1,9 +0,0 @@
<?php
declare(strict_types=1);
namespace Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Source;
final class RandomDependency
{
}

12
rules-tests/Restoration/Rector/New_/CompleteMissingDependencyInNewRector/Source/RandomValueObject.php
View File

@ -1,12 +0,0 @@
<?php
declare(strict_types=1);
namespace Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Source;
final class RandomValueObject
{
public function __construct(RandomDependency $randomDependency)
{
}
}

17
rules-tests/Restoration/Rector/New_/CompleteMissingDependencyInNewRector/config/configured_rule.php
View File

@ -1,17 +0,0 @@
<?php
declare(strict_types=1);
use Rector\Restoration\Rector\New_\CompleteMissingDependencyInNewRector;
use Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\Source\RandomDependency;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();
$services->set(CompleteMissingDependencyInNewRector::class)
->call('configure', [[
CompleteMissingDependencyInNewRector::CLASS_TO_INSTANTIATE_BY_TYPE => [
RandomDependency::class => RandomDependency::class,
],
]]);
};

174
rules/Restoration/Rector/New_/CompleteMissingDependencyInNewRector.php
View File

@ -1,174 +0,0 @@
<?php
declare(strict_types=1);
namespace Rector\Restoration\Rector\New_;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Name\FullyQualified;
use PHPStan\Reflection\ReflectionProvider;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use ReflectionMethod;
use ReflectionNamedType;
use ReflectionParameter;
use ReflectionType;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\Restoration\Rector\New_\CompleteMissingDependencyInNewRector\CompleteMissingDependencyInNewRectorTest
*/
final class CompleteMissingDependencyInNewRector extends AbstractRector implements ConfigurableRectorInterface
{
/**
* @api
* @var string
*/
public const CLASS_TO_INSTANTIATE_BY_TYPE = 'class_to_instantiate_by_type';
/**
* @var array<class-string, class-string>
*/
private array $classToInstantiateByType = [];
public function __construct(
private ReflectionProvider $reflectionProvider
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Complete missing constructor dependency instance by type', [
new ConfiguredCodeSample(
<<<'CODE_SAMPLE'
final class SomeClass
{
public function run()
{
$valueObject = new RandomValueObject();
}
}
class RandomValueObject
{
public function __construct(RandomDependency $randomDependency)
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
final class SomeClass
{
public function run()
{
$valueObject = new RandomValueObject(new RandomDependency());
}
}
class RandomValueObject
{
public function __construct(RandomDependency $randomDependency)
{
}
}
CODE_SAMPLE
,
[
self::CLASS_TO_INSTANTIATE_BY_TYPE => [
'RandomDependency' => 'RandomDependency',
],
]
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [New_::class];
}
/**
* @param New_ $node
*/
public function refactor(Node $node): ?Node
{
if ($this->shouldSkipNew($node)) {
return null;
}
/** @var ReflectionMethod $constructorMethodReflection */
$constructorMethodReflection = $this->getNewNodeClassConstructorMethodReflection($node);
foreach ($constructorMethodReflection->getParameters() as $position => $reflectionParameter) {
// argument is already set
if (isset($node->args[$position])) {
continue;
}
$classToInstantiate = $this->resolveClassToInstantiateByParameterReflection($reflectionParameter);
if ($classToInstantiate === null) {
continue;
}
$new = new New_(new FullyQualified($classToInstantiate));
$node->args[$position] = new Arg($new);
}
return $node;
}
/**
* @param array<string, array<class-string, class-string>> $configuration
*/
public function configure(array $configuration): void
{
$this->classToInstantiateByType = $configuration[self::CLASS_TO_INSTANTIATE_BY_TYPE] ?? [];
}
private function shouldSkipNew(New_ $new): bool
{
$constructorMethodReflection = $this->getNewNodeClassConstructorMethodReflection($new);
if (! $constructorMethodReflection instanceof ReflectionMethod) {
return true;
}
return $constructorMethodReflection->getNumberOfRequiredParameters() <= count($new->args);
}
private function getNewNodeClassConstructorMethodReflection(New_ $new): ?ReflectionMethod
{
$className = $this->getName($new->class);
if ($className === null) {
return null;
}
if (! $this->reflectionProvider->hasClass($className)) {
return null;
}
$classReflection = $this->reflectionProvider->getClass($className);
$reflectionClass = $classReflection->getNativeReflection();
return $reflectionClass->getConstructor();
}
private function resolveClassToInstantiateByParameterReflection(ReflectionParameter $reflectionParameter): ?string
{
$reflectionType = $reflectionParameter->getType();
if (! $reflectionType instanceof ReflectionType) {
return null;
}
$requiredType = $reflectionType instanceof ReflectionNamedType
? $reflectionType->getName()
: (string) $reflectionType;
return $this->classToInstantiateByType[$requiredType] ?? null;
}
}