added tests for generating relations

Author: cebe

src/generator/ApiGenerator.php

@@ -692,6 +692,7 @@ public function generate()
                             'description' => $model->description,
                             'attributes' => $model->attributes,
                             'relations' => $model->relations,
+                            'relationNamespace' => $this->modelNamespace,
                         ])
                     );
                     if ($this->generateModelFaker) {

src/generator/default/dbmodel.php

@@ -7,9 +7,19 @@
  * <?= str_replace("\n", "\n * ", trim($description)) ?>
 
  *
-<?php foreach ($attributes as $attribute): ?>
+<?php foreach ($attributes as $attribute):
+    if (\yii\helpers\StringHelper::endsWith($attribute['name'], '_id') && isset($relations[substr($attribute['name'], 0, -3)])) {
+        // TODO this change should be made in SchemaToDatabase class
+        $attribute['type'] = 'int';
+    }
+    ?>
  * @property <?= $attribute['type'] ?? 'mixed' ?> $<?= str_replace("\n", "\n * ", rtrim($attribute['name'] . ' ' . $attribute['description'])) ?>
 
+<?php endforeach; ?>
+ *
+<?php foreach ($relations as $relationName => $relation): ?>
+ * @property \<?= trim($relationNamespace, '\\') ?>\<?= $relation['class'] ?> $<?= $relationName ?>
+
 <?php endforeach; ?>
  */
 abstract class <?= $className ?> extends \yii\db\ActiveRecord
@@ -32,6 +42,9 @@ public function rules()
         if ($attribute['readOnly']) {
             continue;
         }
+        if (\yii\helpers\StringHelper::endsWith($attribute['name'], '_id') && isset($relations[substr($attribute['name'], 0, -3)])) {
+            continue;
+        }
         if ($attribute['required']) {
             $requiredAttributes[$attribute['name']] = $attribute['name'];
         }
@@ -72,7 +85,7 @@ public function rules()
 <?php foreach ($relations as $relationName => $relation): ?>
     public function get<?= ucfirst($relationName) ?>()
     {
-        return $this-><?= $relation['method'] ?>(<?= $relation['class'] ?>::class, <?php
+        return $this-><?= $relation['method'] ?>(\<?= trim($relationNamespace, '\\') ?>\<?= $relation['class'] ?>::class, <?php
             echo str_replace(
                     [',', '=>', ', ]'],
                     [', ', ' => ', ']'],

tests/GeneratorTest.php

@@ -63,7 +63,7 @@ public function testGenerate($testFile)
             $actualFile = str_replace('@app', Yii::getAlias('@app'), $file);
             $this->assertFileExists($expectedFile);
             $this->assertFileExists($actualFile);
-            $this->assertFileEquals($expectedFile, $actualFile);
+            $this->assertFileEquals($expectedFile, $actualFile, "Failed asserting that file contents of\n$actualFile\nare equal to file contents of\n$expectedFile");
         }
     }
 }

tests/specs/petstore.yaml

@@ -140,9 +140,23 @@ components:
           readOnly: True
         name:
           type: string
+        store:
+          $ref: '#/components/schemas/Store'
         tag:
           type: string
           x-faker: "$faker->randomElement(['one', 'two', 'three', 'four'])"
+    Store:
+      description: A store's description
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+          readOnly: True
+        name:
+          type: string
     Pets:
       type: array
       items:

tests/specs/petstore/models/Store.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace app\models;
+
+class Store extends \app\models\base\Store
+{
+
+
+}
+

tests/specs/petstore/models/StoreFaker.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace app\models;
+
+use Faker\Factory as FakerFactory;
+use Faker\UniqueGenerator;
+
+/**
+ * Fake data generator for Store
+ */
+class StoreFaker
+{
+    public function generateModel()
+    {
+        $faker = FakerFactory::create(\Yii::$app->language);
+        $uniqueFaker = new UniqueGenerator($faker);
+        $model = new Store;
+        $model->id = $uniqueFaker->numberBetween(0, 2147483647);
+        $model->name = $faker->sentence;
+        return $model;
+    }
+}

tests/specs/petstore/models/base/Pet.php

@@ -7,7 +7,10 @@
  *
  * @property int $id
  * @property string $name
+ * @property int $store_id A store's description
  * @property string $tag
+ *
+ * @property \app\models\Store $store
  */
 abstract class Pet extends \yii\db\ActiveRecord
 {
@@ -25,4 +28,9 @@ public function rules()
         ];
     }
 
+    public function getStore()
+    {
+        return $this->hasOne(\app\models\Store::class, ['id' => 'store_id']);
+    }
+
 }

tests/specs/petstore/models/base/Store.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace app\models\base;
+
+/**
+ * A store's description
+ *
+ * @property int $id
+ * @property string $name
+ *
+ */
+abstract class Store extends \yii\db\ActiveRecord
+{
+    public static function tableName()
+    {
+        return '{{%stores}}';
+    }
+
+    public function rules()
+    {
+        return [
+            [['name'], 'trim'],
+            [['name'], 'required'],
+            [['name'], 'string'],
+        ];
+    }
+
+}

tests/specs/petstore_arrayref/models/base/Pet.php

@@ -8,6 +8,7 @@
  * @property int $id
  * @property string $name
  * @property string $tag
+ *
  */
 abstract class Pet extends \yii\db\ActiveRecord
 {

tests/specs/petstore_namespace/mymodels/Store.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace app\mymodels;
+
+class Store extends \app\mymodels\base\Store
+{
+
+
+}
+