improvement router and unit test

Author: Fady Michel

src/Route.php

@@ -14,79 +14,64 @@ class Route
     protected $name;
 
     /**
-     * @var array
+     * @var array<string>
      */
-    protected $controller;
+    protected $controller = [];
 
     /**
      * @var string
      */
     protected $path;
 
     /**
-     * @var array
-     */
-    protected $varsNames = [];
-
-    /**
-     * @var array
+     * @var array<string>
      */
     protected $vars = [];
 
     /**
-     * @var array
+     * @var array<string>
      */
-    protected $methods = ['GET', 'POST'];
+    protected $methods = [];
 
-    /**
-     * Route constructor.
-     * @param string $name
-     * @param string $path
-     * @param array $controller
-     * @param array $methods
-     */
-    public function __construct(string $name, string $path, array $controller, array $methods = [])
+    public function __construct(string $name, string $path, array $controller, array $methods = ['GET', 'POST'])
     {
         $this->name = $name;
         $this->path = $path;
         $this->controller = $controller;
         $this->methods = $methods;
     }
 
-    /**
-     * @return bool
-     */
     public function hasVars(): bool
     {
-        return !empty($this->getVarsNames());
+        return $this->getVarsNames() !== [];
     }
 
-    /**
-     * @param string $path
-     * @return array|null
-     */
-    public function match(string $path): ?array
+    public function match(string $path, string $method): bool
     {
-        if (preg_match('#^'.$this->generateRegex().'$#sD', $this->trimPath($path), $matches)) {
-            return array_filter($matches, function ($key) {
+        if (
+            in_array($method, $this->getMethods()) &&
+            preg_match('#^' . $this->generateRegex() . '$#sD', $this->trimPath($path), $matches)
+        ) {
+
+            $values = array_filter($matches, function ($key) {
                 return is_string($key);
             }, ARRAY_FILTER_USE_KEY);
+
+            foreach ($values as $key => $value) {
+                $this->addVar($key, $value);
+            }
+
+            return true;
         }
 
-        return null;
+        return false;
     }
 
-    /**
-     * @return string
-     */
     public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * @return string
-     */
     public function getPath(): string
     {
         return $this->path;
@@ -111,28 +96,25 @@ public function getVars(): array
     public function getVarsNames(): array
     {
         preg_match_all('/{[^}]*}/', $this->path, $matches);
-        return reset($matches);
+        return reset($matches) ?: [];
     }
 
     public function getMethods(): array
     {
         return $this->methods;
     }
 
-    private function trimPath(string $path) :string
+    private function trimPath(string $path): string
     {
-        return '/'.rtrim(ltrim(trim($path), '/'), '/');
+        return '/' . rtrim(ltrim(trim($path), '/'), '/');
     }
 
-    /**
-     * @return string
-     */
     private function generateRegex(): string
     {
         $regex = $this->path;
         foreach ($this->getVarsNames() as $variable) {
-            $varName = trim($variable,'{\}');
-            $regex = str_replace($variable, '(?P<'.$varName.'>[^/]++)', $regex);
+            $varName = trim($variable, '{\}');
+            $regex = str_replace($variable, '(?P<' . $varName . '>[^/]++)', $regex);
         }
         return $regex;
     }

src/Router.php

@@ -1,9 +1,7 @@
 <?php
 
-
 namespace DevCoder;
 
-use Exception;
 use Psr\Http\Message\ServerRequestInterface;
 
 /**
@@ -15,13 +13,13 @@ class Router implements RouterInterface
     const NO_ROUTE = 1;
 
     /**
-     * @var Route[]
+     * @var array<Route>
      */
     protected $routes = [];
 
     /**
      * Router constructor.
-     * @param Route[]
+     * @param $routes array<Route>
      */
     public function __construct(array $routes = [])
     {
@@ -42,45 +40,48 @@ public function add(Route $route): self
     /**
      * @param ServerRequestInterface $serverRequest
      * @return Route
-     * @throws Exception
+     * @throws \Exception
      */
     public function match(ServerRequestInterface $serverRequest): Route
     {
-        $path = $serverRequest->getUri()->getPath();
-        foreach ($this->routes as $route) {
+        return $this->matchFromPath($serverRequest->getUri()->getPath(), $serverRequest->getMethod());
+    }
 
-            $varsValues = $route->match($path);
-            if ($varsValues === null || !in_array($serverRequest->getMethod(), $route->getMethods())) {
+    /**
+     * @param string $path
+     * @param string $method
+     * @return Route
+     * @throws \Exception
+     */
+    public function matchFromPath(string $path, string $method): Route
+    {
+        foreach ($this->routes as $route) {
+            if ($route->match($path, $method) === false) {
                 continue;
             }
-
-            foreach ($varsValues as $key => $value) {
-                $route->addVar($key, $value);
-            }
-
             return $route;
         }
 
-        throw new Exception('Aucune route ne correspond à l\'URL', self::NO_ROUTE);
+        throw new \Exception('Aucune route ne correspond à l\'URL', self::NO_ROUTE);
     }
 
     public function generateUri(string $name, array $parameters = []): string
     {
         if (!array_key_exists($name, $this->routes)) {
-            throw new Exception(sprintf('%s name route doesnt exist', $name));
+            throw new \Exception(sprintf('%s name route doesnt exist', $name));
         }
 
         $route = $this->routes[$name];
         if ($route->hasVars() && empty($parameters)) {
-            throw new Exception(sprintf('%s route need parameters: %s', $name, implode(',', $route->getVarsNames()))
+            throw new \Exception(sprintf('%s route need parameters: %s', $name, implode(',', $route->getVarsNames()))
             );
         }
 
         $uri = $route->getPath();
         foreach ($route->getVarsNames() as $variable) {
             $varName = trim($variable, '{\}');
             if (!array_key_exists($varName, $parameters)) {
-                throw new Exception(sprintf('%s not found in parameters to generate url', $varName));
+                throw new \Exception(sprintf('%s not found in parameters to generate url', $varName));
             }
             $uri = str_replace($variable, $parameters[$varName], $uri);
         }

src/RouterInterface.php

@@ -17,6 +17,14 @@ interface RouterInterface
      */
     public function match(ServerRequestInterface $serverRequest) : Route;
 
+    /**
+     * @param string $path
+     * @param string $method
+     * @return Route
+     * @throws \Exception if no found route.
+     */
+    public function matchFromPath(string $path, string $method) : Route;
+
     /**
      * @param string $name
      * @param array $parameters

tests/RouteTest.php

@@ -13,15 +13,14 @@
  */
 class RouteTest extends TestCase {
 
-
-
     public function testNotMatchRoute()
     {
         $routeWithoutAttribute = new Route('view_articles','/view/article/', ['App\\Controller\\HomeController', 'home']);
         $routeWithAttribute = new Route('view_article','/view/article/{article}', ['App\\Controller\\HomeController', 'home']);
 
-        $this->assertNull($routeWithoutAttribute->match('/view/article/1'));
-        $this->assertNull($routeWithAttribute->match('/view/article/'));
+        $this->assertFalse($routeWithoutAttribute->match('/view/article/1', 'GET'));
+        $this->assertFalse($routeWithoutAttribute->match('/view/article/1', 'PUT'));
+        $this->assertFalse($routeWithAttribute->match('/view/article/', 'POST'));
     }
 
     public function testMatchRoute()
@@ -30,9 +29,9 @@ public function testMatchRoute()
         $routeWithAttributes = new Route('view_article_page','/view/article/{article}/{page}', ['App\\Controller\\HomeController', 'home']);
         $routeWithoutAttribute = new Route('view_articles','/view/article', ['App\\Controller\\HomeController', 'home']);
 
-        $this->assertInternalType('array',$routeWithAttribute->match('/view/article/1'));
-        $this->assertInternalType('array',$routeWithAttributes->match('/view/article/1/24'));
-        $this->assertInternalType('array',$routeWithoutAttribute->match('/view/article/'));
+        $this->assertTrue($routeWithAttribute->match('/view/article/1', 'GET'));
+        $this->assertTrue(!$routeWithAttribute->match('/view/article/1', 'PUT'));
+        $this->assertTrue($routeWithAttributes->match('/view/article/1/24','GET'));
+        $this->assertTrue($routeWithoutAttribute->match('/view/article/','GET'));
     }
-
-}
+}

tests/RouterTest.php

@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: fadymichel
- * Date: 20/05/18
- * Time: 01:57
- */
 
 namespace Test\DevCoder;
 
@@ -18,7 +12,6 @@
  */
 class RouterTest extends TestCase
 {
-
     /**
      * @var Router
      */
@@ -39,7 +32,6 @@ public function __construct($name = null, array $data = [], $dataName = '')
             ->add($routeArticleWithParams);
     }
 
-
     public function testGenerateUrl() {
 
         $urlHome = $this->router->generateUri('home_page');
@@ -53,11 +45,4 @@ public function testGenerateUrl() {
         $this->assertEquals($routeArticleWithParams, '/view/article/25/3');
 
     }
-
-    public function testResolveRoute() {
-
-
-
-    }
-
-}
+}