[php 8.5] Pipe Operator

Author: Arshid

rules-tests/Php85/Rector/FuncCall/NestedFuncCallToPipeRector/Fixture/pip.php.inc

@@ -0,0 +1,11 @@
+<?php
+namespace Rector\Tests\Php85\Rector\FuncCall\NestedFuncCallToPipeRector\Fixture;
+
+$result = trim(strtoupper("Hello World"));
+?>
+-----
+<?php
+namespace Rector\Tests\Php85\Rector\FuncCall\NestedFuncCallToPipeRector\Fixture;
+
+$result = strtoupper("Hello World") |> trim(...);
+?>

rules-tests/Php85/Rector/FuncCall/NestedFuncCallToPipeRector/Fixture/pipe_more.php.inc

@@ -0,0 +1,11 @@
+<?php
+namespace Rector\Tests\Php85\Rector\FuncCall\NestedFuncCallToPipeRector\Fixture;
+
+$result = htmlspecialchars(trim(strtoupper("Hello World")));
+?>
+-----
+<?php
+namespace Rector\Tests\Php85\Rector\FuncCall\NestedFuncCallToPipeRector\Fixture;
+
+$result = strtoupper("Hello World") |> trim(...) |> htmlspecialchars(...);
+?>

rules-tests/Php85/Rector/FuncCall/NestedFuncCallToPipeRector/Fixture/skip_extra_var.php.inc

@@ -0,0 +1,5 @@
+<?php
+namespace Rector\Tests\Php85\Rector\FuncCall\NestedFuncCallToPipeRector\Fixture;
+
+$result = substr(strtoupper("Hello World"), 0, 5);
+?>

rules-tests/Php85/Rector/FuncCall/NestedFuncCallToPipeRector/NestedFuncCallToPipeRectorTest.php

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

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

rules/Php85/Rector/FuncCall/NestedFuncCallToPipeRector.php

@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php85\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\BinaryOp\Pipe;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Name;
+use PhpParser\Node\VariadicPlaceholder;
+use Rector\Rector\AbstractRector;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Rector\ValueObject\PhpVersionFeature;
+
+/**
+ * @see \Rector\Tests\Php85\Rector\FuncCall\NestedFuncCallToPipeRector\NestedFuncCallToPipeRectorTest
+ */
+final class NestedFuncCallToPipeRector extends AbstractRector implements MinPhpVersionInterface
+{
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::PIPE_OPERATOR;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Convert nested single-argument function calls to |> pipe operator',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+$result = trim(strtoupper("Hello World"));
+CODE_SAMPLE,
+                    <<<'CODE_SAMPLE'
+$result = "Hello World" |> strtoupper(...) |> trim(...);
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Assign::class, FuncCall::class];
+    }
+
+    public function refactor(Node $node): ?Node
+    {  
+        // match assignment: $result = FuncCall
+        if (! $node instanceof Assign) {
+            return null;
+        }
+
+        if (! $node->expr instanceof FuncCall) {
+            return null;
+        }
+
+        [$seedArgs, $calls] = $this->collectChain($node->expr);
+
+        if (! $seedArgs || count($calls) < 2) {
+            return null;
+        }
+
+        $calls = array_reverse($calls);
+
+        $firstCall = array_shift($calls);
+        $expr = new FuncCall(clone $firstCall->name, $seedArgs);
+
+        foreach ($calls as $call) {
+            $expr = new Pipe(
+                $expr,
+                new FuncCall(clone $call->name, [new VariadicPlaceholder()])
+            );
+        }
+
+        return new Assign($node->var, $expr);
+    }
+
+    protected function collectChain(FuncCall $func): array
+    {
+        $calls = [];
+        $current = $func;
+        while ($current instanceof FuncCall && count($current->args) === 1) {
+            $calls[] = $current;
+            $arg = $current->args[0]->value;
+            if ($arg instanceof FuncCall && count($arg->args) === 1) {
+                $current = $arg;
+                continue;
+            }
+            return [$current->args, $calls];
+        }
+        return [null, []];
+    }
+
+   
+}

src/ValueObject/PhpVersionFeature.php

@@ -798,4 +798,10 @@ final class PhpVersionFeature
      * @var int
      */
     public const DEPRECATE_NULL_ARG_IN_ARRAY_KEY_EXISTS_FUNCTION = PhpVersion::PHP_85;
+
+    /**
+     * @see https://wiki.php.net/rfc/pipe-operator-v3
+     * @var int
+     */
+    public const PIPE_OPERATOR = PhpVersion::PHP_85;
 }