Merge pull request #113 from skipperbent/development

Development

README.md

@@ -116,7 +116,7 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
 This is a basic example of an ExceptionHandler implementation:
 
 ```php
-namespace BB\Handlers;
+namespace Demo\Handlers;
 
 use Pecee\Http\Request;
 use Pecee\SimpleRouter\RouterEntry;
@@ -140,7 +140,7 @@ class CustomExceptionHandler implements IExceptionHandler {
     }
 
 }
-``
+```
 
 ### Sub-domain routing
 
@@ -184,79 +184,39 @@ This is a simple example of an integration into a framework.
 The framework has it's own ```Router``` class which inherits from the ```SimpleRouter``` class. This allows the framework to add custom functionality.
 
 ```php
-namespace Pecee;
+namespace Demo;
 
 use Pecee\Exception\RouterException;
-use Pecee\Handler\ExceptionHandler;
 use Pecee\Http\Middleware\IMiddleware;
 use Pecee\SimpleRouter\RouterBase;
 use Pecee\SimpleRouter\SimpleRouter;
 
 class Router extends SimpleRouter {
 
-    protected static $defaultExceptionHandler;
     protected static $defaultMiddlewares = array();
 
     public static function start($defaultNamespace = null) {
 
-        // Debug information
-        Debug::getInstance()->add('Router initialised.');
+        // change this to whatever makes sense in your project
+        require_once 'routes.php';
 
-        // Load framework specific controllers
-        static::get('/js-wrap', 'ControllerJs@wrap', ['namespace' => '\Pecee\Controller'])->setAlias('pecee.js.wrap');
-        static::get('/css-wrap', 'ControllerCss@wrap', ['namespace' => '\Pecee\Controller'])->setAlias('pecee.css.wrap');
-        static::get('/captcha', 'ControllerCaptcha@show', ['namespace' => '\Pecee\Controller']);
 
-        // Load routes.php
-        $file = $_ENV['base_path'] . DIRECTORY_SEPARATOR . 'app' . DIRECTORY_SEPARATOR . 'routes.php';
-        if(file_exists($file)) {
-            require_once $file;
+        if(count(static::$defaultMiddlewares)) {
+            /* @var $middleware \Pecee\Http\Middleware\IMiddleware */
+            foreach(static::$defaultMiddlewares as $middleware) {
+                $middleware = new $middleware();
+                if(!($middleware instanceof IMiddleware)) {
+                    throw new RouterException('Middleware must be implement the IMiddleware interface.');
+                }
+                $middleware->handle(RouterBase::getInstance()->getRequest());
+            }
         }
 
         // Set default namespace
-        $defaultNamespace = '\\'.$_ENV['app_name'] . '\\Controller';
+        $defaultNamespace = '\\Demo\\Controllers';
 
-        // Handle exceptions
-        try {
+        parent::start($defaultNamespace);
 
-            if(count(static::$defaultMiddlewares)) {
-                /* @var $middleware \Pecee\Http\Middleware\IMiddleware */
-                foreach(static::$defaultMiddlewares as $middleware) {
-                    $middleware = new $middleware();
-                    if(!($middleware instanceof IMiddleware)) {
-                        throw new RouterException('Middleware must be implement the IMiddleware interface.');
-                    }
-                    $middleware->handle(RouterBase::getInstance()->getRequest());
-                }
-            }
-
-            parent::start($defaultNamespace);
-        } catch(\Exception $e) {
-
-            $route = RouterBase::getInstance()->getLoadedRoute();
-
-            // Otherwise use the fallback default exceptions handler
-            if(static::$defaultExceptionHandler !== null) {
-                static::loadExceptionHandler(static::$defaultExceptionHandler, $route, $e);
-            }
-
-            throw $e;
-        }
-
-    }
-
-    protected static function loadExceptionHandler($class, $route, $e) {
-        $class = new $class();
-
-        if(!($class instanceof ExceptionHandler)) {
-            throw new \ErrorException('Exception handler must be an instance of \Pecee\Handler\ExceptionHandler');
-        }
-
-        $class->handleError(RouterBase::getInstance()->getRequest(), $route, $e);
-    }
-
-    public static function defaultExceptionHandler($handler) {
-        static::$defaultExceptionHandler = $handler;
     }
 
     /**
@@ -348,7 +308,6 @@ Sometimes it can be necessary to keep urls stored in the database, file or simil
 To interfere with the router, we create a class that inherits from ```RouterBootManager```. This class will be loaded before any other rules in ```routes.php``` and allow us to "change" the current route, if any of our criteria are fulfilled (like coming from the url ```/my-cat-is-beatiful```).
 
 ```php
