[stmts-aware] Deprecate the interface and replace with meta-type + groups (#7679)

* [enum] kick of node group, deprecate stmts aware interface

* use StmtsAware meta-type

* [coding-style] Decouple NewlineBetweenClassLikeStmtsRector from NewlineAfterStatementRector

* skip node in RenameParamToMatchTypeRector as vague type that can be narrowed by name

* update test

* import FQNs

* add file without ns

* remove rest of instanceof checks

* fixup! remove rest of instanceof checks

Author: TomasVotruba

phpstan.neon

@@ -8,6 +8,10 @@ parameters:
     reportUnmatchedIgnoredErrors: false
     errorFormat: symplify
 
+    # 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
 
@@ -30,8 +34,8 @@ parameters:
     scanDirectories:
         - stubs
 
-    scanFiles:
-        - src/Contract/PhpParser/Node/StmtsAwareInterface.php
+#    scanFiles:
+#        - src/Contract/PhpParser/Node/StmtsAwareInterface.php
 
     excludePaths:
         - '*tests/*/Fixture/*'
@@ -207,7 +211,7 @@ parameters:
             message: '#Function "(class_exists|interface_exists)\(\)" cannot be used/left in the code\: use ReflectionProvider\->has\*\(\) instead#'
             path: src/Skipper/SkipCriteriaResolver/SkippedClassResolver.php
 
-        - '#(.*?)\\Contract\\PhpParser\\Node\\StmtsAwareInterface\:\:\$stmts#'
+#        - '#(.*?)\\Contract\\PhpParser\\Node\\StmtsAwareInterface\:\:\$stmts#'
 
         # dev rule
         - '#Class "Rector\\Utils\\Rector\\MoveAbstractRectorToChildrenRector" is missing @see annotation with test case class reference#'
@@ -328,10 +332,6 @@ parameters:
         - identifier: symplify.noConstructorOverride
           path: src/StaticTypeMapper/ValueObject/Type/SimpleStaticType.php
 
-        -
-            identifier: symplify.seeAnnotationToTest
-            path: utils/PHPStan/Rule/PreferDirectIsNameRule.php
-
         -
             identifier: arrayValues.list
             path: rules/CodingStyle/Application/UseImportsAdder.php
@@ -363,9 +363,6 @@ parameters:
             identifier:  symplify.multipleClassLikeInFile
 
         # copied from /vendor, to keep as original as possible
-        -
-            identifier: symplify.forbiddenNode
-            path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php
         -
             identifier: missingType.iterableValue
             path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php
@@ -381,3 +378,9 @@ parameters:
         -
             message: '#Property Rector\\PhpParser\\NodeTraverser\\AbstractImmutableNodeTraverser\:\:\$visitors \(list<PhpParser\\NodeVisitor>\) does not accept array<int\|string, PhpParser\\NodeVisitor>#'
             path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php
+
+        # false positive
+        -
+            message: '#Method (.*?)refactor\(\) (never returns|should return) (.*?)#'
+            paths:
+                - rules/Php70/Rector/If_/IfToSpaceshipRector.php

preload.php

@@ -26,6 +26,7 @@ function isPHPStanTestPreloaded(): bool
 }
 
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node.php';
+// @todo to be deprecated
 require_once __DIR__ . '/src/Contract/PhpParser/Node/StmtsAwareInterface.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/NodeAbstract.php';
 require_once __DIR__ . '/vendor/nikic/php-parser/lib/PhpParser/Node/Expr.php';

…ementRector/Fixture/with_comment.php.inc …ure/class_elements_with_comments.php.incrules-tests/CodingStyle/Rector/Stmt/NewlineAfterStatementRector/Fixture/with_comment.php.inc renamed to rules-tests/CodingStyle/Rector/ClassLike/NewlineBetweenClassLikeStmtsRector/Fixture/class_elements_with_comments.php.inc rules-tests/CodingStyle/Rector/Stmt/NewlineAfterStatementRector/Fixture/with_comment.php.inc renamed to rules-tests/CodingStyle/Rector/ClassLike/NewlineBetweenClassLikeStmtsRector/Fixture/class_elements_with_comments.php.inc

