Add Rector

README.md

@@ -39,6 +39,7 @@ locally they will need to be installed. All of them are available via [Phive](ht
 * [Infection](https://infection.github.io/)
 * [PHP Coveralls](https://php-coveralls.github.io/php-coveralls/)
 * [PHP CS Fixer](https://cs.symfony.com/)
+* [Rector](https://github.com/rectorphp/rector/)
 
 ## Source Files
 
@@ -120,6 +121,18 @@ running unit tests. This workflow also configures PHPUnit to report on code cove
 upload the results to [Coveralls.io](https://coveralls.io) (you will need a free account,
 but it is also fine to use this workflow without Coveralls).
 
+#### Rector
+
+*Requires **rector.php***
+
+Rector provides automated refactoring of code, allowing you to make sweeping updates based on
+predefined rulesets. Rector can be highly opinionated based on its configuration file (**rector.php**)
+so be sure to read the documentation and figure out the best fit for you. This workflow performs
+a "dry run" to check for any changes that Rector would have made and fail if there are matches.
+
+> Note: Rector updates rules all the time so you may want to lock your repo to the latest known working version of Rector to prevent unexpected failures
+> E.g. in **.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4`
+
 #### Unused
 
 Composer Unused does one thing: checks that your code actually uses the dependencies you

src/.github/workflows/rector.yml

@@ -0,0 +1,68 @@
+name: Rector
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.**'
+      - 'rector.php'
+      - '.github/workflows/rector.yml'
+  push:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.**'
+      - 'rector.php'
+      - '.github/workflows/rector.yml'
+
+jobs:
+  build:
+    name: PHP ${{ matrix.php-versions }} Rector Analysis
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.3', '7.4', '8.0']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          tools: phpstan
+          extensions: intl, json, mbstring, xml
+          coverage: none
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: |
+          composer -q config -g github-oauth.github.com "${{ secrets.GITHUB_TOKEN }}"
+          if [ -f composer.lock ]; then
+            composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          else
+            composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          fi
+
+      - name: Analyze for refactoring
+        run: |
+          composer global require --dev rector/rector
+          rector process --dry-run --no-progress-bar

src/rector.php

@@ -0,0 +1,108 @@
+<?php
+
+use Rector\CodeQuality\Rector\BooleanAnd\SimplifyEmptyArrayCheckRector;
+use Rector\CodeQuality\Rector\Expression\InlineIfToExplicitIfRector;
+use Rector\CodeQuality\Rector\For_\ForToForeachRector;
+use Rector\CodeQuality\Rector\Foreach_\UnusedForeachValueToArrayKeysRector;
+use Rector\CodeQuality\Rector\FuncCall\AddPregQuoteDelimiterRector;
+use Rector\CodeQuality\Rector\FuncCall\ChangeArrayPushToArrayAssignRector;
+use Rector\CodeQuality\Rector\FuncCall\SimplifyRegexPatternRector;
+use Rector\CodeQuality\Rector\FuncCall\SimplifyStrposLowerRector;
+use Rector\CodeQuality\Rector\If_\CombineIfRector;
+use Rector\CodeQuality\Rector\If_\ShortenElseIfRector;
+use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
+use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;
+use Rector\CodeQuality\Rector\Return_\SimplifyUselessVariableRector;
+use Rector\CodeQuality\Rector\Ternary\UnnecessaryTernaryExpressionRector;
+use Rector\CodingStyle\Rector\ClassMethod\FuncGetArgsToVariadicParamRector;
+use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
+use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
+use Rector\Core\Configuration\Option;
+use Rector\Core\ValueObject\PhpVersion;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPromotedPropertyRector;
+use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
+use Rector\EarlyReturn\Rector\Foreach_\ChangeNestedForeachIfsToEarlyContinueRector;
+use Rector\EarlyReturn\Rector\If_\ChangeIfElseValueAssignToEarlyReturnRector;
+use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
+use Rector\EarlyReturn\Rector\Return_\PreparedValueToEarlyReturnRector;
+use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
+use Rector\Php56\Rector\FunctionLike\AddDefaultValueForUndefinedVariableRector;
+use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
+use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector;
+use Rector\PHPUnit\Set\PHPUnitSetList;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // Rule sets to apply
+    $containerConfigurator->import(SetList::DEAD_CODE);
+    $containerConfigurator->import(LevelSetList::UP_TO_PHP_73);
+    $containerConfigurator->import(PHPUnitSetList::PHPUNIT_SPECIFIC_METHOD);
+    $containerConfigurator->import(PHPUnitSetList::PHPUNIT_80);
+
+    $parameters = $containerConfigurator->parameters();
+
+    // The paths to refactor (can also be supplied with CLI arguments)
+    $parameters->set(Option::PATHS, [
+        __DIR__ . '/app',
+        __DIR__ . '/tests',
+    ]);
+
+    // Do you need to include constants, class aliases, or a custom autoloader?
+    $parameters->set(Option::BOOTSTRAP_FILES, [
+        realpath(getcwd()) . '/vendor/codeigniter4/framework/system/Test/bootstrap.php',
+    ]);
+
+    // Set the target version for refactoring
+    $parameters->set(Option::PHP_VERSION_FEATURES, PhpVersion::PHP_73);
+
+    // Auto-import fully qualified class names
+    $parameters->set(Option::AUTO_IMPORT_NAMES, true);
+
+    // Are there files or rules you need to skip?
+    $parameters->set(Option::SKIP, [
+        __DIR__ . '/app/Views',
+
+        JsonThrowOnErrorRector::class,
+        StringifyStrNeedlesRector::class,
+
+        // Note: requires php 8
+        RemoveUnusedPromotedPropertyRector::class,
+
+        // Ignore tests that might make calls without a result
+        RemoveEmptyMethodCallRector::class => [
+            __DIR__ . '/tests',
+        ],
+
+        // May load view files directly when detecting classes
+        StringClassNameToClassConstantRector::class,
+
+        // May be uninitialized on purpose
+        AddDefaultValueForUndefinedVariableRector::class,
+    ]);
+
+    // Additional rules to apply
+    $services = $containerConfigurator->services();
+    $services->set(SimplifyUselessVariableRector::class);
+    $services->set(RemoveAlwaysElseRector::class);
+    $services->set(CountArrayToEmptyArrayComparisonRector::class);
+    $services->set(ForToForeachRector::class);
+    $services->set(ChangeNestedForeachIfsToEarlyContinueRector::class);
+    $services->set(ChangeIfElseValueAssignToEarlyReturnRector::class);
+    $services->set(SimplifyStrposLowerRector::class);
+    $services->set(CombineIfRector::class);
+    $services->set(SimplifyIfReturnBoolRector::class);
+    $services->set(InlineIfToExplicitIfRector::class);
+    $services->set(PreparedValueToEarlyReturnRector::class);
+    $services->set(ShortenElseIfRector::class);
+    $services->set(SimplifyIfElseToTernaryRector::class);
+    $services->set(UnusedForeachValueToArrayKeysRector::class);
+    $services->set(ChangeArrayPushToArrayAssignRector::class);
+    $services->set(UnnecessaryTernaryExpressionRector::class);
+    $services->set(AddPregQuoteDelimiterRector::class);
+    $services->set(SimplifyRegexPatternRector::class);
+    $services->set(FuncGetArgsToVariadicParamRector::class);
+    $services->set(MakeInheritedMethodVisibilitySameAsParentRector::class);
+    $services->set(SimplifyEmptyArrayCheckRector::class);
+};