[CodeQuality] Add NumberCompareToMaxFuncCallRector (#4914)

build/target-repository/docs/rector_rules_overview.md

@@ -1,12 +1,12 @@
-# 353 Rules Overview
+# 355 Rules Overview
 
 <br>
 
 ## Categories
 
 - [Arguments](#arguments) (4)
 
-- [CodeQuality](#codequality) (70)
+- [CodeQuality](#codequality) (71)
 
 - [CodingStyle](#codingstyle) (30)
 
@@ -54,7 +54,7 @@
 
 - [Transform](#transform) (22)
 
-- [TypeDeclaration](#typedeclaration) (41)
+- [TypeDeclaration](#typedeclaration) (42)
 
 - [Visibility](#visibility) (3)
 
@@ -862,6 +862,25 @@ Change unsafe new `static()` to new `self()`
 
 <br>
 
+### NumberCompareToMaxFuncCallRector
+
+Ternary number compare to `max()` call
+
+- class: [`Rector\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector`](../rules/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector.php)
+
+```diff
+ class SomeClass
+ {
+     public function run($value)
+     {
+-        return $value > 100 ? $value : 100;
++        return max($value, 100);
+     }
+ }
+```
+
+<br>
+
 ### OptionalParametersAfterRequiredRector
 
 Move required parameters after optional ones
@@ -993,8 +1012,9 @@ Simplify bool value compare to true or false
      public function run(bool $value, string $items)
      {
 -         $match = in_array($value, $items, TRUE) === TRUE;
--         $match = in_array($value, $items, TRUE) !== FALSE;
 +         $match = in_array($value, $items, TRUE);
+
+-         $match = in_array($value, $items, TRUE) !== FALSE;
 +         $match = in_array($value, $items, TRUE);
      }
  }
@@ -1714,8 +1734,11 @@ Convert enscaped {$string} to more readable sprintf or concat, if no mask is use
 - class: [`Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector`](../rules/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector.php)
 
 ```diff
--echo "Unsupported format {$format}";
-+echo sprintf('Unsupported format %s', $format);
+-echo "Unsupported format {$format} - use another";
++echo sprintf('Unsupported format %s - use another', $format);
+
+-echo "Try {$allowed}";
++echo 'Try ' . $allowed;
 ```
 
 <br>
@@ -6738,6 +6761,25 @@ Add strict type declaration based on returned constants
 
 <br>
 
+### ReturnTypeFromStrictFluentReturnRector
+
+Add return type from strict return `$this`
+
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictFluentReturnRector`](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictFluentReturnRector.php)
+
+```diff
+ final class SomeClass
+ {
+-    public function run()
++    public function run(): self
+     {
+         return $this;
+     }
+ }
+```
+
+<br>
+
 ### ReturnTypeFromStrictNativeCallRector
 
 Add strict return type based native function or class method return

config/set/code-quality.php

@@ -68,6 +68,7 @@
 use Rector\CodeQuality\Rector\Switch_\SingularSwitchToIfRector;
 use Rector\CodeQuality\Rector\Switch_\SwitchTrueToIfRector;
 use Rector\CodeQuality\Rector\Ternary\ArrayKeyExistsTernaryThenValueToCoalescingRector;
+use Rector\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector;
 use Rector\CodeQuality\Rector\Ternary\SimplifyTautologyTernaryRector;
 use Rector\CodeQuality\Rector\Ternary\SwitchNegatedTernaryRector;
 use Rector\CodeQuality\Rector\Ternary\TernaryEmptyArrayArrayDimFetchToCoalesceRector;
@@ -186,5 +187,6 @@
         DisallowedEmptyRuleFixerRector::class,
         ConvertStaticPrivateConstantToSelfRector::class,
         LocallyCalledStaticMethodToNonStaticRector::class,
+        NumberCompareToMaxFuncCallRector::class,
     ]);
 };

packages/Testing/PHPUnit/AbstractRectorTestCase.php

@@ -230,7 +230,8 @@ private function doTestFileMatchesExpectedContent(
         SimpleParameterProvider::setParameter(Option::SOURCE, [$originalFilePath]);
 
         $changedContent = $this->processFilePath($originalFilePath);
-        $originalFileContent = $this->currentFileProvider->getFile()->getOriginalFileContent();
+        $originalFileContent = $this->currentFileProvider->getFile()
+            ->getOriginalFileContent();
 
         $fixtureFilename = basename($fixtureFilePath);
         $failureMessage = sprintf('Failed on fixture file "%s"', $fixtureFilename);
@@ -255,7 +256,8 @@ private function processFilePath(string $filePath): string
 
         $this->applicationFileProcessor->processFiles([$filePath], $configuration);
 
-        return $this->currentFileProvider->getFile()->getFileContent();
+        return $this->currentFileProvider->getFile()
+            ->getFileContent();
     }
 
     private function createInputFilePath(string $fixtureFilePath): string

rules-tests/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector/Fixture/also_the_other_side.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+final class AlsoTheOtherSide
+{
+    public function run(int $value)
+    {
+        return 100 < $value ? $value : 100;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+final class AlsoTheOtherSide
+{
+    public function run(int $value)
+    {
+        return max($value, 100);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector/Fixture/include_greater_or_equal.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+final class IncludeGreaterOrEqual
+{
+    public function run(int $value)
+    {
+        return $value >= 100 ? $value : 100;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+final class IncludeGreaterOrEqual
+{
+    public function run(int $value)
+    {
+        return max($value, 100);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector/Fixture/skip_else_another_value.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+final class SkipElseAnotherValue
+{
+    public function run(int $value)
+    {
+        return $value > 100 ? $value : 55;
+    }
+}

rules-tests/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector/Fixture/skip_non_number.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+final class SkipNonNumber
+{
+    public function run($value)
+    {
+        return 100 < $value ? $value : 100;
+    }
+}

rules-tests/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector/Fixture/some_class.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+class SomeClass
+{
+    public function run(int $value)
+    {
+        return $value > 100 ? $value : 100;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\Fixture;
+
+class SomeClass
+{
+    public function run(int $value)
+    {
+        return max($value, 100);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector/NumberCompareToMaxFuncCallRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class NumberCompareToMaxFuncCallRectorTest 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/Ternary/NumberCompareToMaxFuncCallRector/config/configured_rule.php

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

rules/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Ternary;
+
+use PhpParser\Node\Expr\BinaryOp\GreaterOrEqual;
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp;
+use PhpParser\Node\Expr\BinaryOp\Greater;
+use PhpParser\Node\Expr\BinaryOp\Smaller;
+use PhpParser\Node\Expr\BinaryOp\SmallerOrEqual;
+use PhpParser\Node\Expr\Ternary;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector\NumberCompareToMaxFuncCallRectorTest
+ */
+final class NumberCompareToMaxFuncCallRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Ternary number compare to max() call', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run($value)
+    {
+        return $value > 100 ? $value : 100;
+    }
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run($value)
+    {
+        return max($value, 100);
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Ternary::class];
+    }
+
+    /**
+     * @param Ternary $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->cond instanceof BinaryOp) {
+            return null;
+        }
+
+        $binaryOp = $node->cond;
+        if (! $this->areIntegersCompared($binaryOp)) {
+            return null;
+        }
+
+        if ($binaryOp instanceof Smaller || $binaryOp instanceof SmallerOrEqual) {
+            if (! $this->nodeComparator->areNodesEqual($binaryOp->left, $node->else)) {
+                return null;
+            }
+
+            if (! $this->nodeComparator->areNodesEqual($binaryOp->right, $node->if)) {
+                return null;
+            }
+
+            return $this->nodeFactory->createFuncCall('max', [$node->if, $node->else]);
+        }
+
+        if ($binaryOp instanceof Greater || $binaryOp instanceof GreaterOrEqual) {
+            if (! $this->nodeComparator->areNodesEqual($binaryOp->left, $node->if)) {
+                return null;
+            }
+
+            if (! $this->nodeComparator->areNodesEqual($binaryOp->right, $node->else)) {
+                return null;
+            }
+
+            return $this->nodeFactory->createFuncCall('max', [$node->if, $node->else]);
+        }
+
+        return null;
+    }
+
+    private function areIntegersCompared(BinaryOp $binaryOp): bool
+    {
+        $leftType = $this->getType($binaryOp->left);
+        if (! $leftType->isInteger()->yes()) {
+            return false;
+        }
+
+        $rightType = $this->getType($binaryOp->right);
+        return $rightType->isInteger()
+            ->yes();
+    }
+}