Merge pull request #3 from Minstel/Controller-RouteAction_trait

RouteAction trait

4 files changed, 279 insertions, 1 deletions

diff --git a/composer.json b/composer.json
index 9aaffb9..fab78e9 100644
--- a/composer.json
+++ b/composer.json
@@ -16,7 +16,8 @@
     },
     "require": {
         "php": ">=5.6.0",
-        "psr/http-message": "^1.0"
+        "psr/http-message": "^1.0",
+        "jasny/php-functions": "^2.0"
     },
     "require-dev": {
         "jasny/php-code-quality": "^2.0"
diff --git a/src/Controller/RouteAction.php b/src/Controller/RouteAction.php
new file mode 100644
index 0000000..dabd501
--- /dev/null
+++ b/src/Controller/RouteAction.php
@@ -0,0 +1,117 @@
+<?php
+
+namespace Jasny\Controller;
+
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Execute controller on given route
+ */
+trait RouteAction
+{
+    /**
+     * Get request, set for controller
+     *
+     * @return ServerRequestInterface
+     */
+     abstract public function getRequest();
+
+     /**
+     * Get response. set for controller
+     *
+     * @return ResponseInterface
+     */
+     abstract public function getResponse();
+
+    /**
+     * Run the controller
+     *
+     * @return ResponseInterface
+     */
+    public function run() {
+        $request = $this->getRequest();
+        $route = $request->getAttribute('route');
+        $method = $this->getActionMethod(isset($route->action) ? $route->action : 'default');
+        
+        if (!method_exists($this, $method)) {
+            return $this->setResponseError(404, 'Not Found');
+        }
+
+        try {
+            $args = isset($route->args) ? 
+                $route->args :
+                $this->getFunctionArgs($route, new \ReflectionMethod($this, $method));            
+        } catch (\RuntimeException $e) {
+            return $this->setResponseError(400, 'Bad Request');   
+        }
+
+        $response = call_user_func_array([$this, $method], $args);
+
+        return $response ?: $this->getResponse();        
+    }
+
+    /**
+     * Get the method name of the action
+     * 
+     * @param string $action
+     * @return string
+     */
+    protected function getActionMethod($action)
+    {
+        return \Jasny\camelcase($action) . 'Action';
+    }
+
+    /**
+     * Get the arguments for a function from a route using reflection
+     * 
+     * @param object $route
+     * @param \ReflectionFunctionAbstract $refl
+     * @return array
+     */
+    protected function getFunctionArgs($route, \ReflectionFunctionAbstract $refl)
+    {
+        $args = [];
+        $params = $refl->getParameters();
+
+        foreach ($params as $param) {
+            $key = $param->name;
+
+            if (property_exists($route, $key)) {
+                $value = $route->{$key};
+            } else {
+                if (!$param->isOptional()) {
+                    $fn = $refl instanceof \ReflectionMethod
+                        ? $refl->class . ':' . $refl->name
+                        : $refl->name;
+
+                    throw new \RuntimeException("Missing argument '$key' for $fn()");
+                }
+                
+                $value = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
+            }
+
+            $args[$key] = $value;
+        }
+        
+        return $args;
+    }
+
+    /**
+     * Set response to error state
+     *
+     * @param int $code
+     * @param string $message 
+     * @return ResponseInterface
+     */
+    protected function setResponseError($code, $message)
+    {
+        $response = $this->getResponse();
+
+        $errorResponse = $response->withStatus($code);
+        $errorResponse->getBody()->write($message);
+
+        return $errorResponse;
+    }
+}
+
diff --git a/tests/Controller/RouteActionTest.php b/tests/Controller/RouteActionTest.php
new file mode 100644
index 0000000..edc4bd7
--- /dev/null
+++ b/tests/Controller/RouteActionTest.php
@@ -0,0 +1,110 @@
+<?php
+
+require_once dirname(__DIR__) . '/support/TestController.php';
+
+use Jasny\Controller\RouteAction;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+
+/**
+ * @covers Jasny\Controller\RouteAction
+ */
+class RouteActionTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * Test running controller action
+     *
+     * @dataProvider runPositiveProvider
+     * @param object $route
+     */
+    public function testRunPositive($route)
+    {
+        $controller = new TestController();
+        $request = $this->createMock(ServerRequestInterface::class);
+        $response = $this->createMock(ResponseInterface::class);
+
+        $request->method('getAttribute')->with($this->equalTo('route'))->will($this->returnValue($route));
+
+        $result = $controller($request, $response);
+        $args = !empty($route->args) ? $route->args : [$route->param1, isset($route->param2) ? $route->param2 : 'defaultValue'];
+
+        $this->assertEquals(get_class($response), get_class($result), "Controller should return 'ResponseInterface' instance");
+        $this->assertEquals($args[0], $result->param1, "First route parameter was not passed correctly");
+        $this->assertEquals($args[1], $result->param2, "Second route parameter was not passed correctly");
+
+        if (isset($route->action)) {
+            $this->assertTrue($result->actionCalled, "Controller action was not called");
+            $this->assertFalse(isset($result->defaultActionCalled), "Controller default action was called"); 
+        } else {
+            $this->assertTrue($result->defaultActionCalled, "Controller default action was not called");
+            $this->assertFalse(isset($result->actionCalled), "Controller non-default action was called");
+        }
+    }
+
+    /**
+     * Provide data for testing run method
+     */
+    public function runPositiveProvider()
+    {
+        return [
+            [(object)['controller' => 'TestController', 'param1' => 'value1']],
+            [(object)['controller' => 'TestController', 'param1' => 'value1', 'param2' => 'value2']],
+            [(object)['controller' => 'TestController', 'args' => ['value1', 'value2']]],
+            [(object)['controller' => 'TestController', 'action' => 'test-run', 'param1' => 'value1']],
+            [(object)['controller' => 'TestController', 'action' => 'test-run', 'param1' => 'value1', 'param2' => 'value2']],
+            [(object)['controller' => 'TestController', 'action' => 'test-run', 'args' => ['value1', 'value2']]]
+        ];
+    }
+
+    /**
+     * Test running controller action
+     *
+     * @dataProvider runNegativeProvider
+     * @param object $route
+     * @param int $errorCode
+     * @param string $errorMessage
+     */
+    public function testRunNegative($route, $errorCode, $errorMessage)
+    {
+        $controller = new TestController();
+        $request = $this->createMock(ServerRequestInterface::class);
+        $response = $this->createMock(ResponseInterface::class);
+
+        $request->method('getAttribute')->with($this->equalTo('route'))->will($this->returnValue($route));
+
+        $this->expectResponseError($response, $errorCode, $errorMessage);
+
+        $result = $controller($request, $response);
+
+        $this->assertEquals(get_class($response), get_class($result), "Controller should return 'ResponseInterface' instance");
+    }
+
+    /**
+     * Provide data for testing run method
+     */
+    public function runNegativeProvider()
+    {
+        return [
+            [(object)['controller' => 'TestController', 'action' => 'nonExistMethod'], 404, 'Not Found'],
+            [(object)['controller' => 'TestController', 'action' => 'test-run'], 400, 'Bad Request'],
+            [(object)['controller' => 'TestController', 'action' => 'test-run', 'param2' => 'value2'], 400, 'Bad Request']
+        ];
+    }
+
+    /**
+     * Expect that response will be set to error state
+     *
+     * @param ResponseInterface $response
+     * @param int $code
+     * @param string $message
+     */
+    public function expectResponseError($response, $code, $message)
+    {   
+        $stream = $this->createMock(StreamInterface::class);
+        $stream->expects($this->once())->method('write')->with($this->equalTo($message));
+
+        $response->expects($this->once())->method('getBody')->will($this->returnValue($stream));
+        $response->expects($this->once())->method('withStatus')->with($this->equalTo($code))->will($this->returnSelf());
+    }
+}
diff --git a/tests/support/TestController.php b/tests/support/TestController.php
new file mode 100644
index 0000000..e0bdb7b
--- /dev/null
+++ b/tests/support/TestController.php
@@ -0,0 +1,50 @@
+<?php
+
+use Jasny\Controller;
+use Jasny\Controller\RouteAction;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Class for testing 'RouteAction' trait
+ */
+class TestController extends Controller
+{
+    use RouteAction;
+
+    /**
+     * Test action for executing router
+     *
+     * @param mixed $param1
+     * @param mixed $param2
+     * @return ResponseInterface
+     */
+    public function testRunAction($param1, $param2 = 'defaultValue')
+    {
+        $response = $this->getResponse();
+
+        $response->actionCalled = true;
+        $response->param1 = $param1;
+        $response->param2 = $param2;
+
+        return $response;
+    }
+
+    /**
+     * Test action for executing router
+     *
+     * @param mixed $param1
+     * @param mixed $param2
+     * @return ResponseInterface
+     */
+    public function defaultAction($param1, $param2 = 'defaultValue')
+    {
+        $response = $this->getResponse();
+
+        $response->defaultActionCalled = true;
+        $response->param1 = $param1;
+        $response->param2 = $param2;
+
+        return $response;
+    }
+}