Move paths to config file.

Author: zachleigh

README.md

@@ -19,14 +19,18 @@ composer require zachleigh/laravel-vue-generators
 In Laravel's config/app.php file, add the service provider to the array with the 'providers' key.
 ```
 VueGenerators\ServiceProvider::class
-```    
+```
+Publish the config file:
+```
+php artisan vendor:publish --provider="VueGenerators\ServiceProvider"
+```
 
 ### Usage
 This package currently contains two commands: `component` and `mixin`.      
 #### component
 Create a Vue js component file.
 ```
-php artisan vueg:component {name} {--empty} {--path=assets.js.components}
+php artisan vueg:component {name} {--empty} {--path=}
 ```
 ###### name
 Name of the component.
@@ -41,16 +45,16 @@ php artisan vueg:component MyComponent --empty
 ```
 Will create a file with no component methods.
 ###### path
-By default, all components will be saved in resources/assets/js/components/. Specify a custom, period divide path with the path flag. Path root is in resources/.
+By default, all components will be saved in resources/assets/js/components/. Specify a custom path with the path flag. Path root is in resources/.
 ```
-php artisan vueg:component MyComponent --path=assets.js.custom.folder
+php artisan vueg:component MyComponent --path=assets/js/custom/folder
 ``` 
 Will create a file called MyComponent.vue at resources/assets/js/custom/folder/MyComponent.vue.
 
 #### mixin
 Create a Vue js mixin file.
 ```
-php artisan vueg:mixin {name} {--empty} {--path=assets.js.mixins}
+php artisan vueg:mixin {name} {--empty} {--path=}
 ```
 ###### name
 Name of the mixin.
@@ -65,9 +69,9 @@ php artisan vueg:mixin MyMixin --empty
 ```
 Will create a file with no mixin methods.
 ###### path
-By default, all mixins will be saved in resources/assets/js/mixins/. Specify a custom, period divide path with the path flag. Path root is in resources/.
+By default, all mixins will be saved in resources/assets/js/mixins/. Specify a custom path with the path flag. Path root is in resources/.
 ```
