Merge pull request #16600 from craftcms/pullrequests/samsonasik/start…

…-using-rector Start using Rector in CI/CD pipeline
craftcms · Jan 31, 2025 · 15b60f3 · 15b60f3
2 parents 7547163 + 7d5d187
commit 15b60f3
Show file tree

Hide file tree

Showing 23 changed files with 120 additions and 26 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,3 +24,22 @@ jobs:
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
       slack_webhook_url: ${{ secrets.SLACK_CRAFT_WEBHOOK_URL }}
+
+    # this can be moved to .github repo once this is proven works on CI
+  rector:
+    strategy:
+      fail-fast: false
+
+    runs-on: ubuntu-latest
+    timeout-minutes: 8
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          # PHP 8.2 is required, so Rector's code is PHP 8.2 compatible even after refactoring
+          php-version: 8.2
+          coverage: none
+
+      - run: composer install --no-progress --ansi
+      - run: vendor/bin/rector process --dry-run --ansi
diff --git a/composer.json b/composer.json
@@ -75,16 +75,17 @@
   },
   "require-dev": {
     "codeception/codeception": "^5.0.11",
+    "codeception/lib-innerbrowser": "4.0.1",
     "codeception/module-asserts": "^3.0.0",
     "codeception/module-datafactory": "^3.0.0",
     "codeception/module-phpbrowser": "^3.0.0",
     "codeception/module-rest": "^3.3.2",
     "codeception/module-yii2": "^1.1.9",
-    "codeception/lib-innerbrowser": "4.0.1",
     "craftcms/ecs": "dev-main",
     "fakerphp/faker": "^1.19.0",
     "league/factory-muffin": "^3.3.0",
     "phpstan/phpstan": "^1.10.56",
+    "rector/rector": "^1.2",
     "vlucas/phpdotenv": "^5.4.1",
     "yiisoft/yii2-redis": "^2.0"
   },

diff --git a/composer.lock b/composer.lock
diff --git a/rector.php b/rector.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/lib',
+        __DIR__ . '/src',
+    ])
+    ->withSkip([
+        __DIR__ . '/src/icons/index.php',
+    ])
+    ->withPhpSets(php56: true);
diff --git a/src/base/Field.php b/src/base/Field.php
@@ -1004,7 +1004,7 @@ private function _valueSql(?string $key): ?string
         }
 
         if ($key !== null && (!is_array($dbType) || !isset($dbType[$key]))) {
-            throw new InvalidArgumentException(sprintf('%s doesn’t store values under the key “%s”.', __CLASS__, $key));
+            throw new InvalidArgumentException(sprintf('%s doesn’t store values under the key “%s”.', self::class, $key));
         }
 
         $db = Craft::$app->getDb();

