Merge pull request #18 from SOHELAHMED7/enhance-faker-to-consider-relations

Resolve - Enhance faker generation to consider DB relations

Author: SOHELAHMED7

src/generator/default/faker.php

@@ -43,9 +43,9 @@ public function generateModel($attributes = [])
     {
         $faker = $this->faker;
         $uniqueFaker = $this->uniqueFaker;
-        $model = new <?= $model->getClassName() ?>();
+        $model = new <?= $modelClass ?>();
 <?php foreach ($model->attributes as $attribute):
-        if (!$attribute->fakerStub || $attribute->isReference()) {
+        if (!$attribute->fakerStub /*|| $attribute->isReference()*/) {
             continue;
         }
         ?>
@@ -62,4 +62,17 @@ public function generateModel($attributes = [])
         }
         return $model;
     }
+<?php if ($model->hasOneRelations):?>
+
+    public static function dependentOn()
+    {
+        return [
+            // just model class names
+<?php foreach ($model->hasOneRelations as $key => $hasOneRelation): ?>
+            <?php echo \yii\helpers\VarDumper::export($model->hasOneRelations[$key]->getClassName()).','.PHP_EOL ?>
+<?php endforeach; ?>
+
+        ];
+    }
+<?php endif;?>
 }

src/lib/AttributeResolver.php

@@ -7,6 +7,7 @@
 
 namespace cebe\yii2openapi\lib;
 
+use cebe\yii2openapi\lib\Config;
 use cebe\yii2openapi\lib\CustomSpecAttr;
 use cebe\yii2openapi\lib\exceptions\InvalidDefinitionException;
 use cebe\yii2openapi\lib\items\Attribute;
@@ -66,20 +67,24 @@ class AttributeResolver
      */
     private $junctions;
 
-    /**@var bool */
+    /** @var bool */
     private $isJunctionSchema;
 
-    /**@var bool */
+    /** @var bool */
     private $hasMany2Many;
 
-    public function __construct(string $schemaName, ComponentSchema $schema, JunctionSchemas $junctions)
+    /** @var Config */
+    private $config;
+
+    public function __construct(string $schemaName, ComponentSchema $schema, JunctionSchemas $junctions, ?Config $config = null)
     {
         $this->schemaName = $schemaName;
         $this->schema = $schema;
         $this->tableName = $schema->resolveTableName($schemaName);
         $this->junctions = $junctions;
         $this->isJunctionSchema = $junctions->isJunctionSchema($schemaName);
         $this->hasMany2Many = $junctions->hasMany2Many($schemaName);
+        $this->config = $config;
     }
 
     /**
@@ -391,7 +396,7 @@ protected function catchManyToMany(
      */
     protected function guessFakerStub(Attribute $attribute, PropertySchema $property):?string
     {
-        $resolver = Yii::createObject(['class' => FakerStubResolver::class], [$attribute, $property]);
+        $resolver = Yii::createObject(['class' => FakerStubResolver::class], [$attribute, $property, $this->config]);
         return $resolver->resolve();
     }
 

src/lib/FakerStubResolver.php

@@ -32,10 +32,14 @@ class FakerStubResolver
      */
     private $property;
 
-    public function __construct(Attribute $attribute, PropertySchema $property)
+    /** @var Config */
+    private $config;
+
+    public function __construct(Attribute $attribute, PropertySchema $property, ?Config $config = null)
     {
         $this->attribute = $attribute;
         $this->property = $property;
+        $this->config = $config;
     }
 
     public function resolve():?string
@@ -46,6 +50,14 @@ public function resolve():?string
         if ($this->attribute->isReadOnly() && $this->attribute->isVirtual()) {
             return null;
         }
+
+        // column name ends with `_id`
+        if (substr($this->attribute->columnName, -strlen('_id'))==='_id') {
+            return '$faker->randomElement(\\'.$this->config->modelNamespace
+                    . ($this->config->modelNamespace ? '\\' : '')
+                    . ucfirst($this->attribute->reference).'::find()->select("id")->column())';
+        }
+
         $limits = $this->attribute->limits;
         switch ($this->attribute->phpType) {
             case 'bool':

src/lib/SchemaToDatabase.php

@@ -89,7 +89,7 @@ public function prepareModels():array
                 $schemaName = $junctions->trimPrefix($schemaName);
             }
             /**@var \cebe\yii2openapi\lib\AttributeResolver $resolver */
-            $resolver = Yii::createObject(AttributeResolver::class, [$schemaName, $schema, $junctions]);
+            $resolver = Yii::createObject(AttributeResolver::class, [$schemaName, $schema, $junctions, $this->config]);
             $models[$schemaName] = $resolver->resolve();
         }
         foreach ($models as  $model) {

tests/DbTestCase.php

@@ -101,7 +101,7 @@ protected function checkFiles(array $actual, array $expected)
             self::assertFileExists($file);
             self::assertFileExists($expectedFilePath);
 
-            $this->assertFileEquals($expectedFilePath, $file, "Failed asserting that file contents of\n$file\nare equal to file contents of\n$expectedFilePath");
+            $this->assertFileEquals($expectedFilePath, $file, "Failed asserting that file contents of\n$file\nare equal to file contents of\n$expectedFilePath \n\n cp $file $expectedFilePath \n\n ");
         }
     }
 

tests/fixtures/blog.php

@@ -73,13 +73,13 @@
                 ->asReference('Category')
                 ->setRequired()
                 ->setDescription('Category of posts')
