Resolve: Extension FK COLUMN NAME cause error in case of column name without underscore #29

src/lib/AttributeResolver.php

@@ -7,8 +7,6 @@
 
 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;
 use cebe\yii2openapi\lib\items\AttributeRelation;
@@ -22,7 +20,6 @@
 use Yii;
 use yii\helpers\Inflector;
 use yii\helpers\StringHelper;
-use yii\helpers\VarDumper;
 use function explode;
 use function strpos;
 use function strtolower;
@@ -266,7 +263,7 @@ protected function resolveProperty(
 
             $relation = Yii::createObject(
                 AttributeRelation::class,
-                [$property->getName(), $relatedTableName, $relatedClassName]
+                [static::relationName($property->getName(), $property->fkColName), $relatedTableName, $relatedClassName]
             )
                            ->asHasOne([$fkProperty->getName() => $attribute->columnName]);
             $relation->onUpdateFkConstraint = $property->onUpdateFkConstraint;
@@ -317,7 +314,7 @@ protected function resolveProperty(
                     $this->relations[$property->getName()] =
                         Yii::createObject(
                             AttributeRelation::class,
-                            [$property->getName(), $relatedTableName, $relatedClassName]
+                            [static::relationName($property->getName(), $property->fkColName), $relatedTableName, $relatedClassName]
                         )
                            ->asHasMany([$fkProperty->getName() => $fkProperty->getName()])->asSelfReference();
                     return;
@@ -326,7 +323,7 @@ protected function resolveProperty(
                 $this->relations[$property->getName()] =
                     Yii::createObject(
                         AttributeRelation::class,
-                        [$property->getName(), $relatedTableName, $relatedClassName]
+                        [static::relationName($property->getName(), $property->fkColName), $relatedTableName, $relatedClassName]
                     )
                        ->asHasMany([$foreignPk => $this->schema->getPkName()]);
                 return;
@@ -345,7 +342,7 @@ protected function resolveProperty(
             $this->relations[$property->getName()] =
                 Yii::createObject(
                     AttributeRelation::class,
-                    [$property->getName(), $relatedTableName, $relatedClassName]
+                    [static::relationName($property->getName(), $property->fkColName), $relatedTableName, $relatedClassName]
                 )
                    ->asHasMany([Inflector::camel2id($this->schemaName, '_') . '_id' => $this->schema->getPkName()]);
             return;
@@ -492,4 +489,14 @@ protected function resolvePropertyRef(PropertySchema $property, Attribute $attri
         $this->attributes[$property->getName()] =
             $attribute->setFakerStub($this->guessFakerStub($attribute, $fkProperty));
     }
+
+    public static function relationName(string $propertyName, ?string $fkColumnName): string
+    {
+        $fkColumnName = (string) $fkColumnName;
+        $relationName = $propertyName;
+        if (!str_contains($fkColumnName, '_')) {
+            $relationName = strtolower($fkColumnName) === strtolower($relationName) ? $relationName . 'Rel' : $relationName;
+        }
+        return $relationName;
+    }
 }

src/lib/ValidationRulesBuilder.php

@@ -10,8 +10,7 @@
 use cebe\yii2openapi\lib\items\Attribute;
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\yii2openapi\lib\items\ValidationRule;
-use yii\helpers\VarDumper;
-use yii\validators\DateValidator;
+use yii\helpers\Inflector;
 use function count;
 use function implode;
 use function in_array;
@@ -162,10 +161,12 @@ private function addExistRules(array $relations):void
             } elseif ($attribute->phpType === 'string') {
                 $this->addStringRule($attribute);
             }
+
+            $targetRelation = AttributeResolver::relationName(Inflector::variablize($attribute->camelName()), $attribute->fkColName);
             $this->rules[$attribute->columnName . '_exist'] = new ValidationRule(
                 [$attribute->columnName],
                 'exist',
-                ['targetRelation' => $attribute->camelName()]
+                ['targetRelation' => $targetRelation]
             );
         }
     }

tests/specs/blog/models/base/Comment.php

@@ -28,9 +28,9 @@ public function rules()
             'trim' => [['post_id'], 'trim'],
             'required' => [['post_id', 'author_id', 'message', 'created_at'], 'required'],
             'post_id_string' => [['post_id'], 'string', 'max' => 128],
-            'post_id_exist' => [['post_id'], 'exist', 'targetRelation' => 'Post'],
+            'post_id_exist' => [['post_id'], 'exist', 'targetRelation' => 'post'],
             'author_id_integer' => [['author_id'], 'integer'],
