Fix applying auto-fixes when the code contains pipe operator

Author: ondrejmirtes

src/Parser/PipeTransformerVisitor.php

@@ -15,6 +15,8 @@ final class PipeTransformerVisitor extends NodeVisitorAbstract
 
 	public const ORIGINAL_PIPE_ATTRIBUTE_NAME = 'originalPipeAttrs';
 
+	public const ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME = 'originalVariadicPlaceholderAttrs';
+
 	#[Override]
 	public function enterNode(Node $node): ?Node
 	{
@@ -27,6 +29,7 @@ public function enterNode(Node $node): ?Node
 				new Arg($node->left),
 			], attributes: array_merge($node->right->getAttributes(), [
 				self::ORIGINAL_PIPE_ATTRIBUTE_NAME => $node->getAttributes(),
+				self::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME => $node->right->getRawArgs()[0]->getAttributes(),
 			]));
 		}
 
@@ -35,6 +38,7 @@ public function enterNode(Node $node): ?Node
 				new Arg($node->left),
 			], attributes: array_merge($node->right->getAttributes(), [
 				self::ORIGINAL_PIPE_ATTRIBUTE_NAME => $node->getAttributes(),
+				self::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME => $node->right->getRawArgs()[0]->getAttributes(),
 			]));
 		}
 
@@ -43,6 +47,7 @@ public function enterNode(Node $node): ?Node
 				new Arg($node->left),
 			], attributes: array_merge($node->right->getAttributes(), [
 				self::ORIGINAL_PIPE_ATTRIBUTE_NAME => $node->getAttributes(),
+				self::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME => $node->right->getRawArgs()[0]->getAttributes(),
 			]));
 		}
 

src/Parser/ReversePipeTransformerVisitor.php

@@ -18,13 +18,15 @@ public function enterNode(Node $node): ?Node
 		if ($node instanceof Node\Expr\FuncCall && !$node->isFirstClassCallable()) {
 			$attributes = $node->getAttributes();
 			$origPipeAttributes = $attributes[PipeTransformerVisitor::ORIGINAL_PIPE_ATTRIBUTE_NAME] ?? [];
+			$origVariadicPlaceholderAttributes = $attributes[PipeTransformerVisitor::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME] ?? [];
 			if ($origPipeAttributes !== [] && count($node->getArgs()) === 1) {
 				$origPipeAttributes[self::ARG_ATTRIBUTES_NAME] = $node->getArgs()[0]->getAttributes();
 				if ($node->name instanceof Node\Name) {
 					unset($attributes[PipeTransformerVisitor::ORIGINAL_PIPE_ATTRIBUTE_NAME]);
+					unset($attributes[PipeTransformerVisitor::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME]);
 					return new Node\Expr\BinaryOp\Pipe(
 						$node->getArgs()[0]->value,
-						new Node\Expr\FuncCall($node->name, [new Node\VariadicPlaceholder()], attributes: $attributes),
+						new Node\Expr\FuncCall($node->name, [new Node\VariadicPlaceholder($origVariadicPlaceholderAttributes)], attributes: $attributes),
 						attributes: $origPipeAttributes,
 					);
 				}
@@ -40,12 +42,14 @@ public function enterNode(Node $node): ?Node
 		if ($node instanceof Node\Expr\MethodCall && !$node->isFirstClassCallable()) {
 			$attributes = $node->getAttributes();
 			$origPipeAttributes = $attributes[PipeTransformerVisitor::ORIGINAL_PIPE_ATTRIBUTE_NAME] ?? [];
+			$origVariadicPlaceholderAttributes = $attributes[PipeTransformerVisitor::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME] ?? [];
 			if ($origPipeAttributes !== [] && count($node->getArgs()) === 1) {
 				$origPipeAttributes[self::ARG_ATTRIBUTES_NAME] = $node->getArgs()[0]->getAttributes();
 				unset($attributes[PipeTransformerVisitor::ORIGINAL_PIPE_ATTRIBUTE_NAME]);
+				unset($attributes[PipeTransformerVisitor::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME]);
 				return new Node\Expr\BinaryOp\Pipe(
 					$node->getArgs()[0]->value,
-					new Node\Expr\MethodCall($node->var, $node->name, [new Node\VariadicPlaceholder()], attributes: $attributes),
+					new Node\Expr\MethodCall($node->var, $node->name, [new Node\VariadicPlaceholder($origVariadicPlaceholderAttributes)], attributes: $attributes),
 					attributes: $origPipeAttributes,
 				);
 			}
@@ -54,12 +58,14 @@ public function enterNode(Node $node): ?Node
 		if ($node instanceof Node\Expr\StaticCall && !$node->isFirstClassCallable()) {
 			$attributes = $node->getAttributes();
 			$origPipeAttributes = $attributes[PipeTransformerVisitor::ORIGINAL_PIPE_ATTRIBUTE_NAME] ?? [];
+			$origVariadicPlaceholderAttributes = $attributes[PipeTransformerVisitor::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME] ?? [];
 			if ($origPipeAttributes !== [] && count($node->getArgs()) === 1) {
 				$origPipeAttributes[self::ARG_ATTRIBUTES_NAME] = $node->getArgs()[0]->getAttributes();
 				unset($attributes[PipeTransformerVisitor::ORIGINAL_PIPE_ATTRIBUTE_NAME]);
+				unset($attributes[PipeTransformerVisitor::ORIGINAL_VARIADIC_PLACEHOLDER_ATTRIBUTE_NAME]);
 				return new Node\Expr\BinaryOp\Pipe(
 					$node->getArgs()[0]->value,
-					new Node\Expr\StaticCall($node->class, $node->name, [new Node\VariadicPlaceholder()], attributes: $attributes),
+					new Node\Expr\StaticCall($node->class, $node->name, [new Node\VariadicPlaceholder($origVariadicPlaceholderAttributes)], attributes: $attributes),
 					attributes: $origPipeAttributes,
 				);
 			}

tests/PHPStan/Build/FinalClassRuleTest.php

@@ -5,6 +5,7 @@
 use PHPStan\File\FileHelper;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\RequiresPhp;
 
 /**
  * @extends RuleTestCase<FinalClassRule>
@@ -32,4 +33,10 @@ public function testFix(): void
 		$this->fix(__DIR__ . '/data/final-class-rule.php', __DIR__ . '/data/final-class-rule.php.fixed');
 	}
 
+	#[RequiresPhp('>= 8.5')]
+	public function testFixWithPipe(): void
+	{
+		$this->fix(__DIR__ . '/data/final-class-rule-pipe.php', __DIR__ . '/data/final-class-rule-pipe.php.fixed');
+	}
+
 }

tests/PHPStan/Build/data/final-class-rule-pipe.php

@@ -0,0 +1,15 @@
+<?php // lint >= 8.5
+
+namespace FinalClassRulePipe;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+		$one = '1'
+			|> strtoupper(...)
+			|> strtolower(...);
+	}
+
+}

tests/PHPStan/Build/data/final-class-rule-pipe.php.fixed

@@ -0,0 +1,15 @@
+<?php // lint >= 8.5
+
+namespace FinalClassRulePipe;
+
+final class Foo
+{
+
+	public function doFoo(): void
+	{
+		$one = '1'
+			|> strtoupper(...)
+			|> strtolower(...);
+	}
+
+}