Added exceptions

Author: plugowski

src/Exception/RouteCallbackNotFoundException.php

@@ -0,0 +1,16 @@
+<?php
+namespace PhpRouter\Exception;
+
+use PhpRouter\RouteException;
+
+/**
+ * Class RouteCallbackNotFoundException
+ * @package PhpRouter\Exception
+ */
+class RouteCallbackNotFoundException extends RouteException
+{
+    /**
+     * @var int
+     */
+    protected $code = RouteException::CALLBACK_NOT_FOUND;
+}

src/Exception/RouteInvalidDefinitionException.php

@@ -0,0 +1,16 @@
+<?php
+namespace PhpRouter\Exception;
+
+use PhpRouter\RouteException;
+
+/**
+ * Class RouteInvalidDefinitionException
+ * @package PhpRouter\Exception
+ */
+class RouteInvalidDefinitionException extends RouteException
+{
+    /**
+     * @var int
+     */
+    protected $code = RouteException::INVALID_DEFINITION;
+}

src/Exception/RouteInvalidTypeException.php

@@ -0,0 +1,16 @@
+<?php
+namespace PhpRouter\Exception;
+
+use PhpRouter\RouteException;
+
+/**
+ * Class RouteInvalidTypeException
+ * @package PhpRouter\Exception
+ */
+class RouteInvalidTypeException extends RouteException
+{
+    /**
+     * @var int
+     */
+    protected $code = RouteException::WRONG_TYPE;
+}

src/Exception/RouteNotFoundException.php

@@ -0,0 +1,16 @@
+<?php
+namespace PhpRouter\Exception;
+
+use PhpRouter\RouteException;
+
+/**
+ * Class RouteNotFoundException
+ * @package PhpRouter\Exception
+ */
+class RouteNotFoundException extends RouteException
+{
+    /**
+     * @var int
+     */
+    protected $code = RouteException::ROUTE_NOT_FOUND;
+}

src/Exception/RouteWrongCallbackException.php

@@ -0,0 +1,16 @@
+<?php
+namespace PhpRouter\Exception;
+
+use PhpRouter\RouteException;
+
+/**
+ * Class RouteWrongCallbackException
+ * @package PhpRouter\Exception
+ */
+class RouteWrongCallbackException extends RouteException
+{
+    /**
+     * @var int
+     */
+    protected $code = RouteException::WRONG_CALLBACK_FORMAT;
+}

src/Route.php

@@ -1,7 +1,10 @@
 <?php
 namespace PhpRouter;
 
