Merge pull request #2 from ARCANEDEV/develop

Adding a custom router for localized routes

src/Contracts/LocalizationInterface.php

@@ -1,4 +1,5 @@
 <?php namespace Arcanedev\Localization\Contracts;
+
 use Arcanedev\Localization\Entities\LocaleCollection;
 use Arcanedev\Localization\Exceptions\UndefinedSupportedLocalesException;
 use Arcanedev\Localization\Exceptions\UnsupportedLocaleException;

src/Contracts/RouteTranslatorInterface.php

@@ -22,7 +22,7 @@ public function getCurrentRoute();
     /**
      * Set the current route.
      *
-     * @param  string  $currentRoute
+     * @param  false|string  $currentRoute
      *
      * @return self
      */

src/LocalizationServiceProvider.php

@@ -67,7 +67,7 @@ public function register()
 
         $this->app->register(Providers\UtilitiesServiceProvider::class);
         $this->registerLocalization();
-        $this->app->register(Providers\RouterServiceProvider::class);
+        $this->app->register(Providers\RoutingServiceProvider::class);
     }
 
     /**

src/Middleware/LocaleCookieRedirect.php

@@ -53,6 +53,4 @@ public function handle(Request $request, Closure $next)
 
         return $next($request);
     }
-
-
 }

src/Providers/RouterServiceProvider.php → src/Providers/RoutingServiceProvider.php

@@ -4,17 +4,16 @@
 use Arcanedev\Localization\Middleware\LocaleSessionRedirect;
 use Arcanedev\Localization\Middleware\LocalizationRedirect;
 use Arcanedev\Localization\Middleware\LocalizationRoutes;
-use Arcanedev\Support\ServiceProvider;
-use Closure;
-use Illuminate\Routing\Router;
+use Illuminate\Routing\RoutingServiceProvider as ServiceProvider;
+use Arcanedev\Localization\Routing\Router;
 
 /**
- * Class     RouterServiceProvider
+ * Class     RoutingServiceProvider
  *
  * @package  Arcanedev\Localization\Providers
  * @author   ARCANEDEV <[email protected]>
  */
-class RouterServiceProvider extends ServiceProvider
+class RoutingServiceProvider extends ServiceProvider
 {
     /* ------------------------------------------------------------------------------------------------
      |  Properties
@@ -38,10 +37,23 @@ class RouterServiceProvider extends ServiceProvider
      */
     public function register()
     {
-        $router = $this->app['router'];
+        $this->registerRouter();
+    }
 
-        $this->registerMiddlewares($router);
-        $this->registerMacros($router);
+    /* ------------------------------------------------------------------------------------------------
+     |  Router Functions
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Register the router instance.
+     */
+    protected function registerRouter()
+    {
+        $this->app['router'] = $this->app->share(function ($app) {
+            return new Router($app['events'], $app);
+        });
+
+        $this->registerMiddlewares($this->app['router']);
     }
 
     /**
@@ -68,41 +80,23 @@ private function registerMiddleware(Router $router, $name, $class)
     {
         $router->middleware($name,  $class);
 
-        if ($this->app['config']->get('localization.route.middleware.' . $name, false)) {
+        if ($this->getMiddleware($name)) {
             $this->middleware[] = $name;
         }
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Route Macros
-     | ------------------------------------------------------------------------------------------------
-     */
     /**
-     * Register the router macros.
+     * Get the middleware status.
      *
-     * @param  Router  $router
-     */
-    private function registerMacros(Router $router)
-    {
-        $this->registerLocalizedGroupMacro($router);
-    }
-
-    /**
-     * Register the 'localizedGroup' macro.
+     * @param  string  $name
      *
-     * @param  Router  $router
+     * @return bool
      */
-    private function registerLocalizedGroupMacro(Router $router)
+    private function getMiddleware($name)
     {
-        $middleware = $this->middleware;
+        /** @var \Illuminate\Config\Repository $config */
+        $config = $this->app['config'];
 
-        $router->macro('localizedGroup', function (Closure $callback) use ($router, $middleware) {
-            $attributes = [
-                'prefix'     => localization()->setLocale(),
-                'middleware' => $middleware,
-            ];
-
-            $router->group($attributes, $callback);
-        });
+        return (bool) $config->get('localization.route.middleware.' . $name, false);
     }
 }

