Merge pull request #126 from php-api-clients/better-generated-example-values-for-formatted-strings

Better generated examples values for formatted strings

Author: WyriHaximus

composer.json

@@ -35,7 +35,8 @@
         "eventsauce/object-hydrator": "^1.2",
         "react/async": "^4.0",
         "wyrihaximus/react-awaitable-observable": "^1.0",
-        "ckr/arraymerger": "^3.0"
+        "ckr/arraymerger": "^3.0",
+        "ramsey/uuid": "^4.7"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -6,6 +6,7 @@
 use ApiClients\Tools\OpenApiClientGenerator\Representation\PropertyType;
 use cebe\openapi\spec\Schema as baseSchema;
 use Ckr\Util\ArrayMerger;
+use Ramsey\Uuid\Uuid;
 
 final class Property
 {
@@ -45,11 +46,11 @@ public static function gather(
         );
         if ($type->payload instanceof \ApiClients\Tools\OpenApiClientGenerator\Representation\Schema) {
             if (count($type->payload->properties) === 0) {
-                $type = new PropertyType('scalar', 'mixed', false);
+                $type = new PropertyType('scalar', null, 'mixed', false);
             }
         } else if ($type->payload instanceof PropertyType && $type->payload->payload instanceof \ApiClients\Tools\OpenApiClientGenerator\Representation\Schema) {
             if (count($type->payload->payload->properties) === 0) {
-                $type = new PropertyType('scalar', 'mixed', false);
+                $type = new PropertyType('scalar', null, 'mixed', false);
             }
         }
         $exampleData = self::generateExampleData($exampleData, $type, $propertyName);
@@ -77,7 +78,23 @@ private static function generateExampleData(mixed $exampleData, PropertyType $ty
             } elseif ($type->payload === 'bool') {
                 return false;
             } elseif ($type->payload === 'string') {
-                return 'generated_' . $propertyName;
+                if ($type->format === 'uri') {
+                    return 'https://example.com/';
+                }
+                if ($type->format === 'date-time') {
+                    return date(\DateTimeInterface::RFC3339, 0);
+                }
+                if ($type->format === 'uuid') {
+                    return Uuid::getFactory()->uuid6()->toString();
+                }
+                if ($type->format === 'ipv4') {
+                    return '127.0.0.1';
+                }
+                if ($type->format === 'ipv6') {
+                    return '::1';
+                }
+
+                return 'generated_' . $propertyName . '_' . ($type->format ?? 'null');
             }
         }
 

src/Gatherer/Property.php

@@ -67,6 +67,7 @@ public static function gather(
         if ($type === 'array') {
             return new PropertyType(
                 'array',
+                null,
                 Type::gather($className, $propertyName, $property->items, $required, $schemaRegistry),
                 $nullable
             );
@@ -93,6 +94,7 @@ public static function gather(
         if ($type === '') {
             return new PropertyType(
                 'scalar',
+                null,
                 'mixed',
                 false,
             );
@@ -101,6 +103,7 @@ public static function gather(
         if ($type === 'object') {
             return new PropertyType(
                 'object',
+                null,
                 Schema::gather(
                     $schemaRegistry->get($property, $className . '\\' . Utils::className($propertyName)),
                     $property,
@@ -112,6 +115,7 @@ public static function gather(
 
         return new PropertyType(
             'scalar',
+            $property->format ?? null,
             $type,
             $nullable,
         );

src/Gatherer/Type.php

@@ -6,6 +6,7 @@ final class PropertyType
 {
     public function __construct(
         public readonly string $type,
+        public readonly ?string $format,
         public readonly string|Schema|PropertyType $payload,
         public readonly bool $nullable,
     ){