2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
2021-05-09 20:15:43 +00:00
|
|
|
declare (strict_types=1);
|
2022-06-06 17:12:56 +00:00
|
|
|
namespace Rector\CodeQuality\Rector\NotEqual;
|
2019-02-19 17:26:22 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Expr\BinaryOp\NotEqual;
|
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\Rector\AbstractRector;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2019-02-19 17:26:22 +00:00
|
|
|
/**
|
2021-04-10 18:47:17 +00:00
|
|
|
* @changelog https://stackoverflow.com/a/4294663/1348344
|
2021-03-12 22:20:25 +00:00
|
|
|
* @see \Rector\Tests\CodeQuality\Rector\NotEqual\CommonNotEqualRector\CommonNotEqualRectorTest
|
2019-02-19 17:26:22 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class CommonNotEqualRector extends AbstractRector
|
2019-02-19 17:26:22 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2019-02-19 17:26:22 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Use common != instead of less known <> with same meaning', [new CodeSample(<<<'CODE_SAMPLE'
|
2019-02-19 17:26:22 +00:00
|
|
|
final class SomeClass
|
|
|
|
{
|
|
|
|
public function run($one, $two)
|
|
|
|
{
|
|
|
|
return $one <> $two;
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2019-02-19 17:26:22 +00:00
|
|
|
final class SomeClass
|
|
|
|
{
|
|
|
|
public function run($one, $two)
|
|
|
|
{
|
|
|
|
return $one != $two;
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
)]);
|
2019-02-19 17:26:22 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2019-02-19 17:26:22 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2019-02-19 17:26:22 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return [NotEqual::class];
|
2019-02-19 17:26:22 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param NotEqual $node
|
2019-02-19 17:26:22 +00:00
|
|
|
*/
|
2023-11-27 16:03:30 +00:00
|
|
|
public function refactor(Node $node) : ?NotEqual
|
2019-02-19 17:26:22 +00:00
|
|
|
{
|
2023-11-27 16:03:30 +00:00
|
|
|
if (!$this->doesNotEqualContainsShipCompareToken($node)) {
|
|
|
|
return null;
|
|
|
|
}
|
2019-02-19 17:26:22 +00:00
|
|
|
// invoke override to default "!="
|
2022-06-07 08:22:29 +00:00
|
|
|
$node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
|
2019-02-19 17:26:22 +00:00
|
|
|
return $node;
|
|
|
|
}
|
2023-11-27 16:03:30 +00:00
|
|
|
private function doesNotEqualContainsShipCompareToken(NotEqual $notEqual) : bool
|
|
|
|
{
|
|
|
|
$tokenStartPos = $notEqual->getStartTokenPos();
|
|
|
|
$tokenEndPos = $notEqual->getEndTokenPos();
|
|
|
|
for ($i = $tokenStartPos; $i < $tokenEndPos; ++$i) {
|
|
|
|
$token = $this->file->getOldTokens()[$i];
|
|
|
|
if (!isset($token[1])) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
if ($token[1] === '<>') {
|
|
|
|
return \true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return \false;
|
|
|
|
}
|
2019-02-19 17:26:22 +00:00
|
|
|
}
|