src/Routing/Router.php

@@ -0,0 +1,117 @@
+<?php namespace Arcanedev\Localization\Routing;
+
+use Closure;
+use Illuminate\Routing\Router as IlluminateRouter;
+
+/**
+ * Class     Router
+ *
+ * @package  Arcanedev\Localization\Routing
+ * @author   ARCANEDEV <[email protected]>
+ */
+class Router extends IlluminateRouter
+{
+    /* ------------------------------------------------------------------------------------------------
+     |  Route Functions
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Create a route group with shared attributes.
+     *
+     * @param  array     $attributes
+     * @param  \Closure  $callback
+     */
+    public function localizedGroup(Closure $callback, $attributes = [])
+    {
+        $attributes = array_merge($attributes, [
+            'prefix'     => localization()->setLocale(),
+            'middleware' => $this->getMiddleware(),
+        ]);
+
+        $this->group($attributes, $callback);
+    }
+
+    /**
+     * @param  string                 $trans
+     * @param  \Closure|array|string  $action
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    public function transGet($trans, $action)
+    {
+        $uri = localization()->transRoute($trans);
+
+        return $this->get($uri, $action);
+    }
+
+    /**
+     * @param  string                 $trans
+     * @param  \Closure|array|string  $action
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    public function transPost($trans, $action)
+    {
+        $uri = localization()->transRoute($trans);
+
+        return $this->post($uri, $action);
+    }
+
+    /**
+     * @param  string                 $trans
+     * @param  \Closure|array|string  $action
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    public function transPut($trans, $action)
+    {
+        $uri = localization()->transRoute($trans);
+
+        return $this->put($uri, $action);
+    }
+
+    /**
+     * Register a new PATCH route with the router.
+     *
+     * @param  string                 $trans
+     * @param  \Closure|array|string  $action
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    public function transPatch($trans, $action)
+    {
+        $uri = localization()->transRoute($trans);
+
+        return $this->patch($uri, $action);
+    }
+
+    /**
+     * Register a new DELETE route with the router.
+     *
+     * @param  string                 $trans
+     * @param  \Closure|array|string  $action
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    public function transDelete($trans, $action)
+    {
+        $uri = localization()->transRoute($trans);
+
+        return $this->delete($uri, $action);
+    }
+
+    /**
+     * Register a new OPTIONS route with the router.
+     *
+     * @param  string                 $trans
+     * @param  \Closure|array|string  $action
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    public function transOptions($trans, $action)
+    {
+        $uri = localization()->transRoute($trans);
+
+        return $this->options($uri, $action);
+    }
+}

src/Traits/LocalizationKernelTrait.php

@@ -0,0 +1,25 @@
+<?php namespace Arcanedev\Localization\Traits;
+
+/**
+ * Class     LocalizationKernelTrait
+ *
+ * @package  Arcanedev\Localization\Traits
+ * @author   ARCANEDEV <[email protected]>
+ *
+ * @property  \Illuminate\Foundation\Application      app
+ * @property  \Arcanedev\Localization\Routing\Router  router
+ */
+trait LocalizationKernelTrait
+{
+    /**
+     * Get the route dispatcher callback.
+     *
+     * @return \Closure
+     */
+    protected function dispatchToRouter()
+    {
+        $this->router = $this->app['router'];
+
+        return parent::dispatchToRouter();
+    }
+}

src/Utilities/RouteTranslator.php

@@ -68,7 +68,7 @@ public function getCurrentRoute()
     /**
      * Set the current route.
      *
-     * @param  string  $currentRoute
+     * @param  false|string  $currentRoute
      *
      * @return self
      */

src/Utilities/Url.php

@@ -1,4 +1,5 @@
 <?php namespace Arcanedev\Localization\Utilities;
+
 use Arcanedev\Localization\Contracts\UrlInterface;
 use Illuminate\Routing\Route;
 use Illuminate\Routing\Router;
@@ -145,6 +146,8 @@ public static function unparse($parsed)
     /**
      * Extract Attributes From Router.
      *
+     * @param  Router  $router
+     *
      * @return array
      */
     private static function extractAttributesFromCurrentRoute(Router $router)

tests/Stubs/Http/Kernel.php

@@ -0,0 +1,19 @@
+<?php namespace Arcanedev\Localization\Tests\Stubs\Http;
+
+use Arcanedev\Localization\Traits\LocalizationKernelTrait;
+use Orchestra\Testbench\Http\Kernel as HttpKernel;
+
+/**
+ * Class     Kernel
+ *
+ * @package  Arcanedev\Localization\Tests\Stubs\Http
+ * @author   ARCANEDEV <[email protected]>
+ */
+class Kernel extends HttpKernel
+{
+    /* ------------------------------------------------------------------------------------------------
+     |  Traits
+     | ------------------------------------------------------------------------------------------------
+     */
+    use LocalizationKernelTrait;
+}

tests/TestCase.php

@@ -125,6 +125,20 @@ protected function refreshApplication($locale = false)
         $this->setRoutes($locale);
     }
 