-            'author_id_exist' => [['author_id'], 'exist', 'targetRelation' => 'Author'],
+            'author_id_exist' => [['author_id'], 'exist', 'targetRelation' => 'author'],
             'message_default' => [['message'], 'default', 'value' => []],
             'meta_data_default' => [['meta_data'], 'default', 'value' => []],
             'created_at_integer' => [['created_at'], 'integer'],

tests/specs/blog/models/base/Post.php

@@ -30,9 +30,9 @@ public function rules()
             'trim' => [['title', 'slug', 'created_at'], 'trim'],
             'required' => [['title', 'category_id', 'active'], 'required'],
             'category_id_integer' => [['category_id'], 'integer'],
-            'category_id_exist' => [['category_id'], 'exist', 'targetRelation' => 'Category'],
+            'category_id_exist' => [['category_id'], 'exist', 'targetRelation' => 'category'],
             'created_by_id_integer' => [['created_by_id'], 'integer'],
-            'created_by_id_exist' => [['created_by_id'], 'exist', 'targetRelation' => 'CreatedBy'],
+            'created_by_id_exist' => [['created_by_id'], 'exist', 'targetRelation' => 'createdBy'],
             'title_unique' => [['title'], 'unique'],
             'slug_unique' => [['slug'], 'unique'],
             'title_string' => [['title'], 'string', 'max' => 255],

tests/specs/blog_v2/models/base/Comment.php

@@ -28,9 +28,9 @@ public function rules()
             'trim' => [['message', 'meta_data', 'created_at'], 'trim'],
             'required' => [['post_id', 'message', 'created_at'], 'required'],
             'post_id_integer' => [['post_id'], 'integer'],
-            'post_id_exist' => [['post_id'], 'exist', 'targetRelation' => 'Post'],
+            'post_id_exist' => [['post_id'], 'exist', 'targetRelation' => 'post'],
             'user_id_integer' => [['user_id'], 'integer'],
-            'user_id_exist' => [['user_id'], 'exist', 'targetRelation' => 'User'],
+            'user_id_exist' => [['user_id'], 'exist', 'targetRelation' => 'user'],
             'message_string' => [['message'], 'string'],
             'meta_data_string' => [['meta_data'], 'string', 'min' => 1, 'max' => 300],
             'meta_data_default' => [['meta_data'], 'default', 'value' => ''],

tests/specs/blog_v2/models/base/Post.php

@@ -32,9 +32,9 @@ public function rules()
             'trim' => [['title', 'slug', 'created_at'], 'trim'],
             'required' => [['title', 'category_id', 'active'], 'required'],
             'category_id_integer' => [['category_id'], 'integer'],
-            'category_id_exist' => [['category_id'], 'exist', 'targetRelation' => 'Category'],
+            'category_id_exist' => [['category_id'], 'exist', 'targetRelation' => 'category'],
             'created_by_id_integer' => [['created_by_id'], 'integer'],
-            'created_by_id_exist' => [['created_by_id'], 'exist', 'targetRelation' => 'CreatedBy'],
+            'created_by_id_exist' => [['created_by_id'], 'exist', 'targetRelation' => 'createdBy'],
             'title_unique' => [['title'], 'unique'],
             'title_string' => [['title'], 'string', 'max' => 255],
             'slug_string' => [['slug'], 'string', 'min' => 1, 'max' => 200],

tests/specs/fk_col_name/app/models/base/Webhook.php

@@ -25,9 +25,9 @@ public function rules()
         return [
             'trim' => [['name'], 'trim'],
             'user_id_integer' => [['user_id'], 'integer'],
-            'user_id_exist' => [['user_id'], 'exist', 'targetRelation' => 'User'],
+            'user_id_exist' => [['user_id'], 'exist', 'targetRelation' => 'user'],
             'redelivery_of_integer' => [['redelivery_of'], 'integer'],
-            'redelivery_of_exist' => [['redelivery_of'], 'exist', 'targetRelation' => 'RedeliveryOf'],
+            'redelivery_of_exist' => [['redelivery_of'], 'exist', 'targetRelation' => 'redeliveryOf'],
             'name_string' => [['name'], 'string'],
         ];
     }

tests/specs/fk_col_name_index/app/models/base/Webhook.php

