Unit tests for format property (#9)

Author: PaulHendriks

tests/Unit/Attribute/FieldTest.php

@@ -6,13 +6,14 @@
 
 use PHPUnit\Framework\TestCase;
 use Spiral\JsonSchemaGenerator\Attribute\Field;
+use Spiral\JsonSchemaGenerator\Schema\Format;
 
 final class FieldTest extends TestCase
 {
     #[Field]
     private string $default = '';
 
-    #[Field(title: 'Title', description: 'Description', default: 'foo')]
+    #[Field(title: 'Title', description: 'Description', default: 'foo', format: Format::Email)]
     private string $withValues = 'foo';
 
     public function testFieldWithDefaultValues(): void
@@ -36,4 +37,13 @@ public function testFieldWithValues(): void
         $this->assertSame('Description', $attr->description);
         $this->assertSame('foo', $attr->default);
     }
+
+    public function testFieldWithFormat(): void
+    {
+        $ref = new \ReflectionProperty(self::class, 'withValues');
+
+        $attr = $ref->getAttributes(Field::class)[0]->newInstance();
+        $this->assertInstanceOf('Spiral\JsonSchemaGenerator\Schema\Format', $attr->format);
+        $this->assertSame('email', $attr->format->value);
+    }
 }

tests/Unit/Fixture/Movie.php

@@ -5,6 +5,7 @@
 namespace Spiral\JsonSchemaGenerator\Tests\Unit\Fixture;
 
 use Spiral\JsonSchemaGenerator\Attribute\Field;
+use Spiral\JsonSchemaGenerator\Schema\Format;
 
 class Movie
 {
@@ -18,5 +19,7 @@ public function __construct(
         public readonly ?string $director = null,
         #[Field(title: 'Release Status', description: 'The release status of the movie')]
         public readonly ?ReleaseStatus $releaseStatus = null,
+        #[Field(title: 'Release date', description: 'The release date of the movie', format: Format::Date)]
+        public readonly ?string $releaseDate = null,
     ) {}
 }

tests/Unit/GeneratorTest.php

@@ -46,6 +46,12 @@ public function testGenerateMovie(): void
                             ],
                         ],
                     ],
+                    'releaseDate'      => [
+                        'type' => 'string',
+                        'format' => 'date',
+                        'title' => 'Release date',
+                        'description' => 'The release date of the movie',
+                    ],
                 ],
                 'required'    => [
                     'title',
@@ -142,6 +148,12 @@ public function testGenerateActor(): void
                                     ],
                                 ],
                             ],
+                            'releaseDate'      => [
+                                'type' => 'string',
+                                'format' => 'date',
+                                'title' => 'Release date',
+                                'description' => 'The release date of the movie',
+                            ],
                         ],
                         'required'   => [
                             'title',

tests/Unit/Schema/PropertyTest.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Spiral\JsonSchemaGenerator\Exception\InvalidTypeException;
+use Spiral\JsonSchemaGenerator\Schema\Format;
 use Spiral\JsonSchemaGenerator\Schema\Property;
 use Spiral\JsonSchemaGenerator\Schema\Type;
 use Spiral\JsonSchemaGenerator\Tests\Unit\Fixture\Actor;
@@ -147,4 +148,16 @@ public function testInvalidTypeException(): void
         $this->expectException(InvalidTypeException::class);
         new Property(type: 'foo');
     }
+
+    public function testPropertyWithFormat(): void
+    {
+        $property = new Property(type: Type::String, title: 'Homepage', format: Format::Uri);
+
+        $this->assertEquals([
+            'type' => 'string',
+            'title' => 'Homepage',
+            'format' => 'uri',
+        ], $property->jsonSerialize());
+    }
+
 }