diff --git a/src/controllers/ConfigSyncController.php b/src/controllers/ConfigSyncController.php
@@ -242,7 +242,7 @@ protected function initialState(bool $force = false): array
      */
     protected function postComposerInstallState(): array
     {
-        throw new NotSupportedException('postComposerInstallState() is not supported by ' . __CLASS__);
+        throw new NotSupportedException('postComposerInstallState() is not supported by ' . self::class);
     }
 
     /**

diff --git a/src/elements/GlobalSet.php b/src/elements/GlobalSet.php
@@ -187,7 +187,7 @@ protected function defineBehaviors(): array
         $behaviors = parent::defineBehaviors();
         $behaviors['fieldLayout'] = [
             'class' => FieldLayoutBehavior::class,
-            'elementType' => __CLASS__,
+            'elementType' => self::class,
         ];
         return $behaviors;
     }

diff --git a/src/elements/db/ElementQuery.php b/src/elements/db/ElementQuery.php
@@ -631,7 +631,7 @@ public function __set($name, $value)
      */
     public function __toString()
     {
-        return __CLASS__;
+        return self::class;
     }
 
     /**

diff --git a/src/fieldlayoutelements/Html.php b/src/fieldlayoutelements/Html.php
@@ -37,7 +37,7 @@ public function __construct(string $html, array $config = [])
      */
     public function selectorHtml(): string
     {
-        throw new NotSupportedException(sprintf('%s should not be included in user-modifyable field layouts.', __CLASS__));
+        throw new NotSupportedException(sprintf('%s should not be included in user-modifyable field layouts.', self::class));
     }
 
     /**

diff --git a/src/fieldlayoutelements/addresses/AddressField.php b/src/fieldlayoutelements/addresses/AddressField.php
@@ -102,7 +102,7 @@ protected function selectorLabel(): ?string
     public function formHtml(ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Address) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in address field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in address field layouts.', self::class));
         }
 
         $view = Craft::$app->getView();

diff --git a/src/fieldlayoutelements/addresses/CountryCodeField.php b/src/fieldlayoutelements/addresses/CountryCodeField.php
@@ -93,7 +93,7 @@ public function defaultLabel(?ElementInterface $element = null, bool $static = f
     protected function inputHtml(?ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Address) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in address field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in address field layouts.', self::class));
         }
 
         return

diff --git a/src/fieldlayoutelements/addresses/LatLongField.php b/src/fieldlayoutelements/addresses/LatLongField.php
@@ -119,7 +119,7 @@ protected function selectorLabel(): ?string
     protected function inputHtml(ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Address) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in address field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in address field layouts.', self::class));
         }
 
         return

diff --git a/src/fieldlayoutelements/assets/AltField.php b/src/fieldlayoutelements/assets/AltField.php
@@ -111,7 +111,7 @@ public function defaultLabel(?ElementInterface $element = null, bool $static = f
     protected function translatable(?ElementInterface $element = null, bool $static = false): bool
     {
         if (!$element instanceof Asset) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', self::class));
         }
 
         return $element->getVolume()->altTranslationMethod !== Field::TRANSLATION_METHOD_NONE;
@@ -123,7 +123,7 @@ protected function translatable(?ElementInterface $element = null, bool $static
     protected function translationDescription(?ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Asset) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', self::class));
         }
 
         return ElementHelper::translationDescription($element->getVolume()->altTranslationMethod);

diff --git a/src/fieldlayoutelements/assets/AssetTitleField.php b/src/fieldlayoutelements/assets/AssetTitleField.php
@@ -28,7 +28,7 @@ class AssetTitleField extends TitleField
     protected function translatable(?ElementInterface $element = null, bool $static = false): bool
     {
         if (!$element instanceof Asset) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', self::class));
         }
 
         return $element->getVolume()->titleTranslationMethod !== Field::TRANSLATION_METHOD_NONE;
@@ -40,7 +40,7 @@ protected function translatable(?ElementInterface $element = null, bool $static
     protected function translationDescription(?ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Asset) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in asset field layouts.', self::class));
         }
 
         return ElementHelper::translationDescription($element->getVolume()->titleTranslationMethod);

diff --git a/src/fieldlayoutelements/entries/EntryTitleField.php b/src/fieldlayoutelements/entries/EntryTitleField.php
@@ -60,7 +60,7 @@ public function fields(): array
     protected function translatable(?ElementInterface $element = null, bool $static = false): bool
     {
         if (!$element instanceof Entry) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in entry field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in entry field layouts.', self::class));
         }
 
         return $element->getType()->titleTranslationMethod !== Field::TRANSLATION_METHOD_NONE;
@@ -72,7 +72,7 @@ protected function translatable(?ElementInterface $element = null, bool $static
     protected function translationDescription(?ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Entry) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in entry field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in entry field layouts.', self::class));
         }
 
         return ElementHelper::translationDescription($element->getType()->titleTranslationMethod);
@@ -84,7 +84,7 @@ protected function translationDescription(?ElementInterface $element = null, boo
     public function inputHtml(?ElementInterface $element = null, bool $static = false): ?string
     {
         if (!$element instanceof Entry) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in entry field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in entry field layouts.', self::class));
         }
 
         if (!$element->getType()->hasTitleField) {

diff --git a/src/fieldlayoutelements/users/AffiliatedSiteField.php b/src/fieldlayoutelements/users/AffiliatedSiteField.php
@@ -83,7 +83,7 @@ protected function instructions(ElementInterface $element = null, bool $static =
     protected function inputHtml(?ElementInterface $element = null, bool $static = false): ?string
     {
         if ($element && !$element instanceof User) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', self::class));
         }
 
         if (!Craft::$app->getIsMultiSite()) {

diff --git a/src/fieldlayoutelements/users/EmailField.php b/src/fieldlayoutelements/users/EmailField.php
@@ -112,7 +112,7 @@ protected function inputHtml(?ElementInterface $element = null, bool $static = f
     {
         if ($element) {
             if (!$element instanceof User) {
-                throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', __CLASS__));
+                throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', self::class));
             }
 
             if (
@@ -139,7 +139,7 @@ protected function inputHtml(?ElementInterface $element = null, bool $static = f
     protected function inputAttributes(?ElementInterface $element = null, bool $static = false): array
     {
         if (!$element instanceof User) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', self::class));
         }
 
         return [

diff --git a/src/fieldlayoutelements/users/FullNameField.php b/src/fieldlayoutelements/users/FullNameField.php
@@ -31,7 +31,7 @@ class FullNameField extends BaseFullNameField
     protected function inputAttributes(?ElementInterface $element = null, bool $static = false): array
     {
         if (!$element instanceof User) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', self::class));
         }
 
         return [

diff --git a/src/fieldlayoutelements/users/PhotoField.php b/src/fieldlayoutelements/users/PhotoField.php
@@ -74,7 +74,7 @@ public function defaultLabel(?ElementInterface $element = null, bool $static = f
     protected function inputHtml(?ElementInterface $element = null, bool $static = false): ?string
     {
         if ($element && !$element instanceof User) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', self::class));
         }
 
         if (!$element?->id) {

diff --git a/src/fieldlayoutelements/users/UsernameField.php b/src/fieldlayoutelements/users/UsernameField.php
@@ -98,7 +98,7 @@ protected function inputHtml(?ElementInterface $element = null, bool $static = f
     protected function inputAttributes(?ElementInterface $element = null, bool $static = false): array
     {
         if (!$element instanceof User) {
-            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', __CLASS__));
+            throw new InvalidArgumentException(sprintf('%s can only be used in user field layouts.', self::class));
         }
 
         return [

diff --git a/src/queue/Queue.php b/src/queue/Queue.php
@@ -941,7 +941,7 @@ private function _lock(callable $callback, ?int $timeout = null, bool $throwExce
 
         if ($acquireLock) {
             $channel = $this->channel();
-            $mutexName = sprintf('%s::%s', __CLASS__, $channel);
+            $mutexName = sprintf('%s::%s', self::class, $channel);
             if (!$this->mutex->acquire($mutexName, $timeout ?? $this->mutexTimeout)) {
                 if ($throwException) {
                     throw new MutexException($mutexName, "Could not acquire a mutex lock for the queue ($channel).");

diff --git a/src/records/VolumeFolder.php b/src/records/VolumeFolder.php
@@ -53,7 +53,7 @@ public static function tableName(): string
      */
     public function getParent(): ActiveQueryInterface
     {
-        return $this->hasOne(__CLASS__, ['id' => 'parentId']);
+        return $this->hasOne(self::class, ['id' => 'parentId']);
     }
 
     /**

diff --git a/src/services/ProjectConfig.php b/src/services/ProjectConfig.php
@@ -387,7 +387,7 @@ public function __construct($config = [])
     {
         if (isset($config['maxBackups'])) {
             $config['maxDeltas'] = ArrayHelper::remove($config, 'maxBackups');
-            Craft::$app->getDeprecator()->log(__CLASS__ . '::maxBackups', '`' . __CLASS__ . '::maxBackups` has been deprecated. Use `maxDeltas` instead.');
+            Craft::$app->getDeprecator()->log(self::class . '::maxBackups', '`' . self::class . '::maxBackups` has been deprecated. Use `maxDeltas` instead.');
         }
 
         parent::__construct($config);
-Original file line number
+Diff line change
@@ Expand Up / @@ -242,7 +242,7 @@ protected function initialState(bool $force = false): array @@
          */
         protected function postComposerInstallState(): array
         {
-            throw new NotSupportedException('postComposerInstallState() is not supported by ' . __CLASS__);
+            throw new NotSupportedException('postComposerInstallState() is not supported by ' . self::class);
         }
         /**
@@ Expand Down @@