[Php85] Remove calls to deprecated no-op functions

Author: mttsch

config/set/php85.php

@@ -3,8 +3,22 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector;
+use Rector\DeadCode\ValueObject\WrapFuncCallWithPhpVersionIdChecker;
 use Rector\Php85\Rector\ArrayDimFetch\ArrayFirstLastRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([ArrayFirstLastRector::class]);
+
+    // https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_no-op_functions_from_the_resource_to_object_conversion
+    $rectorConfig->ruleWithConfiguration(
+        WrapFuncCallWithPhpVersionIdCheckerRector::class,
+        [
+            new WrapFuncCallWithPhpVersionIdChecker('curl_close', 80500),
+            new WrapFuncCallWithPhpVersionIdChecker('curl_share_close', 80500),
+            new WrapFuncCallWithPhpVersionIdChecker('finfo_close', 80500),
+            new WrapFuncCallWithPhpVersionIdChecker('imagedestroy', 80500),
+            new WrapFuncCallWithPhpVersionIdChecker('xml_parser_free', 80500),
+        ]
+    );
 };

rules-tests/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector/Fixture/different_function.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector\Fixture;
+
+different_function();
+different_function(1, 2);
+
+?>

rules-tests/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector/Fixture/skip_func_call_in_assignment.php.inc

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector\Fixture;
+
+$foo = no_op_function();
+
+?>

rules-tests/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector/Fixture/skip_func_call_in_condition.php.inc

@@ -0,0 +1,9 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector\Fixture;
+
+if (no_op_function()) {
+
+}
+
+?>

rules-tests/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector/Fixture/wrapped_function.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector\Fixture;
+
+no_op_function();
+no_op_function(1, 2);
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector\Fixture;
+
+if (PHP_VERSION_ID < 80500) {
+    no_op_function();
+}
+if (PHP_VERSION_ID < 80500) {
+    no_op_function(1, 2);
+}
+
+?>

rules-tests/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector/WrapFuncCallWithPhpVersionIdCheckerRectorTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class WrapFuncCallWithPhpVersionIdCheckerRectorTest 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/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector/config/configured_rule.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector;
+use Rector\DeadCode\ValueObject\WrapFuncCallWithPhpVersionIdChecker;
+
+return RectorConfig::configure()
+    ->withConfiguredRule(
+        WrapFuncCallWithPhpVersionIdCheckerRector::class,
+        [new WrapFuncCallWithPhpVersionIdChecker('no_op_function', 80500)]
+    );

rules/DeadCode/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DeadCode\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp\Smaller;
+use PhpParser\Node\Expr\ConstFetch;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Name;
+use PhpParser\Node\Param;
+use PhpParser\Node\Scalar\Int_;
+use PhpParser\Node\Stmt\Expression;
+use PhpParser\Node\Stmt\If_;
+use Rector\Contract\Rector\ConfigurableRectorInterface;
+use Rector\DeadCode\ValueObject\WrapFuncCallWithPhpVersionIdChecker;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
+
+/**
+ * @see \Rector\Tests\DeadCode\Rector\FuncCall\WrapFuncCallWithPhpVersionIdCheckerRector\WrapFuncCallWithPhpVersionIdCheckerRectorTest
+ */
+final class WrapFuncCallWithPhpVersionIdCheckerRector extends AbstractRector implements ConfigurableRectorInterface
+{
+    /**
+     * @var WrapFuncCallWithPhpVersionIdChecker[]
+     */
+    private array $wrapFuncCallWithPhpVersionIdCheckers = [];
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Wraps function calls without assignment in a condition to check for a PHP version id',
+            [
+                new ConfiguredCodeSample(
+                    <<<'CODE_SAMPLE'
+    no_op_function();
+    CODE_SAMPLE
+
+                    ,
+                    <<<'CODE_SAMPLE'
+    if (PHP_VERSION_ID < 80500) {
+        no_op_function();
+    }
+    CODE_SAMPLE
+                    ,
+                    [new WrapFuncCallWithPhpVersionIdChecker('no_op_function', 80500)]
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Expression::class];
+    }
+
+    /**
+     * @param Expression $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->expr instanceof FuncCall) {
+            return null;
+        }
+
+        $funcCall = $node->expr;
+
+        foreach ($this->wrapFuncCallWithPhpVersionIdCheckers as $wrapFuncCallWithPhpVersionIdChecker) {
+            if ($this->getName($funcCall) !== $wrapFuncCallWithPhpVersionIdChecker->getFunctionName()) {
+                continue;
+            }
+
+            $phpVersionIdConst = new ConstFetch(new Name('PHP_VERSION_ID'));
+            $if = new If_(new Smaller($phpVersionIdConst, new Int_(
+                $wrapFuncCallWithPhpVersionIdChecker->getPhpVersionId()
+            )));
+            $if->stmts = [$node];
+
+            return $if;
+        }
+
+        return null;
+    }
+
+    public function configure(array $configuration): void
+    {
+        Assert::allIsInstanceOf($configuration, WrapFuncCallWithPhpVersionIdChecker::class);
+
+        $this->wrapFuncCallWithPhpVersionIdCheckers = $configuration;
+    }
+}

rules/DeadCode/ValueObject/WrapFuncCallWithPhpVersionIdChecker.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Rector\DeadCode\ValueObject;
+
+final readonly class WrapFuncCallWithPhpVersionIdChecker
+{
+    public function __construct(
+        private string $functionName,
+        private int $phpVersionId
+    ) {
+    }
+
+    public function getFunctionName(): string
+    {
+        return $this->functionName;
+    }
+
+    public function getPhpVersionId(): int
+    {
+        return $this->phpVersionId;
+    }
+}