mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-03 18:00:50 +00:00
c4c84e0db7
34fff11f80
Remove deprecated addConstructorDependencyToClass() from AbstractRector class, use PropertyToAddCollector directly instaed (#506)
189 lines
6.7 KiB
PHP
189 lines
6.7 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\RemovingStatic\Rector\Class_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr\MethodCall;
|
|
use PhpParser\Node\Expr\PropertyFetch;
|
|
use PhpParser\Node\Expr\StaticCall;
|
|
use PhpParser\Node\Expr\Variable;
|
|
use PhpParser\Node\Stmt\Class_;
|
|
use PHPStan\Type\ObjectType;
|
|
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Naming\Naming\PropertyNaming;
|
|
use Rector\PostRector\Collector\PropertyToAddCollector;
|
|
use Rector\PostRector\ValueObject\PropertyMetadata;
|
|
use Rector\RemovingStatic\Printer\FactoryClassPrinter;
|
|
use Rector\RemovingStatic\StaticTypesInClassResolver;
|
|
use Rector\RemovingStatic\UniqueObjectFactoryFactory;
|
|
use Rector\RemovingStatic\UniqueObjectOrServiceDetector;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\RemovingStatic\Rector\Class_\PassFactoryToEntityRector\PassFactoryToEntityRectorTest
|
|
*/
|
|
final class PassFactoryToUniqueObjectRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\ConfigurableRectorInterface
|
|
{
|
|
/**
|
|
* @api
|
|
* @var string
|
|
*/
|
|
public const TYPES_TO_SERVICES = 'types_to_services';
|
|
/**
|
|
* @var ObjectType[]
|
|
*/
|
|
private $serviceObjectTypes = [];
|
|
/**
|
|
* @var \Rector\RemovingStatic\StaticTypesInClassResolver
|
|
*/
|
|
private $staticTypesInClassResolver;
|
|
/**
|
|
* @var \Rector\Naming\Naming\PropertyNaming
|
|
*/
|
|
private $propertyNaming;
|
|
/**
|
|
* @var \Rector\RemovingStatic\UniqueObjectOrServiceDetector
|
|
*/
|
|
private $uniqueObjectOrServiceDetector;
|
|
/**
|
|
* @var \Rector\RemovingStatic\UniqueObjectFactoryFactory
|
|
*/
|
|
private $uniqueObjectFactoryFactory;
|
|
/**
|
|
* @var \Rector\RemovingStatic\Printer\FactoryClassPrinter
|
|
*/
|
|
private $factoryClassPrinter;
|
|
/**
|
|
* @var \Rector\PostRector\Collector\PropertyToAddCollector
|
|
*/
|
|
private $propertyToAddCollector;
|
|
public function __construct(\Rector\RemovingStatic\StaticTypesInClassResolver $staticTypesInClassResolver, \Rector\Naming\Naming\PropertyNaming $propertyNaming, \Rector\RemovingStatic\UniqueObjectOrServiceDetector $uniqueObjectOrServiceDetector, \Rector\RemovingStatic\UniqueObjectFactoryFactory $uniqueObjectFactoryFactory, \Rector\RemovingStatic\Printer\FactoryClassPrinter $factoryClassPrinter, \Rector\PostRector\Collector\PropertyToAddCollector $propertyToAddCollector)
|
|
{
|
|
$this->staticTypesInClassResolver = $staticTypesInClassResolver;
|
|
$this->propertyNaming = $propertyNaming;
|
|
$this->uniqueObjectOrServiceDetector = $uniqueObjectOrServiceDetector;
|
|
$this->uniqueObjectFactoryFactory = $uniqueObjectFactoryFactory;
|
|
$this->factoryClassPrinter = $factoryClassPrinter;
|
|
$this->propertyToAddCollector = $propertyToAddCollector;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Convert new X/Static::call() to factories in entities, pass them via constructor to each other', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
return new AnotherClass;
|
|
}
|
|
}
|
|
|
|
class AnotherClass
|
|
{
|
|
public function someFun()
|
|
{
|
|
return StaticClass::staticMethod();
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function __construct(AnotherClassFactory $anotherClassFactory)
|
|
{
|
|
$this->anotherClassFactory = $anotherClassFactory;
|
|
}
|
|
|
|
public function run()
|
|
{
|
|
return $this->anotherClassFactory->create();
|
|
}
|
|
}
|
|
|
|
class AnotherClass
|
|
{
|
|
public function __construct(StaticClass $staticClass)
|
|
{
|
|
$this->staticClass = $staticClass;
|
|
}
|
|
|
|
public function someFun()
|
|
{
|
|
return $this->staticClass->staticMethod();
|
|
}
|
|
}
|
|
|
|
final class AnotherClassFactory
|
|
{
|
|
/**
|
|
* @var StaticClass
|
|
*/
|
|
private $staticClass;
|
|
|
|
public function __construct(StaticClass $staticClass)
|
|
{
|
|
$this->staticClass = $staticClass;
|
|
}
|
|
|
|
public function create(): AnotherClass
|
|
{
|
|
return new AnotherClass($this->staticClass);
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, [self::TYPES_TO_SERVICES => ['StaticClass']])]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Stmt\Class_::class, \PhpParser\Node\Expr\StaticCall::class];
|
|
}
|
|
/**
|
|
* @param StaticCall|Class_ $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
if ($node instanceof \PhpParser\Node\Stmt\Class_) {
|
|
return $this->refactorClass($node);
|
|
}
|
|
foreach ($this->serviceObjectTypes as $serviceObjectType) {
|
|
if (!$this->isObjectType($node->class, $serviceObjectType)) {
|
|
continue;
|
|
}
|
|
// is this object created via new somewhere else? use factory!
|
|
$variableName = $this->propertyNaming->fqnToVariableName($serviceObjectType);
|
|
$thisPropertyFetch = new \PhpParser\Node\Expr\PropertyFetch(new \PhpParser\Node\Expr\Variable('this'), $variableName);
|
|
return new \PhpParser\Node\Expr\MethodCall($thisPropertyFetch, $node->name, $node->args);
|
|
}
|
|
return $node;
|
|
}
|
|
/**
|
|
* @param array<string, mixed[]> $configuration
|
|
*/
|
|
public function configure(array $configuration) : void
|
|
{
|
|
$typesToServices = $configuration[self::TYPES_TO_SERVICES] ?? [];
|
|
foreach ($typesToServices as $typeToService) {
|
|
$this->serviceObjectTypes[] = new \PHPStan\Type\ObjectType($typeToService);
|
|
}
|
|
}
|
|
private function refactorClass(\PhpParser\Node\Stmt\Class_ $class) : \PhpParser\Node\Stmt\Class_
|
|
{
|
|
$staticTypesInClass = $this->staticTypesInClassResolver->collectStaticCallTypeInClass($class, $this->serviceObjectTypes);
|
|
foreach ($staticTypesInClass as $staticTypeInClass) {
|
|
$variableName = $this->propertyNaming->fqnToVariableName($staticTypeInClass);
|
|
$propertyMetadata = new \Rector\PostRector\ValueObject\PropertyMetadata($variableName, $staticTypeInClass, \PhpParser\Node\Stmt\Class_::MODIFIER_PRIVATE);
|
|
$this->propertyToAddCollector->addPropertyToClass($class, $propertyMetadata);
|
|
// is this an object? create factory for it next to this :)
|
|
if ($this->uniqueObjectOrServiceDetector->isUniqueObject()) {
|
|
$factoryClass = $this->uniqueObjectFactoryFactory->createFactoryClass($class, $staticTypeInClass);
|
|
$this->factoryClassPrinter->printFactoryForClass($factoryClass, $class);
|
|
}
|
|
}
|
|
return $class;
|
|
}
|
|
}
|