mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-07 11:50:51 +00:00
156 lines
4.5 KiB
PHP
156 lines
4.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Rector\Php80\Rector\Identical;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Expr\BinaryOp;
|
|
use PhpParser\Node\Expr\BinaryOp\Identical;
|
|
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
|
|
use PhpParser\Node\Expr\BooleanNot;
|
|
use PhpParser\Node\Expr\FuncCall;
|
|
use PhpParser\Node\Expr\UnaryMinus;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Nette\NodeAnalyzer\BinaryOpAnalyzer;
|
|
use Rector\Nette\ValueObject\FuncCallAndExpr;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
|
|
/**
|
|
* @changelog https://wiki.php.net/rfc/add_str_starts_with_and_ends_with_functions
|
|
*
|
|
* @see \Rector\Tests\Php80\Rector\Identical\StrEndsWithRector\StrEndsWithRectorTest
|
|
*/
|
|
final class StrEndsWithRector extends AbstractRector
|
|
{
|
|
public function __construct(
|
|
private BinaryOpAnalyzer $binaryOpAnalyzer
|
|
) {
|
|
}
|
|
|
|
public function getRuleDefinition(): RuleDefinition
|
|
{
|
|
return new RuleDefinition('Change helper functions to str_ends_with()', [
|
|
new CodeSample(
|
|
<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
$isMatch = substr($haystack, -strlen($needle)) === $needle;
|
|
|
|
$isNotMatch = substr($haystack, -strlen($needle)) !== $needle;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
,
|
|
<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
$isMatch = str_ends_with($haystack, $needle);
|
|
|
|
$isNotMatch = !str_ends_with($haystack, $needle);
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes(): array
|
|
{
|
|
return [Identical::class, NotIdentical::class];
|
|
}
|
|
|
|
/**
|
|
* @param Identical|NotIdentical $node
|
|
*/
|
|
public function refactor(Node $node): ?Node
|
|
{
|
|
return $this->refactorSubstr($node) ?? $this->refactorSubstrCompare($node);
|
|
}
|
|
|
|
/**
|
|
* Covers:
|
|
* $isMatch = substr($haystack, -strlen($needle)) === $needle;
|
|
*/
|
|
private function refactorSubstr(BinaryOp $binaryOp): FuncCall | BooleanNot | null
|
|
{
|
|
if ($binaryOp->left instanceof FuncCall && $this->isName($binaryOp->left, 'substr')) {
|
|
$substrFuncCall = $binaryOp->left;
|
|
$comparedNeedleExpr = $binaryOp->right;
|
|
} elseif ($binaryOp->right instanceof FuncCall && $this->isName($binaryOp->right, 'substr')) {
|
|
$substrFuncCall = $binaryOp->right;
|
|
$comparedNeedleExpr = $binaryOp->left;
|
|
} else {
|
|
return null;
|
|
}
|
|
|
|
$haystack = $substrFuncCall->args[0]->value;
|
|
|
|
$needle = $this->matchUnaryMinusStrlenFuncCallArgValue($substrFuncCall->args[1]->value);
|
|
if (! $this->nodeComparator->areNodesEqual($needle, $comparedNeedleExpr)) {
|
|
return null;
|
|
}
|
|
|
|
$endsWithNode = $this->nodeFactory->createFuncCall('str_ends_with', [$haystack, $needle]);
|
|
|
|
if ($binaryOp instanceof NotIdentical) {
|
|
return new BooleanNot($endsWithNode);
|
|
}
|
|
|
|
return $endsWithNode;
|
|
}
|
|
|
|
private function refactorSubstrCompare(BinaryOp $binaryOp): ?FuncCall
|
|
{
|
|
$funcCallAndExpr = $this->binaryOpAnalyzer->matchFuncCallAndOtherExpr($binaryOp, 'substr_compare');
|
|
if (! $funcCallAndExpr instanceof FuncCallAndExpr) {
|
|
return null;
|
|
}
|
|
|
|
$expr = $funcCallAndExpr->getExpr();
|
|
if (! $this->valueResolver->isValue($expr, 0)) {
|
|
return null;
|
|
}
|
|
|
|
$substrCompareFuncCall = $funcCallAndExpr->getFuncCall();
|
|
$haystack = $substrCompareFuncCall->args[0]->value;
|
|
$needle = $substrCompareFuncCall->args[1]->value;
|
|
|
|
$comparedNeedleExpr = $this->matchUnaryMinusStrlenFuncCallArgValue($substrCompareFuncCall->args[2]->value);
|
|
if (! $this->nodeComparator->areNodesEqual($needle, $comparedNeedleExpr)) {
|
|
return null;
|
|
}
|
|
|
|
return $this->nodeFactory->createFuncCall('str_ends_with', [$haystack, $needle]);
|
|
}
|
|
|
|
private function matchUnaryMinusStrlenFuncCallArgValue(Node $node): ?Expr
|
|
{
|
|
if (! $node instanceof UnaryMinus) {
|
|
return null;
|
|
}
|
|
|
|
if (! $node->expr instanceof FuncCall) {
|
|
return null;
|
|
}
|
|
|
|
if (! $this->nodeNameResolver->isName($node->expr, 'strlen')) {
|
|
return null;
|
|
}
|
|
|
|
/** @var FuncCall $funcCall */
|
|
$funcCall = $node->expr;
|
|
|
|
return $funcCall->args[0]->value;
|
|
}
|
|
}
|