Return a response will shortcut the action

 * Shortcut on Response type

Author: wdalmut

spec/AppSpec.php

@@ -27,7 +27,9 @@ function it_should_execute_matched_route(
     ) {
         $matched = ["controller" => "A", "action" => "B"];
         $matcher->matchRequest(Argument::Any())->willReturn($matched);
-        $executor->execute(Argument::Any(), Argument::Any(), $matched)->shouldBeCalledTimes(1);
+        $executor->execute(Argument::Any(), Argument::Any(), $matched)
+            ->willReturn($response)
+            ->shouldBeCalledTimes(1);
 
         $this->run($request, $response)->shouldBe($response);
     }

src/App.php

@@ -28,7 +28,7 @@ public function run(Request $request, Response $response)
 
         try {
             $matched = $this->getRouter()->matchRequest($request);
-            $this->getExecutor()->execute($request, $response, $matched);
+            $response = $this->getExecutor()->execute($request, $response, $matched);
         } catch (ResourceNotFoundException $e) {
             $response->setStatusCode(404);
             call_user_func_array($this->errorHandler, [$request, $response, $e]);

src/Exception/ShortcutException.php

@@ -0,0 +1,20 @@
+<?php
+namespace Corley\Middleware\Exception;
+
+use Exception;
+use Symfony\Component\HttpFoundation\Response;
+
+class ShortcutException extends Exception
+{
+    private $response;
+
+    public function __construct(Response $response)
+    {
+        $this->response = $response;
+    }
+
+    public function getResponse()
+    {
+        return $this->response;
+    }
+}

src/Executor/AnnotExecutor.php

@@ -7,6 +7,7 @@
 use Corley\Middleware\Annotations\Before;
 use Corley\Middleware\Annotations\After;
 use Interop\Container\ContainerInterface;
+use Corley\Middleware\Exception\ShortcutException;
 
 class AnnotExecutor
 {
@@ -31,15 +32,21 @@ public function execute(Request $request, Response $response, array $matched)
         $action     = $matched["action"];
         $controller = $matched["controller"];
 
-        $this->limiter = [];
-        $this->executeActionsFor($controller, $action, Before::class, $matched, false);
+        try {
+            $this->limiter = [];
+            $this->executeActionsFor($controller, $action, Before::class, $matched, false);
 
-        $controller = $this->getContainer()->get($controller);
-        $data = array_diff_key($matched, array_flip(["annotation", "_route", "controller", "action"]));
-        $actionReturn = call_user_func_array([$controller, $action], array_merge([$request, $response], $data));
+            $controller = $this->getContainer()->get($controller);
+            $data = array_diff_key($matched, array_flip(["annotation", "_route", "controller", "action"]));
+            $actionReturn = $this->call([$controller, $action], array_merge([$request, $response], $data));
 
-        $this->limiter = [];
-        $this->executeActionsFor($controller, $action, After::class, $actionReturn, true);
+            $this->limiter = [];
+            $this->executeActionsFor($controller, $action, After::class, $actionReturn, true);
+        } catch (ShortcutException $e) {
+            $response = $e->getResponse();
+        }
+
+        return $response;
     }
 
     private function executeActionsFor($controller, $action, $filterClass, $data = null, $after = false)
@@ -59,10 +66,10 @@ private function executeSteps(array $annotations, callable $method, $filterClass
                 if (!$after) {
                     $method($annotation->targetClass, $annotation->targetMethod, $filterClass, $data, $after);
                 }
+
                 $newController = $this->getContainer()->get($annotation->targetClass);
-                call_user_func_array([$newController, $annotation->targetMethod], [
-                    $this->request, $this->response, $data
-                ]);
+                $this->call([$newController, $annotation->targetMethod], [ $this->request, $this->response, $data ]);
+
                 if ($after) {
                     $method($annotation->targetClass, $annotation->targetMethod, $filterClass, $data, $after);
                 }
@@ -71,6 +78,17 @@ private function executeSteps(array $annotations, callable $method, $filterClass
         }
     }
 
+    private function call(callable $method, array $params)
+    {
+        $response = call_user_func_array($method, $params);
+
+        if ($response instanceOf Response) {
+            throw new ShortcutException($response);
+        }
+
+        return $response;
+    }
+
     public function getContainer()
     {
         return $this->container;

tests/AppTest.php

@@ -181,4 +181,54 @@ public function testExceptionHandling()
 
         $this->assertSame(1, $count);
     }
+
+    public function testFlowShortCircuitOnResponse()
+    {
+        $request = Request::create("/deny");
+        $response = new Response();
+
+        ob_start();
+        $this->app->run($request, $response);
+        $content = ob_get_contents();
+        ob_end_clean();
+
+        $this->assertEquals(401, $response->getStatusCode());
+        $this->assertEquals("", $content);
+    }
+
+    public function testShortCircuitOnActions()
+    {
+        $request = Request::create("/close-direct");
+        $response = new Response();
+
+        ob_start();
+        $this->app->run($request, $response);
+        $content = ob_get_contents();
+        ob_end_clean();
+
+        $this->assertEquals(202, $response->getStatusCode());
+        $this->assertEquals(<<<EOF
+Corley\\Demo\\Controller\\Tests\\Seven::action
+
+EOF
+, $content);
+    }
+
+    public function testShortCircuitDuringAfterSteps()
+    {
+        $request = Request::create("/close-after");
+        $response = new Response();
+
+        ob_start();
+        $this->app->run($request, $response);
+        $content = ob_get_contents();
+        ob_end_clean();
+
+        $this->assertEquals(401, $response->getStatusCode());
+        $this->assertEquals(<<<EOF
+Corley\\Demo\\Controller\\Tests\\Seven::pass
+
+EOF
+, $content);
+    }
 }

