Generate belongs to relationhships for models

Author: jasonmccreary

src/Generators/MigrationGenerator.php

@@ -62,7 +62,7 @@ protected function buildDefinition(Model $model)
 
             $definition .= self::INDENT . '$table->' . $dataType . "('{$column->name()}'";
 
-            if (!empty($column->attributes())) {
+            if (!empty($column->attributes()) && $column->dataType() !== 'id') {
                 $definition .= ', ';
                 if (in_array($column->dataType(), ['set', 'enum'])) {
                     $definition .= json_encode($column->attributes());

src/Generators/ModelGenerator.php

@@ -5,6 +5,7 @@
 use Blueprint\Contracts\Generator;
 use Blueprint\Models\Column;
 use Blueprint\Models\Model;
+use Illuminate\Support\Str;
 
 class ModelGenerator implements Generator
 {
@@ -40,7 +41,12 @@ protected function populateStub(string $stub, Model $model)
     {
         $stub = str_replace('DummyNamespace', 'App', $stub);
         $stub = str_replace('DummyClass', $model->name(), $stub);
-        $stub = str_replace('// properties...', $this->buildProperties($model), $stub);
+
+        $body = $this->buildProperties($model);
+        $body .= PHP_EOL . PHP_EOL;
+        $body .= $this->buildRelationships($model);
+
+        $stub = str_replace('// ...', trim($body), $stub);
         $stub = $this->addTraits($model, $stub);
 
         return $stub;
@@ -52,24 +58,52 @@ private function buildProperties(Model $model)
 
         $columns = $this->fillableColumns($model->columns());
         if (!empty($columns)) {
-            $properties .= PHP_EOL . str_replace('[]', $this->pretty_print_array($columns, false), $this->propertyStub('fillable'));
+            $properties .= PHP_EOL . str_replace('[]', $this->pretty_print_array($columns, false), $this->getStub('fillable'));
         } else {
-            $properties .= $this->propertyStub('fillable');
+            $properties .= $this->getStub('fillable');
         }
 
         $columns = $this->castableColumns($model->columns());
         if (!empty($columns)) {
-            $properties .= PHP_EOL . str_replace('[]', $this->pretty_print_array($columns), $this->propertyStub('casts'));
+            $properties .= PHP_EOL . str_replace('[]', $this->pretty_print_array($columns), $this->getStub('casts'));
         }
 
         $columns = $this->dateColumns($model->columns());
         if (!empty($columns)) {
-            $properties .= PHP_EOL . str_replace('[]', $this->pretty_print_array($columns, false), $this->propertyStub('dates'));
+            $properties .= PHP_EOL . str_replace('[]', $this->pretty_print_array($columns, false), $this->getStub('dates'));
         }
 
         return trim($properties);
     }
 
+    private function buildRelationships(Model $model)
+    {
+        $columns = array_filter($model->columns(), function (Column $column) {
+            return Str::endsWith($column->name(), '_id');
+        });
+
+        if (empty($columns)) {
+            return '';
+        }
+
+        $methods = '';
+        $template = $this->getStub('method');
+
+        /** @var Column $column */
+        foreach ($columns as $column) {
+            $name = Str::substr($column->name(), 0, -3);
+            $class = Str::studly($column->attributes()[0] ?? $name);
+            $relationship = sprintf("\$this->belongsTo(\App\%s::class)", $class);
+
+            $method = str_replace('DummyName', Str::camel($name), $template);
+            $method = str_replace('null', $relationship, $method);
+
+            $methods .= PHP_EOL . $method;
+        }
+
+        return $methods;
+    }
+
     protected function getPath(Model $model)
     {
         return 'app/' . $model->name() . '.php';
@@ -140,7 +174,7 @@ private function pretty_print_array(array $data, $assoc = true)
         return trim($output);
     }
 
-    private function propertyStub(string $stub)
+    private function getStub(string $stub)
     {
         static $stubs = [];
 

src/Lexers/ModelLexer.php

@@ -147,6 +147,9 @@ private function buildColumn(string $name, string $definition)
 
             if ($value === 'id') {
                 $data_type = 'id';
+                if (isset($parts[1])) {
+                    $attributes = [$parts[1]];
+                }
             } elseif (isset(self::$dataTypes[strtolower($value)])) {
                 $attributes = $parts[1] ?? null;
                 $data_type = self::$dataTypes[strtolower($value)];

stubs/model/class.stub

@@ -6,5 +6,5 @@ use Illuminate\Database\Eloquent\Model;
 
 class DummyClass extends Model
 {
-    // properties...
+    // ...
 }

stubs/model/method.stub

@@ -0,0 +1,4 @@
+    public function DummyName()
+    {
+        return null;
+    }

tests/Feature/Generator/MigrationGeneratorTest.php

@@ -77,6 +77,7 @@ public function modelTreeDataProvider()
             ['definitions/model-modifiers.bp', 'database/migrations/timestamp_create_modifiers_table.php', 'migrations/modifiers.php'],
             ['definitions/soft-deletes.bp', 'database/migrations/timestamp_create_comments_table.php', 'migrations/soft-deletes.php'],
             ['definitions/with-timezones.bp', 'database/migrations/timestamp_create_comments_table.php', 'migrations/with-timezones.php'],
+            ['definitions/relationships.bp', 'database/migrations/timestamp_create_comments_table.php', 'migrations/relationships.php'],
         ];
     }
 }

tests/Feature/Generator/ModelGeneratorTest.php

@@ -67,6 +67,12 @@ public function output_writes_migration_for_model_tree($definition, $path, $mode
                 ->andReturn(file_get_contents('stubs/model/dates.stub'));
         }
 
+        if ($definition === 'definitions/relationships.bp') {
+            $this->files->expects('get')
+                ->with('stubs/model/method.stub')
+                ->andReturn(file_get_contents('stubs/model/method.stub'));
+        }
+
         $this->files->expects('put')
             ->with($path, $this->fixture($model));
 
@@ -84,6 +90,7 @@ public function modelTreeDataProvider()
             ['definitions/readme-example.bp', 'app/Post.php', 'models/readme-example.php'],
             ['definitions/soft-deletes.bp', 'app/Comment.php', 'models/soft-deletes.php'],
             ['definitions/with-timezones.bp', 'app/Comment.php', 'models/soft-deletes.php'],
+            ['definitions/relationships.bp', 'app/Comment.php', 'models/relationships.php'],
         ];
     }
 }

tests/fixtures/definitions/relationships.bp

@@ -0,0 +1,4 @@
+models:
+  Comment:
+    post_id: id
+    author_id: id:user

tests/fixtures/migrations/relationships.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateCommentsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('comments', function (Blueprint $table) {
+            $table->increments('id');
+            $table->unsignedBigInteger('post_id');
+            $table->unsignedBigInteger('author_id');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('comments');
+    }
+}

tests/fixtures/models/relationships.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+
+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',
+    ];
+
+
+    public function post()
+    {
+        return $this->belongsTo(\App\Post::class);
+    }
+
+    public function author()
+    {
+        return $this->belongsTo(\App\User::class);
+    }
+}