UPDATE - Group routers

Author: Rod1Andrade

public/index.php

@@ -2,26 +2,6 @@
 
 require "../vendor/autoload.php";
 
-$router = new \Rodri\SimpleRouter\Router();
+# Routes of application
+require_once '../routes/routes.php';
 
-# Namespaces Configurations
-$router->setControllerNamespace('Rodri\SimpleRouter\Controllers');
-$router->setMiddlewareNamespace('Rodri\SimpleRouter\Middlewares');
-
-$router->debug(true);
-
-# Header Router Configurations
-$router->headerConfigs([
-    'Content-type: application/json'
-]);
-
-# Routers
-$router->get(['/hello'], 'HelloControllerExample#hello');
-$router->get(['/hello/message/:id'], 'HelloControllerExample#helloByMessage');
-
-$router->post(['/post'], 'HelloControllerExample#postTest');
-
-// TODO: Group router
-
-# Execution of set router
-$router->dispatch();

routes/routes.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Router file - Here you can set all your application routes.
+ * Remember to change debug value to false if not in development mode.
+ *
+ * @author Rodrigo Andrade
+ * @since 2021-07-10
+ * @version 1.0.0
+ */
+
+use Rodri\SimpleRouter\Router;
+
+$router = new Router();
+
+# Namespaces Configurations
+$router->setControllerNamespace('Rodri\SimpleRouter\Controllers');
+$router->setMiddlewareNamespace('Rodri\SimpleRouter\Middlewares');
+
+# Debug mode
+$router->debug(true);
+
+# Header Router Configurations
+$router->headerConfigs([
+    'Content-type: application/json'
+]);
+
+# Routers without group
+$router->get(['/hello'], 'HelloControllerExample#hello');
+$router->get(['/hello/message/:id'], 'HelloControllerExample#helloByMessage');
+$router->post(['/post'], 'HelloControllerExample#postTest');
+
+# Router with group
+$router->group(['/group/test'], function (Router $router) {
+    $router->get([''], 'HelloControllerExample#hello');
+    $router->get(['/:id'], 'HelloControllerExample#helloByMessage');
+    $router->post([''], 'HelloControllerExample#postTest');
+});
+
+$router->group(['/group'], function (Router $router) {
+    $router->get([''], 'HelloControllerExample#hello');
+    $router->get(['/:id'], 'HelloControllerExample#helloByMessage');
+    $router->post([''], 'HelloControllerExample#postTest');
+});
+
+# Execution of set router
+$router->dispatch();

src/Exceptions/ControllerMethodNotFoundException.php

@@ -6,5 +6,4 @@
 
 class ControllerMethodNotFoundException extends \RuntimeException
 {
-
 }

src/Exceptions/SimpleRouterException.php

@@ -8,5 +8,4 @@
 
 class SimpleRouterException extends ReflectionException
 {
-
 }

src/Response.php

@@ -22,6 +22,15 @@ public function __construct(
         header($statusCode);
     }
 
