feat(php86): add DowngradeClampRector (#364)

Author: calebdw

config/set/downgrade-php86.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DowngradePhp86\Rector\FuncCall\DowngradeClampRector;
+use Rector\ValueObject\PhpVersion;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->phpVersion(PhpVersion::PHP_85);
+    $rectorConfig->rule(DowngradeClampRector::class);
+};

config/set/level/down-to-php84.php

@@ -3,8 +3,9 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\DowngradeLevelSetList;
 use Rector\Set\ValueObject\DowngradeSetList;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->sets([DowngradeSetList::PHP_85]);
+    $rectorConfig->sets([DowngradeLevelSetList::DOWN_TO_PHP_85, DowngradeSetList::PHP_85]);
 };

config/set/level/down-to-php85.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\DowngradeSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([DowngradeSetList::PHP_86]);
+};

rules-tests/DowngradePhp86/Rector/FuncCall/DowngradeClampRector/DowngradeClampRectorTest.php

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

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp86\Rector\FuncCall\DowngradeClampRector\Fixture;
+
+clamp($value, $min, $max);
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp86\Rector\FuncCall\DowngradeClampRector\Fixture;
+
+max($min, min($max, $value));
+
+?>

rules-tests/DowngradePhp86/Rector/FuncCall/DowngradeClampRector/Fixture/skip_first_class_callable.php.inc

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp86\Rector\FuncCall\DowngradeClampRector\Fixture;
+
+clamp(...);

rules-tests/DowngradePhp86/Rector/FuncCall/DowngradeClampRector/Fixture/with_named_args.php.inc

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp86\Rector\FuncCall\DowngradeClampRector\Fixture;
+
+clamp(max: $max, value: $value, min: $min);
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp86\Rector\FuncCall\DowngradeClampRector\Fixture;
+
+max($min, min($max, $value));
+
+?>

rules-tests/DowngradePhp86/Rector/FuncCall/DowngradeClampRector/config/configured_rule.php

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

rules/DowngradePhp86/Rector/FuncCall/DowngradeClampRector.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DowngradePhp86\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\FuncCall;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see https://wiki.php.net/rfc/clamp_v2
+ * @see \Rector\Tests\DowngradePhp86\Rector\FuncCall\DowngradeClampRector\DowngradeClampRectorTest
+ */
+final class DowngradeClampRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replace clamp() with min()/max().',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+clamp($value, $min, $max);
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+max($min, min($max, $value));
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [FuncCall::class];
+    }
+
+    /**
+     * @param FuncCall $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isName($node, 'clamp')) {
+            return null;
+        }
+
+        if ($node->isFirstClassCallable()) {
+            return null;
+        }
+
+        $valueArg = $node->getArg('value', 0);
+        $minArg = $node->getArg('min', 1);
+        $maxArg = $node->getArg('max', 2);
+
+        if (! $valueArg instanceof Arg || ! $minArg instanceof Arg || ! $maxArg instanceof Arg) {
+            return null;
+        }
+
+        return $this->nodeFactory->createFuncCall('max', [
+            $minArg->value,
+            $this->nodeFactory->createFuncCall('min', [$maxArg->value, $valueArg->value]),
+        ]);
+    }
+}

src/Set/ValueObject/DowngradeLevelSetList.php

@@ -10,6 +10,8 @@
  */
 final class DowngradeLevelSetList
 {
+    public const string DOWN_TO_PHP_85 = __DIR__ . '/../../../config/set/level/down-to-php85.php';
+
     public const string DOWN_TO_PHP_84 = __DIR__ . '/../../../config/set/level/down-to-php84.php';
 
     public const string DOWN_TO_PHP_83 = __DIR__ . '/../../../config/set/level/down-to-php83.php';