-
 use Pecee\Http\Request;
 use Pecee\SimpleRouter\RouterBootManager;
 

demo-project/README.md

@@ -2,31 +2,30 @@
 
 This project is here to give you a basic understanding of how to setup and using simple-php-router.
 
-Please note that this demo-project only covers how to integrate simple-php-project in a project without a framework. If you are using some sort of PHP framework in your project 
-the implementation might vary.
+Please note that this demo-project only covers how to integrate the `simple-php-router` in a project without a framework. If you are using some sort of PHP framework in your project the implementation might vary.
 
 **What we won't cover:**
 
 - How to setup a solution that fits your need. This is a basic demo to help you get started.
-- How to add Controllers, Middlewares or ExceptionHandlers with cool functionality.
+- Understanding of MVC; including Controllers, Middlewares or ExceptionHandlers.
 - How to integrate into third party frameworks.
 
 **What we cover:**
 
 - How to get up and running fast - from scratch.
-- How to set ExceptionHandlers, Middlewares and Controllers working.
+- How to get ExceptionHandlers, Middlewares and Controllers working.
 - How to setup your webservers.
 
 ## Installation
 
-- Navigate to the `demo-project` folder and run `composer install`.
+- Navigate to the `demo-project` folder in terminal and run `composer update` to install the latest version.
 - Point your webserver to `demo-project/public`.
 
 ### Setting up Nginx
 
-If you are using Nginx remember to enable url-rewriting.
+If you are using Nginx please make sure that url-rewriting is enabled.
 
