rector/rules/CodeQuality/Rector/Ternary/ArrayKeyExistsTernaryThenVa...

108 lines
3.0 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\CodeQuality\Rector\Ternary;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\ArrayDimFetch;
use PhpParser\Node\Expr\BinaryOp\Coalesce;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\Ternary;
use Rector\PhpParser\Node\Value\ValueResolver;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://3v4l.org/f7itn
*
* @see \Rector\Tests\CodeQuality\Rector\Ternary\ArrayKeyExistsTernaryThenValueToCoalescingRector\ArrayKeyExistsTernaryThenValueToCoalescingRectorTest
*/
final class ArrayKeyExistsTernaryThenValueToCoalescingRector extends AbstractRector
{
/**
* @readonly
* @var \Rector\PhpParser\Node\Value\ValueResolver
*/
private $valueResolver;
public function __construct(ValueResolver $valueResolver)
{
$this->valueResolver = $valueResolver;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Change array_key_exists() ternary to coalescing', [new CodeSample(<<<'CODE_SAMPLE'
class SomeClass
{
public function run($values, $keyToMatch)
{
$result = array_key_exists($keyToMatch, $values) ? $values[$keyToMatch] : null;
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass
{
public function run($values, $keyToMatch)
{
$result = $values[$keyToMatch] ?? null;
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Ternary::class];
}
/**
* @param Ternary $node
*/
public function refactor(Node $node) : ?Node
{
if (!$node->cond instanceof FuncCall) {
return null;
}
if (!$this->isName($node->cond, 'array_key_exists')) {
return null;
}
if (!$node->if instanceof ArrayDimFetch) {
return null;
}
if (!$this->areArrayKeysExistsArgsMatchingDimFetch($node->cond, $node->if)) {
return null;
}
if (!$this->valueResolver->isNull($node->else)) {
return null;
}
return new Coalesce($node->if, $node->else);
}
/**
* Equals if:
*
* array_key_exists($key, $values);
* =
* $values[$key]
*/
private function areArrayKeysExistsArgsMatchingDimFetch(FuncCall $funcCall, ArrayDimFetch $arrayDimFetch) : bool
{
$firstArg = $funcCall->args[0];
if (!$firstArg instanceof Arg) {
return \false;
}
$keyExpr = $firstArg->value;
$secondArg = $funcCall->args[1];
if (!$secondArg instanceof Arg) {
return \false;
}
$valuesExpr = $secondArg->value;
if (!$this->nodeComparator->areNodesEqual($arrayDimFetch->var, $valuesExpr)) {
return \false;
}
return $this->nodeComparator->areNodesEqual($arrayDimFetch->dim, $keyExpr);
}
}