-                ->setFakerStub('$uniqueFaker->numberBetween(0, 1000000)'),
+                ->setFakerStub('$faker->randomElement(\Category::find()->select("id")->column())'),
             'created_at' => (new Attribute('created_at', ['phpType' => 'string', 'dbType' => 'date']))
                ->setFakerStub('$faker->dateTimeThisCentury->format(\'Y-m-d\')'),
             'created_by' => (new Attribute('created_by', ['phpType' => 'int', 'dbType' => 'integer']))
                 ->asReference('User')
                 ->setDescription('The User')
-                ->setFakerStub('$uniqueFaker->numberBetween(0, 1000000)'),
+                ->setFakerStub('$faker->randomElement(\User::find()->select("id")->column())'),
         ],
         'relations' => [
             'category' => new AttributeRelation('category',
@@ -110,12 +110,12 @@
                 ->setSize(128)
                 ->asReference('Post')
                 ->setDescription('A blog post (uid used as pk for test purposes)')
-                ->setFakerStub('substr($uniqueFaker->sha256, 0, 128)'),
+                ->setFakerStub('$faker->randomElement(\Post::find()->select("id")->column())'),
             'author' => (new Attribute('author', ['phpType' => 'int', 'dbType' => 'integer']))
                 ->setRequired()
                 ->asReference('User')
                 ->setDescription('The User')
-                ->setFakerStub('$uniqueFaker->numberBetween(0, 1000000)'),
+                ->setFakerStub('$faker->randomElement(\User::find()->select("id")->column())'),
             'message' => (new Attribute('message', ['phpType' => 'array', 'dbType' => 'json', 'xDbType' => 'json']))
                 ->setRequired()->setDefault([])->setFakerStub('[]'),
             'meta_data' => (new Attribute('meta_data', ['phpType' => 'array', 'dbType' => 'json', 'xDbType' => 'json']))

tests/specs/blog/models/CommentFaker.php

@@ -30,6 +30,8 @@ public function generateModel($attributes = [])
         $uniqueFaker = $this->uniqueFaker;
         $model = new Comment();
         //$model->id = $uniqueFaker->numberBetween(0, 1000000);
+        $model->post_id = $faker->randomElement(\app\models\Post::find()->select("id")->column());
+        $model->author_id = $faker->randomElement(\app\models\User::find()->select("id")->column());
         $model->message = [];
         $model->meta_data = [];
         $model->created_at = $faker->unixTime;
@@ -40,4 +42,14 @@ public function generateModel($attributes = [])
         }
         return $model;
     }
+
+    public static function dependentOn()
+    {
+        return [
+            // just model class names
+            'Post',
+            'User',
+
+        ];
+    }
 }

tests/specs/blog/models/PostFaker.php

@@ -32,13 +32,25 @@ public function generateModel($attributes = [])
         $model->uid = substr($uniqueFaker->sha256, 0, 128);
         $model->title = substr($faker->sentence, 0, 255);
         $model->slug = substr($uniqueFaker->slug, 0, 200);
+        $model->category_id = $faker->randomElement(\app\models\Category::find()->select("id")->column());
         $model->active = $faker->boolean;
         $model->created_at = $faker->dateTimeThisCentury->format('Y-m-d');
+        $model->created_by_id = $faker->randomElement(\app\models\User::find()->select("id")->column());
         if (!is_callable($attributes)) {
             $model->setAttributes($attributes, false);
         } else {
             $model = $attributes($model, $faker, $uniqueFaker);
         }
         return $model;
     }
+
+    public static function dependentOn()
+    {
+        return [
+            // just model class names
+            'Category',
+            'User',
+
+        ];
+    }
 }

tests/specs/blog_v2/models/CommentFaker.php

@@ -30,6 +30,8 @@ public function generateModel($attributes = [])
         $uniqueFaker = $this->uniqueFaker;
         $model = new Comment();
         //$model->id = $uniqueFaker->numberBetween(0, 1000000);
+        $model->post_id = $faker->randomElement(\app\models\Post::find()->select("id")->column());
+        $model->user_id = $faker->randomElement(\app\models\User::find()->select("id")->column());
         $model->message = $faker->sentence;
         $model->meta_data = substr($faker->text(300), 0, 300);
         $model->created_at = $faker->dateTimeThisYear('now', 'UTC')->format('Y-m-d H:i:s');
@@ -40,4 +42,14 @@ public function generateModel($attributes = [])
         }
         return $model;
     }
+
+    public static function dependentOn()
+    {
+        return [
+            // just model class names
+            'Post',
+            'User',
+
+        ];
+    }
 }

tests/specs/blog_v2/models/PostFaker.php

@@ -33,13 +33,25 @@ public function generateModel($attributes = [])
         $model->title = substr($faker->sentence, 0, 255);
         $model->slug = substr($uniqueFaker->slug, 0, 200);
         $model->lang = $faker->randomElement(['ru','eng']);
+        $model->category_id = $faker->randomElement(\app\models\Category::find()->select("id")->column());
         $model->active = $faker->boolean;
         $model->created_at = $faker->dateTimeThisCentury->format('Y-m-d');
+        $model->created_by_id = $faker->randomElement(\app\models\User::find()->select("id")->column());
         if (!is_callable($attributes)) {
             $model->setAttributes($attributes, false);
         } else {
             $model = $attributes($model, $faker, $uniqueFaker);
         }
         return $model;
     }
+
+    public static function dependentOn()
+    {
+        return [
+            // just model class names
+            'Category',
+            'User',
+
+        ];
+    }
 }