improve compatibility with phpstan@bleedingEdge (#404)

Co-authored-by: Markus Staab <m.staab@complex-it.de>

composer.json

@@ -6,7 +6,7 @@
 		"php": "^7.4 || ^8.0",
 		"composer-runtime-api": "^2.0",
 		"composer/semver": "^3.2",
-		"phpstan/phpstan": "^1.2"
+		"phpstan/phpstan": "^1.5.6"
 	},
 	"require-dev": {
 		"ext-mysqli": "*",

config/extensions.neon

@@ -54,7 +54,7 @@ services:
         tags:
         	- phpstan.typeSpecifier.methodTypeSpecifyingExtension
 
-    -     
+    -
         class: staabm\PHPStanDba\Extensions\PdoStatementFetchObjectDynamicReturnTypeExtension
         tags:
         	- phpstan.broker.dynamicMethodReturnTypeExtension
@@ -85,3 +85,8 @@ services:
         class: staabm\PHPStanDba\Extensions\PdoQuoteDynamicReturnTypeExtension
         tags:
         	- phpstan.broker.dynamicMethodReturnTypeExtension
+
+    -
+        class: staabm\PHPStanDba\Ast\PreviousConnectingVisitor
+        tags:
+        	- phpstan.parser.richParserNodeVisitor

src/QueryReflection/ExpressionFinder.php → src/Ast/ExpressionFinder.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace staabm\PHPStanDba\QueryReflection;
+namespace staabm\PHPStanDba\Ast;
 
 use PhpParser\Node;
 use PhpParser\Node\Expr;
@@ -15,20 +15,6 @@
 
 final class ExpressionFinder
 {
-    /**
-     * Do not change, part of internal PHPStan naming.
-     *
-     * @var string
-     */
-    private const PREVIOUS = 'previous';
-
-    /**
-     * Convention key name in php-parser and PHPStan for parent node.
-     *
-     * @var string
-     */
-    private const PARENT = 'parent';
-
     private NodeFinder $nodeFinder;
 
     public function __construct()
@@ -119,12 +105,14 @@ private function resolveName($node)
     }
 
     /**
+     * XXX At best, this method would be implemented in NodeConnectingVisitor, and the 'firstPreviousAssign' would be directly available.
+     *
      * @param callable(Node $node):bool $filter
      */
     private function findFirstPreviousOfNode(Node $node, callable $filter): ?Node
     {
         // move to previous expression
-        $previousStatement = $node->getAttribute(self::PREVIOUS);
+        $previousStatement = $node->getAttribute(PreviousConnectingVisitor::ATTRIBUTE_PREVIOUS);
         if (null !== $previousStatement) {
             if (!$previousStatement instanceof Node) {
                 throw new ShouldNotHappenException();
@@ -138,7 +126,7 @@ private function findFirstPreviousOfNode(Node $node, callable $filter): ?Node
             return $this->findFirstPreviousOfNode($previousStatement, $filter);
         }
 
-        $parent = $node->getAttribute(self::PARENT);
+        $parent = $node->getAttribute(PreviousConnectingVisitor::ATTRIBUTE_PARENT);
         if ($parent instanceof FunctionLike) {
             return null;
         }

src/Ast/PreviousConnectingVisitor.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace staabm\PHPStanDba\Ast;
+
+use function array_pop;
+use PhpParser\Node;
+use PhpParser\NodeVisitorAbstract;
+
+final class PreviousConnectingVisitor extends NodeVisitorAbstract
+{
+    public const ATTRIBUTE_PARENT = 'dba-parent';
+    public const ATTRIBUTE_PREVIOUS = 'dba-previous';
+
+    /**
+     * @var Node[]
+     */
+    private $stack = [];
+
+    /**
+     * @var ?Node
+     */
+    private $previous;
+
+    public function beforeTraverse(array $nodes)
+    {
+        $this->stack = [];
+        $this->previous = null;
+
+        return null;
+    }
+
+    public function enterNode(Node $node)
+    {
+        if (!empty($this->stack)) {
+            $node->setAttribute(self::ATTRIBUTE_PARENT, $this->stack[\count($this->stack) - 1]);
+        }
+
+        if (null !== $this->previous && $this->previous->getAttribute(self::ATTRIBUTE_PARENT) === $node->getAttribute(self::ATTRIBUTE_PARENT)) {
+            $node->setAttribute(self::ATTRIBUTE_PREVIOUS, $this->previous);
+        }
+
+        $this->stack[] = $node;
+
+        return null;
+    }
+
+    public function leaveNode(Node $node)
+    {
+        $this->previous = $node;
+
+        array_pop($this->stack);
+
+        return null;
+    }
+}

src/PdoReflection/PdoStatementReflection.php

@@ -13,7 +13,7 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
-use staabm\PHPStanDba\QueryReflection\ExpressionFinder;
+use staabm\PHPStanDba\Ast\ExpressionFinder;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\QueryReflector;
 

src/QueryReflection/QueryReflection.php

@@ -17,6 +17,7 @@
 use staabm\PHPStanDba\Analyzer\QueryPlanAnalyzerMysql;
 use staabm\PHPStanDba\Analyzer\QueryPlanQueryResolver;
 use staabm\PHPStanDba\Analyzer\QueryPlanResult;
+use staabm\PHPStanDba\Ast\ExpressionFinder;
 use staabm\PHPStanDba\DbaException;
 use staabm\PHPStanDba\Error;
 use staabm\PHPStanDba\UnresolvableQueryException;