Resolve multiple PRs (#140)

Resolve - Prevent _id suffix in column name on reference properties

Fix #90

PR in fork: SOHELAHMED7#21

---

Resolve: Running phpunit second time fails a tests

Fix: #139

PR in fork: SOHELAHMED7#20

---

Resolve: If data type is not changed then still migrations are generated
for timestamp in MySQL

Fix #143

PR in fork: SOHELAHMED7#24

---

Resolve: Model name generated more than once in Faker

Fix #148

PR in fork: SOHELAHMED7#25

---

Resolve: Wrong migration for Pgsql is generated for string/varchar
datatype

Fix #149

PR in fork: SOHELAHMED7#26

---

Resolve - PathAutoCompletion causes timeouts on large projects 

Fix #145

PR in fork: SOHELAHMED7#27


---

Resolve - nullable false should put attribute in required section in
model validation rules

Fix #153 

PR in fork: SOHELAHMED7#28

Author: cebe

CONTRIBUTING.md

@@ -44,6 +44,15 @@ To apply multiple migration with one command:
 ./yii migrate-pgsql/down --interactive=0 4
 ```
 
+PHPUnit run only one test by regex
+----------------------------------
+
+If a PHPUnit test file have 2 test method with names like `testEdit()` and `testEditExpression()` then by running `./vendor/bin/phpunit --filter XDbDefaultExpressionTest::testEdit` both tests will run. In order to run only one test `testEdit()`, run below command:
+
+```bash
+./vendor/bin/phpunit --filter '/XDbDefaultExpressionTest::testEdit$/'
+```
+
 
 Switching PHP versions
 ----------------------
@@ -84,5 +93,60 @@ with Zend OPcache v7.4.27, Copyright (c), by Zend Technologies
 with Xdebug v2.9.6, Copyright (c) 2002-2020, by Derick Rethans
 ```
 
+Issues and solutions
+--------------------
+
+#### Issue when switching PHP version as mentioned above
+
+```
+root@f65bb59c3289:/app# ./vendor/bin/phpunit
+
+Fatal error: Composer detected issues in your platform: Your Composer dependencies require a PHP version ">= 8.1.0". You are running 7.4.33. in /app/vendor/composer/platform_check.php on line 24
+```
+
+#### Solution
+
+```bash
+sudo rm -rf vendor
+composer update
+```
+
 
+## Use PR of your own fork of this library in your project to check new changes
+
+Say you have a fork of this library at https://github.com/SOHELAHMED7/yii2-openapi
+
+You implemented new changes or fixed bugs and created PR on GitHub. It is not yet merged in upstream master branch.
+
+You wanted to check this new changes in your own project which is using this lib cebe/yii2-openapi.
+
+You can accomplish it by:
+
+
+Add below to composer.json of your project file
+
+
+```json
+    "repositories": [
+        {
+            "type": "composer",
+            "url": "https://asset-packagist.org"
+        },
+        {
+            "type": "vcs",
+            "url": "http://github.com/SOHELAHMED7/yii2-openapi"
+        }
+    ]
+```
+
+Then lets say you have PR https://github.com/SOHELAHMED7/yii2-openapi/pull/24.
+
+And branch name is `143-if-data-type-is-not-changed-then-still-migrations-are-generated-for-timestamp-in-mysql`.
+
+Run below command:
+
+```bash
+composer require cebe/yii2-openapi:dev-143-if-data-type-is-not-changed-then-still-migrations-are-generated-for-timestamp-in-mysql
+```
 
+Ensure to use upstream package name `cebe/yii2-openapi` instead of your fork (`sohelahmed7/yii2-openapi`) in composer command. And prefix branch name by `dev-`

Makefile

@@ -55,7 +55,7 @@ installdocker:
 	docker-compose run --user=$(UID) --rm php composer install && chmod +x tests/yii
 
 testdocker:
-	docker-compose run --user=$(UID) --rm php sh -c 'vendor/bin/phpunit'
+	docker-compose run --user=$(UID) --rm php sh -c 'vendor/bin/phpunit --repeat 3'
 
 efs: clean_all up migrate # Everything From Scratch
 

README.md

@@ -249,6 +249,30 @@ Allow to set foreign key constraint in migrations for ON DELETE event of row in
 
 Allow to set foreign key constraint in migrations for ON UPDATE event of row in database table. For example, see above section for `x-fk-on-delete`.
 
+### `x-fk-column-name`
+
+Provide custom column name in case of relationship column. Example:
+
+```yaml
+  components:
+    schemas:
+      Webhook:
+        type: object
+        description: example for x-fk-column-name
+        properties:
+          id:
+            type: integer
+          name:
+            type: string
+          user:
+            $ref: '../openapi.yaml#/components/schemas/User' # this will automatically create `user_id` column
+          redelivery_of:
+            allOf:
+              - $ref: '../openapi.yaml#/components/schemas/Delivery'
+              # this will automatically create `redelivery_of_id` column, but to avoid that use below extension
+              - x-fk-column-name: redelivery_of # this will create `redelivery_of` column instead of `redelivery_of_id`
+```
+
 ## Many-to-Many relation definition
 
 There are two ways for define many-to-many relations:
@@ -386,7 +410,7 @@ It works on all 3 DB: MySQL, MariaDb and PgSQL.
           - three
 ```
 
-Note: Change in enum values are not very simple. For Mysql and Mariadb, migrations will be generated but in many cases custom modification in it are required. For Pgsql migrations for change in enum values will not be generated. It should be handled manually.
+Note: Changes in enum values are not very simple. For Mysql and Mariadb, migrations will be generated but in many cases custom modification in it are required. For Pgsql migrations for change in enum values will not be generated. It should be handled manually.
 
 ## Handling of `numeric` (#numeric, #MariaDb)
 
@@ -420,6 +444,28 @@ DB-Result = decimal(12,2)
 ```
 DB-Result = decimal(10,2)
 
+## Handling of `timestamp` database column data type
+
+If field is defined as
+
+```yaml
+created_at:
+    type: string
+    format: date-time # or datetime
+    example: '2020-03-14T21:42:17Z'
+    readOnly: true
+```
+
+then database type selected will be `timestamp`. This is by design. If `datetime` data type is needed, use `x-db-type` as
+
+```yaml
+created_at:
+    type: string
+    format: date-time # or datetime
+    example: '2020-03-14T21:42:17Z'
+    x-db-type: datetime
+    readOnly: true
+```
 
 ## Assumptions
 

src/generator/ApiGenerator.php

@@ -372,7 +372,8 @@ public function hints()
      */
     public function autoCompleteData()
     {
-        return (new PathAutoCompletion())->complete();
+        $config = $this->makeConfig();
+        return (new PathAutoCompletion($config))->complete();
     }
 
     /**

src/generator/default/faker.php

@@ -3,6 +3,7 @@
  * @var \cebe\yii2openapi\lib\items\DbModel $model
  * @var string $namespace
  * @var string $modelNamespace
+ * @var array $deps list of all models that this model is dependent on
  **/
 
 $modelClass = ($modelNamespace !== $namespace ? '\\'.trim($modelNamespace, '\\').'\\' : '').$model->getClassName();
@@ -68,8 +69,8 @@ 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 foreach ($deps as $dep): ?>
+            <?php echo \yii\helpers\VarDumper::export($dep).','.PHP_EOL ?>
 <?php endforeach; ?>
 
         ];

