From bbb138996ad3fa3b0d1d3f603a302869830b7ba7 Mon Sep 17 00:00:00 2001
From: PJ Dietz <pjdietz@gmail.com>
Date: Sun, 10 May 2015 11:02:59 -0400
Subject: [PATCH] Add Dispatching namesapce

---
 src/Dispatching/DispatchException.php         |  7 ++++
 .../DispatchStack.php                         | 16 +++-----
 .../DispatchStackInterface.php                |  3 +-
 src/{Routing => Dispatching}/Dispatcher.php   | 10 +++--
 src/Dispatching/DispatcherInterface.php       | 40 +++++++++++++++++++
 src/Routing/DispatcherInterface.php           | 23 -----------
 src/Routing/MethodMap.php                     |  2 +
 .../{ => Dispatching}/DispatchStackTest.php   | 29 +++++++++-----
 .../{ => Dispatching}/DispatcherTest.php      |  9 +++--
 test/tests/unit/Routing/MethodMapTest.php     |  2 +-
 10 files changed, 88 insertions(+), 53 deletions(-)
 create mode 100644 src/Dispatching/DispatchException.php
 rename src/{Routing => Dispatching}/DispatchStack.php (89%)
 rename src/{Routing => Dispatching}/DispatchStackInterface.php (94%)
 rename src/{Routing => Dispatching}/Dispatcher.php (75%)
 create mode 100644 src/Dispatching/DispatcherInterface.php
 delete mode 100644 src/Routing/DispatcherInterface.php
 rename test/tests/unit/Routing/{ => Dispatching}/DispatchStackTest.php (75%)
 rename test/tests/unit/Routing/{ => Dispatching}/DispatcherTest.php (93%)

diff --git a/src/Dispatching/DispatchException.php b/src/Dispatching/DispatchException.php
new file mode 100644
index 0000000..9a7d9da
--- /dev/null
+++ b/src/Dispatching/DispatchException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace WellRESTed\Dispatching;
+
+class DispatchException extends \InvalidArgumentException
+{
+}
diff --git a/src/Routing/DispatchStack.php b/src/Dispatching/DispatchStack.php
similarity index 89%
rename from src/Routing/DispatchStack.php
rename to src/Dispatching/DispatchStack.php
index 6a49d51..59879d4 100644
--- a/src/Routing/DispatchStack.php
+++ b/src/Dispatching/DispatchStack.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace WellRESTed\Routing;
+namespace WellRESTed\Dispatching;
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -10,9 +10,12 @@ class DispatchStack implements DispatchStackInterface
     private $stack;
     private $dispatcher;
 
-    public function __construct()
+    /**
+     * @param DispatcherInterface $dispatcher
+     */
+    public function __construct(DispatcherInterface $dispatcher)
     {
-        $this->dispatcher = $this->getDispatcher();
+        $this->dispatcher = $dispatcher;
         $this->stack = [];
     }
 
@@ -59,13 +62,6 @@ class DispatchStack implements DispatchStackInterface
 
     // ------------------------------------------------------------------------
 