-You can easily do this by adding the following configuration for the Nginx configuration for the demo-project.
+You can easily enable url-rewriting by adding the following configuration for the Nginx configuration-file for the demo-project.
 
 ```
 location / {
@@ -36,8 +35,7 @@ location / {
 
 ### Setting up Apache
 
-Nothing special is required for Apache to work. We've include the `.htaccess` file in the `public` folder. If rewriting is not working for you, please 
-check that `.htaccess` support is enabled in the Apache configuration - or add the rules manually.
+Nothing special is required for Apache to work. We've include the `.htaccess` file in the `public` folder. If rewriting is not working for you, please check that the `mod_rewrite` module (htaccess support) is enabled in the Apache configuration.
 
 ## Folder structure
 
@@ -48,26 +46,24 @@ check that `.htaccess` support is enabled in the Apache configuration - or add t
 
 ## Notes
 
-The demo project has it's own `Router` class implemented which extends the `SimpleRouter` class with further functionality such as 
-default exceptionhandlers and middlewares. This class can be useful adding functionality that are required before and after routing 
-occurs or add extra functionality to the router. 
+The demo project has it's own `Router` class implementation which extends the `SimpleRouter` class with further functionality. 
+This class can be useful adding additional functionality that are required before and after routing occurs or any extra functionality belonging to the router itself. 
 
-In this project we also use our custom router-class to autoload the `routes.php` file.
+In this project we also use our custom router-class to autoload the `routes.php` file from our custom location (`app/routes.php`).
 
-Please check the `routes.php` file in `demo-project/app` for all the urls/rules in the project.
+Please check the `routes.php` file in `demo-project/app` for all the urls/rules available in the project.
 
 ### CSRF-verifier
 
-We've added a custom CSRF-verifier middleware called `CsrfVerifier` and disabled CSRF checks for all calls to `/api/*`.
+For the purpose of this demo, we've added a custom CSRF-verifier middleware called `CsrfVerifier` and disabled CSRF checks for all calls to `/api/*`. This will ensure that CSRF form-checks are not applied when calling our demo api url.
 
 ### Exception handlers
 
-The included `CustomExceptionHandler` class returns a json response for errors received on calls to `/api/*` or otherwise just forms a simple formatted error response.
+The included `CustomExceptionHandler` class returns a very basic json response for errors received on calls to `/api/*` or otherwise just a simple formatted error response.
 
 ### Middlewares
 
-`ApiVerification` class is added to all calls to `/api/*`. This simple class just adds some data to the `Request` object, which is returned in one of the methods in the 
-`ApiController` class.
+`ApiVerification` class is added to all calls to `/api/*`. This simple class just adds some data to the `Request` object, which is returned in one of the methods in the `ApiController` class. We've added this class to demonstrate that you can use middlewares to ensure that the user has the correct authentication - before router loads the controller itself.
 
 ### Urls
 

demo-project/app/Controllers/DefaultController.php

@@ -22,4 +22,8 @@ class DefaultController {
 
     }
 
+    public function notFound() {
+        echo 'Page not found';
+    }
+
 }

demo-project/app/Handlers/CustomExceptionHandler.php

@@ -21,8 +21,14 @@ class CustomExceptionHandler implements IExceptionHandler {
 
         // else we just throw the error
         if($error->getCode() == 404) {
-            die(sprintf('An error occurred (%s):<br/>%s', $error->getCode(), $error->getMessage()));
+
+            // Return 404 path
+            $request->setUri('/404');
+            return $request;
+
         }
+
+        throw $error;
     }
 
 }

demo-project/app/Router.php

@@ -8,14 +8,12 @@
 namespace Demo;
 
 use Pecee\Exception\RouterException;
-use Pecee\Handler\IExceptionHandler;
 use Pecee\Http\Middleware\IMiddleware;
 use Pecee\SimpleRouter\RouterBase;
 use Pecee\SimpleRouter\SimpleRouter;
 
 class Router extends SimpleRouter {
 
-    protected static $defaultExceptionHandler;
     protected static $defaultMiddlewares = array();
 
     public static function start($defaultNamespace = null) {
@@ -23,50 +21,23 @@ class Router extends SimpleRouter {
         // change this to whatever makes sense in your project
         require_once 'routes.php';
 
-        // Handle exceptions
-        try {
 
-            if(count(static::$defaultMiddlewares)) {
-                /* @var $middleware \Pecee\Http\Middleware\IMiddleware */
-                foreach(static::$defaultMiddlewares as $middleware) {
-                    $middleware = new $middleware();
-                    if(!($middleware instanceof IMiddleware)) {
-                        throw new RouterException('Middleware must be implement the IMiddleware interface.');
-                    }
-                    $middleware->handle(RouterBase::getInstance()->getRequest());
+        if(count(static::$defaultMiddlewares)) {
+            /* @var $middleware \Pecee\Http\Middleware\IMiddleware */
+            foreach(static::$defaultMiddlewares as $middleware) {
+                $middleware = new $middleware();
+                if(!($middleware instanceof IMiddleware)) {
+                    throw new RouterException('Middleware must be implement the IMiddleware interface.');
                 }
+                $middleware->handle(RouterBase::getInstance()->getRequest());
             }
-
-            // Set default namespace
-            $defaultNamespace = '\\Demo\\Controllers';
-
-            parent::start($defaultNamespace);
-        } catch(\Exception $e) {
-
-            $route = RouterBase::getInstance()->getLoadedRoute();
-
-            // Otherwise use the fallback default exceptions handler
-            if(static::$defaultExceptionHandler !== null) {
-                static::loadExceptionHandler(static::$defaultExceptionHandler, $route, $e);
-            }
-
-            throw $e;
         }
 
-    }
+        // Set default namespace
+        $defaultNamespace = '\\Demo\\Controllers';
 