@@ -1,8 +1,8 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Stmt\NewlineAfterStatementRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassLike\NewlineBetweenClassLikeStmtsRector\Fixture;
 
-class WithComment
+final class ClassElementsWithComments
 {
     /**
      * @var string
@@ -30,9 +30,9 @@ class WithComment
 -----
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Stmt\NewlineAfterStatementRector\Fixture;
+namespace Rector\Tests\CodingStyle\Rector\ClassLike\NewlineBetweenClassLikeStmtsRector\Fixture;
 
-class WithComment
+final class ClassElementsWithComments
 {
     /**
      * @var string

rules-tests/CodingStyle/Rector/ClassLike/NewlineBetweenClassLikeStmtsRector/Fixture/skip_already_has_newline.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassLike\NewlineBetweenClassLikeStmtsRector\Fixture;
+
+class SkipAlreadyHasNewline
+{
+    private $property;
+
+    private $property2;
+}

rules-tests/CodingStyle/Rector/ClassLike/NewlineBetweenClassLikeStmtsRector/Fixture/skip_html_php_mix.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\ClassLike\NewlineBetweenClassLikeStmtsRector\Fixture;
+
+if (mt_rand(0, 1)) { ?>
+    <div>
+        <h1>Hi</h1>
+    </div>
+
+<?php } else { ?>
+    <div>
+        <h1>Bye</h1>
+    </div>
+
+<?php } ?>
+
+End of file

rules-tests/CodingStyle/Rector/ClassLike/NewlineBetweenClassLikeStmtsRector/NewlineBetweenClassLikeStmtsRectorTest.php

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

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodingStyle\Rector\ClassLike\NewlineBetweenClassLikeStmtsRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withRules([NewlineBetweenClassLikeStmtsRector::class]);

rules-tests/CodingStyle/Rector/Stmt/NewlineAfterStatementRector/Fixture/no_new_line.php.inc

@@ -4,10 +4,6 @@ namespace Rector\Tests\CodingStyle\Rector\Stmt\NewlineAfterStatementRector\Fixtu
 
 class NoNewLine
 {
-    private $property;
-    private $property2;
-    private const VIEW = 'view';
-    private const ADD = 'add';
     public function run(array $data)
     {
         if (rand(0, 1)) {
@@ -30,14 +26,6 @@ namespace Rector\Tests\CodingStyle\Rector\Stmt\NewlineAfterStatementRector\Fixtu
 
 class NoNewLine
 {
-    private $property;
-
-    private $property2;
-
-    private const VIEW = 'view';
-
-    private const ADD = 'add';
-
     public function run(array $data)
     {
         if (rand(0, 1)) {

rules-tests/CodingStyle/Rector/Stmt/NewlineAfterStatementRector/Fixture/skip_already_has_newline.php.inc

@@ -2,12 +2,8 @@
 
 namespace Rector\Tests\CodingStyle\Rector\Stmt\NewlineAfterStatementRector\Fixture;
 
-class SkipAlreadyHasNewline
+final class SkipAlreadyHasNewline
 {
-    private $property;
-
-    private $property2;
-
     public function run(array $data)
     {
         if (rand(0, 1)) {
@@ -23,5 +19,3 @@ class SkipAlreadyHasNewline
         return true;
     }
 }
-
-?>

rules-tests/CodingStyle/Rector/Stmt/NewlineAfterStatementRector/Fixture/skip_class_like.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\Stmt\NewlineAfterStatementRector\Fixture;
+
+final class SkipClassLike
+{
+    public function firstMethod()
+    {
+    }
+    public function secondMethod()
+    {
+    }
+}