[stmts-aware] Use NodeGroup::STMTS_AWARE over StmtsAwareInterface (#346)

* [stmts-aware] Use NodeGroup::STMTS_AWARE over StmtsAwareInterface

* [stmts-aware] Use NodeGroup::STMTS_AWARE over StmtsAwareInterface

* [ci-review] Rector Rectify

* cleanup ignored phpstan notice

---------

Co-authored-by: GitHub Action <[email protected]>

Author: samsonasik

composer.json

@@ -11,7 +11,7 @@
         "phpstan/phpstan": "^2.1.32",
         "phpstan/phpstan-webmozart-assert": "^2.0",
         "phpunit/phpunit": "^11.5",
-        "rector/rector-src": "dev-main",
+        "rector/rector-src": "dev-tv-stmts-interface",
         "symplify/easy-coding-standard": "^12.3",
         "symplify/rule-doc-generator": "^12.2",
         "symplify/vendor-patches": "^11.5",

phpstan.neon

@@ -8,6 +8,10 @@ parameters:
 
     reportUnmatchedIgnoredErrors: false
 
+    # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
+    typeAliases:
+        StmtsAware: \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_
+
     # requires exact closure types
     checkMissingCallableSignature: true
 
@@ -44,9 +48,6 @@ parameters:
 
         - '#(.*?)\:\:refactor\(\) should return array<PhpParser\\Node\\Stmt>\|PhpParser\\Node\\Stmt\\ClassConst\|null but returns array<PhpParser\\Node\\Stmt>\|PhpParser\\Node\\Stmt\|null#'
 
-        # phpstan need to load rector nodes first to avoid this
-        - '#Access to an undefined property Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface\:\:\$stmts#'
-
         -
             message: '#Parameter \#1 \$attributeClass of class Rector\\DowngradePhp80\\ValueObject\\DowngradeAttributeToAnnotation constructor expects class\-string, string given#'
             path: "config/*"
@@ -66,7 +67,6 @@ parameters:
             identifier: argument.type
 
         - '#Asking about instanceof PHPStan\\.* is not covered by backward compatibility promise#'
-        - '#Method Rector\\(.*?)\\Rector\\FuncCall\\(.*?)::refactor\(\) never returns \d so it can be removed from the return type#'
 
         # false positive intanceof in OR usage
         -

rules/DowngradePhp72/Rector/FuncCall/DowngradeStreamIsattyRector.php

@@ -14,11 +14,11 @@
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\Node\Stmt\Switch_;
 use PHPStan\Analyser\Scope;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Exception\ShouldNotHappenException;
 use Rector\Naming\Naming\VariableNaming;
 use Rector\NodeAnalyzer\ExprInTopStmtMatcher;
 use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\Enum\NodeGroup;
 use Rector\PhpParser\Parser\InlineCodeParser;
 use Rector\PHPStan\ScopeFetcher;
 use Rector\Rector\AbstractRector;
@@ -93,11 +93,12 @@ public function run($stream)
      */
     public function getNodeTypes(): array
     {
-        return [StmtsAwareInterface::class, Switch_::class, Return_::class, Expression::class, Echo_::class];
+        $stmtsAware = NodeGroup::STMTS_AWARE;
+        return [...$stmtsAware, Switch_::class, Return_::class, Expression::class, Echo_::class];
     }
 
     /**
-     * @param StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $node
+     * @param StmtsAware|Switch_|Return_|Expression|Echo_ $node
      * @return Node[]|null
      */
     public function refactor(Node $node): ?array

rules/DowngradePhp73/Rector/FuncCall/DowngradeArrayKeyFirstLastRector.php

@@ -25,10 +25,10 @@
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\Node\Stmt\Switch_;
 use PHPStan\Analyser\Scope;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Naming\Naming\VariableNaming;
 use Rector\NodeAnalyzer\ExprInTopStmtMatcher;
 use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\Enum\NodeGroup;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -80,11 +80,12 @@ public function run($items)
      */
     public function getNodeTypes(): array
     {
-        return [StmtsAwareInterface::class, Switch_::class, Return_::class, Expression::class, Echo_::class];
+        $stmtsAware = NodeGroup::STMTS_AWARE;
+        return [...$stmtsAware, Switch_::class, Return_::class, Expression::class, Echo_::class];
     }
 
     /**
-     * @param StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $node
+     * @param StmtsAware|Switch_|Return_|Expression|Echo_ $node
      * @return Node[]|null
      */
     public function refactor(Node $node): ?array
@@ -143,7 +144,7 @@ private function resolveVariableFromCallLikeScope(CallLike $callLike, ?Scope $sc
      */
     private function refactorArrayKeyFirst(
         FuncCall $funcCall,
-        StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt
+        Node|Switch_|Return_|Expression|Echo_ $stmt
     ): null|array {
         $args = $funcCall->getArgs();
         if (! isset($args[0])) {
@@ -182,7 +183,7 @@ private function refactorArrayKeyFirst(
      */
     private function refactorArrayKeyLast(
         FuncCall $funcCall,
-        StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt
+        Node|Switch_|Return_|Expression|Echo_ $stmt
     ): null|array {
         $args = $funcCall->getArgs();
         $firstArg = $args[0] ?? null;
@@ -216,7 +217,7 @@ private function refactorArrayKeyLast(
 
         $resetExpression = new Expression($this->nodeFactory->createFuncCall('reset', [$array]));
 
-        if ($stmt instanceof StmtsAwareInterface) {
+        if (property_exists($stmt, 'stmts')) {
             $stmt->stmts = array_merge([$resetExpression], $stmt->stmts);
         } elseif (! $stmt instanceof Return_) {
             $newStmts[] = $resetExpression;
@@ -228,7 +229,7 @@ private function refactorArrayKeyLast(
     private function resolvePrependNewStmt(
         Expr|Variable $array,
         FuncCall $funcCall,
-        Stmt|StmtsAwareInterface $stmt
+        Stmt|Node $stmt
     ): Expression|If_ {
         if (! $stmt instanceof If_ || $stmt->cond instanceof FuncCall || ! $stmt->cond instanceof BooleanOr) {
             return new Expression($funcCall);

rules/DowngradePhp81/Rector/FuncCall/DowngradeArrayIsListRector.php

@@ -15,10 +15,10 @@
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\Node\Stmt\Switch_;
 use PHPStan\Analyser\Scope;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Exception\ShouldNotHappenException;
 use Rector\NodeAnalyzer\ExprInTopStmtMatcher;
 use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\Enum\NodeGroup;
 use Rector\PhpParser\Parser\InlineCodeParser;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -78,11 +78,12 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function getNodeTypes(): array
     {
-        return [StmtsAwareInterface::class, Switch_::class, Return_::class, Expression::class, Echo_::class];
+        $stmtsAware = NodeGroup::STMTS_AWARE;
+        return [...$stmtsAware, Switch_::class, Return_::class, Expression::class, Echo_::class];
     }
 
     /**
-     * @param StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $node
+     * @param StmtsAware|Switch_|Return_|Expression|Echo_ $node
      * @return Node[]|null
      */
     public function refactor(Node $node): ?array

rules/DowngradePhp81/Rector/StmtsAwareInterface/DowngradeSetAccessibleReflectionPropertyRector.php

@@ -18,8 +18,8 @@
 use PhpParser\Node\Stmt\Expression;
 use PhpParser\Node\Stmt\If_;
 use PhpParser\Node\Stmt\Return_;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Naming\Naming\VariableNaming;
+use Rector\PhpParser\Enum\NodeGroup;
 use Rector\PHPStan\ScopeFetcher;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -81,11 +81,11 @@ public function run($object)
      */
     public function getNodeTypes(): array
     {
-        return [StmtsAwareInterface::class];
+        return NodeGroup::STMTS_AWARE;
     }
 
     /**
-     * @param StmtsAwareInterface $node
+     * @param StmtsAware $node
      */
     public function refactor(Node $node): ?Node
     {

rules/DowngradePhp83/Rector/FuncCall/DowngradeJsonValidateRector.php

@@ -15,11 +15,11 @@
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\Node\Stmt\Switch_;
 use PHPStan\Analyser\Scope;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\Exception\ShouldNotHappenException;
 use Rector\Naming\Naming\VariableNaming;
 use Rector\NodeAnalyzer\ExprInTopStmtMatcher;
 use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\Enum\NodeGroup;
 use Rector\PhpParser\Parser\InlineCodeParser;
 use Rector\PHPStan\ScopeFetcher;
 use Rector\Rector\AbstractRector;
@@ -84,11 +84,12 @@ public function getRuleDefinition(): RuleDefinition
      */
     public function getNodeTypes(): array
     {
-        return [StmtsAwareInterface::class, Switch_::class, Return_::class, Expression::class, Echo_::class];
+        $stmtsAware = NodeGroup::STMTS_AWARE;
+        return [...$stmtsAware, Switch_::class, Return_::class, Expression::class, Echo_::class];
     }
 
     /**
-     * @param StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $node
+     * @param StmtsAware|Switch_|Return_|Expression|Echo_ $node
      * @return Node[]|null
      */
     public function refactor(Node $node): ?array

rules/DowngradePhp85/Rector/StmtsAwareInterface/DowngradePipeOperatorRector.php

@@ -14,8 +14,8 @@
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt\Expression;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\NodeFactory\NamedVariableFactory;
+use Rector\PhpParser\Enum\NodeGroup;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -67,11 +67,11 @@ public function getRuleDefinition(): RuleDefinition
 
     public function getNodeTypes(): array
     {
-        return [StmtsAwareInterface::class];
+        return NodeGroup::STMTS_AWARE;
     }
 
     /**
-     * @param StmtsAwareInterface $node
+     * @param StmtsAware $node
      */
     public function refactor(Node $node): ?Node
     {

src/NodeAnalyzer/ExprInTopStmtMatcher.php

@@ -17,7 +17,6 @@
 use PhpParser\Node\Stmt\Switch_;
 use PhpParser\Node\Stmt\While_;
 use PHPStan\Analyser\Scope;
-use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\PhpParser\Node\BetterNodeFinder;
 
@@ -35,7 +34,7 @@ public function __construct(
     /**
      * @param callable(Node $node): bool $filter
      */
-    public function match(StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt, callable $filter): null|Expr
+    public function match(Node|Switch_|Return_|Expression|Echo_ $stmt, callable $filter): null|Expr
     {
         if ($stmt instanceof Closure) {
             return null;
@@ -80,7 +79,7 @@ public function match(StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt
      * @param callable(Node $node): bool $filter
      */
     private function resolveOnReturnOrExpression(
-        StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt,
+        Node|Switch_|Return_|Expression|Echo_ $stmt,
         callable $filter
     ): ?Expr {
         if (! $stmt instanceof Return_ && ! $stmt instanceof Expression) {
@@ -99,7 +98,7 @@ private function resolveOnReturnOrExpression(
      * @param callable(Node $node): bool $filter
      */
     private function resolveExpr(
-        StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt,
+        Node|Switch_|Return_|Expression|Echo_ $stmt,
         array|Expr $exprs,
         callable $filter
     ): ?Expr {
@@ -127,7 +126,7 @@ private function resolveExpr(
      * @param callable(Node $node): bool $filter
      */
     private function resolveFromChildCond(
-        StmtsAwareInterface|Switch_|Return_|Expression|Echo_ $stmt,
+        Node|Switch_|Return_|Expression|Echo_ $stmt,
         callable $filter
     ): null|Expr {
         if (! $stmt instanceof If_ && ! $stmt instanceof Switch_) {