[6.x] Workbench

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
       php_version: '8.4'
       craft_version: '6'
       node_version: '22'
-      jobs: '["ecs", "prettier", "phpstan", "tests", "rector"]'
+      jobs: '["ecs", "prettier", "phpstan", "tests"]'
       working_directory: 'yii2-adapter'
       notify_slack: true
       slack_subteam: <!subteam^SGFL9NKNZ>

.github/workflows/laravel-ci.yml

@@ -34,6 +34,44 @@ jobs:
       - name: Run Pint
         run: pint --parallel --test --verbose
 
+  rector:
+    name: 'Code Quality / Rector'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPOSER_AUTH_JSON: |
+            {
+              "http-basic": {
+                "repo.packagist.com": {
+                  "username": "${{ secrets.packagist_username }}",
+                  "password": "${{ secrets.packagist_token }}"
+                }
+              }
+            }
+
+      - name: Set version
+        run: composer config version "6.x-dev"
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v3
+
+      - name: Run Rector
+        run: vendor/bin/rector process --dry-run --ansi
+
   phpstan:
     name: 'Code Quality / Phpstan'
     runs-on: ubuntu-latest

composer.json

@@ -109,7 +109,10 @@
     "psr-4": {
       "CraftCms\\Cms\\Tests\\": "tests/",
       "CraftCms\\Cms\\Database\\": "database/",
-      "CraftCms\\Yii2Adapter\\Tests\\": "yii2-adapter/tests-laravel/"
+      "CraftCms\\Yii2Adapter\\Tests\\": "yii2-adapter/tests-laravel/",
+      "Workbench\\App\\": "workbench/app/",
+      "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+      "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
     }
   },
   "scripts": {
@@ -118,7 +121,19 @@
     "phpstan": "phpstan --memory-limit=1G",
     "rector": "rector",
     "tests": "./vendor/bin/pest --compact",
-    "tests-adapter": "./vendor/bin/pest --configuration ./yii2-adapter/phpunit.xml.dist --test-directory ./yii2-adapter/tests-laravel"
+    "tests-adapter": "./vendor/bin/pest --configuration ./yii2-adapter/phpunit.xml.dist --test-directory ./yii2-adapter/tests-laravel",
+    "post-autoload-dump": [
+      "@clear",
+      "@prepare"
+    ],
+    "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+    "prepare": "@php vendor/bin/testbench package:discover --ansi",
+    "build": "@php vendor/bin/testbench workbench:build --ansi",
+    "serve": [
+      "Composer\\Config::disableProcessTimeout",
+      "@build",
+      "@php vendor/bin/testbench serve --ansi"
+    ]
   },
   "config": {
     "sort-packages": true,

src/Database/Migrations/Install.php

@@ -488,6 +488,7 @@ public function createTables(): void
             $table->char('uid', 36)->default('0');
         });
 
+        Schema::dropIfExists(Table::MIGRATIONS);
         app(Migrator::class)
             ->getRepository()
             ->createRepository();

src/Http/Middleware/HandleInertiaRequests.php

@@ -16,6 +16,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
 use Inertia\Middleware;
+use Override;
 
 class HandleInertiaRequests extends Middleware
 {
@@ -33,7 +34,7 @@ class HandleInertiaRequests extends Middleware
      *
      * @see https://inertiajs.com/asset-versioning
      */
-    #[\Override]
+    #[Override]
     public function version(Request $request): ?string
     {
         return parent::version($request);
@@ -46,15 +47,20 @@ public function version(Request $request): ?string
      *
      * @return array<string, mixed>
      */
-    #[\Override]
+    #[Override]
     public function share(Request $request): array
     {
-        $currentSite = Sites::getCurrentSite();
         $isInstalled = Cms::isInstalled();
+
+        if (! $isInstalled) {
+            return parent::share($request);
+        }
+
+        $currentSite = Sites::getCurrentSite();
         $updates = app(Updates::class);
         $nav = app(Navigation::class);
 
-        if ($isInstalled && ! $updates->isCraftUpdatePending()) {
+        if (! $updates->isCraftUpdatePending()) {
             $currentUser = Craft::$app->getUser()->getIdentity();
 
             if (! $currentUser) {

src/Translation/I18N.php

@@ -295,7 +295,14 @@ public function translate(string|Stringable $message, array $parameters = [], ?s
          * Translate it using Laravel's translations.
          */
         if ($translation === (string) $message) {
-            return __($message, $parameters, $locale);
+            $result = __($message, $parameters, $locale);
+
+            // We're dealing with a message that's equal to a translation file (for example 'site')
+            if (is_array($result)) {
+                return $translation;
+            }
+
+            return $result;
         }
 
         return $translation;

testbench.yaml

@@ -7,3 +7,27 @@ providers:
   - CraftCms\Cms\Providers\CraftServiceProvider
   - CraftCms\Yii2Adapter\Yii2ServiceProvider
   - Laravel\Wayfinder\WayfinderServiceProvider
+
+seeders:
+  - Workbench\Database\Seeders\DatabaseSeeder
+
+workbench:
+  welcome: true
+  start: /admin
+  install: false # We run the Craft install in DatabaseSeeder
+  user: 1
+  guard: craft
+  sync:
+    - from: resources
+      to: public/vendor/craft
+    - from: storage
+      to: workbench/storage
+      reverse: true
+  build:
+    - migrate-fresh
+  discovers:
+    web: true
+    commands: true
+    config: true
+    factories: true
+    seeders: true

workbench/.gitignore

@@ -0,0 +1,3 @@
+.env
+.env.dusk
+storage

workbench/app/Providers/WorkbenchServiceProvider.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class WorkbenchServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     */
+    #[\Override]
+    public function register(): void
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        //
+    }
+}

workbench/bootstrap/app.php

@@ -0,0 +1,17 @@
+<?php
+
+use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Configuration\Exceptions;
+use Illuminate\Foundation\Configuration\Middleware;
+
+use function Orchestra\Testbench\default_skeleton_path;
+
+return Application::configure(basePath: $APP_BASE_PATH ?? default_skeleton_path())
+    ->withRouting(
+        web: __DIR__.'/../routes/web.php',
+        commands: __DIR__.'/../routes/console.php',
+    )
+    ->withMiddleware(function (Middleware $middleware): void {})
+    ->withExceptions(function (Exceptions $exceptions): void {
+        //
+    })->create();

workbench/bootstrap/providers.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    //
+];