Merge branch 'rectorphp:main' into php84/rounding-modes-enum

.github/workflows/build_scoped_rector.yaml

@@ -66,11 +66,11 @@ jobs:
             # 3. prefix classes
             -   run: sh build/build-rector-scoped.sh rector-build rector-prefixed-downgraded
 
-            # 4. lint the code for PHP 7.2 - this must happen here, as setup-php allows only one PHP version switch: https://github.com/shivammathur/setup-php/issues/434
+            # 4. lint the code for PHP 7.4 - this must happen here, as setup-php allows only one PHP version switch: https://github.com/shivammathur/setup-php/issues/434
             -
                 uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 7.2
+                    php-version: 7.4
                     coverage: none
             -   run: composer global require php-parallel-lint/php-parallel-lint --ansi
             -   run: /home/runner/.composer/vendor/bin/parallel-lint rector-prefixed-downgraded --exclude rector-prefixed-downgraded/stubs --exclude rector-prefixed-downgraded/vendor/tracy/tracy/examples --exclude rector-prefixed-downgraded/vendor/rector/rector-generator/templates --exclude rector-prefixed-downgraded/vendor/symfony/console/Debug/CliRequest.php

.github/workflows/code_analysis.yaml

@@ -27,7 +27,7 @@ jobs:
 
                     -
                         name: 'PHPStan'
-                        run: vendor/bin/phpstan analyse --ansi --error-format symplify
+                        run: vendor/bin/phpstan analyse --ansi
 
                     -
                         name: 'Commented Code'
@@ -40,7 +40,7 @@ jobs:
                     -
                         name: 'Active Classes'
                         run: |
-                            vendor/bin/class-leak check bin config src rules utils --skip-suffix "Rector" --skip-type="Rector\\Utils\\Compiler\\Unprefixer" --skip-type="Rector\\PhpDocParser\\PhpParser\\SmartPhpParserFactory" --skip-type="Rector\\NodeCollector\\BinaryOpConditionsCollector"
+                            vendor/bin/class-leak check bin config src rules utils --skip-suffix "Rector" --skip-type="Rector\\Utils\\Compiler\\Unprefixer" --skip-type="Rector\\PhpDocParser\\PhpParser\\SmartPhpParserFactory" --skip-type="Rector\\NodeCollector\\BinaryOpConditionsCollector" --skip-type="Rector\\Set\\Contract\\SetListInterface"
 
                     -
                         name: 'Compatible PHPStan versions'

.github/workflows/e2e.yaml

@@ -35,6 +35,11 @@ jobs:
                     - 'e2e/invalid-paths'
                     - 'e2e/applied-polyfill-php80'
                     - 'e2e/print-new-node'
+                    - 'e2e/only-option'
+                    - 'e2e/only-option-quote-double-equalnone'
+                    - 'e2e/only-option-quote-single'
+                    - 'e2e/only-option-quote-single-bsdouble'
+                    - 'e2e/only-option-quote-single-equalnone'
 
         name: End to end test - ${{ matrix.directory }}
 

CONTRIBUTING.md

@@ -56,13 +56,16 @@ above commands in a docker container:
 
 ```bash
 # Build the docker image
-docker compose build
+docker compose build --pull
+
+# Install dependencies
+docker compose run --rm php composer install
 
 # Run the entire CI suite
-docker compose run php composer complete-check
+docker compose run --rm php composer complete-check
 
 # Fix the coding standards
-docker compose run php composer fix-cs
+docker compose run --rm php composer fix-cs
 ```
 
 ## TroubleShooting

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8-cli-alpine
+FROM php:8.2-cli-alpine
 
 WORKDIR /etc/rector
 

README.md