src/lib/AttributeResolver.php

@@ -98,12 +98,17 @@ public function resolve():DbModel
             /** @var $property \cebe\yii2openapi\lib\openapi\PropertySchema */
 
             $isRequired = $this->schema->isRequiredProperty($property->getName());
+            $nullableValue = $property->getProperty()->getSerializableData()->nullable ?? null;
+            if ($nullableValue === false) { // see docs in README regarding NOT NULL, required and nullable
+                $isRequired = true;
+            }
+
             if ($this->isJunctionSchema) {
                 $this->resolveJunctionTableProperty($property, $isRequired);
             } elseif ($this->hasMany2Many) {
                 $this->resolveHasMany2ManyTableProperty($property, $isRequired);
             } else {
-                $this->resolveProperty($property, $isRequired);
+                $this->resolveProperty($property, $isRequired, $nullableValue);
             }
         }
         return Yii::createObject(DbModel::class, [
@@ -141,7 +146,8 @@ protected function resolveJunctionTableProperty(PropertySchema $property, bool $
                       ->setIsPrimary($property->isPrimaryKey())
                       ->asReference($junkAttribute['relatedClassName'])
                       ->setPhpType($junkAttribute['phpType'])
-                      ->setDbType($junkAttribute['dbType']);
+                      ->setDbType($junkAttribute['dbType'])
+                      ->setForeignKeyColumnName($property->fkColName);
             $relation = Yii::createObject(AttributeRelation::class, [
                 $property->getName(),
                 $junkAttribute['relatedTableName'],
@@ -201,20 +207,28 @@ protected function resolveHasMany2ManyTableProperty(PropertySchema $property, bo
     /**
      * @param \cebe\yii2openapi\lib\openapi\PropertySchema $property
      * @param bool                                         $isRequired
+     * @param bool|null|string                             $nullableValue if string then its value will be only constant `ARG_ABSENT`. Default `null` is avoided because it can be in passed value in method call
      * @throws \cebe\yii2openapi\lib\exceptions\InvalidDefinitionException
      * @throws \yii\base\InvalidConfigException
      */
-    protected function resolveProperty(PropertySchema $property, bool $isRequired):void
-    {
+    protected function resolveProperty(
+        PropertySchema $property,
+        bool $isRequired,
+        $nullableValue = 'ARG_ABSENT'
+    ):void {
+        if ($nullableValue === 'ARG_ABSENT') {
+            $nullableValue = $property->getProperty()->getSerializableData()->nullable ?? null;
+        }
         $attribute = Yii::createObject(Attribute::class, [$property->getName()]);
         $attribute->setRequired($isRequired)
                   ->setDescription($property->getAttr('description', ''))
                   ->setReadOnly($property->isReadonly())
                   ->setDefault($property->guessDefault())
                   ->setXDbType($property->getAttr(CustomSpecAttr::DB_TYPE))
                   ->setXDbDefaultExpression($property->getAttr(CustomSpecAttr::DB_DEFAULT_EXPRESSION))
-                  ->setNullable($property->getProperty()->getSerializableData()->nullable ?? null)
-                  ->setIsPrimary($property->isPrimaryKey());
+                  ->setNullable($nullableValue)
+                  ->setIsPrimary($property->isPrimaryKey())
+                  ->setForeignKeyColumnName($property->fkColName);
         if ($property->isReference()) {
             if ($property->isVirtual()) {
                 throw new InvalidDefinitionException('References not supported for virtual attributes');

src/lib/ColumnToCode.php

@@ -110,7 +110,7 @@ class ColumnToCode
      * Its possible values are:
      *      `'FIRST'`
      *      `'AFTER <columnName>'` e.g. AFTER first_name
-     *      `null` means append new column at the end
+     *      `null` (default) means append new column at the end
      */
     private $position;
 

src/lib/CustomSpecAttr.php

@@ -35,4 +35,9 @@ class CustomSpecAttr
      */
     public const FK_ON_DELETE = 'x-fk-on-delete';
     public const FK_ON_UPDATE = 'x-fk-on-update';
+
+    /**
+     * Foreign key column name. See README for usage docs
+     */
+    public const FK_COLUMN_NAME = 'x-fk-column-name';
 }

src/lib/FakerStubResolver.php

@@ -212,6 +212,9 @@ private function fakeForFloat(?int $min, ?int $max):?string
 
     private function fakeForArray():string
     {
+        if ($this->attribute->required) {
+            return '["a" => "b"]';
+        }
         return '[]';
     }
 }