rename middleware into translator

docs/pages/pipeline.md

@@ -10,17 +10,22 @@ whether the migration worked.
 In this example the event `PrivacyAdded` is removed and the event `OldVisited` is replaced by `NewVisited`:
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\ExcludeEventMiddleware;use Patchlevel\EventSourcing\Message\Middleware\RecalculatePlayheadMiddleware;use Patchlevel\EventSourcing\Message\Middleware\ReplaceEventMiddleware;use Patchlevel\EventSourcing\Pipeline\Pipeline;use Patchlevel\EventSourcing\Pipeline\Source\StoreSource;use Patchlevel\EventSourcing\Pipeline\Target\StoreTarget;
+use Patchlevel\EventSourcing\Message\Translator\ExcludeEventTranslator;
+use Patchlevel\EventSourcing\Message\Translator\RecalculatePlayheadTranslator;
+use Patchlevel\EventSourcing\Message\Translator\ReplaceEventTranslator;
+use Patchlevel\EventSourcing\Pipeline\Pipeline;
+use Patchlevel\EventSourcing\Pipeline\Source\StoreSource;
+use Patchlevel\EventSourcing\Pipeline\Target\StoreTarget;
 
 $pipeline = new Pipeline(
     new StoreSource($oldStore),
     new StoreTarget($newStore),
     [
-        new ExcludeEventMiddleware([PrivacyAdded::class]),
-        new ReplaceEventMiddleware(OldVisited::class, static function (OldVisited $oldVisited) {
+        new ExcludeEventTranslator([PrivacyAdded::class]),
+        new ReplaceEventTranslator(OldVisited::class, static function (OldVisited $oldVisited) {
             return new NewVisited($oldVisited->profileId());
         }),
-        new RecalculatePlayheadMiddleware(),
+        new RecalculatePlayheadTranslator(),
     ],
 );
 ```
@@ -192,9 +197,9 @@ Middelwares can be used to manipulate, delete or expand messages or events durin
 With this middleware you can exclude certain events.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\ExcludeEventMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\ExcludeEventTranslator;
 
-$middleware = new ExcludeEventMiddleware([EmailChanged::class]);
+$middleware = new ExcludeEventTranslator([EmailChanged::class]);
 ```
 !!! warning
 
@@ -205,9 +210,9 @@ $middleware = new ExcludeEventMiddleware([EmailChanged::class]);
 With this middleware you can only allow certain events.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\IncludeEventMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\IncludeEventTranslator;
 
-$middleware = new IncludeEventMiddleware([ProfileCreated::class]);
+$middleware = new IncludeEventTranslator([ProfileCreated::class]);
 ```
 !!! warning
 
@@ -220,9 +225,10 @@ you can also write your own filter.
 This middleware expects a callback that returns either true to allow events or false to not allow them.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\AggregateChanged;use Patchlevel\EventSourcing\Message\Middleware\FilterEventMiddleware;
+use Patchlevel\EventSourcing\Aggregate\AggregateChanged;
+use Patchlevel\EventSourcing\Message\Translator\FilterEventTranslator;
 
-$middleware = new FilterEventMiddleware(static function (AggregateChanged $event) {
+$middleware = new FilterEventTranslator(static function (AggregateChanged $event) {
     if (!$event instanceof ProfileCreated) {
         return true;
     }
@@ -239,9 +245,9 @@ $middleware = new FilterEventMiddleware(static function (AggregateChanged $event
 With this middleware you can exclude archived events.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\ExcludeArchivedEventMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\ExcludeArchivedEventTranslator;
 
-$middleware = new ExcludeArchivedEventMiddleware();
+$middleware = new ExcludeArchivedEventTranslator();
 ```
 !!! warning
 
@@ -252,9 +258,9 @@ $middleware = new ExcludeArchivedEventMiddleware();
 With this middleware you can only allow archived events.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\OnlyArchivedEventMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\OnlyArchivedEventTranslator;
 
-$middleware = new OnlyArchivedEventMiddleware();
+$middleware = new OnlyArchivedEventTranslator();
 ```
 !!! warning
 
@@ -267,9 +273,9 @@ The first parameter you have to define is the event class that you want to repla
 And as a second parameter a callback, that the old event awaits and a new event returns.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\ReplaceEventMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\ReplaceEventTranslator;
 
-$middleware = new ReplaceEventMiddleware(OldVisited::class, static function (OldVisited $oldVisited) {
+$middleware = new ReplaceEventTranslator(OldVisited::class, static function (OldVisited $oldVisited) {
     return new NewVisited($oldVisited->profileId());
 });
 ```
@@ -296,9 +302,9 @@ The playhead must always be in ascending order so that the data is valid.
 Some middleware can break this order and the middleware `RecalculatePlayheadMiddleware` can fix this problem.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\RecalculatePlayheadMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\RecalculatePlayheadTranslator;
 
-$middleware = new RecalculatePlayheadMiddleware();
+$middleware = new RecalculatePlayheadTranslator();
 ```
 !!! note
 
@@ -309,11 +315,13 @@ $middleware = new RecalculatePlayheadMiddleware();
 If you want to group your middleware, you can use one or more `ChainMiddleware`.
 
 ```php
-use Patchlevel\EventSourcing\Message\Middleware\ChainMiddleware;use Patchlevel\EventSourcing\Message\Middleware\ExcludeEventMiddleware;use Patchlevel\EventSourcing\Message\Middleware\RecalculatePlayheadMiddleware;
+use Patchlevel\EventSourcing\Message\Translator\ChainTranslator;
+use Patchlevel\EventSourcing\Message\Translator\ExcludeEventTranslator;
+use Patchlevel\EventSourcing\Message\Translator\RecalculatePlayheadTranslator;
 
-$middleware = new ChainMiddleware([
-    new ExcludeEventMiddleware([EmailChanged::class]),
-    new RecalculatePlayheadMiddleware(),
+$middleware = new ChainTranslator([
+    new ExcludeEventTranslator([EmailChanged::class]),
+    new RecalculatePlayheadTranslator(),
 ]);
 ```
 ### Custom middleware
@@ -332,9 +340,10 @@ Now we have a `ProfileRegistered` and a `ProfileActivated` event,
 which should replace the `ProfileCreated` event.
 
 ```php
-use Patchlevel\EventSourcing\Message\Message;use Patchlevel\EventSourcing\Message\Middleware\Middleware;
+use Patchlevel\EventSourcing\Message\Message;
+use Patchlevel\EventSourcing\Message\Translator\Translator;
 
-final class SplitProfileCreatedMiddleware implements Middleware
+final class SplitProfileCreatedMiddleware implements Translator
 {
     public function __invoke(Message $message): array
     {

src/Message/Middleware/ChainMiddleware.php → src/Message/Translator/ChainTranslator.php

@@ -2,17 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
 
 use function array_values;
 
-final class ChainMiddleware implements Middleware
+final class ChainTranslator implements Translator
 {
-    /** @param iterable<Middleware> $middlewares */
+    /** @param iterable<Translator> $translators */
     public function __construct(
-        private readonly iterable $middlewares,
+        private readonly iterable $translators,
     ) {
     }
 
@@ -21,8 +21,8 @@ public function __invoke(Message $message): array
     {
         $messages = [$message];
 
-        foreach ($this->middlewares as $middleware) {
-            $messages = $this->processMiddleware($middleware, $messages);
+        foreach ($this->translators as $middleware) {
+            $messages = $this->process($middleware, $messages);
         }
 
         return $messages;
@@ -33,12 +33,12 @@ public function __invoke(Message $message): array
      *
      * @return list<Message>
      */
-    private function processMiddleware(Middleware $middleware, array $messages): array
+    private function process(Translator $translator, array $messages): array
     {
         $result = [];
 
         foreach ($messages as $message) {
-            $result += $middleware($message);
+            $result += $translator($message);
         }
 
         return array_values($result);

src/Message/Middleware/ExcludeArchivedEventMiddleware.php → src/Message/Translator/ExcludeArchivedEventTranslator.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\HeaderNotFound;
 use Patchlevel\EventSourcing\Message\Message;
 use Patchlevel\EventSourcing\Store\ArchivedHeader;
 
-final class ExcludeArchivedEventMiddleware implements Middleware
+final class ExcludeArchivedEventTranslator implements Translator
 {
     /** @return list<Message> */
     public function __invoke(Message $message): array

src/Message/Middleware/ExcludeEventMiddleware.php → src/Message/Translator/ExcludeEventTranslator.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
 
-final class ExcludeEventMiddleware implements Middleware
+final class ExcludeEventTranslator implements Translator
 {
     /** @param list<class-string> $classes */
     public function __construct(

src/Message/Middleware/FilterEventMiddleware.php → src/Message/Translator/FilterEventTranslator.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
 
-final class FilterEventMiddleware implements Middleware
+final class FilterEventTranslator implements Translator
 {
     /** @var callable(object $event):bool */
     private $callable;

src/Message/Middleware/IncludeEventMiddleware.php → src/Message/Translator/IncludeEventTranslator.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
 
-final class IncludeEventMiddleware implements Middleware
+final class IncludeEventTranslator implements Translator
 {
     /** @param list<class-string> $classes */
     public function __construct(

src/Message/Middleware/OnlyArchivedEventMiddleware.php → src/Message/Translator/OnlyArchivedEventTranslator.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\HeaderNotFound;
 use Patchlevel\EventSourcing\Message\Message;
 use Patchlevel\EventSourcing\Store\ArchivedHeader;
 
-final class OnlyArchivedEventMiddleware implements Middleware
+final class OnlyArchivedEventTranslator implements Translator
 {
     /** @return list<Message> */
     public function __invoke(Message $message): array

src/Message/Middleware/RecalculatePlayheadMiddleware.php → src/Message/Translator/RecalculatePlayheadTranslator.php

@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Aggregate\AggregateHeader;
 use Patchlevel\EventSourcing\Message\Message;
 
 use function array_key_exists;
 
-final class RecalculatePlayheadMiddleware implements Middleware
+final class RecalculatePlayheadTranslator implements Translator
 {
     /** @var array<string, array<string, positive-int>> */
     private array $index = [];

src/Message/Middleware/ReplaceEventMiddleware.php → src/Message/Translator/ReplaceEventTranslator.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
 
 /** @template T of object */
-final class ReplaceEventMiddleware implements Middleware
+final class ReplaceEventTranslator implements Translator
 {
     /** @var callable(T $event):object */
     private $callable;

src/Message/Middleware/Middleware.php → src/Message/Translator/Translator.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
 
-interface Middleware
+interface Translator
 {
     /** @return list<Message> */
     public function __invoke(Message $message): array;

src/Message/Middleware/UntilEventMiddleware.php → src/Message/Translator/UntilEventTranslator.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Message\Middleware;
+namespace Patchlevel\EventSourcing\Message\Translator;
 
 use DateTimeImmutable;
 use Patchlevel\EventSourcing\Aggregate\AggregateHeader;
 use Patchlevel\EventSourcing\Message\Message;
 
-final class UntilEventMiddleware implements Middleware
+final class UntilEventTranslator implements Translator
 {
     public function __construct(
         private readonly DateTimeImmutable $until,

tests/Unit/Message/Middleware/ChainMiddlewareTest.php → tests/Unit/Message/Translator/ChainTranslatorTest.php

@@ -2,19 +2,19 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Unit\Message\Middleware;
+namespace Patchlevel\EventSourcing\Tests\Unit\Message\Translator;
 
 use Patchlevel\EventSourcing\Message\Message;
-use Patchlevel\EventSourcing\Message\Middleware\ChainMiddleware;
-use Patchlevel\EventSourcing\Message\Middleware\Middleware;
+use Patchlevel\EventSourcing\Message\Translator\ChainTranslator;
+use Patchlevel\EventSourcing\Message\Translator\Translator;
 use Patchlevel\EventSourcing\Tests\Unit\Fixture\Email;
 use Patchlevel\EventSourcing\Tests\Unit\Fixture\ProfileCreated;
 use Patchlevel\EventSourcing\Tests\Unit\Fixture\ProfileId;
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 
-/** @covers \Patchlevel\EventSourcing\Message\Middleware\ChainMiddleware */
-final class ChainMiddlewareTest extends TestCase
+/** @covers \Patchlevel\EventSourcing\Message\Translator\ChainTranslator */
+final class ChainTranslatorTest extends TestCase
 {
     use ProphecyTrait;
 
@@ -27,17 +27,17 @@ public function testChain(): void
             ),
         );
 
-        $child1 = $this->prophesize(Middleware::class);
+        $child1 = $this->prophesize(Translator::class);
         $child1->__invoke($message)->willReturn([$message])->shouldBeCalled();
 
-        $child2 = $this->prophesize(Middleware::class);
+        $child2 = $this->prophesize(Translator::class);
         $child2->__invoke($message)->willReturn([$message])->shouldBeCalled();
 
-        $middleware = new ChainMiddleware([
+        $translator = new ChainTranslator([
             $child1->reveal(),
             $child2->reveal(),
         ]);
 
-        $middleware($message);
+        $translator($message);
     }
 }