mirror of https://github.com/rectorphp/rector.git
99 lines
2.8 KiB
PHP
99 lines
2.8 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Transform\Rector\ClassMethod;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Expr\Array_;
|
|
use PhpParser\Node\Expr\ArrayItem;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
use PhpParser\Node\Stmt\Return_;
|
|
use Rector\Contract\Rector\ConfigurableRectorInterface;
|
|
use Rector\Rector\AbstractRector;
|
|
use Rector\Transform\ValueObject\WrapReturn;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
use RectorPrefix202403\Webmozart\Assert\Assert;
|
|
/**
|
|
* @see \Rector\Tests\Transform\Rector\ClassMethod\WrapReturnRector\WrapReturnRectorTest
|
|
*/
|
|
final class WrapReturnRector extends AbstractRector implements ConfigurableRectorInterface
|
|
{
|
|
/**
|
|
* @var WrapReturn[]
|
|
*/
|
|
private $typeMethodWraps = [];
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Wrap return value of specific method', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
|
final class SomeClass
|
|
{
|
|
public function getItem()
|
|
{
|
|
return 1;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
final class SomeClass
|
|
{
|
|
public function getItem()
|
|
{
|
|
return [1];
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, [new WrapReturn('SomeClass', 'getItem', \true)])]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [ClassMethod::class];
|
|
}
|
|
/**
|
|
* @param ClassMethod $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
foreach ($this->typeMethodWraps as $typeMethodWrap) {
|
|
if (!$this->isName($node, $typeMethodWrap->getMethod())) {
|
|
continue;
|
|
}
|
|
if (!$this->isObjectType($node, $typeMethodWrap->getObjectType())) {
|
|
continue;
|
|
}
|
|
if ($node->stmts === null) {
|
|
continue;
|
|
}
|
|
return $this->wrap($node, $typeMethodWrap->isArrayWrap());
|
|
}
|
|
return null;
|
|
}
|
|
/**
|
|
* @param mixed[] $configuration
|
|
*/
|
|
public function configure(array $configuration) : void
|
|
{
|
|
Assert::allIsAOf($configuration, WrapReturn::class);
|
|
$this->typeMethodWraps = $configuration;
|
|
}
|
|
private function wrap(ClassMethod $classMethod, bool $isArrayWrap) : ?ClassMethod
|
|
{
|
|
if (!\is_iterable($classMethod->stmts)) {
|
|
return null;
|
|
}
|
|
foreach ($classMethod->stmts as $key => $stmt) {
|
|
if ($stmt instanceof Return_ && $stmt->expr instanceof Expr) {
|
|
if ($isArrayWrap && !$stmt->expr instanceof Array_) {
|
|
$stmt->expr = new Array_([new ArrayItem($stmt->expr)]);
|
|
}
|
|
$classMethod->stmts[$key] = $stmt;
|
|
}
|
|
}
|
|
return $classMethod;
|
|
}
|
|
}
|