migrate to php7.4

Author: Devcoder-xyz

Diff for: README.md

@@ -13,9 +13,9 @@ composer require devcoder-xyz/php-router
 
 ## Requirements
 
-* PHP version 7.3
+* PHP version 7.4
 * Enable URL rewriting on your web server
-* Need package for PSR-7 HTTP Message
+* Optional : Need package for PSR-7 HTTP Message
   (example : guzzlehttp/psr7 )
 
 **How to use ?**
@@ -61,42 +61,48 @@ class ArticleController {
     }
 }
 
-$router = new \DevCoder\Router([
+$routes = [
     new \DevCoder\Route('home_page', '/', [IndexController::class]),
     new \DevCoder\Route('api_articles_collection', '/api/articles', [ArticleController::class, 'getAll']),
     new \DevCoder\Route('api_articles', '/api/articles/{id}', [ArticleController::class, 'get']),
-]);
+];
+$router = new \DevCoder\Router($routes, 'http://localhost');
 ```
-##Example
-$_SERVER['REQUEST_URI'] = '/api/articles/2'
-$_SERVER['REQUEST_METHOD'] = 'GET'
+
+## Example
+
 ```php
 try {
     // Example
+    
     // \Psr\Http\Message\ServerRequestInterface
-    //$route = $router->match(ServerRequestFactory::fromGlobals());
+    $route = $router->match(ServerRequestFactory::fromGlobals());
     // OR
-
+    
     // $_SERVER['REQUEST_URI'] = '/api/articles/2'
     // $_SERVER['REQUEST_METHOD'] = 'GET'
     $route = $router->matchFromPath($_SERVER['REQUEST_URI'], $_SERVER['REQUEST_METHOD']);
 
-    $parameters = $route->getParameters();
-    // $arguments = ['id' => 2]
-    $arguments = $route->getVars();
+    $handler = $route->getHandler();
+    // $attributes = ['id' => 2]
+    $attributes = $route->getAttributes();
 
-    $controllerName = $parameters[0];
-    $methodName = $parameters[1] ?? null;
+    $controllerName = $handler[0];
+    $methodName = $handler[1] ?? null;
 
     $controller = new $controllerName();
     if (!is_callable($controller)) {
         $controller =  [$controller, $methodName];
     }
 
-    echo $controller(...array_values($arguments));
+    echo $controller(...array_values($attributes));
 
-} catch (\Exception $exception) {
+} catch (\DevCoder\Exception\MethodNotAllowed $exception) {
+    header("HTTP/1.0 405 Method Not Allowed");
+    exit();
+} catch (\DevCoder\Exception\RouteNotFound $exception) {
     header("HTTP/1.0 404 Not Found");
+    exit();
 }
 ```
 How to Define Route methods
@@ -115,8 +121,11 @@ echo $router->generateUri('home_page');
 // /
 echo $router->generateUri('api_articles', ['id' => 1]);
 // /api/articles/1
+
+echo $router->generateUri('api_articles', ['id' => 1], true);
+// http://localhost/api/articles/1
 ```
 
-Ideal for small project
+Ideal for small project.
 Simple and easy!
 [https://github.com/devcoder-xyz/php-router](https://github.com/devcoder-xyz/php-router)

Diff for: composer.json

@@ -16,13 +16,18 @@
         }
     ],
     "require": {
-        "php": ">=7.3",
+        "php": ">=7.4",
         "psr/http-message": "^1.0",
         "psr/http-server-middleware": "^1.0",
         "psr/http-factory": "^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~7.1",
-        "nunomaduro/phpinsights": "^1.14"
+        "phpunit/phpunit": "^9.5",
+        "nunomaduro/phpinsights": "^2.6"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": false
+        }
     }
 }

Diff for: composer.lock

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevCoder\Exception;
+
+final class MethodNotAllowed extends \Exception
+{
+}

Diff for: src/Exception/MethodNotAllowed.php

@@ -8,4 +8,4 @@ public static function trimPath(string $path): string
     {
         return '/' . rtrim(ltrim(trim($path), '/'), '/');
     }
-}
+}

Diff for: src/Helper.php

@@ -5,6 +5,14 @@
 namespace DevCoder;
 
 use DevCoder\Traits\RouteTrait;
+use InvalidArgumentException;
+use function array_filter;
+use function is_string;
+use function preg_match;
+use function preg_match_all;
+use function reset;
+use function str_replace;
+use function trim;
 
 /**
  * Class Route
@@ -14,15 +22,8 @@ final class Route
 {
     use RouteTrait;
 
-    /**
-     * @var string
-     */
-    private $name;
-
-    /**
-     * @var string
-     */
-    private $path;
+    private string $name;
+    private string $path;
 
     /**
      * @var mixed
@@ -32,7 +33,7 @@ final class Route
     /**
      * @var array<string>
      */
