Refactor model relationships into property

jasonmccreary · jasonmccreary · commit ae12e101afaf · 2020-03-22T20:01:18.000-04:00
diff --git a/src/Generators/FactoryGenerator.php b/src/Generators/FactoryGenerator.php
@@ -63,7 +63,7 @@ protected function buildDefinition(Model $model)
 
         /** @var \Blueprint\Models\Column $column */
         foreach ($model->columns() as $column) {
-            if ($column->name() === 'id' || $column->name() === 'relationships') {
+            if ($column->name() === 'id') {
                 continue;
             }
 
diff --git a/src/Generators/MigrationGenerator.php b/src/Generators/MigrationGenerator.php
@@ -61,8 +61,6 @@ protected function buildDefinition(Model $model)
                 $dataType = 'bigIncrements';
             } elseif ($column->dataType() === 'id') {
                 $dataType = 'unsignedBigInteger';
-            } elseif ($column->name() === 'relationships') {
-                continue;
             }
 
             $definition .= self::INDENT . '$table->' . $dataType . "('{$column->name()}'";
diff --git a/src/Generators/ModelGenerator.php b/src/Generators/ModelGenerator.php
@@ -46,7 +46,6 @@ protected function populateStub(string $stub, Model $model)
 
         $body = $this->buildProperties($model);
         $body .= PHP_EOL . PHP_EOL;
-        $body .= $this->buildBelongsTo($model);
         $body .= $this->buildRelationships($model);
 
         $stub = str_replace('// ...', trim($body), $stub);
@@ -111,62 +110,27 @@ private function buildProperties(Model $model)
         return trim($properties);
     }
 
