Make generator classes extendable (#297)

Author: Pr3d4dor

src/Generators/ControllerGenerator.php

@@ -80,7 +80,7 @@ protected function populateStub(string $stub, Controller $controller)
         return $stub;
     }
 
-    private function buildMethods(Controller $controller)
+    protected function buildMethods(Controller $controller)
     {
         $template = $this->files->stub('controller/method.stub');
 
@@ -183,12 +183,7 @@ protected function getPath(Controller $controller)
         return Blueprint::appPath().'/'.$path.'.php';
     }
 
-    private function addImport(Controller $controller, $class)
-    {
-        $this->imports[$controller->name()][] = $class;
-    }
-
-    private function buildImports(Controller $controller)
+    protected function buildImports(Controller $controller)
     {
         $imports = array_unique($this->imports[$controller->name()]);
         sort($imports);
@@ -198,6 +193,11 @@ private function buildImports(Controller $controller)
         }, $imports));
     }
 
+    private function addImport(Controller $controller, $class)
+    {
+        $this->imports[$controller->name()][] = $class;
+    }
+
     private function determineModel(Controller $controller, ?string $reference)
     {
         if (empty($reference) || $reference === 'id') {

src/Generators/FactoryGenerator.php

@@ -185,12 +185,7 @@ protected function buildDefinition(Model $model)
         return trim($definition);
     }
 
-    private function addImport(Model $model, $class)
-    {
-        $this->imports[$model->name()][] = $class;
-    }
-
-    private function buildImports(Model $model)
+    protected function buildImports(Model $model)
     {
         $imports = array_unique($this->imports[$model->name()]);
         sort($imports);
@@ -200,6 +195,11 @@ private function buildImports(Model $model)
         }, $imports));
     }
 
