2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
2018-10-10 15:51:14 +00:00
|
|
|
|
2019-09-22 18:57:03 +00:00
|
|
|
namespace Rector\Php73\Rector\FuncCall;
|
2018-10-10 15:51:14 +00:00
|
|
|
|
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Expr\FuncCall;
|
|
|
|
use PhpParser\Node\Name;
|
2021-03-03 21:28:27 +00:00
|
|
|
use PhpParser\Node\Stmt\Expression;
|
2021-02-28 07:47:48 +00:00
|
|
|
use PHPStan\Reflection\ReflectionProvider;
|
2020-02-06 21:48:18 +00:00
|
|
|
use Rector\Core\Rector\AbstractRector;
|
|
|
|
use Rector\Core\ValueObject\PhpVersionFeature;
|
2021-03-03 21:28:27 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2018-10-10 15:51:14 +00:00
|
|
|
|
|
|
|
/**
|
2021-02-13 23:36:53 +00:00
|
|
|
* @see https://tomasvotruba.com/blog/2018/08/16/whats-new-in-php-73-in-30-seconds-in-diffs/#2-first-and-last-array-key
|
2018-10-10 15:51:14 +00:00
|
|
|
*
|
|
|
|
* This needs to removed 1 floor above, because only nodes in arrays can be removed why traversing,
|
|
|
|
* see https://github.com/nikic/PHP-Parser/issues/389
|
2021-02-28 07:47:48 +00:00
|
|
|
*
|
2019-09-23 11:43:13 +00:00
|
|
|
* @see \Rector\Php73\Tests\Rector\FuncCall\ArrayKeyFirstLastRector\ArrayKeyFirstLastRectorTest
|
2018-10-10 15:51:14 +00:00
|
|
|
*/
|
|
|
|
final class ArrayKeyFirstLastRector extends AbstractRector
|
|
|
|
{
|
2019-07-02 16:04:54 +00:00
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
private const ARRAY_KEY_FIRST = 'array_key_first';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
private const ARRAY_KEY_LAST = 'array_key_last';
|
|
|
|
|
2018-10-10 15:51:14 +00:00
|
|
|
/**
|
2020-09-01 17:56:30 +00:00
|
|
|
* @var array<string, string>
|
2018-10-10 15:51:14 +00:00
|
|
|
*/
|
2020-02-18 22:09:25 +00:00
|
|
|
private const PREVIOUS_TO_NEW_FUNCTIONS = [
|
2019-07-02 16:04:54 +00:00
|
|
|
'reset' => self::ARRAY_KEY_FIRST,
|
|
|
|
'end' => self::ARRAY_KEY_LAST,
|
2018-10-10 15:51:14 +00:00
|
|
|
];
|
|
|
|
|
2021-02-28 07:47:48 +00:00
|
|
|
/**
|
|
|
|
* @var ReflectionProvider
|
|
|
|
*/
|
|
|
|
private $reflectionProvider;
|
|
|
|
|
|
|
|
public function __construct(ReflectionProvider $reflectionProvider)
|
|
|
|
{
|
|
|
|
$this->reflectionProvider = $reflectionProvider;
|
|
|
|
}
|
|
|
|
|
2020-11-16 17:50:38 +00:00
|
|
|
public function getRuleDefinition(): RuleDefinition
|
2018-10-10 15:51:14 +00:00
|
|
|
{
|
2020-11-16 17:50:38 +00:00
|
|
|
return new RuleDefinition(
|
2018-10-10 15:51:14 +00:00
|
|
|
'Make use of array_key_first() and array_key_last()',
|
|
|
|
[
|
|
|
|
new CodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-10 15:51:14 +00:00
|
|
|
reset($items);
|
|
|
|
$firstKey = key($items);
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-10 15:51:14 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-10 15:51:14 +00:00
|
|
|
$firstKey = array_key_first($items);
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-10 15:51:14 +00:00
|
|
|
),
|
|
|
|
new CodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-10 15:51:14 +00:00
|
|
|
end($items);
|
|
|
|
$lastKey = key($items);
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-10 15:51:14 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-10 15:51:14 +00:00
|
|
|
$lastKey = array_key_last($items);
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-10 15:51:14 +00:00
|
|
|
),
|
|
|
|
|
|
|
|
]
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2018-10-10 15:51:14 +00:00
|
|
|
*/
|
|
|
|
public function getNodeTypes(): array
|
|
|
|
{
|
2018-10-22 15:53:21 +00:00
|
|
|
return [FuncCall::class];
|
2018-10-10 15:51:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-10-22 15:53:21 +00:00
|
|
|
* @param FuncCall $node
|
2018-10-10 15:51:14 +00:00
|
|
|
*/
|
2018-10-15 04:36:58 +00:00
|
|
|
public function refactor(Node $node): ?Node
|
2018-10-10 15:51:14 +00:00
|
|
|
{
|
2019-07-02 16:04:54 +00:00
|
|
|
if ($this->shouldSkip($node)) {
|
2018-10-22 15:53:21 +00:00
|
|
|
return null;
|
2018-10-10 15:51:14 +00:00
|
|
|
}
|
|
|
|
|
2019-02-23 09:11:01 +00:00
|
|
|
$nextExpression = $this->getNextExpression($node);
|
2021-01-20 11:41:35 +00:00
|
|
|
if (! $nextExpression instanceof Node) {
|
2018-10-22 15:53:21 +00:00
|
|
|
return null;
|
2018-10-10 15:51:14 +00:00
|
|
|
}
|
|
|
|
|
2019-02-23 09:11:01 +00:00
|
|
|
$resetOrEndFuncCall = $node;
|
2018-10-10 15:51:14 +00:00
|
|
|
|
2019-02-23 09:11:01 +00:00
|
|
|
$keyFuncCall = $this->betterNodeFinder->findFirst($nextExpression, function (Node $node) use (
|
|
|
|
$resetOrEndFuncCall
|
2019-05-09 13:30:39 +00:00
|
|
|
): bool {
|
2019-02-23 09:11:01 +00:00
|
|
|
if (! $node instanceof FuncCall) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (! $this->isName($node, 'key')) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2021-02-19 12:01:23 +00:00
|
|
|
return $this->nodeComparator->areNodesEqual($resetOrEndFuncCall->args[0], $node->args[0]);
|
2019-02-23 09:11:01 +00:00
|
|
|
});
|
2018-10-10 15:51:14 +00:00
|
|
|
|
2021-01-19 11:24:48 +00:00
|
|
|
if (! $keyFuncCall instanceof FuncCall) {
|
2018-10-22 15:53:21 +00:00
|
|
|
return null;
|
2018-10-10 15:51:14 +00:00
|
|
|
}
|
|
|
|
|
2020-02-18 22:09:25 +00:00
|
|
|
$newName = self::PREVIOUS_TO_NEW_FUNCTIONS[$this->getName($node)];
|
2019-02-23 09:11:01 +00:00
|
|
|
$keyFuncCall->name = new Name($newName);
|
2018-10-10 15:51:14 +00:00
|
|
|
|
2019-02-23 09:11:01 +00:00
|
|
|
$this->removeNode($node);
|
2018-10-10 15:51:14 +00:00
|
|
|
|
2018-10-22 15:53:21 +00:00
|
|
|
return $node;
|
2018-10-10 15:51:14 +00:00
|
|
|
}
|
2019-02-23 09:11:01 +00:00
|
|
|
|
2019-07-02 16:04:54 +00:00
|
|
|
private function shouldSkip(FuncCall $funcCall): bool
|
|
|
|
{
|
2019-12-26 13:31:04 +00:00
|
|
|
if (! $this->isNames($funcCall, ['reset', 'end'])) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->isAtLeastPhpVersion(PhpVersionFeature::ARRAY_KEY_FIRST_LAST)) {
|
2019-07-02 16:04:54 +00:00
|
|
|
return false;
|
|
|
|
}
|
2021-02-28 07:47:48 +00:00
|
|
|
|
|
|
|
if (! $this->reflectionProvider->hasFunction(new Name(self::ARRAY_KEY_FIRST), null)) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return ! $this->reflectionProvider->hasFunction(new Name(self::ARRAY_KEY_LAST), null);
|
2019-07-02 16:04:54 +00:00
|
|
|
}
|
2021-03-03 21:28:27 +00:00
|
|
|
|
|
|
|
private function getNextExpression(FuncCall $funcCall): ?Node
|
|
|
|
{
|
|
|
|
$currentExpression = $funcCall->getAttribute(AttributeKey::CURRENT_STATEMENT);
|
|
|
|
if (! $currentExpression instanceof Expression) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $currentExpression->getAttribute(AttributeKey::NEXT_NODE);
|
|
|
|
}
|
2018-10-10 15:51:14 +00:00
|
|
|
}
|