Merge pull request #197 from Laravel-Backpack/pr/188

Pr/188 - allow stub publish
Laravel-Backpack · Jul 24, 2023 · e531489 · e531489
2 parents e2b4294 + ccbfc2e
commit e531489
Show file tree

Hide file tree

Showing 14 changed files with 59 additions and 20 deletions.
diff --git a/src/Console/Commands/ChartControllerBackpackCommand.php b/src/Console/Commands/ChartControllerBackpackCommand.php
@@ -7,6 +7,8 @@
 
 class ChartControllerBackpackCommand extends GeneratorCommand
 {
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
+
     /**
      * The console command name.
      *
@@ -55,7 +57,7 @@ protected function getPath($name)
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/chart-controller.stub';
+        return $this->getStubPath('chart-controller');
     }
 
     /**

diff --git a/src/Console/Commands/ConfigBackpackCommand.php b/src/Console/Commands/ConfigBackpackCommand.php
@@ -6,6 +6,8 @@
 
 class ConfigBackpackCommand extends GeneratorCommand
 {
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
+
     /**
      * The console command name.
      *
@@ -41,7 +43,7 @@ class ConfigBackpackCommand extends GeneratorCommand
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/config.stub';
+        return $this->getStubPath('config');
     }
 
     /**

diff --git a/src/Console/Commands/CrudControllerBackpackCommand.php b/src/Console/Commands/CrudControllerBackpackCommand.php
@@ -8,6 +8,7 @@
 class CrudControllerBackpackCommand extends BackpackCommand
 {
     use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
 
     /**
      * The console command name.
@@ -94,7 +95,7 @@ protected function getPath($name)
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/crud-controller.stub';
+        return $this->getStubPath('crud-controller');
     }
 
     /**

diff --git a/src/Console/Commands/CrudModelBackpackCommand.php b/src/Console/Commands/CrudModelBackpackCommand.php
@@ -8,6 +8,7 @@
 class CrudModelBackpackCommand extends BackpackCommand
 {
     use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
 
     /**
      * The console command name.
@@ -145,7 +146,7 @@ public function handle()
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/crud-model.stub';
+        return $this->getStubPath('crud-model');
     }
 
     /**

diff --git a/src/Console/Commands/CrudOperationBackpackCommand.php b/src/Console/Commands/CrudOperationBackpackCommand.php
@@ -7,6 +7,8 @@
 
 class CrudOperationBackpackCommand extends GeneratorCommand
 {
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
+
     /**
      * The console command name.
      *
@@ -55,7 +57,7 @@ protected function getPath($name)
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/crud-operation.stub';
+        return $this->getStubPath('crud-operation');
     }
 
     /**

diff --git a/src/Console/Commands/CrudRequestBackpackCommand.php b/src/Console/Commands/CrudRequestBackpackCommand.php
@@ -8,6 +8,7 @@
 class CrudRequestBackpackCommand extends BackpackCommand
 {
     use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
 
     /**
      * The console command name.
@@ -93,7 +94,7 @@ protected function getPath($name)
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/crud-request.stub';
+        return $this->getStubPath('crud-request');
     }
 
     /**

diff --git a/src/Console/Commands/ModelBackpackCommand.php b/src/Console/Commands/ModelBackpackCommand.php
@@ -7,6 +7,8 @@
 
 class ModelBackpackCommand extends GeneratorCommand
 {
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
+
     /**
      * The console command name.
      *
@@ -43,10 +45,10 @@ class ModelBackpackCommand extends GeneratorCommand
     protected function getStub()
     {
         if ($this->option('softdelete')) {
-            return __DIR__.'/../stubs/model-softdelete.stub';
+            return $this->getStubPath('model-softdelete');
         }
 
-        return __DIR__.'/../stubs/model.stub';
+        return $this->getStubPath('model');
     }
 
     /**

diff --git a/src/Console/Commands/PageBackpackCommand.php b/src/Console/Commands/PageBackpackCommand.php
@@ -8,6 +8,7 @@
 class PageBackpackCommand extends GeneratorCommand
 {
     use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
 
     /**
      * The console command name.
@@ -120,7 +121,7 @@ public function handle()
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/page.stub';
+        return $this->getStubPath('page');
     }
 
     /**

diff --git a/src/Console/Commands/PageControllerBackpackCommand.php b/src/Console/Commands/PageControllerBackpackCommand.php
@@ -9,6 +9,7 @@
 class PageControllerBackpackCommand extends GeneratorCommand
 {
     use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
 
     /**
      * The console command name.
@@ -111,7 +112,7 @@ protected function getPath($name)
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/page-controller.stub';
+        return $this->getStubPath('page-controller');
     }
 
     /**

diff --git a/src/Console/Commands/RequestBackpackCommand.php b/src/Console/Commands/RequestBackpackCommand.php
@@ -6,6 +6,8 @@
 
 class RequestBackpackCommand extends GeneratorCommand
 {
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
+
     /**
      * The console command name.
      *
@@ -41,7 +43,7 @@ class RequestBackpackCommand extends GeneratorCommand
      */
     protected function getStub()
     {
-        return __DIR__.'/../stubs/request.stub';
+        return $this->getStubPath('request');
     }
 
     /**

diff --git a/src/Console/Commands/Traits/PublishableStubTrait.php b/src/Console/Commands/Traits/PublishableStubTrait.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Backpack\Generators\Console\Commands\Traits;
+
+use Illuminate\Support\Str;
+
+trait PublishableStubTrait
+{
+    /**
+     * Return the path to the stub.
+     */
+    public function getStubPath(string $path): string
+    {
+        $path = Str::finish($path, '.stub');
+
+        if (file_exists(base_path("stubs/backpack/generators/{$path}"))) {
+            return base_path("stubs/backpack/generators/{$path}");
+        }
+
+        return __DIR__."/../../stubs/{$path}";
+    }
+}
diff --git a/src/Console/Commands/ViewBackpackCommand.php b/src/Console/Commands/ViewBackpackCommand.php
@@ -6,6 +6,8 @@
 
 class ViewBackpackCommand extends GeneratorCommand
 {
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
+
     /**
      * The console command name.
      *
@@ -42,10 +44,10 @@ class ViewBackpackCommand extends GeneratorCommand
     protected function getStub()
     {
         if ($this->option('plain')) {
-            return __DIR__.'/../stubs/view-plain.stub';
+            return $this->getStubPath('view-plain');
         }
 
-        return __DIR__.'/../stubs/view.stub';
+        return $this->getStubPath('view');
     }
 
     /**

diff --git a/src/Console/Commands/Views/PublishOrCreateViewBackpackCommand.php b/src/Console/Commands/Views/PublishOrCreateViewBackpackCommand.php
@@ -9,6 +9,7 @@
 abstract class PublishOrCreateViewBackpackCommand extends GeneratorCommand
 {
     use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;
 
     /**
      * The source file to copy from.
@@ -41,7 +42,7 @@ abstract class PublishOrCreateViewBackpackCommand extends GeneratorCommand
      */
     protected function getStub()
     {
-        return __DIR__.'/../../stubs/'.$this->stub;
+        return $this->getStubPath($this->stub);
     }
 
     /**

diff --git a/src/GeneratorsServiceProvider.php b/src/GeneratorsServiceProvider.php
@@ -49,13 +49,12 @@ class GeneratorsServiceProvider extends ServiceProvider
         WidgetBackpackCommand::class,
     ];
 
-    /**
-     * Register any package services.
-     *
-     * @return void
-     */
-    public function register()
+    public function boot(): void
     {
         $this->commands($this->commands);
+
+        $this->publishes([
+            __DIR__.'/Console/stubs' => base_path('stubs/backpack/generators'),
+        ], 'backpack-generators-stubs');
     }
 }