+    /**
+     * Check if has some response value.
+     * @return bool
+     */
+    public function hasResponseValue(): bool
+    {
+        return $this->response != null;
+    }
+
     public function __toString(): string
     {
         if($this->response != null)

src/Router.php

@@ -5,10 +5,9 @@
 
 use Closure;
 use Exception;
+use PhpParser\Builder\Class_;
 use ReflectionException;
 use Rodri\SimpleRouter\Exceptions\ControllerMethodNotFoundException;
-use Rodri\SimpleRouter\Exceptions\SimpleRouterException;
-use Rodri\SimpleRouter\Handlers\GroupHttpHandler;
 use Rodri\SimpleRouter\Handlers\HttpHandler;
 use Rodri\SimpleRouter\Handlers\RouterHandler;
 use Rodri\SimpleRouter\Helpers\StatusCode;
@@ -25,11 +24,15 @@ class Router
     private ?RouterHandler $baseRouterHandler;
     private string $controllerNamespace;
     private bool $debugMode;
+    private ?string $baseUrl = null;
+
+    private array $groupRouter;
 
     public function __construct()
     {
         $this->baseRouterHandler = null;
         $this->debugMode = false;
+        $this->groupRouter = array();
     }
 
     /**
@@ -83,10 +86,30 @@ public function addRouterHandler(RouterHandler $routerHandler): void
     }
 
     /**
-     * @throws Exception
+     * Add a new Router to group array
+     * @param Router $router
+     */
+    public function addRouterGroup(Router $router): void
+    {
+        $this->groupRouter[] = $router;
+    }
+
+    /**
+     * Group the routes to work with the same base URI. The route in group
+     * can have the same middleware defined.
+     * @param array $routerOptions Router options [0] => '/router' ['middleware' => Middleware
+     * @param Closure $closure function(Router $router)
      */
     public function group(array $routerOptions, Closure $closure): void
     {
+        $router = clone $this;
+        $router->baseUrl = null;
+        $router->baseUrl = $routerOptions[0];
+
+        # Pass to closure function a instate of route
+        $closure($router);
+
+        $this->addRouterGroup($router);
     }
 
     /**
@@ -98,7 +121,7 @@ public function get(array $routerOptions, string $controller): void
     {
         $this->addRouterHandler(
             new HttpHandler(
-                $routerOptions[0],
+                $this->buildURI($routerOptions[0]),
                 $this->concatControllerAndNamespace($controller),
                 'GET'
             )
@@ -114,7 +137,7 @@ public function post(array $routerOptions, string $controller): void
     {
         $this->addRouterHandler(
             new HttpHandler(
-                $routerOptions[0],
+                $this->buildURI($routerOptions[0]),
                 $this->concatControllerAndNamespace($controller),
                 'POST'
             )
@@ -130,7 +153,7 @@ public function put(array $routerOptions, string $controller): void
     {
         $this->addRouterHandler(
             new HttpHandler(
-                $routerOptions[0],
+                $this->buildURI($routerOptions[0]),
                 $this->concatControllerAndNamespace($controller),
                 'PUT'
             )
@@ -146,7 +169,7 @@ public function patch(array $routerOptions, string $controller): void
     {
         $this->addRouterHandler(
             new HttpHandler(
-                $routerOptions[0],
+                $this->buildURI($routerOptions[0]),
                 $this->concatControllerAndNamespace($controller),
                 'PATCH'
             )
@@ -162,7 +185,7 @@ public function delete(array $routerOptions, string $controller): void
     {
         $this->addRouterHandler(
             new HttpHandler(
-                $routerOptions[0],
+                $this->buildURI($routerOptions[0]),
                 $this->concatControllerAndNamespace($controller),
                 'DELETE'
             )
@@ -172,11 +195,15 @@ public function delete(array $routerOptions, string $controller): void
     /**
      * Dispatch to router work call the expected handle.
      */
-    public function dispatch()
+    public function dispatch(): void
     {
+
+        # If have router grouped routes
+        if($this->dispatchGroupRoutes()) return;
+
         try {
             echo $this->baseRouterHandler->handle(new Request());
-        } catch (ControllerMethodNotFoundException|ReflectionException $e) {
+        } catch (ControllerMethodNotFoundException | ReflectionException $e) {
             if ($this->debugMode) {
                 echo new Response([
                     'Mode' => 'Debug',
@@ -194,6 +221,26 @@ public function dispatch()
         flush();
     }
 
+    /**
+     * Dispatch all grouped routes.
+     *
+     * @return bool
+     */
+    private function dispatchGroupRoutes(): bool
+    {
+        foreach ($this->groupRouter as $groupRouter) {
+            if ($groupRouter instanceof Router) {
+                $response = $groupRouter->baseRouterHandler->handle(new Request());
+                if($response->hasResponseValue()) {
+                    echo $response;
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
     /**
      * @param string $controller
      * @return string
@@ -202,4 +249,18 @@ private function concatControllerAndNamespace(string $controller): string
     {
         return $this->controllerNamespace . '\\' . $controller;
     }
+
+    /**
+     * Build a URI with a base URL if exist
+     * @param String $route
+     * @return String
+     */
+    private function buildURI(String $route): String
+    {
+        if(isset($this->baseUrl)) {
+            $route = $this->baseUrl.$route;
+        }
+
+        return $route;
+    }
 }