add UndefinedRouteException exception

Author: miladrahimi

README.md

@@ -537,6 +537,7 @@ PhpRouter also throws the following exceptions:
 * `RouteNotFoundException` if PhpRouter cannot find any route that matches the user request.
 * `InvalidControllerException` if PhpRouter cannot invoke the controller.
 * `InvalidMiddlewareException` if PhpRouter cannot invoke the middleware.
+* `UndefinedRouteException` if `Router::url()` cannot find any route with the given name.
 
 The `RouteNotFoundException` should be considered `404 Not found` error.
 

src/Exceptions/UndefinedRouteException.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace MiladRahimi\PhpRouter\Exceptions;
+
+use Exception;
+
+/**
+ * Class UndefinedRouteException
+ *
+ * @package MiladRahimi\PhpRouter\Exceptions
+ */
+class UndefinedRouteException extends Exception
+{
+    //
+}

src/Router.php

@@ -8,6 +8,7 @@
 use MiladRahimi\PhpRouter\Exceptions\InvalidControllerException;
 use MiladRahimi\PhpRouter\Exceptions\InvalidMiddlewareException;
 use MiladRahimi\PhpRouter\Exceptions\RouteNotFoundException;
+use MiladRahimi\PhpRouter\Exceptions\UndefinedRouteException;
 use MiladRahimi\PhpRouter\Services\HttpPublisher;
 use MiladRahimi\PhpRouter\Services\Publisher;
 use MiladRahimi\PhpRouter\Values\Route;
@@ -670,16 +671,16 @@ public function define(string $name, string $pattern): self
 
     /**
      * Generate URL for given route name
-     * It returns null if route with given name is not found.
      *
      * @param string $routeName
      * @param string[] $parameters
-     * @return string|null
+     * @return string
+     * @throws UndefinedRouteException
      */
-    public function url(string $routeName, array $parameters = []): ?string
+    public function url(string $routeName, array $parameters = []): string
     {
         if (isset($this->names[$routeName]) == false) {
-            return null;
+            throw new UndefinedRouteException("There is no route with name `$routeName`.");
         }
 
         $uri = $this->names[$routeName]->getUri();

tests/UrlTest.php

@@ -3,6 +3,7 @@
 namespace MiladRahimi\PhpRouter\Tests;
 
 use MiladRahimi\PhpRouter\Enums\HttpMethods;
+use MiladRahimi\PhpRouter\Exceptions\UndefinedRouteException;
 use MiladRahimi\PhpRouter\Router;
 use Throwable;
 
@@ -11,7 +12,7 @@ class UrlTest extends TestCase
     /**
      * @throws Throwable
      */
-    public function test_generating_url_for_home()
+    public function test_generating_url_for_the_homepage()
     {
         $router = $this->router()
             ->name('home')
@@ -47,41 +48,41 @@ public function test_generating_url_for_a_page()
      */
     public function test_generating_url_for_a_page_with_required_parameter()
     {
-        $this->mockRequest(HttpMethods::GET, 'http://web.com/666');
+        $this->mockRequest(HttpMethods::GET, 'http://web.com/contact');
 
         $router = $this->router()
             ->name('page')
             ->get('/{name}', function (Router $r) {
-                return $r->url('page', ['name' => '13']);
+                return $r->url('page', ['name' => 'about']);
             })
             ->dispatch();
 
-        $this->assertEquals('/13', $this->output($router));
+        $this->assertEquals('/about', $this->output($router));
     }
 
     /**
      * @throws Throwable
      */
     public function test_generating_url_for_a_page_with_optional_parameter()
     {
-        $this->mockRequest(HttpMethods::GET, 'http://web.com/666');
+        $this->mockRequest(HttpMethods::GET, 'http://web.com/contact');
 
         $router = $this->router()
             ->name('page')
             ->get('/{name?}', function (Router $r) {
-                return $r->url('page', ['name' => '13']);
+                return $r->url('page', ['name' => 'about']);
             })
             ->dispatch();
 
-        $this->assertEquals('/13', $this->output($router));
+        $this->assertEquals('/about', $this->output($router));
     }
 
     /**
      * @throws Throwable
      */
     public function test_generating_url_for_a_page_with_optional_parameter_2()
     {
-        $this->mockRequest(HttpMethods::GET, 'http://web.com/666');
+        $this->mockRequest(HttpMethods::GET, 'http://web.com/contact');
 
         $router = $this->router()
             ->name('page')
@@ -98,24 +99,7 @@ public function test_generating_url_for_a_page_with_optional_parameter_2()
      */
     public function test_generating_url_for_a_page_with_optional_parameter_3()
     {
-        $this->mockRequest(HttpMethods::GET, 'http://web.com/page/666');
-
-        $router = $this->router()
-            ->name('page')
-            ->get('/page/?{name?}', function (Router $r) {
-                return $r->url('page');
-            })
-            ->dispatch();
-
-        $this->assertEquals('/page', $this->output($router));
-    }
-
-    /**
-     * @throws Throwable
-     */
-    public function test_generating_url_for_a_page_with_optional_parameter_4()
-    {
-        $this->mockRequest(HttpMethods::GET, 'http://web.com/page/666');
+        $this->mockRequest(HttpMethods::GET, 'http://web.com/page/contact');
 
         $router = $this->router()
             ->name('page')
@@ -132,14 +116,13 @@ public function test_generating_url_for_a_page_with_optional_parameter_4()
      */
     public function test_generating_url_for_undefined_route()
     {
-        $router = $this->router()
+        $this->expectException(UndefinedRouteException::class);
+        $this->expectExceptionMessage("There is no route with name `home`.");
+
+        $this->router()
             ->get('/', function (Router $r) {
-                // There is no route with this name
-                // It must return NULL (empty response)
                 return $r->url('home');
             })
             ->dispatch();
-
-        $this->assertEquals('', $this->output($router));
     }
 }