Pass original node to fixNode()

Author: ondrejmirtes

build/PHPStan/Build/NamedArgumentsRule.php

@@ -92,10 +92,9 @@ public function processNode(Node $node, Scope $scope): array
 	}
 
 	/**
-	 * @param Node\Expr\FuncCall|Node\Expr\New_|Node\Expr\StaticCall $node
 	 * @return list<IdentifierRuleError>
 	 */
-	private function processArgs(ExtendedParametersAcceptor $acceptor, Scope $scope, Node\Expr\CallLike $node): array
+	private function processArgs(ExtendedParametersAcceptor $acceptor, Scope $scope, Node\Expr\FuncCall|Node\Expr\New_|Node\Expr\StaticCall $node): array
 	{
 		if ($acceptor->isVariadic()) {
 			return [];
@@ -169,8 +168,7 @@ private function processArgs(ExtendedParametersAcceptor $acceptor, Scope $scope,
 		}
 
 		if (count($errorBuilders) > 0) {
-			$errorBuilders[0]->fixNode(static function (Node $node) use ($acceptor, $hasNamedArgument, $parameters, $scope) {
-				/** @var Node\Expr\FuncCall|Node\Expr\New_|Node\Expr\StaticCall $node */
+			$errorBuilders[0]->fixNode($node, static function ($node) use ($acceptor, $hasNamedArgument, $parameters, $scope) {
 				$normalizedArgs = ArgumentsNormalizer::reorderArgs($acceptor, $node->getArgs());
 				if ($normalizedArgs === null) {
 					return $node;

build/ignore-gte-php7.4-errors.neon

@@ -3,7 +3,7 @@ includes:
 
 parameters:
 	ignoreErrors:
-		- '#^Class PHPStan\\Rules\\RuleErrors\\RuleError(?:\d+) has an uninitialized property (?:\$message|\$line|\$identifier|\$tip|\$file|\$metadata)#'
+		- '#^Class PHPStan\\Rules\\RuleErrors\\RuleError(?:\d+) has an uninitialized property (?:\$message|\$line|\$identifier|\$tip|\$file|\$metadata|\$originalNode)#'
 		- '#Extension has an uninitialized property (?:\$typeSpecifier|\$broker)#'
 		-
 			message: '#has an uninitialized property#'

src/Analyser/RuleErrorTransformer.php

@@ -98,7 +98,7 @@ public function transform(
 
 		$fixedErrorDiff = null;
 		if ($ruleError instanceof FixableNodeRuleError) {
-			if ($node instanceof VirtualNode) {
+			if ($ruleError->getOriginalNode() instanceof VirtualNode) {
 				throw new ShouldNotHappenException('Cannot fix virtual node');
 			}
 			$fixingFile = $filePath;
@@ -124,7 +124,7 @@ public function transform(
 			$newStmts = $cloningTraverser->traverse($fileNodes);
 
 			$traverser = new NodeTraverser();
-			$visitor = new ReplacingNodeVisitor($node, $ruleError->getNewNodeCallable());
+			$visitor = new ReplacingNodeVisitor($ruleError->getOriginalNode(), $ruleError->getNewNodeCallable());
 			$traverser->addVisitor($visitor);
 
 			/** @var Stmt[] $newStmts */

src/Rules/FixableNodeRuleError.php

@@ -7,6 +7,8 @@
 interface FixableNodeRuleError extends RuleError
 {
 
+	public function getOriginalNode(): Node;
+
 	/** @return callable(Node): Node */
 	public function getNewNodeCallable(): callable;
 

src/Rules/RuleErrorBuilder.php

@@ -120,6 +120,11 @@ public static function getRuleErrorTypes(): array
 			self::TYPE_FIXABLE_NODE => [
 				FixableNodeRuleError::class,
 				[
+					[
+						'originalNode',
+						'\PhpParser\Node',
+						'\PhpParser\Node',
+					],
 					[
 						'newNodeCallable',
 						null,
@@ -268,12 +273,15 @@ public function nonIgnorable(): self
 
 	/**
 	 * @internal Experimental
-	 * @param callable(Node): Node $cb
+	 * @template TNode of Node
+	 * @param TNode $node
+	 * @param callable(TNode): Node $cb
 	 * @phpstan-this-out self<T&FixableNodeRuleError>
 	 * @return self<T&FixableNodeRuleError>
 	 */
-	public function fixNode(callable $cb): self
+	public function fixNode(Node $node, callable $cb): self
 	{
+		$this->properties['originalNode'] = $node;
 		$this->properties['newNodeCallable'] = $cb;
 		$this->type |= self::TYPE_FIXABLE_NODE;
 

src/Rules/RuleErrors/RuleError129.php

@@ -14,6 +14,8 @@ final class RuleError129 implements RuleError, FixableNodeRuleError
 
 	public string $message;
 
+	public Node $originalNode;
+
 	/** @var callable(Node): Node */
 	public $newNodeCallable;
 
@@ -22,6 +24,11 @@ public function getMessage(): string
 		return $this->message;
 	}
 
+	public function getOriginalNode(): Node
+	{
+		return $this->originalNode;
+	}
+
 	/**
 	 * @return callable(Node): Node
 	 */

src/Rules/RuleErrors/RuleError131.php

@@ -17,6 +17,8 @@ final class RuleError131 implements RuleError, LineRuleError, FixableNodeRuleErr
 
 	public int $line;
 
+	public Node $originalNode;
+
 	/** @var callable(Node): Node */
 	public $newNodeCallable;
 
@@ -30,6 +32,11 @@ public function getLine(): int
 		return $this->line;
 	}
 
+	public function getOriginalNode(): Node
+	{
+		return $this->originalNode;
+	}
+
 	/**
 	 * @return callable(Node): Node
 	 */

src/Rules/RuleErrors/RuleError133.php

@@ -19,6 +19,8 @@ final class RuleError133 implements RuleError, FileRuleError, FixableNodeRuleErr
 
 	public string $fileDescription;
 
+	public Node $originalNode;
+
 	/** @var callable(Node): Node */
 	public $newNodeCallable;
 
@@ -37,6 +39,11 @@ public function getFileDescription(): string
 		return $this->fileDescription;
 	}
 
+	public function getOriginalNode(): Node
+	{
+		return $this->originalNode;
+	}
+
 	/**
 	 * @return callable(Node): Node
 	 */

src/Rules/RuleErrors/RuleError135.php

@@ -22,6 +22,8 @@ final class RuleError135 implements RuleError, LineRuleError, FileRuleError, Fix
 
 	public string $fileDescription;
 
+	public Node $originalNode;
+
 	/** @var callable(Node): Node */
 	public $newNodeCallable;
 
@@ -45,6 +47,11 @@ public function getFileDescription(): string
 		return $this->fileDescription;
 	}
 
+	public function getOriginalNode(): Node
+	{
+		return $this->originalNode;
+	}
+
 	/**
 	 * @return callable(Node): Node
 	 */

src/Rules/RuleErrors/RuleError137.php

@@ -17,6 +17,8 @@ final class RuleError137 implements RuleError, TipRuleError, FixableNodeRuleErro
 
 	public string $tip;
 
+	public Node $originalNode;
+
 	/** @var callable(Node): Node */
 	public $newNodeCallable;
 
@@ -30,6 +32,11 @@ public function getTip(): string
 		return $this->tip;
 	}
 
+	public function getOriginalNode(): Node
+	{
+		return $this->originalNode;
+	}
+
 	/**
 	 * @return callable(Node): Node
 	 */