[NetteUtilsCodeQuality] Fixes #4686 Add SubstrMinusToStringEndsWithRector

rules/nette-code-quality/src/Rector/Identical/SubstrMinusToStringEndsWithRector.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\NetteCodeQuality\Rector\Identical;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp\Identical;
+use PhpParser\Node\Expr\BinaryOp\NotIdentical;
+use PhpParser\Node\Expr\BooleanNot;
+use PhpParser\Node\Expr\UnaryMinus;
+use PhpParser\Node\Scalar\LNumber;
+use PhpParser\Node\Scalar\String_;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\SubstrMinusToStringEndsWithRectorTest
+ */
+final class SubstrMinusToStringEndsWithRector extends AbstractRector
+{
+    /**
+     * @var string
+     */
+    private const SUBSTR = 'substr';
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change substr function with minus to Strings::endsWith()',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+substr($var, -4) !== 'Test';
+substr($var, -4) === 'Test';
+CODE_SAMPLE
+,
+                    <<<'CODE_SAMPLE'
+! \Nette\Utils\Strings::endsWith($var, 'Test');
+\Nette\Utils\Strings::endsWith($var, 'Test');
+CODE_SAMPLE
+                ),
+
+            ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [Identical::class, NotIdentical::class];
+    }
+
+    /**
+     * @param Identical|NotIdentical $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isFuncCallName($node->left, self::SUBSTR) && ! $this->isFuncCallName($node->right, self::SUBSTR)) {
+            return null;
+        }
+
+        $substr = $this->isFuncCallName($node->left, self::SUBSTR)
+            ? $node->left
+            : $node->right;
+
+        if (! $substr->args[1]->value instanceof UnaryMinus) {
+            return null;
+        }
+
+        /** @var UnaryMinus $unaryMinus */
+        $unaryMinus = $substr->args[1]->value;
+        if (! $unaryMinus->expr instanceof LNumber) {
+            return null;
+        }
+
+        $string = $this->isFuncCallName($node->left, self::SUBSTR)
+            ? $node->right
+            : $node->left;
+
+        $wordLength = $unaryMinus->expr->value;
+        if ($string instanceof String_ && strlen($string->value) !== $wordLength) {
+            return null;
+        }
+
+        $staticCall = $this->createStaticCall(Strings::class, 'endsWith', [$substr->args[0]->value, $string]);
+
+        if ($node instanceof Identical) {
+            return $staticCall;
+        }
+
+        return new BooleanNot($staticCall);
+    }
+}

rules/nette-code-quality/tests/Rector/Identical/SubstrMinusToStringEndsWithRector/Fixture/fixture.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function check($var)
+{
+    substr($var, -4) !== 'Test';
+    'Test' !== substr($var, -4);
+    substr($var, -4) === 'Test';
+    'Test' === substr($var, -4);
+}
+
+?>
+-----
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function check($var)
+{
+    !\Nette\Utils\Strings::endsWith($var, 'Test');
+    !\Nette\Utils\Strings::endsWith($var, 'Test');
+    \Nette\Utils\Strings::endsWith($var, 'Test');
+    \Nette\Utils\Strings::endsWith($var, 'Test');
+}
+
+?>

rules/nette-code-quality/tests/Rector/Identical/SubstrMinusToStringEndsWithRector/Fixture/inside_if.php.inc

@@ -0,0 +1,49 @@
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function insideIf($var)
+{
+    if (substr($var, -4) !== 'Test') {
+
+    }
+
+    if ('Test' !== substr($var, -4)) {
+
+    }
+
+    if (substr($var, -4) === 'Test') {
+
+    }
+
+    if ('Test' === substr($var, -4)) {
+
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function insideIf($var)
+{
+    if (!\Nette\Utils\Strings::endsWith($var, 'Test')) {
+
+    }
+
+    if (!\Nette\Utils\Strings::endsWith($var, 'Test')) {
+
+    }
+
+    if (\Nette\Utils\Strings::endsWith($var, 'Test')) {
+
+    }
+
+    if (\Nette\Utils\Strings::endsWith($var, 'Test')) {
+
+    }
+}
+
+?>

rules/nette-code-quality/tests/Rector/Identical/SubstrMinusToStringEndsWithRector/Fixture/skip_different_length.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function skipDifferentLength($var)
+{
+    'part' !== substr($var, -3);
+}
+
+?>

rules/nette-code-quality/tests/Rector/Identical/SubstrMinusToStringEndsWithRector/Fixture/skip_not_substr.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function skipNotSustr($var)
+{
+    strlen($var) === 5;
+}
+
+?>

rules/nette-code-quality/tests/Rector/Identical/SubstrMinusToStringEndsWithRector/Fixture/with_var_value.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function withVarValue($var, $value)
+{
+    substr($var, -4) !== $value;
+    $value !== substr($var, -4);
+    substr($var, -4) === $value;
+    $value === substr($var, -4);
+}
+
+?>
+-----
+<?php
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector\Fixture;
+
+function withVarValue($var, $value)
+{
+    !\Nette\Utils\Strings::endsWith($var, $value);
+    !\Nette\Utils\Strings::endsWith($var, $value);
+    \Nette\Utils\Strings::endsWith($var, $value);
+    \Nette\Utils\Strings::endsWith($var, $value);
+}
+
+?>

rules/nette-code-quality/tests/Rector/Identical/SubstrMinusToStringEndsWithRector/SubstrMinusToStringEndsWithRectorTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\NetteCodeQuality\Tests\Rector\Identical\SubstrMinusToStringEndsWithRector;
+
+use Iterator;
+use Rector\NetteCodeQuality\Rector\Identical\SubstrMinusToStringEndsWithRector;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class SubstrMinusToStringEndsWithRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    protected function getRectorClass(): string
+    {
+        return SubstrMinusToStringEndsWithRector::class;
+    }
+}