[TASK] Use Rector in CI workflow (#25)

Author: gilbertsoft

.github/workflows/continuous-integration.yml

@@ -8,7 +8,7 @@ on:
     paths-ignore:
       - '.ddev/**'
   schedule:
-    - cron:  '44 4 * * *'
+    - cron: '44 4 * * *'
 
 env:
   COMPOSER_FLAGS: --ansi --no-interaction --no-progress --prefer-dist
@@ -145,10 +145,48 @@ jobs:
       - name: Lint PHP files
         run: composer ci:php:lint
 
+  php_rector:
+    name: PHP Rector
+    needs:
+      - php_lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          extensions: intl, zip
+          ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
+          php-version: latest
+
+      - name: Composer Cache Vars
+        id: composer-cache-vars
+        run: |
+          echo "::set-output name=dir::$(composer config cache-files-dir)"
+          echo "::set-output name=timestamp::$(date +"%s")"
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache-vars.outputs.dir }}
+          key: ${{ runner.os }}-composer-latest-${{ steps.composer-cache-vars.outputs.timestamp }}
+          restore-keys: |
+            ${{ runner.os }}-composer-latest-
+
+      - name: Install dependencies
+        run: composer install ${{ env.COMPOSER_FLAGS }}
+
+      - name: Validation of Rector rules for PHP files
+        run: composer ci:php:rector
+
   php_coding_standards:
     name: PHP Coding Standards
     needs:
-      - php_lint
+      - php_rector
     runs-on: ubuntu-latest
 
     steps:
@@ -186,7 +224,7 @@ jobs:
   php_sniff:
     name: PHP Code Sniffer
     needs:
-      - php_lint
+      - php_rector
     runs-on: ubuntu-latest
 
     steps:
@@ -224,7 +262,7 @@ jobs:
   php_copypaste_detector:
     name: PHP Copy/Paste Detector
     needs:
-      - php_lint
+      - php_rector
     runs-on: ubuntu-latest
 
     steps:
@@ -263,7 +301,6 @@ jobs:
     name: PHP Stan
     needs:
       - validation
-      - php_lint
       - php_coding_standards
       - php_sniff
       - php_copypaste_detector
@@ -338,10 +375,6 @@ jobs:
   tests:
     name: Tests
     needs:
-      - php_lint
-      - php_coding_standards
-      - php_sniff
-      - php_copypaste_detector
       - php_stan
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}

composer.json

@@ -92,6 +92,7 @@
 		],
 		"ci:php": [
 			"@ci:php:lint",
+			"@ci:php:rector",
 			"@ci:php:cs-fixer",
 			"@ci:php:sniff",
 			"@ci:php:copypaste",
@@ -100,6 +101,7 @@
 		"ci:php:copypaste": "phpcpd src tests",
 		"ci:php:cs-fixer": "php-cs-fixer fix -v --dry-run --using-cache no --diff",
 		"ci:php:lint": "phplint --no-progress",
+		"ci:php:rector": "rector process --dry-run --no-progress-bar",
 		"ci:php:sniff": "phpcs --standard=PSR12 src tests",
 		"ci:php:sniff:strict": "phpcs src tests",
 		"ci:php:stan": "phpstan analyse --no-progress",
@@ -134,10 +136,12 @@
 		],
 		"fix:composer:normalize": "@composer normalize",
 		"fix:php": [
+			"@fix:php:rector",
 			"@fix:php:sniff",
 			"@fix:php:cs"
 		],
 		"fix:php:cs": "php-cs-fixer fix",
