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

pxpm · web-flow · commit e5314899f3b4 · 2023-07-24T11:35:15.000+01:00
Pr/188 - allow stub publish
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');
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`class ChartControllerBackpackCommand extends GeneratorCommand`
`9`	`9`	`{`
	`10`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
	`11`	`+`
`10`	`12`	`/**`
`11`	`13`	`* The console command name.`
`12`	`14`	`*`
`@@ -55,7 +57,7 @@ protected function getPath($name)`
`55`	`57`	`*/`
`56`	`58`	`protected function getStub()`
`57`	`59`	`{`
`58`		`- return __DIR__.'/../stubs/chart-controller.stub';`
	`60`	`+ return $this->getStubPath('chart-controller');`
`59`	`61`	`}`
`60`	`62`
`61`	`63`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@`
`6`	`6`
`7`	`7`	`class ConfigBackpackCommand extends GeneratorCommand`
`8`	`8`	`{`
	`9`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
	`10`	`+`
`9`	`11`	`/**`
`10`	`12`	`* The console command name.`
`11`	`13`	`*`
`@@ -41,7 +43,7 @@ class ConfigBackpackCommand extends GeneratorCommand`
`41`	`43`	`*/`
`42`	`44`	`protected function getStub()`
`43`	`45`	`{`
`44`		`- return __DIR__.'/../stubs/config.stub';`
	`46`	`+ return $this->getStubPath('config');`
`45`	`47`	`}`
`46`	`48`
`47`	`49`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`class CrudControllerBackpackCommand extends BackpackCommand`
`9`	`9`	`{`
`10`	`10`	`use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;`
	`11`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
`11`	`12`
`12`	`13`	`/**`
`13`	`14`	`* The console command name.`
`@@ -94,7 +95,7 @@ protected function getPath($name)`
`94`	`95`	`*/`
`95`	`96`	`protected function getStub()`
`96`	`97`	`{`
`97`		`- return __DIR__.'/../stubs/crud-controller.stub';`
	`98`	`+ return $this->getStubPath('crud-controller');`
`98`	`99`	`}`
`99`	`100`
`100`	`101`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`class CrudModelBackpackCommand extends BackpackCommand`
`9`	`9`	`{`
`10`	`10`	`use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;`
	`11`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
`11`	`12`
`12`	`13`	`/**`
`13`	`14`	`* The console command name.`
`@@ -145,7 +146,7 @@ public function handle()`
`145`	`146`	`*/`
`146`	`147`	`protected function getStub()`
`147`	`148`	`{`
`148`		`- return __DIR__.'/../stubs/crud-model.stub';`
	`149`	`+ return $this->getStubPath('crud-model');`
`149`	`150`	`}`
`150`	`151`
`151`	`152`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`class CrudOperationBackpackCommand extends GeneratorCommand`
`9`	`9`	`{`
	`10`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
	`11`	`+`
`10`	`12`	`/**`
`11`	`13`	`* The console command name.`
`12`	`14`	`*`
`@@ -55,7 +57,7 @@ protected function getPath($name)`
`55`	`57`	`*/`
`56`	`58`	`protected function getStub()`
`57`	`59`	`{`
`58`		`- return __DIR__.'/../stubs/crud-operation.stub';`
	`60`	`+ return $this->getStubPath('crud-operation');`
`59`	`61`	`}`
`60`	`62`
`61`	`63`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`class CrudRequestBackpackCommand extends BackpackCommand`
`9`	`9`	`{`
`10`	`10`	`use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;`
	`11`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
`11`	`12`
`12`	`13`	`/**`
`13`	`14`	`* The console command name.`
`@@ -93,7 +94,7 @@ protected function getPath($name)`
`93`	`94`	`*/`
`94`	`95`	`protected function getStub()`
`95`	`96`	`{`
`96`		`- return __DIR__.'/../stubs/crud-request.stub';`
	`97`	`+ return $this->getStubPath('crud-request');`
`97`	`98`	`}`
`98`	`99`
`99`	`100`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`class ModelBackpackCommand extends GeneratorCommand`
`9`	`9`	`{`
	`10`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
	`11`	`+`
`10`	`12`	`/**`
`11`	`13`	`* The console command name.`
`12`	`14`	`*`
`@@ -43,10 +45,10 @@ class ModelBackpackCommand extends GeneratorCommand`
`43`	`45`	`protected function getStub()`
`44`	`46`	`{`
`45`	`47`	`if ($this->option('softdelete')) {`
`46`		`- return __DIR__.'/../stubs/model-softdelete.stub';`
	`48`	`+ return $this->getStubPath('model-softdelete');`
`47`	`49`	`}`
`48`	`50`
`49`		`- return __DIR__.'/../stubs/model.stub';`
	`51`	`+ return $this->getStubPath('model');`
`50`	`52`	`}`
`51`	`53`
`52`	`54`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`class PageBackpackCommand extends GeneratorCommand`
`9`	`9`	`{`
`10`	`10`	`use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;`
	`11`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
`11`	`12`
`12`	`13`	`/**`
`13`	`14`	`* The console command name.`
`@@ -120,7 +121,7 @@ public function handle()`
`120`	`121`	`*/`
`121`	`122`	`protected function getStub()`
`122`	`123`	`{`
`123`		`- return __DIR__.'/../stubs/page.stub';`
	`124`	`+ return $this->getStubPath('page');`
`124`	`125`	`}`
`125`	`126`
`126`	`127`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`class PageControllerBackpackCommand extends GeneratorCommand`
`10`	`10`	`{`
`11`	`11`	`use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;`
	`12`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
`12`	`13`
`13`	`14`	`/**`
`14`	`15`	`* The console command name.`
`@@ -111,7 +112,7 @@ protected function getPath($name)`
`111`	`112`	`*/`
`112`	`113`	`protected function getStub()`
`113`	`114`	`{`
`114`		`- return __DIR__.'/../stubs/page-controller.stub';`
	`115`	`+ return $this->getStubPath('page-controller');`
`115`	`116`	`}`
`116`	`117`
`117`	`118`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@`
`6`	`6`
`7`	`7`	`class RequestBackpackCommand extends GeneratorCommand`
`8`	`8`	`{`
	`9`	`+ use \Backpack\Generators\Console\Commands\Traits\PublishableStubTrait;`
	`10`	`+`
`9`	`11`	`/**`
`10`	`12`	`* The console command name.`
`11`	`13`	`*`
`@@ -41,7 +43,7 @@ class RequestBackpackCommand extends GeneratorCommand`
`41`	`43`	`*/`
`42`	`44`	`protected function getStub()`
`43`	`45`	`{`
`44`		`- return __DIR__.'/../stubs/request.stub';`
	`46`	`+ return $this->getStubPath('request');`
`45`	`47`	`}`
`46`	`48`
`47`	`49`	`/**`