Use a dedicated config file for supported locales

Author: ivanvermeyen

README.md

@@ -19,16 +19,20 @@ composer require codezero/laravel-localized-routes
 
 > Laravel >= 5.5 will automatically register the ServiceProvider.
 
-## Configure Supported Locales
+#### Publish Configuration File
 
-Add a `locales` key to your `config/app.php` file.
+```php
+php artisan vendor:publish --provider="CodeZero\LocalizedRoutes\LocalizedRoutesServiceProvider" --tag="config"
+```
+
+You will now find a `localize-routes.php` file in the `config` folder.
+
+#### Configure Supported Locales
+
+Add any locales you wish to support to your published `config/localized-routes.php` file:
 
 ```php
-'locales' => [
-    'en',
-    'nl',
-    //...
-],
+'supported-locales' => ['en', 'nl', 'fr'],
 ```
 
 ## Register Routes

config/localized-routes.php

@@ -0,0 +1,10 @@
+<?php
+
+return [
+
+    /**
+     * The locales you wish to support.
+     */
+    'locales' => [],
+
+];

src/LocalizedRoutesServiceProvider.php

@@ -8,13 +8,21 @@
 
 class LocalizedRoutesServiceProvider extends ServiceProvider
 {
+    /**
+     * The package name.
+     *
+     * @var string
+     */
+    protected $name = 'localized-routes';
+
     /**
      * Bootstrap any application services.
      *
      * @return void
      */
     public function boot()
     {
+        $this->registerPublishableFiles();
         $this->registerMacros();
     }
 
@@ -25,6 +33,7 @@ public function boot()
      */
     public function register()
     {
+        $this->mergeConfig();
         $this->registerUrlGenerator();
     }
 
@@ -39,6 +48,29 @@ protected function registerMacros()
         UriTranslationMacro::register();
     }
 
+    /**
+     * Register the publishable files.
+     *
+     * @return void
+     */
+    protected function registerPublishableFiles()
+    {
+        $this->publishes([
+            __DIR__."/../config/{$this->name}.php" => config_path("{$this->name}.php"),
+        ], 'config');
+    }
+
+    /**
+     * Merge published configuration file with
+     * the original package configuration file.
+     *
+     * @return void
+     */
+    protected function mergeConfig()
+    {
+        $this->mergeConfigFrom(__DIR__."/../config/{$this->name}.php", $this->name);
+    }
+
     /**
      * Register the URL generator service.
      *

src/Macros/LocalizedRoutesMacro.php

@@ -20,7 +20,7 @@ public static function register()
             // change it during route registration.
             $currentLocale = App::getLocale();
 
-            $locales = Config::get('app.locales', []);
+            $locales = Config::get('localized-routes.supported-locales', []);
 
             foreach ($locales as $locale) {
                 // Change the current locale so we can

src/UrlGenerator.php

@@ -85,7 +85,7 @@ protected function stripLocaleFromRouteName($name)
             return $name;
         }
 
-        $locales = Config::get('app.locales', []);
+        $locales = Config::get('localized-routes.supported-locales', []);
 
         // If the first part of the route name is a valid
         // locale, then remove it from the array.

tests/Unit/Macros/LocalizedRoutesMacroTest.php

@@ -9,7 +9,7 @@ class LocalizedRoutesMacroTest extends TestCase
 {
     protected function setAvailableLocales($locales)
     {
-        config()->set('app.locales', $locales);
+        config()->set('localized-routes.supported-locales', $locales);
     }
 
     /** @test */

tests/Unit/UrlGeneratorTest.php

@@ -14,7 +14,7 @@ protected function setUp()
     {
         parent::setUp();
 
-        config()->set('app.locales', ['en', 'nl']);
+        config()->set('localized-routes.supported-locales', ['en', 'nl']);
 
         app()->setLocale('en');
     }