+		"fix:php:rector": "rector process --no-diffs",
 		"fix:php:sniff": "phpcbf --standard=PSR12 src",
 		"test:php:unit": [
 			"Composer\\Config::disableProcessTimeout",
@@ -198,8 +202,7 @@
 		"tools:php:copypaste": "phpcpd src tests",
 		"tools:php:cs-fixer": "php-cs-fixer fix -v --dry-run --diff",
 		"tools:php:lint": "phplint",
-		"tools:php:rector": "rector process --dry-run --no-progress-bar --no-diffs",
-		"tools:php:rector:process": "rector process --no-diffs",
+		"tools:php:rector": "rector process --dry-run",
 		"tools:php:sniff": "phpcs --standard=PSR12 src tests",
 		"tools:php:sniff:strict": "phpcs src tests",
 		"tools:php:stan": "phpstan analyse",

rector.php

@@ -14,6 +14,7 @@
 use Rector\Core\Configuration\Option;
 use Rector\Php74\Rector\Property\TypedPropertyRector;
 use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
@@ -30,6 +31,17 @@
 
     // Define what rule sets will be applied
     $containerConfigurator->import(LevelSetList::UP_TO_PHP_74);
+    $containerConfigurator->import(SetList::CODE_QUALITY);
+    $containerConfigurator->import(SetList::CODING_STYLE);
+    $containerConfigurator->import(SetList::DEAD_CODE);
+    $containerConfigurator->import(SetList::NAMING);
+    //$containerConfigurator->import(SetList::ORDER);
+    $containerConfigurator->import(SetList::PRIVATIZATION);
+    $containerConfigurator->import(SetList::PSR_4);
+    //$containerConfigurator->import(SetList::TYPE_DECLARATION);
+    //$containerConfigurator->import(SetList::TYPE_DECLARATION_STRICT);
+    $containerConfigurator->import(SetList::UNWRAP_COMPAT);
+    //$containerConfigurator->import(SetList::EARLY_RETURN);
 
     // get services (needed for register a single rule)
     // $services = $containerConfigurator->services();

src/Command/Typo3/Patch/ApplyCommand.php

@@ -65,7 +65,7 @@ protected function configure()
      *
      * @see https://review.typo3.org/Documentation/rest-api-changes.html#change-id
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)
     {
         // Get parameters
         if (!is_array($changeIds = $input->getArgument('change-id'))) {

src/Command/Typo3/Patch/RemoveCommand.php

@@ -48,7 +48,7 @@ protected function configure()
      * @throws InvalidArgumentException
      * @throws UnexpectedValueException
      */
-    public function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)
     {
         // Get parameters
         if (!is_array($changeIds = $input->getArgument('change-id'))) {

src/Exception/CommandExecutionException.php

@@ -11,6 +11,6 @@
 
 namespace GsTYPO3\CorePatches\Exception;
 
-class CommandExecutionException extends RuntimeException
+final class CommandExecutionException extends RuntimeException
 {
 }

src/Exception/InvalidArgumentException.php

@@ -13,6 +13,6 @@
 
 use Symfony\Component\Console\Exception\InvalidArgumentException as InvalidArgumentExceptionBase;
 
-class InvalidArgumentException extends InvalidArgumentExceptionBase implements ExceptionInterface
+final class InvalidArgumentException extends InvalidArgumentExceptionBase implements ExceptionInterface
 {
 }

src/Exception/InvalidOptionException.php

@@ -13,6 +13,6 @@
 
 use Symfony\Component\Console\Exception\InvalidOptionException as InvalidOptionExceptionBase;
 
-class InvalidOptionException extends InvalidOptionExceptionBase implements ExceptionInterface
+final class InvalidOptionException extends InvalidOptionExceptionBase implements ExceptionInterface
 {
 }

src/Exception/InvalidPatchException.php

@@ -11,6 +11,6 @@
 
 namespace GsTYPO3\CorePatches\Exception;
 
-class InvalidPatchException extends UnexpectedValueException
+final class InvalidPatchException extends UnexpectedValueException
 {
 }

src/Exception/InvalidResponseException.php

@@ -11,6 +11,6 @@
 
 namespace GsTYPO3\CorePatches\Exception;
 
-class InvalidResponseException extends UnexpectedValueException
+final class InvalidResponseException extends UnexpectedValueException
 {
 }