/DowngradeMbStrContainsRector

Author: Arshid

rules-tests/DowngradePhp80/Rector/FuncCall/DowngradeMbStrContainsRector/DowngradeMbStrContainsRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class DowngradeMbStrContainsRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/DowngradePhp80/Rector/FuncCall/DowngradeMbStrContainsRector/Fixture/not_str_contains.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\Fixture;
+
+final class NoStrContains
+{
+    public function run()
+    {
+        return ! str_contains('abc', 'b');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\Fixture;
+
+final class NoStrContains
+{
+    public function run()
+    {
+        return mb_strpos('abc', 'b') === false;
+    }
+}
+
+?>

rules-tests/DowngradePhp80/Rector/FuncCall/DowngradeMbStrContainsRector/Fixture/str_contains.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\Fixture;
+
+final class StrContains
+{
+    public function run()
+    {
+        str_contains('abc', 'b');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\Fixture;
+
+final class StrContains
+{
+    public function run()
+    {
+        mb_strpos('abc', 'b') !== false;
+    }
+}
+
+?>

rules-tests/DowngradePhp80/Rector/FuncCall/DowngradeMbStrContainsRector/Fixture/str_contains.php_with_mixed.php.inc

@@ -0,0 +1,29 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\Fixture;
+
+final class StrContainsPhpWithMixed
+{
+    public function run($haystack, $needle)
+    {
+        str_contains($haystack, 'ab');
+        str_contains('abc', $needle);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\Fixture;
+
+final class StrContainsPhpWithMixed
+{
+    public function run($haystack, $needle)
+    {
+        mb_strpos($haystack, 'ab') !== false;
+        mb_strpos('abc', $needle) !== false;
+    }
+}
+
+?>

rules-tests/DowngradePhp80/Rector/FuncCall/DowngradeMbStrContainsRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(DowngradeMbStrContainsRector::class);
+};

rules/DowngradePhp80/Rector/FuncCall/DowngradeMbStrContainsRector.php

@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DowngradePhp80\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp\Identical;
+use PhpParser\Node\Expr\BinaryOp\NotIdentical;
+use PhpParser\Node\Expr\BooleanNot;
+use PhpParser\Node\Expr\FuncCall;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://wiki.php.net/rfc/str_contains
+ *
+ * @see \Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeMbStrContainsRector\DowngradeMbStrContainsRectorTest
+ */
+final class DowngradeMbStrContainsRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replace str_contains() with mb_strpos() !== false',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run()
+    {
+        return str_contains('abc', 'a');
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run()
+    {
+        return mb_strpos('abc', 'a') !== false;
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [FuncCall::class, BooleanNot::class];
+    }
+
+    /**
+     * @param FuncCall|BooleanNot $node
+     * @return Identical|NotIdentical|null The refactored node.
+     */
+    public function refactor(Node $node): Identical | NotIdentical | null
+    {
+        $funcCall = $this->matchStrContainsOrNotStrContains($node);
+
+        if (! $funcCall instanceof FuncCall) {
+            return null;
+        }
+
+        $args = $funcCall->getArgs();
+        if (count($args) < 2) {
+            return null;
+        }
+
+        $haystack = $args[0]->value;
+        $needle = $args[1]->value;
+
+        $funcCall = $this->nodeFactory->createFuncCall('mb_strpos', [$haystack, $needle]);
+
+        if ($node instanceof BooleanNot) {
+            return new Identical($funcCall, $this->nodeFactory->createFalse());
+        }
+
+        return new NotIdentical($funcCall, $this->nodeFactory->createFalse());
+    }
+
+    private function matchStrContainsOrNotStrContains(FuncCall | BooleanNot $expr): ?FuncCall
+    {
+        $expr = ($expr instanceof BooleanNot) ? $expr->expr : $expr;
+        if (! $expr instanceof FuncCall) {
+            return null;
+        }
+
+        if (! $this->isName($expr, 'str_contains')) {
+            return null;
+        }
+
+        return $expr;
+    }
+}