-use Exception;
+use PhpRouter\Exception\RouteCallbackNotFoundException;
+use PhpRouter\Exception\RouteInvalidDefinitionException;
+use PhpRouter\Exception\RouteInvalidTypeException;
+use PhpRouter\Exception\RouteWrongCallbackException;
 use ReflectionClass;
 
 /**
@@ -15,7 +18,7 @@ class Route
     private $patterns = [
         'route' => '/^
             (?<method>[\|\w]+)\h+
-            (?<path>([@\/\w]+))
+            (?<url>([@\/\w]+))
             (?:\.(?<extension>\w+))?
             (?:\h+\[(?<type>\w+)\])?$/x',
         'callback' => '/^
@@ -71,7 +74,8 @@ class Route
      * @param array|callable $rules
      * @param callable|null $callback
      * @param array $callbackArgs
-     * @throws Exception
+     * @throws RouteInvalidDefinitionException
+     * @throws RouteInvalidTypeException
      */
     public function __construct($route, $rules, $callback = null, $callbackArgs = [])
     {
@@ -91,17 +95,17 @@ public function __construct($route, $rules, $callback = null, $callbackArgs = []
      * Parse route and save results in object properties
      *
      * @param string $route
-     * @throws \Exception
-     * @return void
+     * @throws RouteInvalidDefinitionException
+     * @throws RouteInvalidTypeException
      */
     private function parseRoute($route)
     {
         if (!preg_match($this->patterns['route'], $route, $result)) {
-            throw new \Exception('Wrong route format!');
+            throw new RouteInvalidDefinitionException();
         }
 
         $this->methods = explode('|', $result['method']);
-        $this->url = $result['path'];
+        $this->url = $result['url'];
 
         if (!empty($result['extension'])) {
             $this->extension = $result['extension'];
@@ -110,7 +114,7 @@ private function parseRoute($route)
 
         if (!empty($result['type'])) {
             if (!in_array($result['type'], $this->types)) {
-                throw new \Exception(sprintf('Wrong type format! Allowed [%s]', implode(', ', $this->types)));
+                throw new RouteInvalidTypeException();
             }
 
             $this->type = $result['type'];
@@ -189,7 +193,7 @@ public function parseParams($requestUrl)
      * Execute specified Route - anonymous function or pointed class->method
      *
      * @return mixed
-     * @throws Exception
+     * @throws RouteWrongCallbackException
      */
     public function dispatch()
     {
@@ -198,7 +202,7 @@ public function dispatch()
         } else if (preg_match($this->patterns['callback'], $this->callback, $result)) {
             return $this->call($result['class'], $result['method'], $result['type'], [$this->namedParams]);
         }
-        throw new Exception('Wrong callback');
+        throw new RouteWrongCallbackException();
     }
 
     /**
@@ -209,12 +213,12 @@ public function dispatch()
      * @param string $type
      * @param array $params
      * @return mixed
-     * @throws Exception
+     * @throws RouteCallbackNotFoundException
      */
     private function call($class, $method, $type, array $params = [])
     {
         if (!class_exists($class) || !method_exists($class, $method)) {
-            throw new Exception('No class or method found!');
+            throw new RouteCallbackNotFoundException();
         }
 
         if ('->' == $type) {

src/RouteException.php

@@ -0,0 +1,47 @@
+<?php
+namespace PhpRouter;
+
+use Exception;
+
+/**
+ * Class RouteException
+ * @package PhpRouter
+ */
+class RouteException extends Exception
+{
+    const ROUTE_NOT_FOUND = 404;
+    const INVALID_DEFINITION = 1000;
+    const WRONG_TYPE = 1001;
+    const WRONG_CALLBACK_FORMAT = 1002;
+    const CALLBACK_NOT_FOUND = 1003;
+
+    /**
+     * @var array List of errors and base error descriptions
+     */
+    private static $errors = [
+        self::ROUTE_NOT_FOUND => 'Route not found',
+        self::INVALID_DEFINITION => 'Route definition is not correct',
+        self::WRONG_TYPE => 'Defined request type is not correct',
+        self::WRONG_CALLBACK_FORMAT => 'Declared callback has wrong format',
+        self::CALLBACK_NOT_FOUND => 'Defined callback does not exists',
+    ];
+
+    /**
+     * RouteException constructor.
+     * @param string $message
+     * @param int $code
+     * @param Exception|null $previous
+     */
+    public function __construct($message = '', $code = 0, Exception $previous = null)
+    {
+        parent::__construct($this->getMessageByCode(), $this->getCode(), $previous);
+    }
+
+    /**
+     * @return string
+     */
+    private function getMessageByCode()
+    {
+        return !empty(self::$errors[$this->getCode()]) ? self::$errors[$this->getCode()] : '';
+    }
+}

src/Router.php

@@ -1,6 +1,8 @@
 <?php
 namespace PhpRouter;
 
+use PhpRouter\Exception\RouteNotFoundException;
+
 /**
  * Class Router
  * @package PhpRouter
@@ -31,6 +33,7 @@ public function __construct(RouteRequest $routeRequest, RouteCollection $routeCo
      * Run Router and dispatch requested Route
      *
      * @return mixed
+     * @throws RouteNotFoundException
      */
     public function run()
     {
@@ -44,7 +47,8 @@ public function run()
             $route->parseParams($this->routeRequest->getRequestUrl());
             return $route->dispatch();
         }
-        // @todo: 404
+
+        throw new RouteNotFoundException();
     }
 
     /**

tests/RouteTest.php

@@ -71,7 +71,7 @@ public function shouldCallSpecifiedCallback()
      */
     public function shouldThrowWrongCallbackException()
     {
-        $this->setExpectedException('Exception');
+        $this->setExpectedException('PhpRouter\Exception\RouteWrongCallbackException');
         (new Route('GET /test.html', 'nothingSpecial'))->dispatch();
     }
 
@@ -80,7 +80,7 @@ public function shouldThrowWrongCallbackException()
      */
     public function shouldThrowInvalidRouteException()
     {
-        $this->setExpectedException('Exception');
+        $this->setExpectedException('PhpRouter\Exception\RouteInvalidDefinitionException');
         new Route('/test.html', 'A->index');
     }
 
@@ -89,7 +89,7 @@ public function shouldThrowInvalidRouteException()
      */
     public function shouldThrowInvalidTypeException()
     {
-        $this->setExpectedException('Exception');
+        $this->setExpectedException('PhpRouter\Exception\RouteInvalidTypeException');
         new Route('GET /test.html [not_exists]', 'A->index');
     }
 
@@ -98,7 +98,7 @@ public function shouldThrowInvalidTypeException()
      */
     public function shouldThrowClassOrMethodNotFoundException()
     {
-        $this->setExpectedException('Exception');
+        $this->setExpectedException('PhpRouter\Exception\RouteCallbackNotFoundException');
         (new Route('GET /test/page.html', 'A->test'))->dispatch();
     }
 }

tests/RouterTest.php

@@ -49,10 +49,12 @@ public function shouldMatchRouteAndDispatch()
      */
     public function shouldCallAjaxRouteWithAjaxFalse()
     {
+        $this->setExpectedException('PhpRouter\Exception\RouteNotFoundException');
+
         $request = $this->getRequestMock('GET', '/ajax');
         $router = new Router($request, $this->collection);
 
-        $this->assertNull($router->run());
+        $router->run();
     }
 
     /**