Add Rector to project

Author: sambhavp96

.github/workflows/ci.yaml

@@ -18,7 +18,7 @@ jobs:
           - php-version: 8.2
             phing_tasks: "phpunitfast"
           - php-version: 8.3
-            phing_tasks: "phpunitfast phpcs-console php-cs-fixer-dryrun phpstan-console"
+            phing_tasks: "phpunitfast phpcs-console php-cs-fixer-dryrun phpstan-console rector-console"
 
     steps:
       - name: Setup PHP
@@ -27,6 +27,13 @@ jobs:
           php-version: ${{ matrix.php-version }}
           extensions: intl, xsl
 
+      - name: Cache rector data
+        uses: actions/cache@v4
+        with:
+          path: .rector
+          key: "php-${{ matrix.php-version }}-rector-${{ github.sha }}"
+          restore-keys: "php-${{ matrix.php-version }}-rector-"
+
       - name: Checkout
         uses: actions/checkout@v4
 

.gitignore

@@ -3,3 +3,4 @@ composer.lock
 .php_cs_cache
 .phpstan_cache
 tests/.phpunit.result.cache
+.rector

build.xml

@@ -38,6 +38,7 @@
     <phingcall target="phpmd"/>
     <phingcall target="pdepend"/>
     <phingcall target="phpstan-checkstyle"/>
+    <phingcall target="rector-console"/>
   </target>
 
   <!-- Report rule violations with PHPMD (mess detector) -->
@@ -82,6 +83,18 @@
       <arg line="--configuration=${srcdir}/tests/phpstan.neon --memory-limit=2G analyse" />
     </exec>
   </target>
+  
+  <!-- Rector -->
+  <target name="rector-console">
+    <exec executable="${srcdir}/vendor/bin/rector" escape="false" passthru="true" checkreturn="true">
+      <arg line="--config=${srcdir}/tests/rector.php --dry-run" />
+    </exec>
+  </target>
+  <target name="rector">
+    <exec executable="${srcdir}/vendor/bin/rector" escape="false" passthru="true" checkreturn="true">
+      <arg line="--config=${srcdir}/tests/rector.php" />
+    </exec>
+  </target>
 
   <!-- php-cs-fixer (first task applies fixes, second task simply checks if they are needed) -->
   <target name="php-cs-fixer">

composer.json

@@ -33,6 +33,7 @@
         "phpstan/phpstan": "1.12.7",
         "phpunit/phpunit": "10.5.36",
         "phing/phing": "3.0",
+        "rector/rector": "^1.2",
         "squizlabs/php_codesniffer": "3.10.3"
     }
 }

tests/phpcs.xml

@@ -5,6 +5,7 @@
   <file>.</file>
   <exclude-pattern>*/config/*</exclude-pattern>
   <exclude-pattern>*.php-cs-fixer.*</exclude-pattern>
+  <exclude-pattern>*rector.*</exclude-pattern>
   <arg name="extensions" value="php"/>
   <!-- We only use PEAR to ensure complete comments at this time -->
   <rule ref="PEAR.Commenting">

tests/rector.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Caching\ValueObject\Storage\FileCacheStorage;
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\Set\PHPUnitSetList;
+
+return RectorConfig::configure()
+    ->withCache(
+        cacheClass: FileCacheStorage::class,
+        cacheDirectory: __DIR__ . '/../.rector'
+    )->withPaths([
+        __DIR__ . '/../src',
+    ])
+    ->withSets([
+        PHPUnitSetList::ANNOTATIONS_TO_ATTRIBUTES,
+    ])
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(6)
+    ->withCodeQualityLevel(18);