[Php74] Add ParenthesizeNestedTernaryRector (#2859)

* [Php74] Add ParenthesizeNestedTernaryRector

* phpstan

* [ci-review] Rector Rectify

* verify from parent

* different fixture files for detection

* phpstan

* more explanation

* more explanation

* rename fixture

* more explanation

* clean up comment

* regenerate docs

Co-authored-by: GitHub Action <action@github.com>

build/target-repository/docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 400 Rules Overview
+# 401 Rules Overview
 
 <br>
 
@@ -44,7 +44,7 @@
 
 - [Php73](#php73) (9)
 
-- [Php74](#php74) (14)
+- [Php74](#php74) (15)
 
 - [Php80](#php80) (19)
 
@@ -5694,6 +5694,19 @@ Use null coalescing operator ??=
 
 <br>
 
+### ParenthesizeNestedTernaryRector
+
+Add parentheses to nested ternary
+
+- class: [`Rector\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector`](../rules/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector.php)
+
+```diff
+-$value = $a ? $b : $a ?: null;
++$value = ($a ? $b : $a) ?: null;
+```
+
+<br>
+
 ### RealToFloatTypeCastRector
 
 Change deprecated (real) to (float)

config/set/php74.php

@@ -17,6 +17,7 @@
 use Rector\Php74\Rector\Property\RestoreDefaultNullToNullableTypePropertyRector;
 use Rector\Php74\Rector\Property\TypedPropertyRector;
 use Rector\Php74\Rector\StaticCall\ExportToReflectionFunctionRector;
+use Rector\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector;
 use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -58,4 +59,6 @@
     $rectorConfig->rule(CurlyToSquareBracketArrayStringRector::class);
 
     $rectorConfig->rule(MoneyFormatToNumberFormatRector::class);
+
+    $rectorConfig->rule(ParenthesizeNestedTernaryRector::class);
 };

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/Fixture/fixture.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\Fixture;
+
+function nestedTernaryNoParentheses()
+{
+  $a = 1;
+  $b = 2;
+  $c = 3;
+
+  $value = $a ? $b : $a ?: null;
+  $value = $a ? $b : $a ? $c : null;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\Fixture;
+
+function nestedTernaryNoParentheses()
+{
+  $a = 1;
+  $b = 2;
+  $c = 3;
+
+  $value = ($a ? $b : $a) ?: null;
+  $value = ($a ? $b : $a) ? $c : null;
+}
+
+?>

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/Fixture/skip_nested_ternary_parenthesized.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\Fixture;
+
+function SkipNestedTernaryParenthesized()
+{
+  $a = 1;
+  $b = 2;
+
+  $value = ($a ? $b : $a) ?: null;
+}

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/Fixture/skip_nested_ternary_parenthesized_else.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\Fixture;
+
+function SkipNestedTernaryParenthesizedElse()
+{
+  1 ? 2 : (3 ? 4 : 5);
+}

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/Fixture/skip_nested_ternary_parenthesized_if.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\Fixture;
+
+function SkipNestedTernaryParenthesizedIf()
+{
+  (1 ? 2 : 3) ? 4 : 5;
+}

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/Fixture/skip_not_nested_ternary.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\Fixture;
+
+function skipNotNestedTernary()
+{
+  $a = 1;
+  $b = 2;
+
+  $value = $a ? $b : $a;
+}

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/ParenthesizeNestedTernaryRectorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class ParenthesizeNestedTernaryRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector/config/configured_rule.php

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

rules/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php74\Rector\Ternary;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Ternary;
+use Rector\Core\Rector\AbstractRector;
+use Rector\Core\ValueObject\PhpVersionFeature;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\Php74\Tokenizer\ParenthesizedNestedTernaryAnalyzer;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://www.php.net/manual/en/migration74.deprecated.php
+ * @changelog https://3v4l.org/vhdlJ
+ * @see \Rector\Tests\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector\ParenthesizeNestedTernaryRectorTest
+ */
+final class ParenthesizeNestedTernaryRector extends AbstractRector implements MinPhpVersionInterface
+{
+    public function __construct(private readonly ParenthesizedNestedTernaryAnalyzer $parenthesizedNestedTernaryAnalyzer)
+    {
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::DEPRECATE_NESTED_TERNARY;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add parentheses to nested ternary',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+$value = $a ? $b : $a ?: null;
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+$value = ($a ? $b : $a) ?: null;
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Ternary::class];
+    }
+
+    /**
+     * @param Ternary $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $parentNode = $node->getAttribute(AttributeKey::PARENT_NODE);
+
+        if (! $parentNode instanceof Ternary) {
+            return null;
+        }
+
+        if ($this->parenthesizedNestedTernaryAnalyzer->isParenthesized($this->file, $parentNode)) {
+            return null;
+        }
+
+        $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
+        return $node;
+    }
+}

rules/Php74/Tokenizer/ParenthesizedNestedTernaryAnalyzer.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php74\Tokenizer;
+
+use PhpParser\Node\Expr\Ternary;
+use Rector\Core\ValueObject\Application\File;
+
+final class ParenthesizedNestedTernaryAnalyzer
+{
+    public function isParenthesized(File $file, Ternary $ternary): bool
+    {
+        $oldTokens = $file->getOldTokens();
+        $startTokenPos = $ternary->getStartTokenPos();
+
+        return isset($oldTokens[$startTokenPos]) && $oldTokens[$startTokenPos] === '(';
+    }
+}

src/ValueObject/PhpVersionFeature.php

@@ -398,6 +398,11 @@ final class PhpVersionFeature
      */
     public const EXPORT_TO_REFLECTION_FUNCTION = PhpVersion::PHP_74;
 
+    /**
+     * @var int
+     */
+    public const DEPRECATE_NESTED_TERNARY = PhpVersion::PHP_74;
+
     /**
      * @var int
      */