Publish Blueprint stubs (#312)

Author: bingtsingw

phpunit.xml

@@ -24,7 +24,4 @@
             <directory suffix=".php">./src</directory>
         </whitelist>
     </filter>
-    <php>
-        <const name="STUBS_PATH" value="stubs"/>
-    </php>
 </phpunit>

src/BlueprintServiceProvider.php

@@ -23,9 +23,17 @@ public function boot()
             define('STUBS_PATH', dirname(__DIR__) . '/stubs');
         }
 
+        if (!defined('CUSTOM_STUBS_PATH')) {
+            define('CUSTOM_STUBS_PATH', base_path('stubs/blueprint'));
+        }
+
         $this->publishes([
             __DIR__ . '/../config/blueprint.php' => config_path('blueprint.php'),
         ], 'blueprint-config');
+
+        $this->publishes([
+            dirname(__DIR__) . '/stubs' => CUSTOM_STUBS_PATH,
+        ], 'blueprint-stubs');
     }
 
     /**

src/FileMixins.php

@@ -10,7 +10,10 @@ public function stub()
     {
         return function ($path) {
             if (!isset($this->stubs[$path])) {
-                $this->stubs[$path] = $this->get(STUBS_PATH . '/' . $path);
+                $stubPath = file_exists($customPath = CUSTOM_STUBS_PATH . '/' . $path)
+                          ? $customPath
+                          : STUBS_PATH . '/' . $path;
+                $this->stubs[$path] = $this->get($stubPath);
             }
 
             return $this->stubs[$path];

src/Generators/ControllerGenerator.php

@@ -42,7 +42,7 @@ public function output(Tree $tree): array
 
         $output = [];
 
-        $stub = $this->files->stub('controller/class.stub');
+        $stub = $this->files->stub('controller.class.stub');
 
         /** @var \Blueprint\Models\Controller $controller */
         foreach ($tree->controllers() as $controller) {
@@ -83,7 +83,7 @@ protected function populateStub(string $stub, Controller $controller)
 
     protected function buildMethods(Controller $controller)
     {
-        $template = $this->files->stub('controller/method.stub');
+        $template = $this->files->stub('controller.method.stub');
 
         $methods = '';
 

src/Generators/ModelGenerator.php

@@ -23,7 +23,7 @@ public function output(Tree $tree): array
     {
         $output = [];
 
-        $stub = $this->files->stub('model/class.stub');
+        $stub = $this->files->stub('model.class.stub');
 
         /** @var \Blueprint\Models\Model $model */
         foreach ($tree->models() as $model) {
@@ -99,33 +99,33 @@ protected function buildProperties(Model $model)
         $properties = '';
 
         if (! $model->usesTimestamps()) {
-            $properties .= $this->files->stub('model/timestamps.stub');
+            $properties .= $this->files->stub('model.timestamps.stub');
         }
 
         if (config('blueprint.use_guarded')) {
-            $properties .= $this->files->stub('model/guarded.stub');
+            $properties .= $this->files->stub('model.guarded.stub');
         } else {
             $columns = $this->fillableColumns($model->columns());
             if (! empty($columns)) {
-                $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns, false), $this->files->stub('model/fillable.stub'));
+                $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns, false), $this->files->stub('model.fillable.stub'));
             } else {
-                $properties .= $this->files->stub('model/fillable.stub');
+                $properties .= $this->files->stub('model.fillable.stub');
             }
         }
 
         $columns = $this->hiddenColumns($model->columns());
         if (! empty($columns)) {
-            $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns, false), $this->files->stub('model/hidden.stub'));
+            $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns, false), $this->files->stub('model.hidden.stub'));
         }
 
         $columns = $this->castableColumns($model->columns());
         if (! empty($columns)) {
-            $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns), $this->files->stub('model/casts.stub'));
+            $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns), $this->files->stub('model.casts.stub'));
         }
 
         $columns = $this->dateColumns($model->columns());
         if (! empty($columns)) {
-            $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns, false), $this->files->stub('model/dates.stub'));
+            $properties .= PHP_EOL.str_replace('[]', $this->pretty_print_array($columns, false), $this->files->stub('model.dates.stub'));
         }
 
         return trim($properties);
@@ -134,11 +134,11 @@ protected function buildProperties(Model $model)
     protected function buildRelationships(Model $model)
     {
         $methods = '';
-        $template = $this->files->stub('model/method.stub');
+        $template = $this->files->stub('model.method.stub');
         $commentTemplate = '';
 
         if (config('blueprint.generate_phpdocs')) {
-            $commentTemplate = $this->files->stub('model/method-comment.stub');
+            $commentTemplate = $this->files->stub('model.method.comment.stub');
         }
 
         foreach ($model->relationships() as $type => $references) {

src/Generators/StatementGenerator.php

@@ -26,7 +26,7 @@ protected function buildConstructor($statement)
         static $constructor = null;
 
         if (is_null($constructor)) {
-            $constructor = str_replace('new instance', $this->new_instance, $this->files->stub('partials/constructor.stub'));
+            $constructor = str_replace('new instance', $this->new_instance, $this->files->stub('constructor.stub'));
         }
 
         if (empty($statement->data())) {

src/Generators/Statements/FormRequestGenerator.php

@@ -33,7 +33,7 @@ public function output(Tree $tree): array
 
         $output = [];
 
-        $stub = $this->files->stub('form-request.stub');
+        $stub = $this->files->stub('request.stub');
 
         /** @var \Blueprint\Models\Controller $controller */
         foreach ($tree->controllers() as $controller) {

src/Generators/TestGenerator.php

@@ -50,7 +50,7 @@ public function output(Tree $tree): array
 
         $output = [];
 
-        $stub = $this->files->get(STUBS_PATH.'/test/class.stub');
+        $stub = $this->files->stub('test.class.stub');
 
         /** @var \Blueprint\Models\Controller $controller */
         foreach ($tree->controllers() as $controller) {
@@ -524,7 +524,7 @@ private function buildTraits(Controller $controller)
     private function testCaseStub()
     {
         if (empty($this->stubs['test-case'])) {
-            $this->stubs['test-case'] = $this->files->get(STUBS_PATH.'/test/case.stub');
+            $this->stubs['test-case'] = $this->files->stub('test.case.stub');
         }
 
         return $this->stubs['test-case'];