-    protected static function loadExceptionHandler($class, $route, $e) {
-        $class = new $class();
+        parent::start($defaultNamespace);
 
-        if(!($class instanceof IExceptionHandler)) {
-            throw new \ErrorException('Exception handler must be an instance of \Pecee\Handler\IExceptionHandler');
-        }
-
-        $class->handleError(RouterBase::getInstance()->getRequest(), $route, $e);
-    }
-
-    public static function defaultExceptionHandler($handler) {
-        static::$defaultExceptionHandler = $handler;
     }
 
     /**

demo-project/app/routes.php

@@ -6,14 +6,18 @@
 use Demo\Router;
 
 Router::csrfVerifier(new \Demo\Middlewares\CsrfVerifier());
-Router::defaultExceptionHandler('\Demo\Handlers\CustomExceptionHandler');
 
-Router::get('/', 'DefaultController@index')->setAlias('home');
-Router::get('/contact', 'DefaultController@contact')->setAlias('contact');
-Router::basic('/companies', 'DefaultController@companies')->setAlias('companies');
-Router::basic('/companies/{id}', 'DefaultController@companies')->setAlias('companies');
+Router::group(['exceptionHandler' => 'Demo\Handlers\CustomExceptionHandler'], function() {
+
+    Router::get('/', 'DefaultController@index')->setAlias('home');
+    Router::get('/contact', 'DefaultController@contact')->setAlias('contact');
+    Router::get('/404', 'DefaultController@notFound')->setAlias('404');
+    Router::basic('/companies', 'DefaultController@companies')->setAlias('companies');
+    Router::basic('/companies/{id}', 'DefaultController@companies')->setAlias('companies');
+
+    // Api
+    Router::group(['prefix' => '/api', 'middleware' => 'Demo\Middlewares\ApiVerification'], function() {
+        Router::resource('/demo', 'ApiController');
+    });
 
-// Api
-Router::group(['prefix' => '/api', 'middleware' => 'Demo\Middlewares\ApiVerification'], function() {
-    Router::resource('/demo', 'ApiController');
 });

src/Pecee/SimpleRouter/RouterBase.php

@@ -109,64 +109,68 @@ class RouterBase {
         }
     }
 
-    public function routeRequest() {
+    public function routeRequest($original = true) {
 
         $originalUri = $this->request->getUri();
 
-        // Initialize boot-managers
-        if(count($this->bootManagers)) {
-            /* @var $manager RouterBootManager */
-            foreach($this->bootManagers as $manager) {
-                $this->request = $manager->boot($this->request);
+        try {
 
-                if(!($this->request instanceof Request)) {
-                    throw new RouterException('Custom router bootmanager "'. get_class($manager) .'" must return instance of Request.');
+            // Initialize boot-managers
+            if(count($this->bootManagers)) {
+                /* @var $manager RouterBootManager */
+                foreach($this->bootManagers as $manager) {
+                    $this->request = $manager->boot($this->request);
+
+                    if(!($this->request instanceof Request)) {
+                        throw new RouterException('Custom router bootmanager "'. get_class($manager) .'" must return instance of Request.');
+                    }
                 }
             }
-        }
 
-        // Verify csrf token for request
-        if($this->baseCsrfVerifier !== null) {
-            $this->baseCsrfVerifier->handle($this->request);
-        }
+            // Loop through each route-request
+            $this->processRoutes($this->routes);
 
-        // Loop through each route-request
-        $this->processRoutes($this->routes);
-
-        $routeNotAllowed = false;
-
-        $max = count($this->controllerUrlMap);
-
-        /* @var $route RouterEntry */
-        for($i = 0; $i < $max; $i++) {
-
-            $route = $this->controllerUrlMap[$i];
-
-            $routeMatch = $route->matchRoute($this->request);
-
-            if($routeMatch) {
-
-                if(count($route->getRequestMethods()) && !in_array($this->request->getMethod(), $route->getRequestMethods())) {
-                    $routeNotAllowed = true;
-                    continue;
+            if($original === true) {
+                // Verify csrf token for request
+                if ($this->baseCsrfVerifier !== null) {
+                    $this->baseCsrfVerifier->handle($this->request);
                 }
+            }
 
-                $routeNotAllowed = false;
+            $routeNotAllowed = false;
 
-                $this->request->rewrite_uri = $this->request->uri;
-                $this->request->setUri($originalUri);
+            $max = count($this->controllerUrlMap);
 
-                $this->request->loadedRoute = $route;
-                $route->loadMiddleware($this->request);
+            /* @var $route RouterEntry */
+            for ($i = 0; $i < $max; $i++) {
+
+                $route = $this->controllerUrlMap[$i];
+
+                $routeMatch = $route->matchRoute($this->request);
+
+                if ($routeMatch) {
+
+                    if (count($route->getRequestMethods()) && !in_array($this->request->getMethod(), $route->getRequestMethods())) {
+                        $routeNotAllowed = true;
+                        continue;
+                    }
+
+                    $routeNotAllowed = false;
+
+                    $this->request->rewrite_uri = $this->request->uri;
+                    $this->request->setUri($originalUri);
+
+                    $this->request->loadedRoute = $route;
+                    $route->loadMiddleware($this->request);
 
-                try {
                     $this->request->loadedRoute->renderRoute($this->request);
-                } catch(\Exception $e) {
-                    $this->handleException($e);
-                }
 
-                break;
+                    break;
+                }
             }
+
+        } catch(\Exception $e) {
+            $this->handleException($e);
         }
 
         if($routeNotAllowed) {
@@ -180,6 +184,8 @@ class RouterBase {
 
     protected function handleException(\Exception $e) {
 
+        $request = null;
+
         /* @var $route RouterGroup */
         foreach ($this->exceptionHandlers as $route) {
             $route->loadMiddleware($this->request);
@@ -190,7 +196,13 @@ class RouterBase {
                 throw new RouterException('Exception handler must implement the IExceptionHandler interface.');
             }
 
-            $handler->handleError($this->request, $this->request->loadedRoute, $e);
+            $request = $handler->handleError($this->request, $this->request->loadedRoute, $e);
+        }
+
+        if($request !== null) {
+            $this->request = $request;
+            $this->routeRequest(false);
+            return;
         }
 
         throw $e;
@@ -457,14 +469,14 @@ class RouterBase {
     }
 
     public static function getInstance() {
-        if(self::$instance === null) {
-            self::$instance = new static();
+        if(static::$instance === null) {
+            static::$instance = new static();
         }
-        return self::$instance;
+        return static::$instance;
     }
 
     public static function reset() {
-        self::$instance = null;
+        static::$instance = null;
     }
 
 }

src/Pecee/SimpleRouter/RouterEntry.php

@@ -310,7 +310,7 @@ abstract class RouterEntry {
             if($max) {
                 for($i = 0; $i < $max; $i++) {
                     $name = $parameterNames[$i];
-                    $parameterValue = (isset($parameterValues[$name['name']]) && !empty($parameterValues[$name['name']])) ? $parameterValues[$name['name']] : null;
+                    $parameterValue = isset($parameterValues[$name['name']]) ? $parameterValues[$name['name']] : null;
 
                     if($name['required'] && $parameterValue === null) {
                         throw new RouterException('Missing required parameter ' . $name['name'], 404);

test/Dummy/DummyController.php

@@ -11,4 +11,8 @@ class DummyController {
         echo 'Params: ' . join(', ', $params);
     }
 
+    public function notFound() {
+        echo 'not found';
+    }
+
 }

test/Dummy/Handler/ExceptionHandler.php

@@ -0,0 +1,8 @@
+<?php
+class ExceptionHandler implements \Pecee\Handler\IExceptionHandler {
+
+    public function handleError(\Pecee\Http\Request $request, \Pecee\SimpleRouter\RouterEntry $router = null, \Exception $error){
+        throw $error;
+    }
+
+}

test/GroupTest.php

@@ -7,13 +7,6 @@ class GroupTest extends PHPUnit_Framework_TestCase  {
 
     protected $result;
 
-    public function __construct() {
-        // Initial setup
-        $_SERVER['HTTP_HOST'] = 'example.com';
-        $_SERVER['REQUEST_URI'] = '/api/v1/test';
-        $_SERVER['REQUEST_METHOD'] = 'get';
-    }
-
     protected function group() {
         $this->result = true;
     }

test/MiddlewareTest.php

@@ -2,29 +2,25 @@
 
 require_once 'Dummy/DummyMiddleware.php';
 require_once 'Dummy/DummyController.php';
+require_once 'Dummy/Handler/ExceptionHandler.php';
 
 class MiddlewareTest extends PHPUnit_Framework_TestCase  {
 
-    public function __construct() {
-        // Initial setup
-        $_SERVER['HTTP_HOST'] = 'example.com';
-        $_SERVER['REQUEST_URI'] = '/my/test/url';
-        $_SERVER['REQUEST_METHOD'] = 'get';
-    }
-
     public function testMiddlewareFound() {
-
-        \Pecee\Http\Request::getInstance()->setMethod('get');
-
         \Pecee\SimpleRouter\RouterBase::reset();
 
-        \Pecee\SimpleRouter\SimpleRouter::get('/my/test/url', 'DummyController@start', ['middleware' => 'DummyMiddleware']);
+        \Pecee\Http\Request::getInstance()->setMethod('get');
+        \Pecee\Http\Request::getInstance()->setUri('/my/test/url');
+
+        \Pecee\SimpleRouter\SimpleRouter::group(['exceptionHandler' => 'ExceptionHandler'], function() {
+            \Pecee\SimpleRouter\SimpleRouter::get('/my/test/url', 'DummyController@start', ['middleware' => 'DummyMiddleware']);
+        });
 
         $found = false;
 
         try {
             \Pecee\SimpleRouter\SimpleRouter::start();
-        }catch(Exception $e) {
+        }catch(\Exception $e) {
             $found = ($e instanceof MiddlewareLoadedException);
         }
 

test/RouterRouteTest.php

@@ -2,14 +2,31 @@
 
 require_once 'Dummy/DummyMiddleware.php';
 require_once 'Dummy/DummyController.php';
+require_once 'Dummy/Handler/ExceptionHandler.php';
 
 class RouterRouteTest extends PHPUnit_Framework_TestCase  {
+  
+
+    public function testNotFound() {
+        \Pecee\SimpleRouter\RouterBase::reset();
+
+        \Pecee\Http\Request::getInstance()->setMethod('get');
+        \Pecee\Http\Request::getInstance()->setUri('/test-param1-param2');
+
+        \Pecee\SimpleRouter\SimpleRouter::group(['exceptionHandler' => 'ExceptionHandler'], function() {
+            \Pecee\SimpleRouter\SimpleRouter::get('/non-existing-path', 'DummyController@start');
+        });
+
+        $found = false;
+
+        try {
+            \Pecee\SimpleRouter\SimpleRouter::start();
+        }catch(\Exception $e) {
+            $found = ($e instanceof \Pecee\Exception\RouterException && $e->getCode() == 404);
+        }
+
+        $this->assertTrue($found);
 
-    public function __construct() {
-        // Initial setup
-        $_SERVER['HTTP_HOST'] = 'example.com';
-        $_SERVER['REQUEST_URI'] = '/my/test/url';
-        $_SERVER['REQUEST_METHOD'] = 'get';
     }
 
     public function testGet() {