@@ -27,11 +27,11 @@ public function rules()
         return [
             'trim' => [['name'], 'trim'],
             'user_id_integer' => [['user_id'], 'integer'],
-            'user_id_exist' => [['user_id'], 'exist', 'targetRelation' => 'User'],
+            'user_id_exist' => [['user_id'], 'exist', 'targetRelation' => 'user'],
             'redelivery_of_integer' => [['redelivery_of'], 'integer'],
-            'redelivery_of_exist' => [['redelivery_of'], 'exist', 'targetRelation' => 'RedeliveryOf'],
+            'redelivery_of_exist' => [['redelivery_of'], 'exist', 'targetRelation' => 'redeliveryOf'],
             'rd_abc_2_integer' => [['rd_abc_2'], 'integer'],
-            'rd_abc_2_exist' => [['rd_abc_2'], 'exist', 'targetRelation' => 'Rd2'],
+            'rd_abc_2_exist' => [['rd_abc_2'], 'exist', 'targetRelation' => 'rd2'],
             'user_id_name_unique' => [['user_id', 'name'], 'unique', 'targetAttribute' => [
                 'user_id',
                 'name',

tests/specs/issue_fix/159_bug_giiapi_generated_rules_emailid/maria/models/base/Contact.php

@@ -25,7 +25,7 @@ public function rules()
             'trim' => [['nickname'], 'trim'],
             'required' => [['mailing_id'], 'required'],
             'mailing_id_integer' => [['mailing_id'], 'integer'],
-            'mailing_id_exist' => [['mailing_id'], 'exist', 'targetRelation' => 'Mailing'],
+            'mailing_id_exist' => [['mailing_id'], 'exist', 'targetRelation' => 'mailing'],
             'active_boolean' => [['active'], 'boolean'],
             'active_default' => [['active'], 'default', 'value' => false],
             'nickname_string' => [['nickname'], 'string'],

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/app/models/base/Order.php

@@ -24,7 +24,7 @@ public function rules()
         return [
             'trim' => [['name', 'name2'], 'trim'],
             'invoice_id_integer' => [['invoice_id'], 'integer'],
-            'invoice_id_exist' => [['invoice_id'], 'exist', 'targetRelation' => 'Invoice'],
+            'invoice_id_exist' => [['invoice_id'], 'exist', 'targetRelation' => 'invoice'],
             'name_string' => [['name'], 'string'],
             'name2_string' => [['name2'], 'string'],
         ];

tests/specs/issue_fix/175_bug_allof_with_multiple_dollarrefs/pgsql/models/base/Contact.php

@@ -25,7 +25,7 @@ public function rules()
             'trim' => [['nickname'], 'trim'],
             'required' => [['account_id'], 'required'],
             'account_id_integer' => [['account_id'], 'integer'],
-            'account_id_exist' => [['account_id'], 'exist', 'targetRelation' => 'Account'],
+            'account_id_exist' => [['account_id'], 'exist', 'targetRelation' => 'account'],
             'active_boolean' => [['active'], 'boolean'],
             'active_default' => [['active'], 'default', 'value' => false],
             'nickname_string' => [['nickname'], 'string'],

tests/specs/issue_fix/29_extension_fk_column_name_cause_error_in_case_of_column_name_without_underscore/index.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/issue_fix/29_extension_fk_column_name_cause_error_in_case_of_column_name_without_underscore/index.yaml',
+    'generateUrls' => false,
+    'generateModels' => true,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => false,
+    'generateMigrations' => true,
+    'generateModelFaker' => true,
+];

tests/specs/issue_fix/29_extension_fk_column_name_cause_error_in_case_of_column_name_without_underscore/index.yaml

@@ -0,0 +1,33 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Extension FK COLUMN NAME cause error in case of column name without underscore \#29
+paths:
+  /:
+    get:
+      summary: List
+      operationId: list
+      responses:
+        '200':
+          description: The information
+
+components:
+  schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+    Post:
+      type: object
+      properties:
+        id:
+          type: integer
+        content:
+          type: string
+        user:
+          allOf:
+            - $ref: '#/components/schemas/User'
+            - x-fk-column-name: user

tests/specs/issue_fix/29_extension_fk_column_name_cause_error_in_case_of_column_name_without_underscore/mysql/migrations_mysql_db/m200000_000000_create_table_users.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * Table for User
+ */
+class m200000_000000_create_table_users extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->createTable('{{%users}}', [
+            'id' => $this->primaryKey(),
+            'name' => $this->text()->null(),
+        ]);
+    }
+
+    public function down()
+    {
+        $this->dropTable('{{%users}}');
+    }
+}

tests/specs/issue_fix/29_extension_fk_column_name_cause_error_in_case_of_column_name_without_underscore/mysql/migrations_mysql_db/m200000_000001_create_table_posts.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * Table for Post
+ */
+class m200000_000001_create_table_posts extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->createTable('{{%posts}}', [
+            'id' => $this->primaryKey(),
+            'content' => $this->text()->null(),
+            'user' => $this->integer()->null()->defaultValue(null),
+        ]);
+        $this->addForeignKey('fk_posts_user_users_id', '{{%posts}}', 'user', '{{%users}}', 'id');
+    }
+
+    public function down()
+    {
+        $this->dropForeignKey('fk_posts_user_users_id', '{{%posts}}');
+        $this->dropTable('{{%posts}}');
+    }
+}