Rector 0.10

.editorconfig

@@ -11,3 +11,7 @@ insert_final_newline = true
 
 [composer.{json,lock}]
 indent_size = 4
+
+[*.neon]
+indent_size = 4
+indent_style = tab

.github/workflows/local_package_functional_tests.yml

@@ -14,46 +14,44 @@ jobs:
                 with:
                     php-version: 7.3
                     coverage: none # disable xdebug, pcov
-                    extensions: "intl"
-
-            # This is copied from `local_package_run_rector`.
-            -    run: |
-                    # Download the latest Drupal core project and all its dependencies
-                    composer create-project drupal/recommended-project:~8 ../drupal --no-progress
-                    mv ../drupal/* ..
-
-            # This is copied from `local_package_run_rector`.
-            -    run: |
-                    # Install drupal-rector using current github-actions directory (allow testing for both forks and main repo)
-                    cd ..
-                    composer config repositories.drupal-rector '{"type": "path", "url": "drupal-rector", "options": {"symlink": true}}'
-                    composer require palantirnet/drupal-rector:@dev --prefer-source --no-progress
-
-            # This is copied from `local_package_run_rector`.
-            -    run: |
-                    # Prepare rector config files with Drupal specific settings
-                    cd ..
-                    cp vendor/palantirnet/drupal-rector/rector.yml .
-
-            # This is copied from `local_package_run_rector`.
-            # This seems needed for the autoloading to work.
-            -    run: |
-                  # Prepare rector_examples folder in the drupal modules directory
-                  cd ..
+                    tools: composer:v2
+                    extensions: dom, curl, libxml, mbstring, zip, pdo, mysql, pdo_mysql, bcmath, gd, exif, iconv
+
+            -   name: Setup Drupal
+                run: |
+                    COMPOSER_MEMORY_LIMIT=-1 composer create-project drupal/recommended-project:~8 ~/drupal --no-interaction
+                    cd ~/drupal
+                    composer config minimum-stability dev
+                    composer config prefer-stable true
+                    composer config preferred-install dist
+                    composer config repositories.0 "{\"type\": \"path\", \"url\": \"$GITHUB_WORKSPACE\", \"options\": {\"symlink\": false}}"
+                    composer config repositories.1 composer https://packages.drupal.org/8
+                    COMPOSER_MEMORY_LIMIT=-1 composer require drupal/core-dev:~8 --with-all-dependencies
+            -   name: Install drupal-rector
+                run: |
+                    cd ~/drupal
+                    composer require palantirnet/drupal-rector:@dev --no-progress
+
+            -   name: Copy rector config
+                run: |
+                    cd ~/drupal
+                    cp vendor/palantirnet/drupal-rector/rector.php .
+                    cat rector.php
+
+            -   name: Prepare rector_examples folder in the drupal modules directory
+                run: |
+                  cd ~/drupal
                   mkdir -p web/modules/custom
-                  cp -r vendor/palantirnet/drupal-rector/rector_examples web/modules/custom/.
-
-            -    run: |
-                    # Install phpunit/phpunit on the Drupal site since it's needed for some of our examples.
-                    cd ..
-                    composer require phpunit/phpunit:~7.5
-
-            -    run: |
-                    # Install local packages, including Behat
-                    composer install
-
-            #            -  uses: mxschmitt/action-tmate@v2
-
-            -    run: |
-                    # Run Behat
-                    vendor/bin/behat
+                  mv vendor/palantirnet/drupal-rector/rector_examples web/modules/custom
+                  ls -la web/modules/custom/rector_examples
+
+            # dry-run is expected to return exit code 1 if there are changes, which we are expecting to happen, here.
+            -   name: Run rector against Drupal (dry-run)
+                run: |
+                    cd ~/drupal
+                    vendor/bin/rector process web/modules/custom/rector_examples --dry-run --debug || if (($? == 1)); then true; else false; fi
+            -   name: Run rector against Drupal
+                run: |
+                    cd ~/drupal
+                    vendor/bin/rector process web/modules/custom/rector_examples --debug
+            -    run: diff -rubB rector_examples_updated ~/drupal/web/modules/custom/rector_examples

.github/workflows/local_package_run_rector.yml

@@ -6,43 +6,86 @@ on:
 
 jobs:
     run_rector_on_rector_examples_module:
-        name: Run Drupal Rector
+        name: rector_examples check
         runs-on: ubuntu-latest
         steps:
             -   uses: actions/checkout@v2
             -   uses: shivammathur/setup-php@v2
                 with:
                     php-version: 7.3
                     coverage: none # disable xdebug, pcov
-                    extensions: "intl"
+                    tools: composer:v2
+                    extensions: dom, curl, libxml, mbstring, zip, pdo, mysql, pdo_mysql, bcmath, gd, exif, iconv
 
-#           Uncomment to enable SSH access to Github Actions - https://github.com/marketplace/actions/debugging-with-tmate#getting-started
-#            - name: Debugging with tmate
-#              uses: mxschmitt/action-tmate@v2
-
-            -   run: |
-                    # Download the latest Drupal core project and all its dependencies
-                    composer create-project drupal/recommended-project:~8 ../drupal --no-progress
-                    mv ../drupal/* ..
-
-            -   run: |
-                    # Install drupal-rector using current github-actions directory (allow testing for both forks and main repo)
-                    cd ..
-                    composer config repositories.drupal-rector '{"type": "path", "url": "drupal-rector", "options": {"symlink": true}}'
-                    composer require palantirnet/drupal-rector:@dev --prefer-source --no-progress
+            -   name: Setup Drupal
+                run: |
+                    COMPOSER_MEMORY_LIMIT=-1 composer create-project drupal/recommended-project:~8 ~/drupal --no-interaction
+                    cd ~/drupal
+                    composer config minimum-stability dev
+                    composer config prefer-stable true
+                    composer config preferred-install dist
+                    composer config repositories.0 "{\"type\": \"path\", \"url\": \"$GITHUB_WORKSPACE\", \"options\": {\"symlink\": false}}"
+                    composer config repositories.1 composer https://packages.drupal.org/8
+                    COMPOSER_MEMORY_LIMIT=-1 composer require drupal/core-dev:~8 --with-all-dependencies
+            -   name: require local druapl-rector
+                run: |
+                    cd ~/drupal
+                    composer require palantirnet/drupal-rector:@dev --no-progress
 
             -   run: |
                     # Prepare rector config files with Drupal specific settings
-                    cd ..
-                    cp vendor/palantirnet/drupal-rector/rector.yml .
+                    cd ~/drupal
+                    cp vendor/palantirnet/drupal-rector/rector.php .
 
             -   run: |
                     # Prepare rector_examples folder in the drupal modules directory
-                    cd ..
+                    cd ~/drupal
                     mkdir -p web/modules/custom
                     cp -r vendor/palantirnet/drupal-rector/rector_examples web/modules/custom/.
 
             -   run: |
                     # Run Rector
-                    cd ..
-                    vendor/bin/rector process web/modules/custom/rector_examples
+                    cd ~/drupal
+                    vendor/bin/rector process web/modules/custom/rector_examples --debug
+    run_rector_on_webform:
+        name: webform check
+        runs-on: ubuntu-latest
+        # There are some non-related errors. So this run acts as a canary
+        # that we manually review to shake loose errors.
+        # @todo: remove when PHPStan doesn't choke on WebformLikert doc block
+        continue-on-error: true
+        steps:
+            -   uses: actions/checkout@v2
+            -   uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 7.3
+                    coverage: none # disable xdebug, pcov
+                    tools: composer:v2
+                    extensions: dom, curl, libxml, mbstring, zip, pdo, mysql, pdo_mysql, bcmath, gd, exif, iconv
+
+            -   name: Setup Drupal
+                run: |
+                    COMPOSER_MEMORY_LIMIT=-1 composer create-project drupal/recommended-project:~8 ~/drupal --no-interaction
+                    cd ~/drupal
+                    composer config minimum-stability dev
+                    composer config prefer-stable true
+                    composer config preferred-install dist
+                    composer config repositories.0 "{\"type\": \"path\", \"url\": \"$GITHUB_WORKSPACE\", \"options\": {\"symlink\": false}}"
+                    composer config repositories.1 composer https://packages.drupal.org/8
+                    COMPOSER_MEMORY_LIMIT=-1 composer require drupal/core-dev:~8 --with-all-dependencies
+                    # Include webform and its conditionally supported dependencies
+                    COMPOSER_MEMORY_LIMIT=-1 composer require drupal/bootstrap drupal/webform
+            -   name: require local druapl-rector
+                run: |
+                    cd ~/drupal
+                    composer require palantirnet/drupal-rector:@dev --no-progress
+
+            -   run: |
+                    # Prepare rector config files with Drupal specific settings
+                    cd ~/drupal
+                    cp vendor/palantirnet/drupal-rector/rector.php .
+
+            -   run: |
+                    # Run Rector
+                    cd ~/drupal
+                    vendor/bin/rector process web/modules/contrib/webform --debug

.github/workflows/packagist_package_run_rector.yml

@@ -1,8 +1,7 @@
 name: packagist_package_run_rector
 
-# This test will run on every pull request, and on every commit that is pushed to master
+# This test will run on every commit that is pushed to master
 on:
-    pull_request: null
     push:
         branches:
             - master
@@ -37,7 +36,7 @@ jobs:
             -   run: |
                     # Prepare rector config files with Drupal specific settings
                     cd drupal
-                    cp vendor/palantirnet/drupal-rector/rector.yml .
+                    cp vendor/palantirnet/drupal-rector/rector.php .
 
             -   run: |
                     # Prepare rector_examples folder in the drupal modules directory

.github/workflows/phpstan.yml

@@ -0,0 +1,16 @@
+name: phpstan
+on: [push, pull_request]
+jobs:
+    phpstan_analyze:
+        name: PHPStan Analyze
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v2
+            -   uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 7.3
+                    coverage: none # disable xdebug, pcov
+                    tools: composer:v2
+                    extensions: dom, curl, libxml, mbstring, zip, pdo, mysql, pdo_mysql, bcmath, gd, exif, iconv
+            -    run: composer install
+            -    run: vendor/bin/phpstan

.github/workflows/phpunit.yml

@@ -0,0 +1,17 @@
+name: phpunit
+on: [push, pull_request]
+jobs:
+    phpunit:
+        name: PHPUnit
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v2
+            -   uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 7.3
+                    coverage: none # disable xdebug, pcov
+                    tools: composer:v2
+                    extensions: dom, curl, libxml, mbstring, zip, pdo, mysql, pdo_mysql, bcmath, gd, exif, iconv
+            -    run: composer install
+            -    run: composer create-project drupal/recommended-project:^8.9 tests/fixtures/drupal
+            -    run: vendor/bin/phpunit

.gitignore

@@ -12,3 +12,6 @@
 
 /features/tmp/*
 !/features/tmp/.placeholder
+
+/.phpunit.cache
+/tests/fixtures/drupal

README.md

@@ -58,34 +58,16 @@ $ composer require --dev palantirnet/drupal-rector
 
 ### Create a configuration file in your project
 
-You will need to have a `rector.yml` configuration in the root of your repository. This should sit beside your document root such as `web` or `docroot`.
+You will need to have a `rector.php` configuration in the root of your repository. This should sit beside your document root such as `web` or `docroot`.
 
-This project provides starting files that should handle most use cases.
+This project uses [`webflo/drupal-finder`](https://packagist.org/packages/webflo/drupal-finder) to find your document root that contains Drupal.
 
-If your document root directory is `web`, you can copy the `rector-config-web-dir.yml`
+To get started, copy the `rector.php` configuration file provided by this package:
 
 ```bash
-cp vendor/palantirnet/drupal-rector/rector-config-web-dir.yml rector.yml
+cp vendor/palantirnet/drupal-rector/rector.php .
 ```
 
-If your document root directory is `docroot`, you can copy the `rector-config-docroot-dir.yml`
-
-```bash
-cp vendor/palantirnet/drupal-rector/rector-config-docroot-dir.yml rector.yml
-```
-
-If your document root directory is something else you will need to manually copy and edit `rector.yml`.
-
-Replace the `web` in these paths with your document root.
-
-```
-parameters:
-  autoload_paths:
-    - 'web/core'
-    - 'web/core/modules'
-    - 'web/modules'
-    - 'web/profiles'
-```
 
 ## Suggested workflow
 
@@ -140,7 +122,7 @@ If you are having these issues try running Rector from the environment that has
 
 ### Iconv error when running Rector in Alpine Docker
 
-If you are getting errors like 
+If you are getting errors like
 
 `iconv(): Wrong charset, conversion from UTF-8 to ASCII//TRANSLIT//IGNORE is not allowed`
 

composer.json

@@ -10,7 +10,8 @@
         "ast"
     ],
     "require": {
-        "rector/rector-prefixed": "0.7.29"
+        "rector/rector-prefixed": "~0.10.0",
+        "webflo/drupal-finder": "^1.2"
     },
     "license": "MIT",
     "authors": [
@@ -28,10 +29,18 @@
         }
     ],
     "autoload": {
+        "files": [
+            "drupal-phpunit-hack.php"
+        ],
         "psr-4": {
             "DrupalRector\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "DrupalRector\\Tests\\": "tests/src"
+        }
+    },
     "config": {
         "optimize-autoloader": true,
         "update-with-dependencies": true,
@@ -45,6 +54,11 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require-dev": {
-        "behat/behat": "^3.6"
+        "behat/behat": "^3.6",
+        "phpstan/extension-installer": "^1.1",
+        "phpstan/phpstan": "^0.12.82",
+        "phpstan/phpstan-deprecation-rules": "^0.12.6",
+        "phpunit/phpunit": "^9.5",
+        "rector/rector": "~0.10.0"
     }
 }

config/drupal-8/drupal-8-all-deprecations.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Core\Configuration\Option;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import(__DIR__ . '/drupal-8.*');
+
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::SKIP, []);
+    $parameters->set(Option::BOOTSTRAP_FILES, [
+        __DIR__ . '/../drupal-phpunit-bootstrap-file.php'
+    ]);
+};