improve docs

Author: DavidBadura

README.md

@@ -1,4 +1,3 @@
-[![Type Coverage](https://shepherd.dev/github/patchlevel/laravel-event-sourcing/coverage.svg)](https://shepherd.dev/github/patchlevel/laravel-event-sourcing)
 [![Latest Stable Version](https://poser.pugx.org/patchlevel/laravel-event-sourcing/v)](//packagist.org/packages/patchlevel/laravel-event-sourcing)
 [![License](https://poser.pugx.org/patchlevel/laravel-event-sourcing/license)](//packagist.org/packages/patchlevel/laravel-event-sourcing)
 
@@ -20,7 +19,7 @@ for [event-sourcing](https://github.com/patchlevel/event-sourcing) library.
 * Safe usage of [Personal Data](https://laravel-event-sourcing.patchlevel.io/latest/personal_data/) with crypto-shredding
 * Smooth [upcasting](https://laravel-event-sourcing.patchlevel.io/latest/upcasting/) of old events
 * Simple setup with [scheme management](https://laravel-event-sourcing.patchlevel.io/latest/store/) and [doctrine migration](https://laravel-event-sourcing.patchlevel.io/latest/store/)
-* Built in [cli commands](https://laravel-event-sourcing.patchlevel.io/latest/cli/) with [symfony](https://symfony.com/)
+* Built in [cli commands](https://event-sourcing.patchlevel.io/latest/cli/)
 * and much more...
 
 ## Installation
@@ -32,13 +31,9 @@ composer require patchlevel/laravel-event-sourcing
 ## Documentation
 
 * [Package Documentation](https://laravel-event-sourcing.patchlevel.io/latest/)
-* [Library Documentation](https://laravel-event-sourcing.patchlevel.io/latest/)
+* [Library Documentation](https://event-sourcing.patchlevel.io/latest/)
 * [Related Blog](https://patchlevel.de/blog)
 
-## Integration
-
-* [Psalm](https://github.com/patchlevel/event-sourcing-psalm-plugin)
-
 ## Sponsors
 
 [<img src="https://github.com/patchlevel/event-sourcing/assets/470138/d00b7459-23b7-431b-80b4-93cfc1b66216" alt="blackfire" width="200">](https://www.blackfire.io)

composer.json

@@ -19,7 +19,7 @@
     ],
     "require": {
         "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
-        "patchlevel/event-sourcing": "3.5.x-dev",
+        "patchlevel/event-sourcing": "^3.5",
         "illuminate/contracts": "^9.28|^10.0|^11.0"
     },
     "require-dev": {

config/event-sourcing.php

@@ -79,7 +79,15 @@
             'enabled' => true,
             'ids' => null,
             'groups' => null,
-            'limit' => null
+            'limit' => null,
+        ],
+        'rebuild_after_file_change' => [
+            'enabled' => true,
+        ],
+        'auto_setup' => [
+            'enabled' => true,
+            'ids' => null,
+            'groups' => null,
         ],
     ],
 

docs/pages/getting_started.md

@@ -15,7 +15,7 @@ First we define the events that happen in our system.
 A hotel can be created with a `name` and an `id`:
 
 ```php
-namespace App\Hotel\Domain\Event;
+namespace App\Event;
 
 use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Event;
@@ -33,7 +33,7 @@ final class HotelCreated
 A guest can check in by `name`:
 
 ```php
-namespace App\Hotel\Domain\Event;
+namespace App\Event;
 
 use Patchlevel\EventSourcing\Attribute\Event;
 
@@ -49,7 +49,7 @@ final class GuestIsCheckedIn
 And also check out again:
 
 ```php
-namespace App\Hotel\Domain\Event;
+namespace App\Event;
 
 use Patchlevel\EventSourcing\Attribute\Event;
 
@@ -75,11 +75,11 @@ In these methods the business checks are made and the events are recorded.
 Last but not least, we need the associated apply methods to change the state.
 
 ```php
-namespace App\Hotel\Domain;
+namespace App\Model;
 
-use App\Hotel\Domain\Event\GuestIsCheckedIn;
-use App\Hotel\Domain\Event\GuestIsCheckedOut;
-use App\Hotel\Domain\Event\HotelCreated;
+use App\Event\GuestIsCheckedIn;
+use App\Event\GuestIsCheckedOut;
+use App\Event\HotelCreated;
 use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
@@ -173,11 +173,11 @@ we need a projection for it. To create a projection we need a projector.
 Each projector is then responsible for a specific projection.
 
 ```php
-namespace App\Hotel\Infrastructure\Projection;
+namespace App\Subscribers;
 
-use App\Hotel\Domain\Event\GuestIsCheckedIn;
-use App\Hotel\Domain\Event\GuestIsCheckedOut;
-use App\Hotel\Domain\Event\HotelCreated;
+use App\Event\GuestIsCheckedIn;
+use App\Event\GuestIsCheckedOut;
+use App\Event\HotelCreated;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
@@ -251,9 +251,17 @@ final class HotelProjection
     }
 }
 ```
-!!! warning
 
-    autoconfigure need to be enabled, otherwise you need add the `event_sourcing.subscriber` tag.
+You need to register the projector in the `event-sourcing.php` configuration file.
+
+```php
+return [
+    'subscribers' => [
+        App\Subscribers\HotelProjector::class,
+    ],
+];
+
+```
 
 !!! note
 
@@ -264,14 +272,14 @@ final class HotelProjection
 In our example we also want to send an email to the head office as soon as a guest is checked in.
 
 ```php
-namespace App\Hotel\Application\Processor;
+namespace App\Subscribers;
 
-use App\Hotel\Domain\Event\GuestIsCheckedIn;
+use App\Event\GuestIsCheckedIn;
 use Illuminate\Support\Facades\Mail;
 use Patchlevel\EventSourcing\Attribute\Processor;
 
 #[Processor('admin_emails')]
-final class SendCheckInEmailListener
+final class SendCheckInEmailProcessor
 {
     #[Subscribe(GuestIsCheckedIn::class)]
     public function onGuestIsCheckedIn(GuestIsCheckedIn $event): void
@@ -280,10 +288,18 @@ final class SendCheckInEmailListener
     }
 }
 ```
-!!! warning
 
-    autoconfigure need to be enabled, otherwise you need add the `event_sourcing.subscriber` tag.
-    
+You need to register the processor in the `event-sourcing.php` configuration file.
+
+```php
+return [
+    'subscribers' => [
+        App\Subscribers\SendCheckInEmailProcessor::class,
+    ],
+];
+
+```
+
 !!! note
 
     You can find out more about processor in the [library](https://event-sourcing.patchlevel.io/latest/subscription/)
@@ -295,8 +311,8 @@ We are now ready to use the Event Sourcing System. We can load, change and save
 ```php
 namespace App\Hotel\Infrastructure\Controller;
 
-use App\Hotel\Domain\Hotel;
-use App\Hotel\Infrastructure\Projection\HotelProjection;
+use App\Model\Hotel;
+use App\Subscribers\HotelProjection;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Patchlevel\EventSourcing\Aggregate\Uuid;

docs/pages/installation.md

@@ -33,26 +33,16 @@ And then run the migrations:
 ```bash
 php artisan migrate
 ```
-## Middlewares (optional)
+## Middlewares
 
-If you want to use the provided middlewares, you can add them to your `config/app.php`:
-
-### Auto Setup Middleware
-
-```php
-use Patchlevel\LaravelEventSourcing\Middleware\AutoSetupMiddleware;
-
-->withMiddleware(static function (Middleware $middleware): void {
-    $middleware->append(AutoSetupMiddleware::class);
-})
-```
-### Subscription Rebuild After File Change Middleware
+Some features need a middleware to work properly.
+You should add the middleware to your `bootstrap/app.php` file.
 
 ```php
-use Patchlevel\LaravelEventSourcing\Middleware\SubscriptionRebuildAfterFileChangeMiddleware;
+use Patchlevel\LaravelEventSourcing\Middleware\EventSourcingMiddleware;
 
 ->withMiddleware(static function (Middleware $middleware): void {
-    $middleware->append(SubscriptionRebuildAfterFileChangeMiddleware::class);
+    $middleware->append(EventSourcingMiddleware::class);
 })
 ```
 !!! success

src/EventSourcingServiceProvider.php

@@ -95,6 +95,7 @@
 use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
 use Patchlevel\Hydrator\MetadataHydrator;
 use Patchlevel\LaravelEventSourcing\Middleware\AutoSetupMiddleware;
+use Patchlevel\LaravelEventSourcing\Middleware\EventSourcingMiddleware;
 use Patchlevel\LaravelEventSourcing\Middleware\SubscriptionRebuildAfterFileChangeMiddleware;
 
 use function app;
@@ -605,6 +606,16 @@ private function registerSubscription(): void
             );
         });
 
+        $this->app->singleton(EventSourcingMiddleware::class, static function () {
+            $autoSetup = config('event-sourcing.subscription.auto_setup.enabled');
+            $rebuildAfterFileChange = config('event-sourcing.subscription.rebuild_after_file_change.enabled');
+
+            return new EventSourcingMiddleware(
+                $autoSetup ? app(AutoSetupMiddleware::class) : null,
+                $rebuildAfterFileChange ? app(SubscriptionRebuildAfterFileChangeMiddleware::class) : null,
+            );
+        });
+
         $this->app->singleton(SubscriptionSetupCommand::class, static function () {
             return new SubscriptionSetupCommand(
                 app(SubscriptionEngine::class),

src/Middleware/EventSourcingMiddleware.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\LaravelEventSourcing\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+
+class EventSourcingMiddleware
+{
+    public function __construct(
+        private readonly AutoSetupMiddleware|null $autoSetupMiddleware = null,
+        private readonly SubscriptionRebuildAfterFileChangeMiddleware|null $subscriptionRebuildAfterFileChangeMiddleware = null,
+    ) {
+    }
+
+    /** @param Closure(Request): Response $next */
+    public function handle(Request $request, Closure $next): Response
+    {
+        $dummyNext = static function () {
+            return new Response();
+        };
+
+        if ($this->autoSetupMiddleware !== null) {
+            $this->autoSetupMiddleware->handle($request, $dummyNext);
+        }
+
+        if ($this->subscriptionRebuildAfterFileChangeMiddleware !== null) {
+            $this->subscriptionRebuildAfterFileChangeMiddleware->handle($request, $dummyNext);
+        }
+
+        return $next($request);
+    }
+}