@@ -11,7 +11,7 @@ Head to [`rectorphp/rector`](http://github.com/rectorphp/rector) for documentati
 
 ## Building `rectorphp/rector`
 
-Code of this repository requires PHP 8. For `rector/rector` package the build downgrades code to PHP 7.2+.
+Code of this repository requires PHP 8. For `rector/rector` package the build downgrades code to PHP 7.4+.
 
 <br>
 

UPGRADING.md

@@ -0,0 +1,95 @@
+# Upgrading from Rector 1.x to 2.0
+
+## PHP version requirements
+
+Rector now uses PHP 7.4 or newer to run.
+
+<br>
+
+## Rector now uses PHP-Parser 5
+
+See [upgrading guide](https://github.com/nikic/PHP-Parser/blob/master/UPGRADE-5.0.md) for PHP-Parser.
+
+<br>
+
+## Rector now uses PHPStan 2
+
+See [upgrading guide](https://github.com/phpstan/phpstan-src/blob/2.0.x/UPGRADING.md) for PHPStan.
+
+<br>
+
+## Upgrade for custom Rules writers
+
+### 1. `AbstractScopeAwareRector` is removed, use `AbstractRector` instead
+
+The `Rector\Rector\AbstractScopeAwareRector` was too granular to fetch single helper object. It made creating new custom rules ambiguous, one layer more complex and confusing. This class has been removed in favor of standard `AbstractRector`. The `Scope` object can be fetched via `ScopeFetcher`.
+
+**Before**
+
+```php
+use Rector\Rector\AbstractScopeAwareRector;
+
+final class SimpleRector extends AbstractScopeAwareRector
+{
+    public function refactorWithScope(Node $node, Scope $scope): ?Node
+    {
+        // ...
+    }
+}
+```
+
+**After**
+
+```php
+use Rector\Rector\AbstractRector;
+use Rector\PHPStan\ScopeFetcher;
+
+final class SimpleRector extends AbstractRector
+{
+    public function refactor(Node $node): ?Node
+    {
+        if (...) {
+            // this allow to fetch scope only when needed
+            $scope = ScopeFetcher::fetch($node);
+        }
+
+        // ...
+    }
+}
+```
+
+
+### 2. `AbstractRector` get focused on code, the `getRuleDefinition()` is no longer required
+
+Core rules need documentation, so people can read their feature and [search through](https://getrector.com/find-rule) them. Yet for writing custom rules and local rules, its not necessary. People often filled it empty, just to make Rector happy.
+
+This is no longer needed. Now The `getRuleDefinition()` method has been removed:
+
+```diff
+ use Rector\Rector\AbstractRector;
+-use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+-use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+ final class SimpleRector extends AbstractRector
+ {
+-    public function getRuleDefinition(): RuleDefinition
+-    {
+-        return new RuleDefinition('// @todo fill the description', [
+-            new CodeSample(
+-                <<<'CODE_SAMPLE'
+-// @todo fill code before
+-CODE_SAMPLE
+-                ,
+-                <<<'CODE_SAMPLE'
+-// @todo fill code after
+-CODE_SAMPLE
+-            ),
+-        ]);
+-    }
+
+     // valuable code here
+ }
+```
+
+If you need description yourself to understand rule after many months, use the common place for documentation - docblock above class.
+

bin/rector.php

@@ -105,7 +105,7 @@ public function loadIfExistsAndNotLoadedYet(string $filePath): void
             return;
         }
 
-        /** @var string $realPath always string after file_exists() check */
+        /** @var non-empty-string $realPath always string after file_exists() check */
         $realPath = realpath($filePath);
         $this->alreadyLoadedAutoloadFiles[] = $realPath;
 

build/build-preload.php

@@ -76,6 +76,7 @@ final class PreloadBuilder
         'TokenEmulator.php',
         'KeywordEmulator.php',
         'Comment.php',
+        'PrettyPrinter.php',
         'PrettyPrinterAbstract.php',
         'Parser.php',
         'ParserAbstract.php',
@@ -104,6 +105,21 @@ final class PreloadBuilder
         'TypeNode.php',
     ];
 
+    /**
+     * The classes are deprecated and moved under Node
+     *
+     * @var string[]
+     */
+    private const IN_USE_CLASS_FILES = [
+        'Node/Expr/ArrayItem.php',
+        'Node/Expr/ClosureUse.php',
+        'Node/Scalar/EncapsedStringPart.php',
+        'Node/Scalar/LNumber.php',
+        'Node/Stmt/DeclareDeclare.php',
+        'Node/Stmt/PropertyProperty.php',
+        'Node/Stmt/StaticVar.php',
+    ];
+
     public function buildPreloadScript(string $buildDirectory, string $preloadFile): void
     {
         $this->buildPreloadScriptPhpParser($buildDirectory, $preloadFile);
@@ -315,6 +331,17 @@ private function findPhpParserFilesAndSortThem(string $vendorDir): array
         // 2. put first-class usages first
         $fileInfos = $this->sortFileInfos($fileInfos);
 
+        foreach ($fileInfos as $key => $fileInfo) {
+            foreach (self::IN_USE_CLASS_FILES as $inUseClassFile) {
+                if (str_ends_with($fileInfo->getPathname(), $inUseClassFile)) {
+                    unset($fileInfos[$key]);
+                    continue 2;
+                }
+            }
+        }
+
+        $fileInfos = array_values($fileInfos);
+
         $stmtsAwareInterface = new SplFileInfo(__DIR__ . '/../src/Contract/PhpParser/Node/StmtsAwareInterface.php');
         array_splice($fileInfos, 1, 0, [$stmtsAwareInterface]);
 

build/build-rector-scoped.sh

@@ -39,7 +39,7 @@ composer remove ocramius/package-versions -W --update-no-dev --working-dir "$BUI
 
 # Work around possible PHP memory limits
 note "Running php-scoper on /bin, /config, /src, /rules and /vendor"
-php -d memory_limit=-1 php-scoper.phar add-prefix bin config src rules vendor composer.json --output-dir "../$RESULT_DIRECTORY" --config scoper.php --force --ansi --working-dir "$BUILD_DIRECTORY";
+php -d memory_limit=-1 php-scoper.phar add-prefix bin config src rules vendor composer.json UPGRADING.md --output-dir "../$RESULT_DIRECTORY" --config scoper.php --force --ansi --working-dir "$BUILD_DIRECTORY";
 
 note "Dumping prefixed Composer Autoload"
 composer dump-autoload --working-dir "$RESULT_DIRECTORY" --ansi --classmap-authoritative --no-dev

build/config/config-downgrade.php

@@ -9,7 +9,7 @@
 return RectorConfig::configure()
     ->withSkip(DowngradeRectorConfig::DEPENDENCY_EXCLUDE_PATHS)
     ->withPHPStanConfigs([__DIR__ . '/phpstan-for-downgrade.neon'])
-    ->withDowngradeSets(php72: true);
+    ->withDowngradeSets(php74: true);
 
 /**
  * Configuration consts for the different rector.php config files

build/config/phpstan-for-downgrade.neon

@@ -5,7 +5,3 @@ parameters:
     scanDirectories:
         # this is needed for symfony/dependendency-injection as it has hidden dependency on symfony/expression-language that we don't use here
         - ../../stubs
-
-    # see https://github.com/rectorphp/rector/issues/3490#issue-634342324
-    featureToggles:
-        disableRuntimeReflectionProvider: true

build/target-repository/.github/workflows/along_other_packages.yaml

@@ -13,7 +13,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php_version: ['7.2', '7.3', '7.4', '8.0', '8.1']
+                php_version: ['7.4', '8.0', '8.1']
                 commands:
                     -
                         name: 'Composer Dependency'
@@ -26,7 +26,7 @@ jobs:
 
                     -
                         name: 'Along PHPStan'
-                        install: composer require phpstan/phpstan:^1.1.1 --dev --ansi
+                        install: composer require phpstan/phpstan:^2.0 --dev --ansi
 
         name: "PHP ${{ matrix.php_version }}"
 

build/target-repository/.github/workflows/e2e.yaml

@@ -14,7 +14,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php_version: ['7.2', '7.3', '7.4', '8.0', '8.1']
+                php_version: ['7.4', '8.0', '8.1']
                 directory:
                     - 'e2e/define-constant'
                     - 'e2e/dont-execute-code'

build/target-repository/.github/workflows/e2e_diff.yaml

@@ -14,7 +14,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php_version: ['7.2', '7.3', '7.4', '8.0', '8.1']
+                php_version: ['7.4', '8.0', '8.1']
                 directory:
                     - 'e2e/attributes'
 

build/target-repository/.github/workflows/e2e_global.yaml

@@ -11,7 +11,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php_version: ['7.2', '7.3', '7.4', '8.0', '8.1']
+                php_version: ['7.4', '8.0', '8.1']
                 directory:
                     - 'e2e/global-install'
 

build/target-repository/.github/workflows/standalone_rule_test.yaml

@@ -11,7 +11,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php_version: ['7.3']
+                php_version: ['7.4']
                 directory:
                     - 'e2e/rector-prefixed-rule-test'
 

build/target-repository/README.md

@@ -8,7 +8,7 @@ Rector instantly upgrades and refactors the PHP code of your application.  It ca
 
 ### 1. Instant Upgrades
 
-Rector now supports upgrades from PHP 5.3 to 8.2 and major open-source projects like [Symfony](https://github.com/rectorphp/rector-symfony), [PHPUnit](https://github.com/rectorphp/rector-phpunit), and [Doctrine](https://github.com/rectorphp/rector-doctrine). Do you want to **be constantly on the latest PHP and Framework without effort**?
+Rector now supports upgrades from PHP 5.3 to 8.4 and major open-source projects like [Symfony](https://github.com/rectorphp/rector-symfony), [PHPUnit](https://github.com/rectorphp/rector-phpunit), and [Doctrine](https://github.com/rectorphp/rector-doctrine). Do you want to **be constantly on the latest PHP and Framework without effort**?
 
 Use Rector to handle **instant upgrades** for you.
 
@@ -162,4 +162,4 @@ We're using [ECS](https://github.com/symplify/easy-coding-standard) with [this s
 
 ### May cause unexpected output on File with mixed PHP+HTML content
 
-When you apply changes to File(s) thas has mixed PHP+HTML content, you may need to manually verify the changed file after apply the changes.
+When you apply changes to files with PHP + HTML content, you may need to manually verify the changed file after apply the changes.

build/target-repository/composer.json

@@ -7,8 +7,8 @@
         "bin/rector"
     ],
     "require": {
-        "php": "^7.2|^8.0",
-        "phpstan/phpstan": "^1.12.5"
+        "php": "^7.4|^8.0",
+        "phpstan/phpstan": "^2.0.4"
     },
     "autoload": {
         "files": [