Update new version, improve with config file

Author: halivert

src/Console/CreateJSRoutesCommand.php

@@ -15,17 +15,17 @@ class CreateJSRoutesCommand extends Command
     protected $signature = "route:tojs
 		{ --name=routes.js : Name of the output file. }
 		{ --p|path= : Path of the output file. }
-		{ --w|whitelist= : List of comma separated route names to include (overrides ignore and methods). }
-		{ --i|ignore=telescope : List of comma separated route names to ignore (overrides methods). }
-		{ --m|methods=GET : List of comma separated methods accepted by filter. Empty for include all methods. }
+		{ --i|include= : List of comma separated route names to include (overrides exclude and methods). }
+		{ --e|exclude= : List of comma separated route names to exclude (overrides methods). }
+		{ --m|methods= : List of comma separated methods accepted by filter. Empty for include all methods. }
 		{ --f|force : Overwrite existing routes by default. }";
 
     /**
      * The console command description.
      *
      * @var string
      */
-    protected $description = "Create object with routes, and a function for its JS use";
+    protected $description = "Create object with routes, and a function for its JS use. Uses key from configuration file 'jsroutes'.";
 
     /**
      * Create a new command instance.
@@ -50,7 +50,7 @@ public function handle()
             return $this->includeRoute($route, $key);
         })->map(function ($route) {
             return [
-                "uri" => $route->uri
+                'uri' => $route->uri
             ];
         });
 
@@ -60,9 +60,9 @@ public function handle()
         $content .= json_encode($routes, $jsonFlags);
         $content .= ";\n\n";
 
-        $content .= file_get_contents(__DIR__ . "/../assets/js/routeFunction.js");
+        $content .= file_get_contents(__DIR__ . '/../assets/js/routeFunction.js');
 
-        $fileName = $this->option("name");
+        $fileName = config('jsroutes.name', $this->option('name'));
         if ($this->createFile($fileName, $content)) {
             $this->info($fileName . " created");
         }
@@ -72,14 +72,14 @@ public function createFile($fileName, $contents)
     {
         if (
             file_exists($file = $this->getJSPath($fileName)) &&
-            !$this->option("force")
+            !$this->option('force')
         ) {
             if (
                 !$this->confirm(
-                    "The [" . $fileName . "] file already exists. Do you want to replace it?"
+                    'The [' . $fileName . '] file already exists. Do you want to replace it?'
                 )
             ) {
-                $this->error("Error");
+                $this->error('Error');
                 return false;
             }
         }
@@ -90,21 +90,26 @@ public function createFile($fileName, $contents)
 
     private function includeRoute($route, $routeName)
     {
-        $whitelist = explode(",", $this->option("whitelist"));
+        $include = config('jsroutes.include', explode(',', $this->option('include')));
 
-        if (in_array($routeName, $whitelist)) {
+        if (in_array($routeName, $include)) {
             return true;
         }
 
-        $ignore = explode(",", $this->option("ignore"));
+        $exclude = config('jsroutes.exclude', explode(',', $this->option('exclude')));
 
-        if (in_array($routeName, $ignore)) {
+        if (in_array($routeName, $exclude)) {
             return false;
         }
 
-        $methods = $this->option("methods");
+        if (config('jsroutes.methods') !== null) {
+            $methods = implode(',', config('jsroutes.methods'));
+        } else {
+            $methods = $this->option('methods');
+        }
+
         $valid = empty($methods);
-        foreach (explode(",", $methods) as $method) {
+        foreach (explode(',', $methods) as $method) {
             $valid |= in_array($method, $route->methods);
         }
 
@@ -113,7 +118,7 @@ private function includeRoute($route, $routeName)
 
     public function getJSPath($fileName)
     {
-        $path = $this->option("path") ?? config('js.path')[0] ?? resource_path('js');
+        $path = config('jsroutes.path', $this->option('path') ?? config('js.path')[0] ?? resource_path('js'));
         return implode(DIRECTORY_SEPARATOR, [$path, $fileName]);
     }
 }

src/JSRoutesServiceProvider.php

@@ -6,6 +6,11 @@
 
 class JSRoutesServiceProvider extends ServiceProvider
 {
+    public function boot()
+    {
+        $this->mergeConfigFrom(__DIR__ . '/config/jsroutes.php', 'jsroutes');
+    }
+
     public function register()
     {
         $this->commands([

src/config/jsroutes.php

@@ -0,0 +1,15 @@
+<?php
+
+return [
+	'path' => './',
+    'name' => 'routes.js',
+    'include' => [
+		'boss.bye'
+    ],
+    'exclude' => [
+		'telescope'
+    ],
+    'methods' => [
+		'GET'
+	],
+];

tests/CreateJSRoutesCommandTest.php

@@ -10,7 +10,7 @@ class CreateJSRoutesCommandTest extends TestCase
     protected function getPackageProviders($app)
     {
         return [
-            'Halivert\JSRoutes\JSRoutesServiceProvider'
+            'Halivert\JSRoutes\Tests\Stubs\Providers\JSRoutesServiceProviderTest'
         ];
     }
 
@@ -54,12 +54,13 @@ protected function getEnvironmentSetUp($app)
 
     public function test_can_create_file()
     {
-        $command = "route:tojs -p ./ -m GET,PATCH -w boss.bye";
-        $result = "routes.js created";
+		$name = config('jsroutes.name', 'routes.js');
+        $command = "route:tojs";
+        $result = $name . " created";
 
-        if (file_exists(realpath("./routes.js"))) {
+        if (file_exists(realpath("./" . $name))) {
             $this->artisan($command)->expectsQuestion(
-                "The [routes.js] file already exists. Do you want to replace it?",
+                "The [" . $name . "] file already exists. Do you want to replace it?",
                 "yes"
             )->expectsOutput($result)->assertExitCode(0);
         } else {

tests/Stubs/Providers/JSRoutesServiceProviderTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Halivert\JSRoutes\Tests\Stubs\Providers;
+
+use Halivert\JSRoutes\JSRoutesServiceProvider;
+use Illuminate\Support\AggregateServiceProvider;
+
+class JSRoutesServiceProviderTest extends AggregateServiceProvider
+{
+    protected $providers = [
+        JSRoutesServiceProvider::class,
+    ];
+
+    public function register()
+    {
+        parent::register();
+
+        $this->app['service.loaded'] = true;
+    }
+}