-    protected function getDispatcher()
-    {
-        return new Dispatcher();
-    }
-
-    // ------------------------------------------------------------------------
-
     private function getCallableChain()
     {
         $dispatcher = $this->dispatcher;
diff --git a/src/Routing/DispatchStackInterface.php b/src/Dispatching/DispatchStackInterface.php
similarity index 94%
rename from src/Routing/DispatchStackInterface.php
rename to src/Dispatching/DispatchStackInterface.php
index f516f16..936972a 100644
--- a/src/Routing/DispatchStackInterface.php
+++ b/src/Dispatching/DispatchStackInterface.php
@@ -1,9 +1,10 @@
 <?php
 
-namespace WellRESTed\Routing;
+namespace WellRESTed\Dispatching;
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use WellRESTed\Routing\MiddlewareInterface;
 
 interface DispatchStackInterface extends MiddlewareInterface
 {
diff --git a/src/Routing/Dispatcher.php b/src/Dispatching/Dispatcher.php
similarity index 75%
rename from src/Routing/Dispatcher.php
rename to src/Dispatching/Dispatcher.php
index 5ccd1c3..b56a40d 100644
--- a/src/Routing/Dispatcher.php
+++ b/src/Dispatching/Dispatcher.php
@@ -1,18 +1,20 @@
 <?php
 
-namespace WellRESTed\Routing;
+namespace WellRESTed\Dispatching;
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use WellRESTed\Routing\MiddlewareInterface;
 
 class Dispatcher implements DispatcherInterface
 {
     /**
-     * @param $middleware
+     * @param mixed $middleware
      * @param ServerRequestInterface $request
      * @param ResponseInterface $response
+     * @param callable $next
      * @return ResponseInterface
-     * @throws \InvalidArgumentException $middleware is not a valid type.
+     * @throws DispatchException Unable to dispatch $middleware
      */
     public function dispatch($middleware, ServerRequestInterface $request, ResponseInterface $response, $next)
     {
@@ -26,7 +28,7 @@ class Dispatcher implements DispatcherInterface
         } elseif ($middleware instanceof ResponseInterface) {
             return $middleware;
         } else {
-            throw new \InvalidArgumentException("Unable to dispatch middleware.");
+            throw new DispatchException("Unable to dispatch middleware.");
         }
     }
 }
diff --git a/src/Dispatching/DispatcherInterface.php b/src/Dispatching/DispatcherInterface.php
new file mode 100644
index 0000000..f98e2a1
--- /dev/null
+++ b/src/Dispatching/DispatcherInterface.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace WellRESTed\Dispatching;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+interface DispatcherInterface
+{
+    /**
+     * Dispatch middleware and return the response.
+     *
+     * This method MUST pass $request, $response, and $next to the middleware
+     * to be dispatched.
+     *
+     * $middleware comes in a number of varieties (e.g., instance, string,
+     * callable). DispatcherInterface interface exist to unpack the middleware
+     * and dispatch it.
+     *
+     * Implementations MUST be able to dispatch the following:
+     * - An instance implementing MiddlewareInterface
+     * - A string containing the fully qualified class name of a class
+     *        implementing MiddlewareInterface
+     * - A callable that returns an instance implementing MiddlewareInterface
+     * - A callable with a signature matching MiddlewareInterface::dispatch
+     *
+     * Implementation MAY dispatch other types of middleware.
+     *
+     * When an implementation recieves a $middware that is not of a type it can
+     * dispatch, it MUST throw a DispatchException.
+     *
+     * @param mixed $middleware
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     * @param callable $next
+     * @return ResponseInterface
+     * @throws DispatchException Unable to dispatch $middleware
+     */
+    public function dispatch($middleware, ServerRequestInterface $request, ResponseInterface $response, $next);
+}
diff --git a/src/Routing/DispatcherInterface.php b/src/Routing/DispatcherInterface.php
deleted file mode 100644
index 4fb5da9..0000000
--- a/src/Routing/DispatcherInterface.php
+++ /dev/null
@@ -1,23 +0,0 @@
-<?php
-/**
- * Created by PhpStorm.
- * User: pjdietz
- * Date: 4/6/15
- * Time: 8:29 PM
- */
-namespace WellRESTed\Routing;
-
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
-
-interface DispatcherInterface
-{
-    /**
-     * @param $middleware
-     * @param ServerRequestInterface $request
-     * @param ResponseInterface $response
-     * @param callable $next
-     * @return ResponseInterface
-     */
-    public function dispatch($middleware, ServerRequestInterface $request, ResponseInterface $response, $next);
-}
diff --git a/src/Routing/MethodMap.php b/src/Routing/MethodMap.php
index bb5309b..3dfd9c4 100644
--- a/src/Routing/MethodMap.php
+++ b/src/Routing/MethodMap.php
@@ -4,6 +4,8 @@ namespace WellRESTed\Routing;
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use WellRESTed\Dispatching\Dispatcher;
+use WellRESTed\Dispatching\DispatcherInterface;
 
 class MethodMap implements MiddlewareInterface, MethodMapInterface
 {
diff --git a/test/tests/unit/Routing/DispatchStackTest.php b/test/tests/unit/Routing/Dispatching/DispatchStackTest.php
similarity index 75%
rename from test/tests/unit/Routing/DispatchStackTest.php
rename to test/tests/unit/Routing/Dispatching/DispatchStackTest.php
index b527011..f46f9a2 100644
--- a/test/tests/unit/Routing/DispatchStackTest.php
+++ b/test/tests/unit/Routing/Dispatching/DispatchStackTest.php
@@ -3,18 +3,19 @@
 namespace WellRESTed\Test\Unit\Routing;
 
 use Prophecy\Argument;
-use WellRESTed\Routing\DispatchStack;
+use WellRESTed\Dispatching\DispatchStack;
 
 /**
- * @coversDefaultClass WellRESTed\Routing\DispatchStack
- * @uses WellRESTed\Routing\DispatchStack
- * @uses WellRESTed\Routing\Dispatcher
+ * @coversDefaultClass WellRESTed\Dispatching\DispatchStack
+ * @uses WellRESTed\Dispatching\DispatchStack
+ * @group dispatching
  */
 class DispatchStackTest extends \PHPUnit_Framework_TestCase
 {
     private $request;
     private $response;
     private $next;
+    private $dispatcher;
 
     public function setUp()
     {
@@ -24,15 +25,19 @@ class DispatchStackTest extends \PHPUnit_Framework_TestCase
         $this->next = function ($request, $response) {
             return $response;
         };
+        $this->dispatcher = $this->prophesize('WellRESTed\Dispatching\DispatcherInterface');
+        $this->dispatcher->dispatch(Argument::cetera())->will(function ($args) {
+            list($middleware, $request, $response, $next) = $args;
+            return $middleware($request, $response, $next);
+        });
     }
 
     /**
      * @covers ::__construct
-     * @covers ::getDispatcher
      */
     public function testCreatesInstance()
     {
-        $stack = new DispatchStack();
+        $stack = new DispatchStack($this->dispatcher->reveal());
         $this->assertNotNull($stack);
     }
 
@@ -41,19 +46,20 @@ class DispatchStackTest extends \PHPUnit_Framework_TestCase
      */
     public function testAddIsFluid()
     {
-        $stack = new DispatchStack();
+        $stack = new DispatchStack($this->dispatcher->reveal());
         $this->assertSame($stack, $stack->add("middleware1"));
     }
 
     /**
      * @covers ::dispatch
+     * @covers ::getCallableChain
      */
     public function testDispachesMiddlewareInOrderAdded()
     {
         // Each middelware will add its "name" to this array.
         $callOrder = [];
 
-        $stack = new DispatchStack();
+        $stack = new DispatchStack($this->dispatcher->reveal());
         $stack->add(function ($request, $response, $next) use (&$callOrder) {
             $callOrder[] = "first";
             return $next($request, $response);
@@ -70,6 +76,9 @@ class DispatchStackTest extends \PHPUnit_Framework_TestCase
         $this->assertEquals(["first", "second", "third"], $callOrder);
     }
 
+    /**
+     * @covers ::dispatch
+     */
     public function testCallsNextAfterDispatchingStack()
     {
         $nextCalled = false;
@@ -82,7 +91,7 @@ class DispatchStackTest extends \PHPUnit_Framework_TestCase
             return $next($request, $response);
         };
 
-        $stack = new DispatchStack();
+        $stack = new DispatchStack($this->dispatcher->reveal());
         $stack->add($middleware);
         $stack->add($middleware);
         $stack->add($middleware);
@@ -102,7 +111,7 @@ class DispatchStackTest extends \PHPUnit_Framework_TestCase
             return $response;
         };
 
-        $stack = new DispatchStack();
+        $stack = new DispatchStack($this->dispatcher->reveal());
         $stack->dispatch($this->request->reveal(), $this->response->reveal(), $next);
         $this->assertTrue($nextCalled);
     }
diff --git a/test/tests/unit/Routing/DispatcherTest.php b/test/tests/unit/Routing/Dispatching/DispatcherTest.php
similarity index 93%
rename from test/tests/unit/Routing/DispatcherTest.php
rename to test/tests/unit/Routing/Dispatching/DispatcherTest.php
index db32f90..501de7d 100644
--- a/test/tests/unit/Routing/DispatcherTest.php
+++ b/test/tests/unit/Routing/Dispatching/DispatcherTest.php
@@ -1,15 +1,16 @@
 <?php
 
-namespace WellRESTed\Test\Unit\Routing;
+namespace WellRESTed\Test\Unit\Dispatching;
 
 use Prophecy\Argument;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
-use WellRESTed\Routing\Dispatcher;
+use WellRESTed\Dispatching\Dispatcher;
 use WellRESTed\Routing\MiddlewareInterface;
 
 /**
- * @covers WellRESTed\Routing\Dispatcher
+ * @covers WellRESTed\Dispatching\Dispatcher
+ * @group dispatching
  */
 class DispatcherTest extends \PHPUnit_Framework_TestCase
 {
@@ -75,7 +76,7 @@ class DispatcherTest extends \PHPUnit_Framework_TestCase
     /**
      * @expectedException \InvalidArgumentException
      */
-    public function testThrowExceptionWhenUnableToDispatch()
+    public function testThrowsExceptionWhenUnableToDispatch()
     {
         $middleware = null;
 
diff --git a/test/tests/unit/Routing/MethodMapTest.php b/test/tests/unit/Routing/MethodMapTest.php
index 39efe67..6db07c2 100644
--- a/test/tests/unit/Routing/MethodMapTest.php
+++ b/test/tests/unit/Routing/MethodMapTest.php
@@ -8,7 +8,7 @@ use WellRESTed\Routing\MethodMap;
 /**
  * @coversDefaultClass WellRESTed\Routing\MethodMap
  * @uses WellRESTed\Routing\MethodMap
- * @uses WellRESTed\Routing\Dispatcher
+ * @uses WellRESTed\Dispatching\Dispatcher
  */
 class MethodMapTest extends \PHPUnit_Framework_TestCase
 {