+    /**
+     * Resolve application HTTP Kernel implementation.
+     *
+     * @param  \Illuminate\Foundation\Application  $app
+     * @return void
+     */
+    protected function resolveApplicationHttpKernel($app)
+    {
+        $app->singleton(
+            'Illuminate\Contracts\Http\Kernel',
+            Stubs\Http\Kernel::class
+        );
+    }
+
     /* ------------------------------------------------------------------------------------------------
      |  Other Functions
      | ------------------------------------------------------------------------------------------------
@@ -151,26 +165,26 @@ function () {
             app('router')->get('test', [
                 'as'    => 'test',
                 function () {
-                    return app('translator')->get('localization::routes.test_text');
+                    return app('translator')->get('localization::routes.test-text');
                 }
             ]);
 
-            app('router')->get(localization()->transRoute('localization::routes.about'), [
+            app('router')->transGet('localization::routes.about', [
                 'as'    => 'about',
                 function () {
                     return localization()->getLocalizedURL('es') ? : "Not url available";
                 }
             ]);
 
-            app('router')->get(localization()->transRoute('localization::routes.view'), [
+            app('router')->transGet('localization::routes.view', [
                 'as'    => 'view',
                 function () {
                     return localization()->getLocalizedURL('es') ? : "Not url available";
                 }
             ]);
 
-            app('router')->get(localization()->transRoute('localization::routes.view_project'), [
-                'as'    => 'view_project',
+            app('router')->transGet('localization::routes.view-project', [
+                'as'    => 'view-project',
                 function () {
                     return localization()->getLocalizedURL('es') ? : "Not url available";
                 }

tests/fixtures/lang/en/routes.php

@@ -3,7 +3,7 @@
 return [
     'about'         => 'about',
     'view'          => 'view/{id}',
-    'view_project'  => 'view/{id}/project/{project_id?}',
+    'view-project'  => 'view/{id}/project/{project_id?}',
     'hello'         => 'Hello world',
-    'test_text'     => 'Test text'
+    'test-text'     => 'Test text'
 ];

tests/fixtures/lang/es/routes.php

@@ -3,7 +3,7 @@
 return [
     'about'         => 'acerca',
     'view'          => 'ver/{id}',
-    'view_project'  => 'ver/{id}/proyecto/{project_id?}',
+    'view-project'  => 'ver/{id}/proyecto/{project_id?}',
     'hello'         => 'Hola mundo',
-    'test_text'     => 'Texto de prueba'
+    'test-text'     => 'Texto de prueba'
 ];