[CodeQuality] Add CoalesceToTernaryRector

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/CoalesceToTernaryRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class CoalesceToTernaryRectorTest 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/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/non_nullable_left.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class NonNullableLeft
+{
+    public function run(string $name)
+    {
+        return $name ?? 'tom';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class NonNullableLeft
+{
+    public function run(string $name)
+    {
+        return $name ?: 'tom';
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_array_dim_fetch.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+final class SkipArrayDimFetch
+{
+    public function run(array $data)
+    {
+        return $data['key'] ?? 'test';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_docblock_based.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class SkipDocblockBased
+{
+    /**
+     * @param string $name
+     */
+    public function run($name)
+    {
+        return $name ?? 'tom';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_mixed_type.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class SkipMixedType
+{
+    public function run(mixed $name)
+    {
+        return $name ?? 'tom';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_not_defined.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class SkipNotDefined
+{
+    public function run()
+    {
+        return $name ?? 'tom';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_null_type.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class SkipNullType
+{
+    public function run(null $name)
+    {
+        return $name ?? 'tom';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_nullable_left.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class SkipNullableLeft
+{
+    public function run(?string $name)
+    {
+        return $name ?? 'tom';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/Fixture/skip_union_nullable_left.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\Fixture;
+
+class SkipUnionNullableLeft
+{
+    public function run(null|string $name)
+    {
+        return $name ?? 'tom';
+    }
+}

rules-tests/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withRules([CoalesceToTernaryRector::class]);

rules/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Coalesce;
+
+use PHPStan\Type\UnionType;
+use PHPStan\Type\NullType;
+use PhpParser\Node;
+use PhpParser\Node\Expr\ArrayDimFetch;
+use PhpParser\Node\Expr\BinaryOp\Coalesce;
+use PhpParser\Node\Expr\Ternary;
+use PHPStan\Type\ErrorType;
+use PHPStan\Type\MixedType;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Rector\PHPStan\ScopeFetcher;
+
+/**
+ * @see \Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\CoalesceToTernaryRectorTest
+ */
+final class CoalesceToTernaryRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replace coalesce to ternary when left side is non nullable',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+function run(string $a)
+{
+	return $a ?? 'foo';
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+function run(string $a)
+{
+	return $a ?: 'foo';
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Coalesce::class];
+    }
+
+    /**
+     * @param Coalesce $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        /**
+         * indexed data maybe false positive
+         */
+        if ($node->left instanceof ArrayDimFetch) {
+            return null;
+        }
+
+        /**
+         * Scope needs to use parent Coalesce to properly get type from left side of coalesce
+         */
+        $scope = ScopeFetcher::fetch($node);
+        $nativeType = $scope->getNativeType($node->left);
+
+        if ($nativeType instanceof ErrorType) {
+            return null;
+        }
+
+        if ($nativeType instanceof MixedType) {
+            return null;
+        }
+
+        if ($nativeType instanceof NullType) {
+            return null;
+        }
+
+        if ($nativeType instanceof UnionType) {
+            foreach ($nativeType->getTypes() as $unionedType) {
+                if ($unionedType instanceof NullType) {
+                    return null;
+                }
+            }
+        }
+
+        return new Ternary($node->left, null, $node->right);
+    }
+}