-    private $methods = [];
+    private array $methods = [];
 
     /**
      * @var array<string>
@@ -53,23 +54,23 @@ final class Route
     public function __construct(string $name, string $path, $handler, array $methods = ['GET'])
     {
         if ($methods === []) {
-            throw new \InvalidArgumentException('HTTP methods argument was empty; must contain at least one method');
+            throw new InvalidArgumentException('HTTP methods argument was empty; must contain at least one method');
         }
         $this->name = $name;
-        $this->path = $path;
+        $this->path = Helper::trimPath($path);
         $this->handler = $handler;
         $this->methods = $methods;
     }
 
-    public function match(string $path, string $method): bool
+    public function match(string $path): bool
     {
         $regex = $this->getPath();
         foreach ($this->getVarsNames() as $variable) {
             $varName = trim($variable, '{\}');
             $regex = str_replace($variable, '(?P<' . $varName . '>[^/]++)', $regex);
         }
 
-        if (in_array($method, $this->getMethods()) && preg_match('#^' . $regex . '$#sD', Helper::trimPath($path), $matches)) {
+        if (preg_match('#^' . $regex . '$#sD', Helper::trimPath($path), $matches)) {
             $values = array_filter($matches, static function ($key) {
                 return is_string($key);
             }, ARRAY_FILTER_USE_KEY);
@@ -91,14 +92,6 @@ public function getPath(): string
         return $this->path;
     }
 
-    /**
-     * @deprecated use getHandler()
-     */
-    public function getParameters()
-    {
-        return $this->getHandler();
-    }
-
     public function getHandler()
     {
         return $this->handler;
@@ -115,27 +108,11 @@ public function getVarsNames(): array
         return reset($matches) ?? [];
     }
 
-    /**
-     * @deprecated use hasAttributes()
-     */
-    public function hasVars(): bool
-    {
-        return $this->hasAttributes();
-    }
-
     public function hasAttributes(): bool
     {
         return $this->getVarsNames() !== [];
     }
 
-    /**
-     * @deprecated use getAttributes()
-     */
-    public function getVars(): array
-    {
-        return $this->getAttributes();
-    }
-
     /**
      * @return array<string>
      */

Diff for: src/Route.php

@@ -4,31 +4,26 @@
 
 namespace DevCoder;
 
