Merge remote-tracking branch 'origin/main' into feature/static-closure-improved

Author: peterfox

.github/workflows/code_analysis.yaml

@@ -50,7 +50,7 @@ jobs:
 
                     -
                         name: 'Finalize classes'
-                        run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
+                        run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"
 
                     -
                         name: 'Check before/after test fixture on no-changes'

.github/workflows/rector_laravel_rector_dev.yaml

@@ -28,3 +28,4 @@ jobs:
             -   run: git clone https://github.com/driftingly/rector-laravel.git
             -   run: composer require rector/rector:dev-main --working-dir rector-laravel
             -   run: cd rector-laravel && vendor/bin/phpunit
+

UPGRADING.md

@@ -1,3 +1,110 @@
+# Upgrading from Rector 2.2.14 to 2.3
+
+* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
+* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead
+
+**Before**
+
+```php
+use Rector\PhpParser\Node\FileWithoutNamespace;
+use Rector\Rector\AbstractRector;
+
+final class SomeRector extends AbstractRector
+{
+    public function getNodeTypes(): array
+    {
+        return [FileWithoutNamespace::class];
+    }
+
+    public function beforeTraverse(array $nodes): array
+    {
+        // some node hacking
+    }
+
+    /**
+     * @param FileWithoutNamespace $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        // ...
+    }
+
+}
+```
+
+**After**
+
+```php
+use Rector\PhpParser\Node\FileNode;
+use Rector\Rector\AbstractRector;
+
+final class SomeRector extends AbstractRector
+{
+    public function getNodeTypes(): array
+    {
+        return [FileNode::class];
+    }
+
+    /**
+     * @param FileNode $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        foreach ($node->stmts as $stmt) {
+            // check if has declare_strict already?
+            // ...
+
+            // create it
+            $declareStrictTypes = $this->createDeclareStrictTypesNode();
+
+            // add it
+            $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
+        }
+
+        return $node;
+    }
+
+}
+```
+
+<br>
+
+The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:
+
+```php
+use Rector\PhpParser\Node\FileNode;
+use Rector\Rector\AbstractRector;
+use PhpParser\Node\Stmt\Namespace_;
+
+final class SomeRector extends AbstractRector
+{
+    public function getNodeTypes(): array
+    {
+        return [FileNode::class, Namespace_::class];
+    }
+
+    /**
+     * @param FileNode|Namespace_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($node instanceof FileNode && $node->isNamespaced()) {
+            // handled in the Namespace_ node
+            return null;
+        }
+
+        foreach ($node->stmts as $stmt) {
+            // modify stmts in desired way here
+        }
+
+        return $node;
+    }
+
+}
+```
+
+<br>
+
 # Upgrading from Rector 1.x to 2.0
 
 ## PHP version requirements

composer.json