-php artisan vueg:mixin MyMixin --path=assets.js.custom.folder
+php artisan vueg:mixin MyMixin --path=assets/js/custom/folder
 ``` 
 Will create a file called MyMixin.vue at resources/assets/js/custom/folder/MyMixin.vue.
 

src/Commands/MakeComponent.php

@@ -11,7 +11,7 @@ class MakeComponent extends VueGeneratorsCommand
      *
      * @var string
      */
-    protected $signature = 'vueg:component {name} {--empty} {--path=assets.js.components}';
+    protected $signature = 'vueg:component {name} {--empty} {--path=}';
 
     /**
      * The console command description.
@@ -29,7 +29,7 @@ public function handle()
 
         $name = $this->argument('name').'.vue';
 
-        $path = $this->createPath($filesystem);
+        $path = $this->createPath($filesystem, 'component');
 
         $fullPath = resource_path("{$path}/{$name}");
 

src/Commands/MakeMixin.php

@@ -11,7 +11,7 @@ class MakeMixin extends VueGeneratorsCommand
      *
      * @var string
      */
-    protected $signature = 'vueg:mixin {name} {--empty} {--path=assets.js.mixins}';
+    protected $signature = 'vueg:mixin {name} {--empty} {--path=}';
 
     /**
      * The console command description.
@@ -29,7 +29,7 @@ public function handle()
 
         $name = $this->argument('name').'.js';
 
-        $path = $this->createPath($filesystem);
+        $path = $this->createPath($filesystem, 'mixin');
 
         $fullPath = resource_path("{$path}/{$name}");
 

src/Commands/VueGeneratorsCommand.php

@@ -14,17 +14,20 @@ class VueGeneratorsCommand extends Command
      * Create path for file.
      *
      * @param Filesystem $filesystem
+     * @param string     $type       File type.
      *
      * @return string
      */
-    protected function createPath(Filesystem $filesystem)
+    protected function createPath(Filesystem $filesystem, $type)
     {
-        $path = $this->option('path');
+        $customPath = $this->option('path');
 
-        $pathArray = explode('.', $path);
+        $defaultPath = config("vue-generators.paths.{$type}s");
 
-        $this->buildPathFromArray($pathArray, $filesystem);
+        $path = $customPath !== null ? $customPath : $defaultPath;
 
-        return implode('/', $pathArray);
+        $this->buildPathFromArray($path, $filesystem);
+
+        return $path;
     }
 }

src/Paths.php

@@ -9,11 +9,13 @@ trait Paths
     /**
      * Build directory tree from array of paths.
      *
-     * @param array           $pathArray
+     * @param string          $path
      * @param Filesystem|null $filesystem
      */
-    protected function buildPathFromArray(array $pathArray, Filesystem $filesystem = null)
+    protected function buildPathFromArray($path, Filesystem $filesystem = null)
     {
+        $pathArray = explode('/', $path);
+        
         if (is_null($filesystem)) {
             $filesystem = new Filesystem();
         }

src/ServiceProvider.php

@@ -25,7 +25,9 @@ public function register()
      */
     public function boot()
     {
-        //
+        $this->publishes([
+            __DIR__.'/config.php' => config_path('vue-generators.php'),
+        ], 'config');
     }
 
     /**

src/config.php

@@ -0,0 +1,15 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Paths
+    |--------------------------------------------------------------------------
+    |
+    | Register default paths for file types.
+    */
+    'paths' => [
+        'components' => 'assets/js/components',
+        'mixins'     => 'assets/js/mixins',
+    ]
+];

tests/CommandTest.php

@@ -67,7 +67,25 @@ public function it_saves_component_file_to_specified_path()
 
         Artisan::call('vueg:component', [
             'name'   => 'NewComponent',
-            '--path' => 'custom.path',
+            '--path' => 'custom/path',
+        ]);
+
+        $this->assertFileExists($file);
+    }
+
+    /**
+     * @test
+     */
+    public function it_saves_componets_to_path_set_in_config()
+    {
+        app()['config']->set('vue-generators.paths.components', 'custom/path');
+
+        $file = resource_path('custom/path/NewComponent.vue');
+
+        $this->assertFileNotExists($file);
+
+        Artisan::call('vueg:component', [
+            'name'   => 'NewComponent',
         ]);
 
         $this->assertFileExists($file);
@@ -134,7 +152,25 @@ public function it_saves_mixin_file_to_specified_path()
 
         Artisan::call('vueg:mixin', [
             'name'   => 'NewMixin',
-            '--path' => 'custom.path',
+            '--path' => 'custom/path',
+        ]);
+
+        $this->assertFileExists($file);
+    }
+
+    /**
+     * @test
+     */
+    public function it_saves_mixins_to_path_set_in_config()
+    {
+        app()['config']->set('vue-generators.paths.mixins', 'custom/path');
+
+        $file = resource_path('custom/path/NewMixin.js');
+
+        $this->assertFileNotExists($file);
+
+        Artisan::call('vueg:mixin', [
+            'name'   => 'NewMixin',
         ]);
 
         $this->assertFileExists($file);

tests/TestCase.php

@@ -33,6 +33,14 @@ public function createApplication()
      */
     protected function setUp()
     {
+        $filesystem = new Filesystem();
+
+        $configDir = __DIR__.'./../src/config.php';
+
+        $configTarget = __DIR__.'./../vendor/laravel/laravel/config/vue-generators.php';
+
+        $filesystem->copy($configDir, $configTarget);
+
         parent::setUp();
     }
 
@@ -45,7 +53,7 @@ protected function tearDown()
 
         $filesystem->deleteDirectory(resource_path());
 
-        $this->buildPathFromArray(explode('.', 'assets.js.components'));
+        $this->buildPathFromArray('assets/js/components');
 
         parent::tearDown();
     }