-    private function buildBelongsTo(Model $model)
-    {
-        $columns = array_filter($model->columns(), function (Column $column) {
-            return $column->name() !== 'id' && $column->dataType() === 'id';
-        });
-
-        if (empty($columns)) {
-            return '';
-        }
-
-        $methods = '';
-        $template = $this->files->stub('model/method.stub');
-
-        /** @var Column $column */
-        foreach ($columns as $column) {
-            $name = Str::beforeLast($column->name(), '_id');
-            $class = Str::studly($column->attributes()[0] ?? $name);
-            $relationship = sprintf("\$this->belongsTo(%s::class)", '\\' . $model->fullyQualifiedNamespace() . '\\' . $class);
-
-            $method = str_replace('DummyName', Str::camel($name), $template);
-            $method = str_replace('null', $relationship, $method);
-
-            $methods .= PHP_EOL . $method;
-        }
-
-        return $methods;
-    }
-
     private function buildRelationships(Model $model)
     {
-        $columns = array_filter($model->columns(), function (Column $column) {
-            return $column->name() === 'relationships';
-        });
-
-        if (empty($columns)) {
-            return '';
-        }
-
         $methods = '';
         $template = $this->files->stub('model/method.stub');
 
-        /** @var Column $column */
-        foreach ($columns as $column) {
-            foreach ($column->attributes() as $methodName => $modelName) {
-                if ('belongsTo' === $methodName) {
-                    throw new \Exception('The belongsTo relationship for the '.$modelName.' model on the '.$model->name().' model should be defined using the '.$modelName.'_id: id syntax');
+        foreach ($model->relationships() as $type => $references) {
+            foreach ($references as $reference) {
+                if (Str::contains($reference, ':')) {
+                    [$class, $name] = explode(':', $reference);
+                } else {
+                    $name = $reference;
+                    $class = null;
                 }
-                $class = Str::studly($column->attributes()[0] ?? $modelName);
-                $relationship = sprintf("\$this->%s(%s::class)",
-                    $methodName,
-                    '\\' . $model->fullyQualifiedNamespace() . '\\' . $class);
 
-                $modelNameForMethod = Str::contains($methodName, 'Many') ? Str::plural($modelName) : $modelName;
-                $method = str_replace('DummyName', Str::camel($modelNameForMethod), $template);
-                $method = str_replace('null', $relationship, $method);
+                $name = Str::beforeLast($name, '_id');
+                $class = Str::studly($class ?? $name);
+                $relationship = sprintf("\$this->%s(%s::class)", $type, '\\' . $model->fullyQualifiedNamespace() . '\\' . $class);
 
+                $method_name = $type === 'hasMany' ? Str::plural($name) : $name;
+                $method = str_replace('DummyName', Str::camel($method_name), $template);
+                $method = str_replace('null', $relationship, $method);
                 $methods .= PHP_EOL . $method;
             }
         }
@@ -189,7 +153,6 @@ private function fillableColumns(array $columns)
             'deleted_at',
             'created_at',
             'updated_at',
-            'relationships',
         ]);
     }
 
diff --git a/src/Lexers/ModelLexer.php b/src/Lexers/ModelLexer.php
@@ -8,6 +8,12 @@
 
 class ModelLexer implements Lexer
 {
+    private static $relationships = [
+        'belongsto' => 'belongsTo',
+        'hasone' => 'hasOne',
+        'hasmany' => 'hasMany',
+    ];
+
     private static $dataTypes = [
         'bigincrements' => 'bigIncrements',
         'biginteger' => 'bigInteger',
@@ -122,6 +128,18 @@ private function buildModel(string $name, array $columns)
             unset($columns['softdeletestz']);
         }
 
+        if (isset($columns['relationships'])) {
+            if (is_array($columns['relationships'])) {
+                foreach ($columns['relationships'] as $type => $relationships) {
+                    foreach (explode(',', $relationships) as $reference) {
+                        $model->addRelationship(self::$relationships[strtolower($type)], trim($reference));
+                    }
+                }
+            }
+
+            unset($columns['relationships']);
+        }
+
         if (!isset($columns['id'])) {
             $column = $this->buildColumn('id', 'id');
             $model->addColumn($column);
@@ -130,44 +148,48 @@ private function buildModel(string $name, array $columns)
         foreach ($columns as $name => $definition) {
             $column = $this->buildColumn($name, $definition);
             $model->addColumn($column);
+
+            if ($column->name() !== 'id' && $column->dataType() === 'id') {
+                if ($column->attributes()) {
+                    $model->addRelationship('belongsTo', $column->attributes()[0] . ':' . $column->name());
+                } else {
+                    $model->addRelationship('belongsTo', $column->name());
+                }
+            }
         }
 
         return $model;
     }
 
-    private function buildColumn(string $name, $definition)
+    private function buildColumn(string $name, string $definition)
     {
         $data_type = 'string';
         $modifiers = [];
 
-        if ($name === 'relationships' && is_array($definition)) {
-            $attributes = $definition;
-        } else {
-            $tokens = explode(' ', $definition);
-            foreach ($tokens as $token) {
-                $parts = explode(':', $token);
-                $value = $parts[0];
-
-                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)];
-                    if (!empty($attributes)) {
-                        $attributes = explode(',', $attributes);
-                    }
+        $tokens = explode(' ', $definition);
+        foreach ($tokens as $token) {
+            $parts = explode(':', $token);
+            $value = $parts[0];
+
+            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)];
+                if (!empty($attributes)) {
+                    $attributes = explode(',', $attributes);
                 }
+            }
 
-                if (isset(self::$modifiers[strtolower($value)])) {
-                    $modifierAttributes = $parts[1] ?? null;
-                    if (empty($modifierAttributes)) {
-                        $modifiers[] = self::$modifiers[strtolower($value)];
-                    } else {
-                        $modifiers[] = [self::$modifiers[strtolower($value)] => $modifierAttributes];
-                    }
+            if (isset(self::$modifiers[strtolower($value)])) {
+                $modifierAttributes = $parts[1] ?? null;
+                if (empty($modifierAttributes)) {
+                    $modifiers[] = self::$modifiers[strtolower($value)];
+                } else {
+                    $modifiers[] = [self::$modifiers[strtolower($value)] => $modifierAttributes];
                 }
             }
         }
diff --git a/src/Models/Model.php b/src/Models/Model.php
@@ -11,6 +11,7 @@ class Model
     private $timestamps = 'timestamps';
     private $softDeletes = false;
     private $columns = [];
+    private $relationships = [];
 
     /**
      * @param $name
@@ -65,6 +66,11 @@ public function columns(): array
         return $this->columns;
     }
 
+    public function relationships(): array
+    {
+        return $this->relationships;
+    }
+
     public function primaryKey()
     {
         return 'id';
@@ -119,4 +125,15 @@ public function column(string $name)
     {
         return $this->columns[$name];
     }
+
+    public function addRelationship(string $type, string $reference)
+    {
+        if (!isset($this->relationships[$type])) {
+            $this->relationships[$type] = [];
+        }
+
+        $this->relationships[$type][] = $reference;
+    }
+
+
 }
diff --git a/tests/Feature/Generator/ModelGeneratorTest.php b/tests/Feature/Generator/ModelGeneratorTest.php
@@ -78,6 +78,36 @@ public function output_generates_models($definition, $path, $model)
         $this->assertEquals(['created' => [$path]], $this->subject->output($tree));
     }
 
+    /**
+     * @test
+     */
+    public function output_generates_relationships()
+    {
+        $this->files->expects('stub')
+            ->with('model/class.stub')
+            ->andReturn(file_get_contents('stubs/model/class.stub'));
+
+        $this->files->expects('stub')
+            ->with('model/fillable.stub')
+            ->andReturn(file_get_contents('stubs/model/fillable.stub'));
+
+        $this->files->expects('stub')
+            ->with('model/casts.stub')
+            ->andReturn(file_get_contents('stubs/model/casts.stub'));
+
+        $this->files->expects('stub')
+            ->with('model/method.stub')
+            ->andReturn(file_get_contents('stubs/model/method.stub'));
+
+        $this->files->expects('put')
+            ->with('app/Subscription.php', $this->fixture('models/model-relationships.php'));
+
+        $tokens = $this->blueprint->parse($this->fixture('definitions/model-relationships.bp'));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => ['app/Subscription.php']], $this->subject->output($tree));
+    }
+
     /**
      * @test
      */
