Handle example

Author: SOHELAHMED7

README.md

@@ -314,7 +314,7 @@ Provide custom database table column name in case of relationship column. This w
 ### `x-no-relation`
 
 To differentiate a component schema property from one-to-many or many-to-many relation in favour of array(json) of
-related objects, `x-no-relation` is used.
+related objects, `x-no-relation` (type: boolean, default: false) is used.
 
 ```yaml
         comments:

src/lib/AttributeResolver.php

@@ -218,7 +218,7 @@ protected function resolveProperty(
         }
         $attribute = Yii::createObject(Attribute::class, [$property->getName()]);
 
-        if (!empty($property->getAttr(CustomSpecAttr::NO_RELATION))) { // TODO custom attr
+        if (!empty($property->getAttr(CustomSpecAttr::NO_RELATION))) {
             $this->attributes[$property->getName()] = $attribute->setFakerStub($this->guessFakerStub($attribute, $property));
         }
 

src/lib/FakerStubResolver.php

@@ -105,18 +105,21 @@ public function resolve(): ?string
         } elseif ($this->attribute->phpType === 'array' ||
             substr($this->attribute->phpType, -2) === '[]') {
             $result = $this->fakeForArray($this->property->getProperty());
+            if ($result !== '$faker->words()') { # example for array will only work with a list/`$faker->words()`
+                return $result;
+            }
         } elseif ($this->attribute->phpType === 'object') {
             $result = $this->fakeForObject($this->property->getProperty());
         } else {
             return null;
         }
 
-        if (!$this->property->hasAttr('example')) {
-            return $result;
-        }
-        if (stripos($result, 'uniqueFaker') !== false) {
+        if (!$this->property->hasAttr('example') ||
+            $this->property->getAttr('uniqueItems')
+        ) {
             return $result;
         }
+
         $example = $this->property->getAttr('example');
         $example = VarExporter::export($example);
         return str_replace('$faker->', '$faker->optional(0.92, ' . $example . ')->', $result);
@@ -277,8 +280,6 @@ private function fakeForArray(SpecObjectInterface $property, int $count = 4): st
             $uniqueItems = $property->uniqueItems;
         }
 
-        // TODO consider example of OpenAPI spec
-
         /** @var Schema|Reference|null $items */
         $items = $property->items;
 
@@ -308,13 +309,6 @@ private function fakeForArray(SpecObjectInterface $property, int $count = 4): st
             return $this->wrapInArray($result, $uniqueItems, $count);
         }
 
-        // TODO more complex type array/object; also consider $ref; may be recursively; may use `oneOf`
-
-//        return '$faker->words()'; // TODO implement faker for array; also consider min, max, unique
-
-//        if ($this->attribute->required) {
-//            return '["a" => "b"]'; // TODO this is incorrect, array schema should be checked first
-//        }
         return '[]';
     }
 
@@ -383,7 +377,8 @@ public function wrapInArray(string $aFaker, bool $uniqueItems, int $count, bool
 
     public function arbitraryArray(): string
     {
-        return '$faker->words()';
+        $theFaker = $this->property->getAttr('uniqueItems') ? '$uniqueFaker' : '$faker';
+        return $theFaker . '->words()';
     }
 
     /**

src/lib/items/Attribute.php

@@ -7,19 +7,13 @@
 
 namespace cebe\yii2openapi\lib\items;
 
-use yii\helpers\VarDumper;
-use \Yii;
-use cebe\yii2openapi\lib\openapi\PropertySchema;
-use cebe\yii2openapi\generator\ApiGenerator;
+use cebe\yii2openapi\db\ColumnSchema;
 use cebe\yii2openapi\lib\exceptions\InvalidDefinitionException;
+use cebe\yii2openapi\lib\openapi\PropertySchema;
 use yii\base\BaseObject;
-use cebe\yii2openapi\db\ColumnSchema;
-use yii\helpers\Inflector;
-use yii\helpers\StringHelper;
-use yii\db\mysql\Schema as MySqlSchema;
-use SamIT\Yii2\MariaDb\Schema as MariaDbSchema;
-use yii\db\pgsql\Schema as PgSqlSchema;
+use yii\base\InvalidConfigException;
 use yii\base\NotSupportedException;
+use yii\helpers\Inflector;
 use function is_array;
 use function strtolower;
 
@@ -302,7 +296,7 @@ public function getFormattedDescription():string
         return $type.' $'.str_replace("\n", "\n * ", rtrim($comment));
     }
 
-    public function toColumnSchema():ColumnSchema
+    public function toColumnSchema(): ColumnSchema
     {
         $column = new ColumnSchema([
             'name' => $this->columnName,
@@ -333,7 +327,11 @@ public function toColumnSchema():ColumnSchema
     }
 
     /**
-     * @throws \yii\base\InvalidConfigException
+     * @param string $dbType
+     * @return string
+     * @throws InvalidDefinitionException
+     * @throws NotSupportedException
+     * @throws InvalidConfigException
      */
     private function yiiAbstractTypeForDbSpecificType(string $dbType): string
     {

tests/specs/issue_fix/20_consider_openapi_spec_examples_in_faker_code_generation/index.yaml

@@ -52,8 +52,8 @@ components:
           items: { } # array of arbitrary types e.g. [ "hello", -2, true, [5.7], {"id": 5} ]
           minItems: 6
           maxItems: 10
-          uniqueItems: true
-          # example: ['long-tail', 'short-tail', 'black', 'white']
+          # uniqueItems: true
+          example: [ 'long-tail', 'short-tail', 'black', 'white' ]
         number_arr:
           type: array
           items:
@@ -68,6 +68,8 @@ components:
 
         int_arr:
           type: array
+          #          uniqueItems: true
+          example: [ 4, 5 ]
           items:
             type: integer
 
@@ -158,6 +160,9 @@ components:
                     properties:
                       id:
                         type: integer
+                      title:
+                        type: string
+                        maxLength: 4
 
         user_ref_obj_arr_normal: # faker for this won't be generated
           type: array