Merge pull request #28 from chubbyphp/pipe-middleware

pipe-middleware

Author: dominikzogg

README.md

@@ -69,7 +69,7 @@ Any Router which implements `Chubbyphp\Framework\Router\RouteMatcherInterface` c
 Through [Composer](http://getcomposer.org) as [chubbyphp/chubbyphp-framework][60].
 
 ```bash
-composer require chubbyphp/chubbyphp-framework "^5.3" \
+composer require chubbyphp/chubbyphp-framework "^6.0" \
     chubbyphp/chubbyphp-framework-router-fastroute "^2.3" \
     slim/psr7 "^1.7"
 ```
@@ -124,7 +124,7 @@ $app->emit($app->handle((new ServerRequestFactory())->createFromGlobals()));
  * [CallbackMiddleware][70]
  * [ExceptionMiddleware][71]
  * [LazyMiddleware][72]
- * [MiddlewareDispatcher][73]
+ * [PipeMiddleware][73]
  * [RouteMatcherMiddleware][74]
  * [SlimCallbackMiddleware][75]
  * [SlimLazyMiddleware][76]
@@ -158,6 +158,7 @@ $app->emit($app->handle((new ServerRequestFactory())->createFromGlobals()));
 
 ## Migration
 
+ * [5.x to 6.x][214]
  * [4.x to 5.x][213]
  * [3.x to 4.x][212]
  * [2.x to 3.x][211]
@@ -208,7 +209,7 @@ $app->emit($app->handle((new ServerRequestFactory())->createFromGlobals()));
 [70]: doc/Middleware/CallbackMiddleware.md
 [71]: doc/Middleware/ExceptionMiddleware.md
 [72]: doc/Middleware/LazyMiddleware.md
-[73]: doc/Middleware/MiddlewareDispatcher.md
+[73]: doc/Middleware/PipeMiddleware.md
 [74]: doc/Middleware/RouteMatcherMiddleware.md
 [75]: doc/Middleware/SlimCallbackMiddleware.md
 [76]: doc/Middleware/SlimLazyMiddleware.md
@@ -236,5 +237,6 @@ $app->emit($app->handle((new ServerRequestFactory())->createFromGlobals()));
 [211]: doc/Migration/2.x-3.x.md
 [212]: doc/Migration/3.x-4.x.md
 [213]: doc/Migration/4.x-5.x.md
+[214]: doc/Migration/5.x-6.x.md
 
 [219]: doc/Migration/Slim-Chubbyphp.md

composer.json

@@ -63,7 +63,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "5.3-dev"
+            "dev-master": "6.0-dev"
         }
     },
     "scripts": {

doc/Middleware/MiddlewareDispatcher.md doc/Middleware/PipeMiddleware.mddoc/Middleware/MiddlewareDispatcher.md renamed to doc/Middleware/PipeMiddleware.md

@@ -1,4 +1,4 @@
-# MiddlewareDispatcher
+# PipeMiddleware
 
 ## Methods
 
@@ -7,7 +7,7 @@
 ```php
 <?php
 
-use Chubbyphp\Framework\Middleware\MiddlewareDispatcher;
+use Chubbyphp\Framework\Middleware\PipeMiddleware;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
@@ -37,7 +37,7 @@ $handler = new class() implements RequestHandlerInterface {
     }
 };
 
-$middlewareDispatcher = new MiddlewareDispatcher();
+$pipeMiddleware = new PipeMiddleware([$middleware1, $middleware2]);
 
-$response = $middlewareDispatcher->dispatch([$middleware1, $middleware2], $handler, $request);
+$response = $pipeMiddleware->dispatch($request, $handler);
 ```

doc/Migration/5.x-6.x.md

@@ -0,0 +1,12 @@
+# 5.x to 6.x
+
+`Chubbyphp\Framework\Middleware\MiddlewareDispatcher` gets dropped and replaced by `Chubbyphp\Framework\Middleware\PipeMiddleware`.
+`Chubbyphp\Framework\Middleware\MiddlewareDispatcher` as an implements of `Chubbyphp\Framework\Middleware\MiddlewareDispatcherInterface` which is gone as well.
+
+This makes the framework as bit less flexible for special use cases, but easier in use for the majority.
+
+Resulting changes:
+- `Chubbyphp\Framework\Handler\RouteRequestHandler::__construct` does not take a `Chubbyphp\Framework\Middleware\MiddlewareDispatcherInterface` as argument anymore.
+- `Chubbyphp\Framework\Application::__construct` does not take a `Chubbyphp\Framework\Middleware\MiddlewareDispatcherInterface` as argument anymore.
+
+`Chubbyphp\Framework\Collection` is gone, use phpstan if you want to make sure you providing the correct types on array of.

doc/RequestHandler/RouteRequestHandler.md

@@ -7,7 +7,6 @@
 ```php
 <?php
 
-use Chubbyphp\Framework\Middleware\MiddlewareDispatcher;
 use Chubbyphp\Framework\RequestHandler\RouteRequestHandler;
 use Psr\Http\Message\ServerRequestInterface;
 use Some\Psr7\Response;
@@ -16,9 +15,7 @@ use Some\Psr7\ServerRequest;
 $request = new ServerRequest();
 $response = new Response();
 
-$middlewareDispatcher = new MiddlewareDispatcher();
+$handler = new RouteRequestHandler();
 
-$callbackHandler = new RouteRequestHandler($middlewareDispatcher);
-
-$response = $callbackHandler->handle($request);
+$response = $handler->handle($request);
 ```

phpstan.neon

@@ -1,5 +1,2 @@
 parameters:
-    ignoreErrors:
-        -
-            message: '/Instanceof between Chubbyphp\\Framework\\Router\\RouteInterface and Chubbyphp\\Framework\\Router\\RouteInterface will always evaluate to true./'
-            path: %currentWorkingDirectory%/src/Router/RoutesByName.php
+    ignoreErrors: []

src/Application.php

@@ -6,8 +6,7 @@
 
 use Chubbyphp\Framework\Emitter\Emitter;
 use Chubbyphp\Framework\Emitter\EmitterInterface;
-use Chubbyphp\Framework\Middleware\MiddlewareDispatcher;
-use Chubbyphp\Framework\Middleware\MiddlewareDispatcherInterface;
+use Chubbyphp\Framework\Middleware\PipeMiddleware;
 use Chubbyphp\Framework\RequestHandler\RouteRequestHandler;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -16,30 +15,17 @@
 
 final class Application implements RequestHandlerInterface
 {
-    /**
-     * @var array<MiddlewareInterface>
-     */
-    private array $middlewares;
-
-    private MiddlewareDispatcherInterface $middlewareDispatcher;
-
-    private RequestHandlerInterface $requestHandler;
-
-    private EmitterInterface $emitter;
+    private PipeMiddleware $pipeMiddleware;
 
     /**
      * @param array<MiddlewareInterface> $middlewares
      */
     public function __construct(
         array $middlewares,
-        ?MiddlewareDispatcherInterface $middlewareDispatcher = null,
-        ?RequestHandlerInterface $requestHandler = null,
-        ?EmitterInterface $emitter = null
+        private RequestHandlerInterface $routeRequestHandler = new RouteRequestHandler(),
+        private EmitterInterface $emitter = new Emitter()
     ) {
-        $this->middlewares = (new Collection($middlewares, [MiddlewareInterface::class]))->toArray();
-        $this->middlewareDispatcher = $middlewareDispatcher ?? new MiddlewareDispatcher();
-        $this->requestHandler = $requestHandler ?? new RouteRequestHandler($this->middlewareDispatcher);
-        $this->emitter = $emitter ?? new Emitter();
+        $this->pipeMiddleware = new PipeMiddleware($middlewares);
     }
 
     public function __invoke(ServerRequestInterface $request): ResponseInterface
@@ -49,11 +35,7 @@ public function __invoke(ServerRequestInterface $request): ResponseInterface
 
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
-        return $this->middlewareDispatcher->dispatch(
-            $this->middlewares,
-            $this->requestHandler,
-            $request
-        );
+        return $this->pipeMiddleware->process($request, $this->routeRequestHandler);
     }
 
     public function emit(ResponseInterface $response): void