diff --git a/tests/Feature/Lexers/ModelLexerTest.php b/tests/Feature/Lexers/ModelLexerTest.php
@@ -341,6 +341,47 @@ public function it_enables_soft_deletes()
         $this->assertEquals([], $columns['id']->modifiers());
     }
 
+    /**
+     * @test
+     */
+    public function it_stores_relationships()
+    {
+        $tokens = [
+            'models' => [
+                'Subscription' => [
+                    'different_id' => 'id:user',
+                    'title' => 'string',
+                    'price' => 'float',
+                    'relationships' => [
+                        'hasmany' => 'Order',
+                        'hasOne' => 'Duration, Transaction:tid',
+                    ],
+                ]
+            ],
+        ];
+
+        $actual = $this->subject->analyze($tokens);
+
+        $this->assertIsArray($actual['models']);
+        $this->assertCount(1, $actual['models']);
+
+        $model = $actual['models']['Subscription'];
+        $this->assertEquals('Subscription', $model->name());
+
+        $columns = $model->columns();
+        $this->assertCount(4, $columns);
+        $this->assertArrayHasKey('id', $columns);
+        $this->assertArrayHasKey('different_id', $columns);
+        $this->assertArrayHasKey('title', $columns);
+        $this->assertArrayHasKey('price', $columns);
+
+        $relationships = $model->relationships();
+        $this->assertCount(3, $relationships);
+        $this->assertEquals(['user:different_id'], $relationships['belongsTo']);
+        $this->assertEquals(['Order'], $relationships['hasMany']);
+        $this->assertEquals(['Duration', 'Transaction:tid'], $relationships['hasOne']);
+    }
+
     public function dataTypeAttributesDataProvider()
     {
         return [
diff --git a/tests/fixtures/definitions/model-relationships.bp b/tests/fixtures/definitions/model-relationships.bp
@@ -0,0 +1,6 @@
+models:
+  Subscription:
+    user_id: id
+    relationships:
+      hasMany: Order
+      hasOne: Duration, Transaction
diff --git a/tests/fixtures/models/model-relationships.php b/tests/fixtures/models/model-relationships.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Subscription extends Model
+{
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'user_id',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'id' => 'integer',
+        'user_id' => 'integer',
+    ];
+
+
+    public function orders()
+    {
+        return $this->hasMany(\App\Order::class);
+    }
+
+    public function duration()
+    {
+        return $this->hasOne(\App\Duration::class);
+    }
+
+    public function transaction()
+    {
+        return $this->hasOne(\App\Transaction::class);
+    }
+
+    public function user()
+    {
+        return $this->belongsTo(\App\User::class);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ protected function buildDefinition(Model $model)`
`63`	`63`
`64`	`64`	`/** @var \Blueprint\Models\Column $column */`
`65`	`65`	`foreach ($model->columns() as $column) {`
`66`		`- if ($column->name() === 'id' \|\| $column->name() === 'relationships') {`
	`66`	`+ if ($column->name() === 'id') {`
`67`	`67`	`continue;`
`68`	`68`	`}`
`69`	`69`
Original file line number	Diff line number	Diff line change
`@@ -61,8 +61,6 @@ protected function buildDefinition(Model $model)`
`61`	`61`	`$dataType = 'bigIncrements';`
`62`	`62`	`} elseif ($column->dataType() === 'id') {`
`63`	`63`	`$dataType = 'unsignedBigInteger';`
`64`		`- } elseif ($column->name() === 'relationships') {`
`65`		`- continue;`
`66`	`64`	`}`
`67`	`65`
`68`	`66`	`$definition .= self::INDENT . '$table->' . $dataType . "('{$column->name()}'";`