@@ -14,7 +14,7 @@
     "require": {
         "php": "^8.2",
         "clue/ndjson-react": "^1.3",
-        "composer/pcre": "^3.3.0",
+        "composer/pcre": "^3.3.2",
         "composer/semver": "^3.4",
         "composer/xdebug-handler": "^3.0.5",
         "doctrine/inflector": "^2.1",
@@ -50,7 +50,7 @@
         "phpstan/phpstan-phpunit": "^2.0",
         "phpstan/phpstan-webmozart-assert": "^2.0",
         "phpunit/phpunit": "^11.5",
-        "rector/jack": "^0.4.0",
+        "rector/jack": "^0.4",
         "rector/release-notes-generator": "^0.5",
         "rector/swiss-knife": "^2.3",
         "rector/type-perfect": "^2.1",

phpstan.neon

@@ -10,7 +10,7 @@ parameters:
 
     # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
     typeAliases:
-        StmtsAware: \PhpParser\Node\Stmt\Block | \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_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
+        StmtsAware: \PhpParser\Node\Stmt\Block | \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_ | \Rector\PhpParser\Node\FileNode
 
     # requires exact closure types
     checkMissingCallableSignature: true
@@ -160,6 +160,8 @@ parameters:
                 - src/Validation/RectorConfigValidator.php
                 # for phpunit version check
                 - src/Testing/PHPUnit/AbstractLazyTestCase.php
+                # future node class exists check
+                - src/Reporting/DeprecatedRulesReporter.php
 
         # use of internal phpstan classes
         -
@@ -187,8 +189,10 @@ parameters:
             message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
             path: src/Util/ArrayParametersMerger.php
 
-        # fixture class
-        - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
+        # fixture Rector rules
+        -
+            identifier:  symplify.seeAnnotationToTest
+            path: tests/Issues/
 
         # classes are part of *.php.inc fixture
         -
@@ -284,7 +288,6 @@ parameters:
                 - src/Configuration/RectorConfigBuilder.php
                 - src/Reporting/DeprecatedRulesReporter.php
             identifier: classConstant.deprecatedInterface
-        - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'
 
         # allowed internally only
         -
@@ -324,6 +327,11 @@ parameters:
         - '#expects array<PhpParser\\Node\\Stmt>, array<PhpParser\\Node> given#'
         - '#should return non\-empty\-string but returns string#'
 
+        # known non-empty class method
+        -
+            message: '#Offset 0 might not exist on array<PhpParser\\Node\\Stmt>\|null#'
+            path: rules/DeadCode/Rector/ClassMethod/RemoveParentDelegatingConstructorRector.php
+
         # false positive, can accept non-class string
         - '#Parameter \#1 \$name of method PHPStan\\BetterReflection\\Reflection\\Adapter\\ReflectionClass\:\:getAttributes\(\) expects class\-string\|null, string given#'
 
@@ -391,12 +399,6 @@ parameters:
             paths:
                 - rules/Php70/Rector/If_/IfToSpaceshipRector.php
 
-        # handles full file
-        -
-            paths:
-                - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
-            identifier: rector.noOnlyNullReturnInRefactor
-
         -
             identifier: rector.noIntegerRefactorReturn
             paths:
@@ -409,22 +411,22 @@ parameters:
         # condition check, just to be sure
         - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'
 
-        # special case, working on a file-level
-        -
-            identifier: rector.noOnlyNullReturnInRefactor
-            path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php
-
-        # handle next with FileNode
-        -
-            identifier: method.parentMethodFinalByPhpDoc
-            path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php
-
         # deprecated
         -
             identifier: public.method.unused
             paths:
                 - rules/Transform/ValueObject/ClassMethodReference.php
                 - rules/CodeQuality/ValueObject/KeyAndExpr.php
+        -
+            identifier: symplify.forbiddenExtendOfNonAbstractClass
+            path: src/PhpParser/Node/FileNode.php
+        -
+            identifier: method.deprecatedClass
+            path: src/PhpParser/Node/FileNode.php
+
+        -
+            identifier: class.extendsDeprecatedClass
+            path: src/PhpParser/Node/FileNode.php
 
         -
             identifier: public.classConstant.unused
@@ -433,13 +435,32 @@ parameters:
                 - rules/Php55/Rector/String_/StringClassNameToClassConstantRector.php
                 - rules/Php81/Enum/AttributeName.php
 
+        -
+            identifier: symplify.seeAnnotationToTest
+            paths:
+                - tests/PhpParser/NodeTraverser/StopTraverseOnTypeChange/Class_
+
         # deprecated rule
         - '#Rule Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector must implements Rector\\VersionBonding\\Contract\\MinPhpVersionInterface#'
         - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
         - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
         - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'
+
+        # BC layer for FileWithoutNamespace node
+        - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
+        - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
+        -
+            path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
+            identifier: symplify.forbiddenExtendOfNonAbstractClass
         -
             message: '#Only abstract classes can be extended#'
             path: rules/Php81/Rector/Array_/FirstClassCallableRector.php
 
+        - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'
 
+        # BC layer for FileWithoutNamespace node
+        - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
+        - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
+        -
+            path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
+            identifier: symplify.forbiddenExtendOfNonAbstractClass

rules-tests/DeadCode/Rector/ClassMethod/RemoveParentDelegatingConstructorRector/Fixture/skip_different_args.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector\Fixture;
+
+use PhpParser\Node\Scalar\String_;
+
+final class SomeDifferentArgs extends String_
+{
+    public function __construct($value, $attributes)
+    {
+        parent::__construct($value, []);
+    }
+}

rules-tests/DeadCode/Rector/ClassMethod/RemoveParentDelegatingConstructorRector/Fixture/skip_different_count.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector\Fixture;
+
+use PhpParser\Node\Scalar\String_;
+
+final class SkipDifferentCount extends String_
+{
+    public function __construct($value)
+    {
+        parent::__construct($value, []);
+    }
+}

rules-tests/DeadCode/Rector/ClassMethod/RemoveParentDelegatingConstructorRector/Fixture/skip_different_type.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector\Fixture;
+
+use PhpParser\NodeTraverser;
+use Rector\Comments\NodeVisitor\CommentRemovingNodeVisitor;
+
+final class SkipDifferentType extends NodeTraverser
+{
+    public function __construct(CommentRemovingNodeVisitor $commentRemovingNodeVisitor)
+    {
+        parent::__construct($commentRemovingNodeVisitor);
+    }
+}

rules-tests/DeadCode/Rector/ClassMethod/RemoveParentDelegatingConstructorRector/Fixture/skip_first_class_callable.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector\Fixture;
+
+use PhpParser\Node\Scalar\String_;
+
+final class SkipFirstClassCallable extends String_
+{
+    public function __construct($value, $attributes)
+    {
+        parent::__construct(...);
+    }
+}

rules-tests/DeadCode/Rector/ClassMethod/RemoveParentDelegatingConstructorRector/Fixture/some_class.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector\Fixture;
+
+use PhpParser\Node\Scalar\String_;
+
+final class SomeClass extends String_
+{
+    public function __construct($value, $attributes)
+    {
+        parent::__construct($value, $attributes);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector\Fixture;
+
+use PhpParser\Node\Scalar\String_;
+
+final class SomeClass extends String_
+{
+}
+
+?>