tests/app/Controller/Tests/Http.php

@@ -0,0 +1,20 @@
+<?php
+namespace Corley\Demo\Controller\Tests;
+
+use Corley\Middleware\Annotations\Route;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Corley\Middleware\Annotations\After;
+use Corley\Middleware\Annotations\Before;
+use Zend\EventManager\EventManager;
+
+class Http
+{
+    public function deny(Request $request, Response $response)
+    {
+        $response->setStatusCode(401);
+        return $response;
+    }
+}
+
+

tests/app/Controller/Tests/Seven.php

@@ -0,0 +1,36 @@
+<?php
+namespace Corley\Demo\Controller\Tests;
+
+use Corley\Middleware\Annotations\Route;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Corley\Middleware\Annotations\After;
+use Corley\Middleware\Annotations\Before;
+use Zend\EventManager\EventManager;
+
+class Seven
+{
+    /**
+     * @Route("/close-direct")
+     * @After(targetClass="Corley\Demo\Controller\Tests\Six", targetMethod="action")
+     */
+    public function action(Request $request, Response $response)
+    {
+        echo __CLASS__ . "::" . __FUNCTION__ . PHP_EOL;
+
+        $response->setStatusCode(202);
+        return $response;
+    }
+
+    /**
+     * @Route("/close-after")
+     * @After(targetClass="Corley\Demo\Controller\Tests\Http", targetMethod="deny")
+     * @After(targetClass="Corley\Demo\Controller\Tests\Seven", targetMethod="action")
+     */
+    public function pass(Request $request, Response $response)
+    {
+        echo __CLASS__ . "::" . __FUNCTION__ . PHP_EOL;
+    }
+}
+
+

tests/app/Controller/Tests/Six.php

@@ -0,0 +1,24 @@
+<?php
+namespace Corley\Demo\Controller\Tests;
+
+use Corley\Middleware\Annotations\Route;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Corley\Middleware\Annotations\After;
+use Corley\Middleware\Annotations\Before;
+use Zend\EventManager\EventManager;
+
+/**
+ * @Before(targetClass="Corley\Demo\Controller\Tests\Http", targetMethod="deny")
+ */
+class Six
+{
+    /**
+     * @Route("/deny")
+     */
+    public function action()
+    {
+        echo __CLASS__ . "::" . __FUNCTION__ . PHP_EOL;
+    }
+}
+