[CodeQuality] Create InArrayAndArrayKeysToArrayKeyExistsRector

config/level/code-quality/code-quality.yml

@@ -0,0 +1,2 @@
+services:
+    Rector\Rector\Contrib\CodeQuality\InArrayAndArrayKeysToArrayKeyExistsRector: ~

src/Rector/Contrib/CodeQuality/InArrayAndArrayKeysToArrayKeyExistsRector.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Rector\Contrib\CodeQuality;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Name;
+use Rector\Rector\AbstractRector;
+use Rector\RectorDefinition\CodeSample;
+use Rector\RectorDefinition\RectorDefinition;
+
+final class InArrayAndArrayKeysToArrayKeyExistsRector extends AbstractRector
+{
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition(
+            'Simplify in_array and array_keys functions combination into array_key_exists when array_keys has one argument only',
+            [
+                new CodeSample('in_array("key", array_keys($array), true);', 'array_key_exists("key", $array);'),
+            ]
+        );
+    }
+
+    public function isCandidate(Node $node): bool
+    {
+        if (! $node instanceof FuncCall) {
+            return false;
+        }
+
+        /** @var Name $funcCallName */
+        $funcCallName = $node->name;
+
+        if ($funcCallName->toString() !== 'in_array') {
+            return false;
+        }
+
+        $secondArgument = $node->args[1]->value;
+        if (! $secondArgument instanceof FuncCall) {
+            return false;
+        }
+
+        /** @var Name $functionName */
+        $functionName = $secondArgument->name;
+
+        if ($functionName->toString() !== 'array_keys') {
+            return false;
+        }
+
+        if (count($secondArgument->args) > 1) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * @param FuncCall $funcCall
+     */
+    public function refactor(Node $funcCall): ?Node
+    {
+        [$key, $array] = $funcCall->args;
+
+        $array = $array->value->args[0];
+
+        $funcCall->args = [
+            $key, $array,
+        ];
+
+        $funcCall->name = new Name('array_key_exists');
+
+        return $funcCall;
+    }
+}

tests/Rector/Contrib/CodeQuality/InArrayAndArrayKeysToArrayKeyExistsRector/Correct/correct.php.inc

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+final class MyClass
+{
+    public function hasKey(): bool
+    {
+        return !array_key_exists('key', [
+          'key' => ',',
+          1 => ';',
+        ]);
+    }
+
+    public function hasMoreThanOneArgument(): bool
+    {
+        return in_array('key', array_keys([
+          'key' => ',',
+          1 => ';',
+      ], 'key'));
+    }
+
+    public function resultIntoAVariable(): void
+    {
+        $array = ['foo', 'bar'];
+        $key = 'key';
+
+        $result = array_key_exists($key, $array);
+    }
+}

tests/Rector/Contrib/CodeQuality/InArrayAndArrayKeysToArrayKeyExistsRector/InArrayAndArrayKeysToArrayKeyExistsRectorTest.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Tests\Rector\Contrib\CodeQuality\InArrayAndArrayKeysToArrayKeyExistsRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+/**
+ * @covers \Rector\Rector\Contrib\CodeQuality\InArrayAndArrayKeysToArrayKeyExistsRector
+ */
+final class InArrayAndArrayKeysToArrayKeyExistsRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideWrongToFixedFiles()
+     */
+    public function test(string $wrong, string $fixed): void
+    {
+        $this->doTestFileMatchesExpectedContent($wrong, $fixed);
+    }
+
+    public function provideWrongToFixedFiles(): Iterator
+    {
+        yield [__DIR__ . '/Wrong/wrong.php.inc', __DIR__ . '/Correct/correct.php.inc'];
+    }
+
+    protected function provideConfig(): string
+    {
+        return __DIR__ . '/config.yml';
+    }
+}

tests/Rector/Contrib/CodeQuality/InArrayAndArrayKeysToArrayKeyExistsRector/Wrong/wrong.php.inc

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+final class MyClass
+{
+    public function hasKey(): bool
+    {
+        return !in_array('key', array_keys([
+          'key' => ',',
+          1 => ';',
+        ]));
+    }
+
+    public function hasMoreThanOneArgument(): bool
+    {
+        return in_array('key', array_keys([
+          'key' => ',',
+          1 => ';',
+      ], 'key'));
+    }
+
+    public function resultIntoAVariable(): void
+    {
+        $array = ['foo', 'bar'];
+        $key = 'key';
+
+        $result = in_array($key, array_keys($array), true);
+    }
+}

tests/Rector/Contrib/CodeQuality/InArrayAndArrayKeysToArrayKeyExistsRector/config.yml

@@ -0,0 +1,2 @@
+services:
+    Rector\Rector\Contrib\CodeQuality\InArrayAndArrayKeysToArrayKeyExistsRector: ~