mirror of https://github.com/rectorphp/rector.git
123 lines
3.9 KiB
PHP
123 lines
3.9 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Naming\Rector\Foreach_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr\Variable;
|
|
use PhpParser\Node\Stmt\Foreach_;
|
|
use Rector\CodeQuality\NodeAnalyzer\ForeachAnalyzer;
|
|
use Rector\Core\NodeAnalyzer\PropertyFetchAnalyzer;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Naming\ExpectedNameResolver\InflectorSingularResolver;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\Naming\Rector\Foreach_\RenameForeachValueVariableToMatchExprVariableRector\RenameForeachValueVariableToMatchExprVariableRectorTest
|
|
*/
|
|
final class RenameForeachValueVariableToMatchExprVariableRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Naming\ExpectedNameResolver\InflectorSingularResolver
|
|
*/
|
|
private $inflectorSingularResolver;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\CodeQuality\NodeAnalyzer\ForeachAnalyzer
|
|
*/
|
|
private $foreachAnalyzer;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\NodeAnalyzer\PropertyFetchAnalyzer
|
|
*/
|
|
private $propertyFetchAnalyzer;
|
|
public function __construct(InflectorSingularResolver $inflectorSingularResolver, ForeachAnalyzer $foreachAnalyzer, PropertyFetchAnalyzer $propertyFetchAnalyzer)
|
|
{
|
|
$this->inflectorSingularResolver = $inflectorSingularResolver;
|
|
$this->foreachAnalyzer = $foreachAnalyzer;
|
|
$this->propertyFetchAnalyzer = $propertyFetchAnalyzer;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Renames value variable name in foreach loop to match expression variable', [new CodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
$array = [];
|
|
foreach ($variables as $property) {
|
|
$array[] = $property;
|
|
}
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
$array = [];
|
|
foreach ($variables as $variable) {
|
|
$array[] = $variable;
|
|
}
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [Foreach_::class];
|
|
}
|
|
/**
|
|
* @param Foreach_ $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
$isPropertyFetch = $this->propertyFetchAnalyzer->isLocalPropertyFetch($node->expr);
|
|
if (!$node->expr instanceof Variable && !$isPropertyFetch) {
|
|
return null;
|
|
}
|
|
$exprName = $this->getName($node->expr);
|
|
if ($exprName === null) {
|
|
return null;
|
|
}
|
|
if ($node->keyVar instanceof Node) {
|
|
return null;
|
|
}
|
|
$valueVarName = $this->getName($node->valueVar);
|
|
if ($valueVarName === null) {
|
|
return null;
|
|
}
|
|
$singularValueVarName = $this->inflectorSingularResolver->resolve($exprName);
|
|
if ($singularValueVarName === $exprName) {
|
|
return null;
|
|
}
|
|
if ($singularValueVarName === $valueVarName) {
|
|
return null;
|
|
}
|
|
if ($this->foreachAnalyzer->isValueVarUsed($node, $singularValueVarName)) {
|
|
return null;
|
|
}
|
|
return $this->processRename($node, $valueVarName, $singularValueVarName);
|
|
}
|
|
private function processRename(Foreach_ $foreach, string $valueVarName, string $singularValueVarName) : Foreach_
|
|
{
|
|
$foreach->valueVar = new Variable($singularValueVarName);
|
|
$this->traverseNodesWithCallable($foreach->stmts, function (Node $node) use($singularValueVarName, $valueVarName) : ?Variable {
|
|
if (!$node instanceof Variable) {
|
|
return null;
|
|
}
|
|
if (!$this->isName($node, $valueVarName)) {
|
|
return null;
|
|
}
|
|
return new Variable($singularValueVarName);
|
|
});
|
|
return $foreach;
|
|
}
|
|
}
|