+    private function addImport(Model $model, $class)
+    {
+        $this->imports[$model->name()][] = $class;
+    }
+
     private function fillableColumns(array $columns): array
     {
         if (config('blueprint.fake_nullables')) {

src/Generators/ModelGenerator.php

@@ -61,7 +61,7 @@ protected function populateStub(string $stub, Model $model)
         return $stub;
     }
 
-    private function buildClassPhpDoc(Model $model)
+    protected function buildClassPhpDoc(Model $model)
     {
         if (! config('blueprint.generate_phpdocs')) {
             return '';
@@ -93,7 +93,7 @@ private function buildClassPhpDoc(Model $model)
         return $phpDoc;
     }
 
-    private function buildProperties(Model $model)
+    protected function buildProperties(Model $model)
     {
         $properties = '';
 
@@ -130,7 +130,7 @@ private function buildProperties(Model $model)
         return trim($properties);
     }
 
-    private function buildRelationships(Model $model)
+    protected function buildRelationships(Model $model)
     {
         $methods = '';
         $template = $this->files->stub('model/method.stub');
@@ -205,6 +205,18 @@ protected function getPath(Model $model)
         return Blueprint::appPath().'/'.$path.'.php';
     }
 
+    protected function addTraits(Model $model, $stub)
+    {
+        if (!$model->usesSoftDeletes()) {
+            return $stub;
+        }
+
+        $stub = str_replace('use Illuminate\\Database\\Eloquent\\Model;', 'use Illuminate\\Database\\Eloquent\\Model;' . PHP_EOL . 'use Illuminate\\Database\\Eloquent\\SoftDeletes;', $stub);
+        $stub = Str::replaceFirst('{', '{' . PHP_EOL . '    use SoftDeletes;' . PHP_EOL, $stub);
+
+        return $stub;
+    }
+
     private function fillableColumns(array $columns)
     {
         return array_diff(array_keys($columns), [
@@ -283,18 +295,6 @@ private function pretty_print_array(array $data, $assoc = true)
         return trim(str_replace("\n", PHP_EOL, $output));
     }
 
-    private function addTraits(Model $model, $stub)
-    {
-        if (! $model->usesSoftDeletes()) {
-            return $stub;
-        }
-
-        $stub = str_replace('use Illuminate\\Database\\Eloquent\\Model;', 'use Illuminate\\Database\\Eloquent\\Model;'.PHP_EOL.'use Illuminate\\Database\\Eloquent\\SoftDeletes;', $stub);
-        $stub = Str::replaceFirst('{', '{'.PHP_EOL.'    use SoftDeletes;'.PHP_EOL, $stub);
-
-        return $stub;
-    }
-
     private function phpDataType(string $dataType)
     {
         static $php_data_types = [

src/Generators/SeederGenerator.php

@@ -45,11 +45,6 @@ public function types(): array
         return ['seeders'];
     }
 
-    private function getPath($model)
-    {
-        return 'database/seeds/'.$model.'Seeder.php';
-    }
-
     protected function populateStub(string $stub, string $model)
     {
         $stub = str_replace('DummyClass', $this->getClassName($model), $stub);
@@ -58,16 +53,21 @@ protected function populateStub(string $stub, string $model)
         return $stub;
     }
 
-    private function getClassName(string $model)
+    protected function getClassName(string $model)
     {
         return $model.'Seeder';
     }
 
-    private function build(string $model)
+    protected function build(string $model)
     {
         return sprintf('factory(\\%s::class, 5)->create();', $this->fqcnForContext($model));
     }
 
+    private function getPath($model)
+    {
+        return 'database/seeds/' . $model . 'Seeder.php';
+    }
+
     private function registerModels(array $tree)
     {
         $this->models = array_merge($tree['cache'] ?? [], $tree['models'] ?? []);

src/Generators/Statements/EventGenerator.php

@@ -75,7 +75,7 @@ protected function populateStub(string $stub, FireStatement $fireStatement)
         return $stub;
     }
 
-    private function buildConstructor(FireStatement $fireStatement)
+    protected function buildConstructor(FireStatement $fireStatement)
     {
         static $constructor = null;
 

src/Generators/Statements/FormRequestGenerator.php

@@ -82,7 +82,7 @@ protected function populateStub(string $stub, string $name, $context, ValidateSt
         return $stub;
     }
 
-    private function buildRules(string $context, ValidateStatement $validateStatement)
+    protected function buildRules(string $context, ValidateStatement $validateStatement)
     {
         return trim(array_reduce($validateStatement->data(), function ($output, $field) use ($context) {
             [$qualifier, $column] = $this->splitField($field);

src/Generators/Statements/JobGenerator.php

@@ -71,7 +71,7 @@ protected function populateStub(string $stub, DispatchStatement $dispatchStateme
         return $stub;
     }
 
-    private function buildConstructor(DispatchStatement $dispatchStatement)
+    protected function buildConstructor(DispatchStatement $dispatchStatement)
     {
         static $constructor = null;
 

src/Generators/Statements/MailGenerator.php

@@ -75,7 +75,7 @@ protected function populateStub(string $stub, SendStatement $sendStatement)
         return $stub;
     }
 
-    private function buildConstructor(SendStatement $sendStatement)
+    protected function buildConstructor(SendStatement $sendStatement)
     {
         static $constructor = null;
 

src/Generators/Statements/ResourceGenerator.php

@@ -83,7 +83,7 @@ protected function populateStub(string $stub, ResourceStatement $resource)
         return $stub;
     }
 
-    private function buildData(ResourceStatement $resource)
+    protected function buildData(ResourceStatement $resource)
     {
         $context = Str::singular($resource->reference());
 

src/Generators/TestGenerator.php

@@ -489,6 +489,23 @@ protected function addTrait(Controller $controller, $trait)
         $this->traits[$controller->name()][] = $trait;
     }
 
+    protected function addImport(Controller $controller, $class)
+    {
+        $this->imports[$controller->name()][] = $class;
+    }
+
+    protected function buildImports(Controller $controller)
+    {
+        $this->addImport($controller, 'Tests\\TestCase');
+
+        $imports = array_unique($this->imports[$controller->name()]);
+        sort($imports);
+
+        return implode(PHP_EOL, array_map(function ($class) {
+            return 'use ' . $class . ';';
+        }, $imports));
+    }
+
     private function buildTraits(Controller $controller)
     {
         if (empty($this->traits[$controller->name()])) {
@@ -510,23 +527,6 @@ private function testCaseStub()
         return $this->stubs['test-case'];
     }
 
-    protected function addImport(Controller $controller, $class)
-    {
-        $this->imports[$controller->name()][] = $class;
-    }
-
-    protected function buildImports(Controller $controller)
-    {
-        $this->addImport($controller, 'Tests\\TestCase');
-
-        $imports = array_unique($this->imports[$controller->name()]);
-        sort($imports);
-
-        return implode(PHP_EOL, array_map(function ($class) {
-            return 'use '.$class.';';
-        }, $imports));
-    }
-
     private function determineModel(string $prefix, ?string $reference)
     {
         if (empty($reference) || $reference === 'id') {