Merge pull request #69 from TomHAnderson/feature/workbench

Feature/workbench

.gitignore

@@ -1,4 +1,5 @@
 /vendor
+/coverage
 composer.phar
 composer.lock
 .DS_Store
@@ -8,3 +9,4 @@ composer.lock
 laravel-doctrine-orm.iml
 .phpcs-cache
 .phpunit.cache
+

composer.json

@@ -37,7 +37,8 @@
         "mockery/mockery": "^1.6",
         "php-parallel-lint/php-parallel-lint": "^1.4",
         "phpstan/phpstan": "^1.12",
-        "phpunit/phpunit": "^11.4"
+        "phpunit/phpunit": "^11.4",
+        "orchestra/testbench": "^9.5"
     },
     "suggest": {
         "gedmo/doctrine-extensions": "Behavioral Doctrine2 extensions",
@@ -50,7 +51,10 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "LaravelDoctrineTest\\Extensions\\": "tests/"
+            "LaravelDoctrineTest\\Extensions\\": "tests/",
+            "Workbench\\App\\": "workbench/app/",
+            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
         }
     },
     "scripts": {
@@ -60,11 +64,26 @@
             "vendor/bin/phpunit",
             "vendor/bin/phpstan analyze src --level 1"
         ],
-        "coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html=coverage"
+        "coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html=coverage",
+        "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"
+        ],
+        "lint": [
+            "@php vendor/bin/phpstan analyse --verbose --ansi"
+        ]
     },
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }
     }
-}
+}

src/BeberleiExtensionsServiceProvider.php

@@ -94,11 +94,4 @@ public function boot(DoctrineManager $manager): void
             $configuration->setCustomStringFunctions($this->string);
         });
     }
-
-    /**
-     * Register the service provider.
-     */
-    public function register(): void
-    {
-    }
 }

src/GedmoExtensionsServiceProvider.php

@@ -4,6 +4,7 @@
 
 namespace LaravelDoctrine\Extensions;
 
+use Gedmo\DoctrineExtensions;
 use Illuminate\Support\ServiceProvider;
 
 class GedmoExtensionsServiceProvider extends ServiceProvider
@@ -18,6 +19,12 @@ public function register(): void
 
             foreach ($registry->getManagers() as $manager) {
                 $chain = $manager->getConfiguration()->getMetadataDriverImpl();
+
+                if ($this->needsAllMappings()) {
+                    DoctrineExtensions::registerMappingIntoDriverChainORM($chain);
+                } else {
+                    DoctrineExtensions::registerAbstractMappingIntoDriverChainORM($chain);
+                }
             }
         });
     }

testbench.yaml

@@ -0,0 +1,18 @@
+providers:
+  - LaravelDoctrine\ORM\DoctrineServiceProvider
+  - LaravelDoctrine\Extensions\BeberleiExtensionsServiceProvider
+  - LaravelDoctrine\Extensions\GedmoExtensionsServiceProvider
+
+workbench:
+  start: '/'
+  install: true
+  health: false
+  discovers:
+    web: false
+    api: false
+    commands: false
+    components: false
+    views: false
+  assets:
+    - laravel-assets
+  sync: []

tests/Feature/BeberleiExtensionsServiceProviderTest.php

@@ -4,35 +4,18 @@
 
 namespace LaravelDoctrineTest\Extensions\Feature;
 
-use Illuminate\Contracts\Foundation\Application;
-use LaravelDoctrine\Extensions\BeberleiExtensionsServiceProvider;
 use LaravelDoctrine\ORM\DoctrineManager;
-use Mockery as m;
-use PHPUnit\Framework\TestCase;
+
+use function app;
 
 class BeberleiExtensionsServiceProviderTest extends TestCase
 {
-    protected Application $app;
-    protected BeberleiExtensionsServiceProvider $provider;
-    protected DoctrineManager $manager;
-
-    public function setUp(): void
+    public function testCustomFunctionsCanBeRegistered(): void
     {
-        $this->app     = m::mock(Application::class);
-        $this->manager = m::mock(DoctrineManager::class);
+        $doctrineManager = $this->app->get(DoctrineManager::class);
 
-        $this->provider = new BeberleiExtensionsServiceProvider($this->app);
+        $entityManager = app('em');
 
-        // silence the 'This test did not perform any assertions' warning
         $this->assertTrue(true);
-
-        parent::setUp();
-    }
-
-    public function testCustomFunctionsCanBeRegistered(): void
-    {
-        $this->manager->shouldReceive('extendAll')->once();
-
-        $this->provider->boot($this->manager);
     }
 }

