Add Middleware support to WordPress Controllers

Author: adamtomat

composer.json

@@ -3,7 +3,7 @@
     "require": {
         "php": ">=7.1.0",
         "php-di/php-di": "^6.0.0",
-        "rareloop/router": "^4.1.0",
+        "rareloop/router": "^4.2.0",
         "psr/container": "^1.0",
         "psr/http-message": "^1.0",
         "psr/http-server-middleware": "^1.0",
@@ -17,7 +17,8 @@
         "zendframework/zend-diactoros": "^1.8",
         "rareloop/psr7-server-request-extension": "^2.0.0",
         "mmeyer2k/dcrypt": "^8.0.1",
-        "spatie/macroable": "^1.0"
+        "spatie/macroable": "^1.0",
+        "mindplay/middleman": "^3.0.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.0",

src/Http/Controller.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rareloop\Lumberjack\Http;
+
+use Rareloop\Router\Controller as BaseController;
+
+class Controller extends BaseController
+{
+
+}

src/Providers/WordPressControllersServiceProvider.php

@@ -4,9 +4,12 @@
 
 use Psr\Http\Message\RequestInterface;
 use Rareloop\Router\Invoker;
+use Rareloop\Router\ProvidesControllerMiddleware;
 use Rareloop\Router\ResponseFactory;
 use Stringy\Stringy;
+use Tightenco\Collect\Support\Collection;
 use Zend\Diactoros\ServerRequestFactory;
+use mindplay\middleman\Dispatcher;
 
 class WordPressControllersServiceProvider extends ServiceProvider
 {
@@ -66,8 +69,26 @@ public function handleRequest(RequestInterface $request, $controllerName, $metho
 
         $this->app->requestHasBeenHandled();
 
-        $invoker = new Invoker($this->app);
-        $output = $invoker->setRequest($request)->call([$controllerName, $methodName]);
-        return ResponseFactory::create($output, $request);
+        $controller = $this->app->get($controllerName);
+        $middlewares = [];
+
+        if ($controller instanceof ProvidesControllerMiddleware) {
+            $controllerMiddleware = new Collection($controller->getControllerMiddleware());
+
+            $middlewares = $controllerMiddleware->reject(function ($cm) use ($methodName) {
+                return $cm->excludedForMethod($methodName);
+            })->map(function ($cm) {
+                return $cm->middleware();
+            });
+        }
+
+        $middlewares[] = function ($request) use ($controller, $methodName) {
+            $invoker = new Invoker($this->app);
+            $output = $invoker->setRequest($request)->call([$controller, $methodName]);
+            return ResponseFactory::create($output, $request);
+        };
+
+        $dispatcher = new Dispatcher($middlewares);
+        return $dispatcher->dispatch($request);
     }
 }

tests/Unit/Providers/WordPressControllersServiceProviderTest.php

@@ -7,7 +7,11 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
 use Rareloop\Lumberjack\Application;
+use Rareloop\Lumberjack\Http\Controller;
 use Rareloop\Lumberjack\Http\Kernal;
 use Rareloop\Lumberjack\Providers\WordPressControllersServiceProvider;
 use Rareloop\Lumberjack\Test\Unit\BrainMonkeyPHPUnitIntegration;
@@ -223,6 +227,55 @@ public function handle_request_resolves_controller_method_params_from_container(
         $this->assertInstanceOf(ResponseInterface::class, $response);
     }
 
+    /** @test */
+    public function handle_request_supports_middleware()
+    {
+        $app = new Application(__DIR__.'/../');
+        $controller = new TestControllerWithMiddleware;
+        $controller->middleware(new AddHeaderMiddleware('X-Header', 'testing123'));
+        $app->bind(TestControllerWithMiddleware::class, $controller);
+
+        $provider = new WordPressControllersServiceProvider($app);
+        $provider->boot($app);
+
+        $response = $provider->handleRequest(new ServerRequest, TestControllerWithMiddleware::class, 'handle');
+
+        $this->assertTrue($response->hasHeader('X-Header'));
+        $this->assertSame('testing123', $response->getHeader('X-Header')[0]);
+    }
+
+    /** @test */
+    public function handle_request_supports_middleware_applied_to_a_specific_method_using_only()
+    {
+        $app = new Application(__DIR__.'/../');
+        $controller = new TestControllerWithMiddleware;
+        $controller->middleware(new AddHeaderMiddleware('X-Header', 'testing123'))->only('notHandle');
+        $app->bind(TestControllerWithMiddleware::class, $controller);
+
+        $provider = new WordPressControllersServiceProvider($app);
+        $provider->boot($app);
+
+        $response = $provider->handleRequest(new ServerRequest, TestControllerWithMiddleware::class, 'handle');
+
+        $this->assertFalse($response->hasHeader('X-Header'));
+    }
+
+    /** @test */
+    public function handle_request_supports_middleware_applied_to_a_specific_method_using_except()
+    {
+        $app = new Application(__DIR__.'/../');
+        $controller = new TestControllerWithMiddleware;
+        $controller->middleware(new AddHeaderMiddleware('X-Header', 'testing123'))->except('handle');
+        $app->bind(TestControllerWithMiddleware::class, $controller);
+
+        $provider = new WordPressControllersServiceProvider($app);
+        $provider->boot($app);
+
+        $response = $provider->handleRequest(new ServerRequest, TestControllerWithMiddleware::class, 'handle');
+
+        $this->assertFalse($response->hasHeader('X-Header'));
+    }
+
     /** @test */
     public function handle_template_include_will_call_app_shutdown_when_it_has_handled_a_request()
     {
@@ -295,3 +348,30 @@ public function handle()
         return new MyResponsable;
     }
 }
+
+class TestControllerWithMiddleware extends Controller
+{
+    public function handle()
+    {
+
+    }
+}
+
+class AddHeaderMiddleware implements MiddlewareInterface
+{
+    private $key;
+    private $value;
+
+    public function __construct($key, $value)
+    {
+        $this->key = $key;
+        $this->value = $value;
+    }
+
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface
+    {
+        $response = $handler->handle($request);
+
+        return $response->withHeader($this->key, $this->value);
+    }
+}