Generate return type declarations (#404)

Author: ghostwriter

config/blueprint.php

@@ -87,6 +87,19 @@
     */
     'fake_nullables' => true,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Method Return Type Declarations
+    |--------------------------------------------------------------------------
+    |
+    | Enable or disable method return typehinting for blueprint generated
+    | methods. Enabling this will enforce code strictness which increases
+    | readability of code and will lower maintenance cost. This will only
+    | Work for projects running PHP v7.0 or higher.
+    |
+    */
+    'use_return_types' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Use Guarded

src/Blueprint.php

@@ -30,6 +30,16 @@ public static function appPath()
         return str_replace('\\', '/', config('blueprint.app_path'));
     }
 
+    public static function supportsReturnTypeHits()
+    {
+        return boolval(config('blueprint.use_return_types')) && self::isPHP7OrHigher();
+    }
+
+    public static function isPHP7OrHigher()
+    {
+        return version_compare(PHP_VERSION, '7.0.0', '>=');
+    }
+
     public static function isLaravel8OrHigher()
     {
         return version_compare(App::version(), '8.0.0', '>=');

src/Generators/ControllerGenerator.php

@@ -163,6 +163,10 @@ protected function buildMethods(Controller $controller)
                 $method = str_replace('{{ body }}', trim($body), $method);
             }
 
+            if (Blueprint::supportsReturnTypeHits()) {
+                $method = str_replace('request)', 'request): \Illuminate\Http\Response', $method);
+            }
+
             $methods .= PHP_EOL.$method;
         }
 

src/Generators/FactoryGenerator.php

@@ -82,6 +82,10 @@ protected function populateStub(string $stub, Model $model)
             ], "use", $stub);
         }
 
+        if (Blueprint::supportsReturnTypeHits()) {
+            $stub = str_replace('definition()', 'definition(): array', $stub);
+        }
+
         $stub = str_replace('use {{ namespacedModel }};', $this->buildImports($model), $stub);
 
         return $stub;

src/Generators/MigrationGenerator.php

@@ -2,6 +2,7 @@
 
 namespace Blueprint\Generators;
 
+use Blueprint\Blueprint;
 use Blueprint\Contracts\Generator;
 use Blueprint\Models\Model;
 use Blueprint\Tree;
@@ -106,6 +107,10 @@ protected function populateStub(string $stub, Model $model)
         $stub = str_replace('{{ table }}', $model->tableName(), $stub);
         $stub = str_replace('{{ definition }}', $this->buildDefinition($model), $stub);
 
+        if (Blueprint::supportsReturnTypeHits()) {
+            $stub =  str_replace(['up()','down()'], ['up(): void','down(): void'], $stub);
+        }
+
         if ($this->hasForeignKeyConstraints) {
             $stub = $this->disableForeignKeyConstraints($stub);
         }

src/Generators/ModelGenerator.php

@@ -162,6 +162,7 @@ protected function buildRelationships(Model $model)
         }
 
         foreach ($model->relationships() as $type => $references) {
+            $custom_template = $template;
             foreach ($references as $reference) {
                 $key = null;
                 $class = null;
@@ -207,7 +208,14 @@ protected function buildRelationships(Model $model)
                 } elseif (in_array($type, ['hasMany', 'belongsToMany', 'morphMany'])) {
                     $method_name = Str::plural($column_name);
                 }
-                $method = str_replace('{{ method }}', Str::camel($method_name), $template);
+                if (Blueprint::supportsReturnTypeHits()) {
+                    $custom_template = str_replace(
+                        '{{ method }}()',
+                        '{{ method }}(): ' . Str::of('\Illuminate\Database\Eloquent\Relations\\')->append(Str::studly($type)),
+                        $custom_template
+                    );
+                }
+                $method = str_replace('{{ method }}', Str::camel($method_name), $custom_template);
                 $method = str_replace('null', $relationship, $method);
 
                 $phpDoc = str_replace('{{ namespacedReturnClass }}', '\Illuminate\Database\Eloquent\Relations\\'.Str::ucfirst($type), $commentTemplate);

src/Generators/SeederGenerator.php

@@ -63,6 +63,11 @@ protected function populateStub(string $stub, string $model)
         } else {
             $stub = str_replace('{{ body }}', $this->build($model), $stub);
         }
+
+        if (Blueprint::supportsReturnTypeHits()) {
+            $stub = str_replace('public function run()', 'public function run(): void', $stub);
+        }
+
         return $stub;
     }
 

src/Generators/StatementGenerator.php

@@ -2,6 +2,7 @@
 
 namespace Blueprint\Generators;
 
+use Blueprint\Blueprint;
 use Blueprint\Contracts\Generator;
 
 abstract class StatementGenerator implements Generator

src/Generators/Statements/FormRequestGenerator.php

@@ -81,6 +81,10 @@ protected function populateStub(string $stub, string $name, $context, ValidateSt
         $stub = str_replace('{{ class }}', $name, $stub);
         $stub = str_replace('{{ rules }}', $this->buildRules($context, $validateStatement), $stub);
 
+        if (Blueprint::supportsReturnTypeHits()) {
+            $stub = str_replace(['authorize()','rules()'], ['authorize(): bool','rules(): array'], $stub);
+        }
+
         return $stub;
     }
 

src/Generators/Statements/JobGenerator.php

@@ -61,6 +61,10 @@ protected function populateStub(string $stub, DispatchStatement $dispatchStateme
         $stub = str_replace('{{ class }}', $dispatchStatement->job(), $stub);
         $stub = str_replace('{{ properties }}', $this->buildConstructor($dispatchStatement), $stub);
 
+        if (Blueprint::supportsReturnTypeHits()) {
+            $stub = str_replace('public function handle()', 'public function handle(): void', $stub);
+        }
+
         return $stub;
     }
 }