+use DevCoder\Exception\MethodNotAllowed;
 use DevCoder\Exception\RouteNotFound;
 use Psr\Http\Message\ServerRequestInterface;
 
 final class Router implements RouterInterface
 {
     private const NO_ROUTE = 404;
+    private const METHOD_NOT_ALLOWED = 405;
 
-    /**
-     * @var \ArrayObject<Route>
-     */
-    private $routes;
-
-    /**
-     * @var UrlGenerator
-     */
-    private $urlGenerator;
+    private \ArrayObject $routes;
+    private UrlGenerator $urlGenerator;
 
     /**
      * Router constructor.
      * @param $routes array<Route>
      */
-    public function __construct(array $routes = [])
+    public function __construct(array $routes = [], string $defaultUri = 'http://localhost')
     {
         $this->routes = new \ArrayObject();
-        $this->urlGenerator = new UrlGenerator($this->routes);
+        $this->urlGenerator = new UrlGenerator($this->routes, $defaultUri);
         foreach ($routes as $route) {
             $this->add($route);
         }
@@ -47,22 +42,32 @@ public function match(ServerRequestInterface $serverRequest): Route
 
     public function matchFromPath(string $path, string $method): Route
     {
+        /**
+         * @var Route $route
+         */
         foreach ($this->routes as $route) {
-            if ($route->match($path, $method) === false) {
+            if ($route->match($path) === false) {
                 continue;
             }
+
+            if (!in_array($method, $route->getMethods())) {
+                throw new MethodNotAllowed(
+                    'Method Not Allowed : ' . $method,
+                    self::METHOD_NOT_ALLOWED
+                );
+            }
             return $route;
         }
 
         throw new RouteNotFound(
-            'No route found for ' . $method,
+            'No route found for ' . $path,
             self::NO_ROUTE
         );
     }
 
-    public function generateUri(string $name, array $parameters = []): string
+    public function generateUri(string $name, array $parameters = [], bool $absoluteUrl = false): string
     {
-        return $this->urlGenerator->generate($name, $parameters);
+        return $this->urlGenerator->generate($name, $parameters, $absoluteUrl);
     }
 
     public function getUrlGenerator(): UrlGenerator

Diff for: src/Router.php

@@ -4,45 +4,40 @@
 
 namespace DevCoder;
 
+use DevCoder\Exception\MethodNotAllowed;
 use DevCoder\Exception\RouteNotFound;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
+use Throwable;
 
 final class RouterMiddleware implements MiddlewareInterface
 {
     public const CONTROLLER = '_controller';
     public const ACTION = '_action';
     public const NAME = '_name';
 
-    /**
-     * @var RouterInterface
-     */
-    private $router;
-
-    /**
-     * @var ResponseFactoryInterface
-     */
-    private $responseFactory;
+    private RouterInterface $router;
+    private ResponseFactoryInterface $responseFactory;
 
     public function __construct(
-        RouterInterface $router,
+        RouterInterface          $router,
         ResponseFactoryInterface $responseFactory)
     {
         $this->router = $router;
         $this->responseFactory = $responseFactory;
     }
 
     public function process(
-        ServerRequestInterface $request,
+        ServerRequestInterface  $request,
         RequestHandlerInterface $handler): ResponseInterface
     {
         try {
             $route = $this->router->match($request);
             $routeHandler = $route->getHandler();
-            $attributes = array_merge([
+            $attributes = \array_merge([
                 self::CONTROLLER => $routeHandler[0],
                 self::ACTION => $routeHandler[1] ?? null,
                 self::NAME => $route->getName(),
@@ -51,9 +46,11 @@ public function process(
             foreach ($attributes as $key => $value) {
                 $request = $request->withAttribute($key, $value);
             }
+        } catch (MethodNotAllowed $exception) {
+            return $this->responseFactory->createResponse(405);
         } catch (RouteNotFound $exception) {
             return $this->responseFactory->createResponse(404);
-        } catch (\Throwable $exception) {
+        } catch (Throwable $exception) {
             throw $exception;
         }
         return $handler->handle($request);

Diff for: src/RouterMiddleware.php

@@ -6,23 +6,23 @@
 
 trait RouteTrait
 {
-    public static function get(string $name, string $path, array $parameters): BaseRoute
+    public static function get(string $name, string $path, $handler): BaseRoute
     {
-        return new BaseRoute($name, $path, $parameters);
+        return new BaseRoute($name, $path, $handler);
     }
 
-    public static function post(string $name, string $path, array $parameters): BaseRoute
+    public static function post(string $name, string $path, $handler): BaseRoute
     {
-        return new BaseRoute($name, $path, $parameters, ['POST']);
+        return new BaseRoute($name, $path, $handler, ['POST']);
     }
 
-    public static function put(string $name, string $path, array $parameters): BaseRoute
+    public static function put(string $name, string $path, $handler): BaseRoute
     {
-        return new BaseRoute($name, $path, $parameters, ['PUT']);
+        return new BaseRoute($name, $path, $handler, ['PUT']);
     }
 
-    public static function delete(string $name, string $path, array $parameters): BaseRoute
+    public static function delete(string $name, string $path, $handler): BaseRoute
     {
-        return new BaseRoute($name, $path, $parameters, ['DELETE']);
+        return new BaseRoute($name, $path, $handler, ['DELETE']);
     }
 }

Diff for: src/Traits/RouteTrait.php

@@ -4,33 +4,45 @@
 
 namespace DevCoder;
 
+use ArrayAccess;
+use InvalidArgumentException;
+use function array_key_exists;
+use function implode;
+use function sprintf;
+use function str_replace;
+use function trim;
+
 final class UrlGenerator
 {
-    /**
-     * @var \ArrayAccess<Route>
-     */
-    private $routes;
+    private ArrayAccess $routes;
+    private string $defaultUri;
 
-    public function __construct(\ArrayAccess $routes)
+    public function __construct(ArrayAccess $routes, string $defaultUri = '')
     {
         $this->routes = $routes;
+        $this->defaultUri = $defaultUri;
     }
 
-    public function generate(string $name, array $parameters = []): string
+    public function generate(string $name, array $parameters = [], bool $absoluteUrl = false): string
     {
         if ($this->routes->offsetExists($name) === false) {
-            throw new \InvalidArgumentException(
+            throw new InvalidArgumentException(
                 sprintf('Unknown %s name route', $name)
             );
         }
         /*** @var Route $route */
         $route = $this->routes[$name];
         if ($route->hasAttributes() === true && $parameters === []) {
-            throw new \InvalidArgumentException(
+            throw new InvalidArgumentException(
                 sprintf('%s route need parameters: %s', $name, implode(',', $route->getVarsNames()))
             );
         }
-        return self::resolveUri($route, $parameters);
+
+        $url = self::resolveUri($route, $parameters);
+        if ($absoluteUrl === true) {
+            $url = ltrim(Helper::trimPath($this->defaultUri), '/') . $url;
+        }
+        return $url;
     }
 
     private static function resolveUri(Route $route, array $parameters): string
@@ -39,12 +51,12 @@ private static function resolveUri(Route $route, array $parameters): string
         foreach ($route->getVarsNames() as $variable) {
             $varName = trim($variable, '{\}');
             if (array_key_exists($varName, $parameters) === false) {
-                throw new \InvalidArgumentException(
+                throw new InvalidArgumentException(
                     sprintf('%s not found in parameters to generate url', $varName)
                 );
             }
             $uri = str_replace($variable, $parameters[$varName], $uri);
         }
         return $uri;
     }
-}
+}

Diff for: src/UrlGenerator.php

@@ -30,10 +30,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->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'));
+        $this->assertTrue($routeWithAttribute->match('/view/article/1'));
+        $this->assertTrue($routeWithAttributes->match('/view/article/1/24'));
+        $this->assertTrue($routeWithoutAttribute->match('/view/article/'));
     }
 
     public function testException()

Diff for: tests/RouteTest.php

@@ -2,21 +2,20 @@
 
 namespace Test\DevCoder;
 
+use DevCoder\Exception\MethodNotAllowed;
 use DevCoder\Exception\RouteNotFound;
-use PHPUnit\Framework\TestCase;
 use DevCoder\Route;
 use DevCoder\Router;
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Class RouterTest
  * @package Test\Webbym\Routing
  */
 class RouterTest extends TestCase
 {
-    /**
-     * @var Router
-     */
-    private $router;
+    private Router $router;
 
     public function __construct($name = null, array $data = [], $dataName = '')
     {
@@ -33,24 +32,31 @@ public function __construct($name = null, array $data = [], $dataName = '')
             ->add($routeArticleWithParams);
     }
 
-    public function testMatchRoute() {
-
+    public function testMatchRoute()
+    {
         $route = $this->router->matchFromPath('/view/article/25', 'GET');
         $this->assertInstanceOf(Route::class, $route);
 
-        $this->assertNotEmpty($route->getParameters());
+        $this->assertNotEmpty($route->getHandler());
         $this->assertNotEmpty($route->getMethods());
-        $this->assertSame(['id' => '25'], $route->getVars());
-
-
+        $this->assertSame(['id' => '25'], $route->getAttributes());
         $this->assertInstanceOf(Route::class, $this->router->matchFromPath('/home', 'GET'));
-        $this->expectException(RouteNotFound::class);
-        $this->router->matchFromPath('/home', 'PUT');
+    }
 
+    public function testNotFoundException()
+    {
+        $this->expectException(RouteNotFound::class);
+        $this->router->matchFromPath('/homes', 'GET');
     }
 
-    public function testGenerateUrl() {
+    public function testMethodNotAllowedException()
+    {
+        $this->expectException(MethodNotAllowed::class);
+        $this->router->matchFromPath('/home', 'PUT');
+    }
 
+    public function testGenerateUrl()
+    {
         $urlHome = $this->router->generateUri('home_page');
         $urlArticle = $this->router->generateUri('article_page');
         $urlArticleWithParam = $this->router->generateUri('article_page_by_id', ['id' => 25]);
@@ -61,8 +67,23 @@ public function testGenerateUrl() {
         $this->assertSame($urlArticleWithParam, '/view/article/25');
         $this->assertSame($routeArticleWithParams, '/view/article/25/3');
 
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidArgumentException::class);
         $this->router->generateUri('article_page_by_id_and_page', ['id' => 25]);
+    }
+
+    public function testGenerateAbsoluteUrl()
+    {
+        $urlHome = $this->router->generateUri('home_page', [], true);
+        $urlArticle = $this->router->generateUri('article_page', [], true);
+        $urlArticleWithParam = $this->router->generateUri('article_page_by_id', ['id' => 25], true);
+        $routeArticleWithParams = $this->router->generateUri('article_page_by_id_and_page', ['id' => 25, 'page' => 3], true);
 
+        $this->assertSame($urlHome, 'http://localhost/home');
+        $this->assertSame($urlArticle, 'http://localhost/view/article');
+        $this->assertSame($urlArticleWithParam, 'http://localhost/view/article/25');
+        $this->assertSame($routeArticleWithParams, 'http://localhost/view/article/25/3');
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->router->generateUri('article_page_by_id_and_page', ['id' => 25]);
     }
 }