Add PHPDoc for model relationships (#106)

Author: amir9480

src/Generators/ModelGenerator.php

@@ -121,6 +121,11 @@ private function buildRelationships(Model $model)
     {
         $methods = '';
         $template = $this->files->stub('model/method.stub');
+        $commentTemplate = '';
+
+        if (config('blueprint.generate_phpdocs')) {
+            $commentTemplate = $this->files->stub('model/method-comment.stub');
+        }
 
         foreach ($model->relationships() as $type => $references) {
             foreach ($references as $reference) {
@@ -138,7 +143,10 @@ private function buildRelationships(Model $model)
                 $method_name = $type === 'hasMany' || $type === 'belongsToMany' ? Str::plural($name) : $name;
                 $method = str_replace('DummyName', Str::camel($method_name), $template);
                 $method = str_replace('null', $relationship, $method);
-                $methods .= PHP_EOL . $method;
+
+                $phpDoc = str_replace('DummyReturn', '\Illuminate\Database\Eloquent\Relations\\' . Str::ucfirst($type), $commentTemplate);
+
+                $methods .= PHP_EOL . $phpDoc . $method;
             }
         }
 

stubs/model/method-comment.stub

@@ -0,0 +1,3 @@
+    /**
+     * @return DummyReturn
+     */

tests/Feature/Generator/ModelGeneratorTest.php

@@ -75,6 +75,10 @@ public function output_generates_models($definition, $path, $model)
             ->with('model/method.stub')
             ->andReturn(file_get_contents('stubs/model/method.stub'));
 
+        $this->files->shouldReceive('stub')
+            ->with('model/method-comment.stub')
+            ->andReturn(file_get_contents('stubs/model/method-comment.stub'));
+
         $this->files->expects('exists')
             ->with(dirname($path))
             ->andReturnTrue();
@@ -186,6 +190,10 @@ public function output_generates_phpdoc_for_model($definition, $path, $model)
             ->with('model/method.stub')
             ->andReturn(file_get_contents('stubs/model/method.stub'));
 
+        $this->files->shouldReceive('stub')
+            ->with('model/method-comment.stub')
+            ->andReturn(file_get_contents('stubs/model/method-comment.stub'));
+
         $this->files->expects('exists')
             ->with(dirname($path))
             ->andReturnTrue();
@@ -215,6 +223,7 @@ public function docBlockModelsDataProvider()
         return [
             ['definitions/readme-example.bp', 'app/Post.php', 'models/readme-example-phpdoc.php'],
             ['definitions/soft-deletes.bp', 'app/Comment.php', 'models/soft-deletes-phpdoc.php'],
+            ['definitions/relationships.bp', 'app/Comment.php', 'models/relationships-phpdoc.php'],
             ['definitions/disable-auto-columns.bp', 'app/State.php', 'models/disable-auto-columns-phpdoc.php'],
         ];
     }

tests/fixtures/models/relationships-phpdoc.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property int $post_id
+ * @property int $author_id
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class Comment extends Model
+{
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'post_id',
+        'author_id',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'id' => 'integer',
+        'post_id' => 'integer',
+        'author_id' => 'integer',
+    ];
+
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function post()
+    {
+        return $this->belongsTo(\App\Post::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function author()
+    {
+        return $this->belongsTo(\App\User::class);
+    }
+}

tests/fixtures/models/soft-deletes-phpdoc.php

@@ -36,6 +36,9 @@ class Comment extends Model
     ];
 
 
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
     public function post()
     {
         return $this->belongsTo(\App\Post::class);