Fix cebe#162 - Bug $ref with x-faker (cebe#164)

Fix cebe#162

PR in fork: SOHELAHMED7#30

Author: cebe

.gitignore

@@ -4,3 +4,5 @@
 /.php_cs.cache
 /.env
 /.phpunit.result.cache
+
+/.idea

README.md

@@ -104,6 +104,40 @@ You may specify custom PHP code for generating fake data for a property:
           x-faker: "$faker->randomElements(['one', 'two', 'three', 'four'])"
 ```
 
+To avoid generating faker code for particular model attribute, use value `false`:
+
+```yaml
+    Post:
+      properties:
+        age:
+          type: integer
+          x-faker: false
+```
+
+Using in reference with `allOf`:
+
+```yaml
+    Invoice:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: integer
+
+    Order:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: integer
+        invoice:
+          allOf:
+            - $ref: '#/components/schemas/Invoice'
+            - x-faker: false
+```
+
 ### `x-table`
 
 Specify the table name for a Schema that defines a model which is stored in the database.

src/lib/FakerStubResolver.php

@@ -44,9 +44,19 @@ public function __construct(Attribute $attribute, PropertySchema $property, ?Con
 
     public function resolve():?string
     {
+        if ($this->property->xFaker === false) {
+            $this->attribute->setFakerStub(null);
+            return null;
+        }
         if ($this->property->hasAttr(CustomSpecAttr::FAKER)) {
-            return $this->property->getAttr(CustomSpecAttr::FAKER);
+            $fakerVal = $this->property->getAttr(CustomSpecAttr::FAKER);
+            if ($fakerVal === false) {
+                $this->attribute->setFakerStub(null);
+                return null;
+            }
+            return $fakerVal;
         }
+
         if ($this->attribute->isReadOnly() && $this->attribute->isVirtual()) {
             return null;
         }

src/lib/openapi/PropertySchema.php

@@ -46,6 +46,13 @@ class PropertySchema
      */
     public $fkColName;
 
+    /**
+     * @var null|bool|string
+     * If `false`, no faker will be generated in faker model
+     * See more about usage in README.md file present in root directory of the project
+     */
+    public $xFaker;
+
     /**
      * @var \cebe\openapi\SpecObjectInterface
      */
@@ -93,7 +100,7 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
         $this->schema = $schema;
         $this->isPk = $name === $schema->getPkName();
 
-        $onUpdate = $onDelete = $reference = $fkColName = null;
+        $onUpdate = $onDelete = $xFaker = $reference = $fkColName = null;
 
         foreach ($property->allOf ?? [] as $element) {
             // x-fk-on-delete | x-fk-on-update
@@ -103,6 +110,11 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
             if (!empty($element->{CustomSpecAttr::FK_ON_DELETE})) {
                 $onDelete = $element->{CustomSpecAttr::FK_ON_DELETE};
             }
+
+            if (isset($element->{CustomSpecAttr::FAKER})) {
+                $xFaker = $element->{CustomSpecAttr::FAKER};
+            }
+
             if ($element instanceof Reference) {
                 $reference = $element;
             }
@@ -128,6 +140,10 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
             $this->fkColName = $fkColName;
             $this->property = $reference;
             $property = $this->property;
+        } elseif ($xFaker !== null && $reference instanceof Reference) {
+            $this->xFaker = $xFaker;
+            $this->property = $reference;
+            $property = $this->property;
         }
 
         if ($property instanceof Reference) {

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/162_bug_dollarref_with_x_faker.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/issue_fix/162_bug_dollarref_with_x_faker/162_bug_dollarref_with_x_faker.yaml',
+    'generateUrls' => false,
+    'generateModels' => true,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => false,
+    'generateMigrations' => false,
+    'generateModelFaker' => true, // `generateModels` must be `true` in orde to use `generateModelFaker` as `true`
+];

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/162_bug_dollarref_with_x_faker.yaml

@@ -0,0 +1,58 @@
+openapi: 3.0.3
+# Edit this schema and start your project
+# This is sample schema
+# To generate code which is based on this schema
+# run commands mentioned Development section in README.md file
+info:
+  title: 'Proxy-Service'
+  description: ""
+  version: 1.0.0
+  contact:
+    name: '...'
+    email: you@example.com
+paths:
+  /:
+    get:
+      summary: List
+      operationId: list
+      responses:
+        '200':
+          description: The information
+servers:
+  - url: 'http://localhost:9937'
+    description: 'Local Dev API'
+security:
+  - BasicAuth: []
+components:
+  securitySchemes:
+    BasicAuth:
+      type: http
+      scheme: basic
+  schemas:
+
+    Invoice:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: integer
+
+    Order:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        name2:
+          type: string
+          x-faker: false
+        invoice:
+          allOf:
+            - $ref: '#/components/schemas/Invoice'
+            - x-faker: false
+            # - nullable: true
+

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/app/models/BaseModelFaker.php

@@ -0,0 +1,144 @@
+<?php
+
+namespace app\models;
+
+use Faker\Factory as FakerFactory;
+use Faker\Generator;
+use Faker\UniqueGenerator;
+
+/**
+ * Base fake data generator
+ */
+abstract class BaseModelFaker
+{
+    /**
+     * @var Generator
+    */
+    protected $faker;
+    /**
+     * @var UniqueGenerator
+    */
+    protected $uniqueFaker;
+
+    public function __construct()
+    {
+        $this->faker = FakerFactory::create(str_replace('-', '_', \Yii::$app->language));
+        $this->uniqueFaker = new UniqueGenerator($this->faker);
+    }
+
+    abstract public function generateModel($attributes = []);
+
+    public function getFaker():Generator
+    {
+        return $this->faker;
+    }
+
+    public function getUniqueFaker():UniqueGenerator
+    {
+        return $this->uniqueFaker;
+    }
+
+    public function setFaker(Generator $faker):void
+    {
+        $this->faker = $faker;
+    }
+
+    public function setUniqueFaker(UniqueGenerator $faker):void
+    {
+        $this->uniqueFaker = $faker;
+    }
+
+    /**
+     * Generate and return model
+     * @param array|callable $attributes
+     * @param UniqueGenerator|null $uniqueFaker
+     * @return \yii\db\ActiveRecord
+     * @example MyFaker::makeOne(['user_id' => 1, 'title' => 'foo']);
+     * @example MyFaker::makeOne( function($model, $faker) {
+     *        $model->scenario = 'create';
+     *        $model->setAttributes(['user_id' => 1, 'title' => $faker->sentence]);
+     *        return $model;
+     *  });
+     */
+    public static function makeOne($attributes = [], ?UniqueGenerator $uniqueFaker = null)
+    {
+        $fakeBuilder = new static();
+        if ($uniqueFaker !== null) {
+            $fakeBuilder->setUniqueFaker($uniqueFaker);
+        }
+        $model = $fakeBuilder->generateModel($attributes);
+        return $model;
+    }
+
+    /**
+     * Generate, save and return model
+     * @param array|callable $attributes
+     * @param UniqueGenerator|null $uniqueFaker
+     * @return \yii\db\ActiveRecord
+     * @example MyFaker::saveOne(['user_id' => 1, 'title' => 'foo']);
+     * @example MyFaker::saveOne( function($model, $faker) {
+     *        $model->scenario = 'create';
+     *        $model->setAttributes(['user_id' => 1, 'title' => $faker->sentence]);
+     *        return $model;
+     *  });
+     */
+    public static function saveOne($attributes = [], ?UniqueGenerator $uniqueFaker = null)
+    {
+        $model = static::makeOne($attributes, $uniqueFaker);
+        $model->save();
+        return $model;
+    }
+
+    /**
+     * Generate and return multiple models
+     * @param int $number
+     * @param array|callable $commonAttributes
+     * @return \yii\db\ActiveRecord[]|array
+     * @example TaskFaker::make(5, ['project_id'=>1, 'user_id' => 2]);
+     * @example TaskFaker::make(5, function($model, $faker, $uniqueFaker) {
+     *       $model->setAttributes(['name' => $uniqueFaker->username, 'state'=>$faker->boolean(20)]);
+     *       return $model;
+     * });
+     */
+    public static function make(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null):array
+    {
+        if ($number < 1) {
+            return [];
+        }
+        $fakeBuilder = new static();
+        if ($uniqueFaker !== null) {
+            $fakeBuilder->setUniqueFaker($uniqueFaker);
+        }
+        return array_map(function () use ($commonAttributes, $fakeBuilder) {
+            $model = $fakeBuilder->generateModel($commonAttributes);
+            return $model;
+        }, range(0, $number -1));
+    }
+
+    /**
+     * Generate, save and return multiple models
+     * @param int $number
+     * @param array|callable $commonAttributes
+     * @return \yii\db\ActiveRecord[]|array
+     * @example TaskFaker::save(5, ['project_id'=>1, 'user_id' => 2]);
+     * @example TaskFaker::save(5, function($model, $faker, $uniqueFaker) {
+     *       $model->setAttributes(['name' => $uniqueFaker->username, 'state'=>$faker->boolean(20)]);
+     *       return $model;
+     * });
+     */
+    public static function save(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null):array
+    {
+        if ($number < 1) {
+            return [];
+        }
+        $fakeBuilder = new static();
+        if ($uniqueFaker !== null) {
+            $fakeBuilder->setUniqueFaker($uniqueFaker);
+        }
+        return array_map(function () use ($commonAttributes, $fakeBuilder) {
+            $model = $fakeBuilder->generateModel($commonAttributes);
+            $model->save();
+            return $model;
+        }, range(0, $number -1));
+    }
+}

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/app/models/Invoice.php

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

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/app/models/InvoiceFaker.php

@@ -0,0 +1,40 @@
+<?php
+namespace app\models;
+
+use Faker\UniqueGenerator;
+
+/**
+ * Fake data generator for Invoice
+ * @method static Invoice makeOne($attributes = [], ?UniqueGenerator $uniqueFaker = null);
+ * @method static Invoice saveOne($attributes = [], ?UniqueGenerator $uniqueFaker = null);
+ * @method static Invoice[] make(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null)
+ * @method static Invoice[] save(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null)
+ */
+class InvoiceFaker extends BaseModelFaker
+{
+
+    /**
+     * @param array|callable $attributes
+     * @return Invoice|\yii\db\ActiveRecord
+     * @example
+     *  $model = (new PostFaker())->generateModels(['author_id' => 1]);
+     *  $model = (new PostFaker())->generateModels(function($model, $faker, $uniqueFaker) {
+     *            $model->scenario = 'create';
+     *            $model->author_id = 1;
+     *            return $model;
+     *  });
+    **/
+    public function generateModel($attributes = [])
+    {
+        $faker = $this->faker;
+        $uniqueFaker = $this->uniqueFaker;
+        $model = new Invoice();
+        //$model->id = $uniqueFaker->numberBetween(0, 1000000);
+        if (!is_callable($attributes)) {
+            $model->setAttributes($attributes, false);
+        } else {
+            $model = $attributes($model, $faker, $uniqueFaker);
+        }
+        return $model;
+    }
+}

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

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