tests/Feature/Blameable/BlameableExtensionTest.php

@@ -13,10 +13,8 @@ class BlameableExtensionTest extends TestCase
 {
     public function testCanRegisterExtension(): void
     {
-        $guard = m::mock(Guard::class);
-
         $extension = new BlameableExtension(
-            $guard,
+            m::mock(Guard::class),
         );
 
         $extension->addSubscribers(

tests/Feature/GedmoExtensionsServiceProviderAllMappingsTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaravelDoctrineTest\Extensions\Feature;
+
+use Illuminate\Config\Repository;
+
+use function tap;
+
+class GedmoExtensionsServiceProviderAllMappingsTest extends TestCase
+{
+    protected function defineEnvironment(mixed $app): void
+    {
+        // Setup default database to use sqlite :memory:
+        tap($app['config'], static function (Repository $config): void {
+            $config->set('doctrine.gedmo.all_mappings', true);
+        });
+    }
+
+    public function testCustomExtensionsCanBeRegistered(): void
+    {
+        $this->app['events']->dispatch('doctrine.extensions.booting');
+
+        $this->assertTrue(true);
+    }
+}

tests/Feature/GedmoExtensionsServiceProviderTest.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaravelDoctrineTest\Extensions\Feature;
+
+class GedmoExtensionsServiceProviderTest extends TestCase
+{
+    public function testCustomExtensionsCanBeRegistered(): void
+    {
+        $this->app['events']->dispatch('doctrine.extensions.booting');
+
+        $this->assertTrue(true);
+    }
+}

tests/Feature/TestCase.php

@@ -7,10 +7,16 @@
 use Doctrine\Common\EventManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Mockery as m;
-use PHPUnit\Framework\TestCase as PHPUnitTestCase;
+use Orchestra\Testbench\Concerns\WithWorkbench;
+use Orchestra\Testbench\TestCase as OrchestraTestCase;
 
-abstract class TestCase extends PHPUnitTestCase
+use function restore_error_handler;
+use function restore_exception_handler;
+
+abstract class TestCase extends OrchestraTestCase
 {
+    use WithWorkbench;
+
     protected EventManager $evm;
     protected EntityManagerInterface $em;
 
@@ -19,11 +25,18 @@ public function setUp(): void
         $this->evm = m::mock(EventManager::class);
         $this->em  = m::mock(EntityManagerInterface::class);
 
-        $this->evm->shouldReceive('addEventSubscriber')->once();
+        $this->evm->shouldReceive('addEventSubscriber');
+
+        parent::setUp();
     }
 
     public function tearDown(): void
     {
+        restore_error_handler();
+        restore_exception_handler();
+
         m::close();
+
+        parent::tearDown();
     }
 }

tests/Feature/Uploadable/UploadableExtensionTest.php

@@ -6,13 +6,16 @@
 
 use Gedmo\Uploadable\UploadableListener;
 use LaravelDoctrine\Extensions\Uploadable\UploadableExtension;
+use LaravelDoctrine\Extensions\Uploadable\UploadableFacade;
 use LaravelDoctrineTest\Extensions\Feature\TestCase;
 use Mockery as m;
 
 class UploadableExtensionTest extends TestCase
 {
     public function testCanRegisterExtension(): void
     {
+        $this->assertFalse(UploadableFacade::isFake());
+
         $listener = m::mock(UploadableListener::class);
 
         $extension = new UploadableExtension(

workbench/app/Models/User.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Workbench\App\Models;
+
+// use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+use Illuminate\Notifications\Notifiable;
+use Laravel\Sanctum\HasApiTokens;
+
+class User extends Authenticatable
+{
+    use HasFactory, Notifiable;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array<int, string>
+     */
+    protected $fillable = [
+        'name',
+        'email',
+        'password',
+    ];
+
+    /**
+     * The attributes that should be hidden for serialization.
+     *
+     * @var array<int, string>
+     */
+    protected $hidden = [
+        'password',
+        'remember_token',
+    ];
+
+    /**
+     * The attributes that should be cast.
+     *
+     * @var array<string, string>
+     */
+    protected $casts = [
+        'email_verified_at' => 'datetime',
+        'password' => 'hashed',
+    ];
+}

workbench/app/Providers/WorkbenchServiceProvider.php

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

workbench/bootstrap/app.php

@@ -0,0 +1,19 @@
+<?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) {
+        //
+    })
+    ->withExceptions(function (Exceptions $exceptions) {
+        //
+    })->create();

workbench/bootstrap/providers.php

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