adjustments

cortexphp · Jan 15, 2025 · e978ba5 · e978ba5
1 parent f20a682
commit e978ba5
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 17 deletions.
diff --git a/src/Converters/FromClosure.php → src/Converters/ClosureConverter.php b/src/Converters/FromClosure.php → src/Converters/ClosureConverter.php
@@ -17,11 +17,15 @@
 use Cortex\JsonSchema\Types\ObjectSchema;
 use Cortex\JsonSchema\Exceptions\SchemaException;
 
-class FromClosure
+class ClosureConverter
 {
-    public static function convert(Closure $closure): ObjectSchema
+    public function __construct(
+        protected Closure $closure,
+    ) {}
+
+    public function convert(): ObjectSchema
     {
-        $reflection = new ReflectionFunction($closure);
+        $reflection = new ReflectionFunction($this->closure);
         $schema = new ObjectSchema();
 
         // TODO: handle descriptions
@@ -40,6 +44,7 @@ protected static function getSchemaFromReflectionParameter(ReflectionParameter $
     {
         $type = $parameter->getType();
 
+        // @phpstan-ignore argument.type
         $schema = self::getSchemaFromReflectionType($type);
 
         $schema->title($parameter->getName());
@@ -64,6 +69,7 @@ protected static function getSchemaFromReflectionParameter(ReflectionParameter $
                 $reflection = new ReflectionEnum($typeName);
 
                 if ($reflection->isBacked()) {
+                    /** @var non-empty-array<array-key, \BackedEnum> */
                     $cases = $typeName::cases();
                     $schema->enum(array_map(fn($case): int|string => $case->value, $cases));
                 }
@@ -81,10 +87,12 @@ protected static function getSchemaFromReflectionType(
     ): Schema {
         $schemaTypes = match (true) {
             $type instanceof ReflectionUnionType, $type instanceof ReflectionIntersectionType => array_map(
+                // @phpstan-ignore argument.type
                 fn(ReflectionNamedType $t): SchemaType => self::resolveSchemaType($t),
                 $type->getTypes(),
             ),
             // If the parameter is not typed or explicitly typed as mixed, we use all schema types
+            // TODO: use phpstan parser to get the type also
             in_array($type?->getName(), ['mixed', null], true) => SchemaType::cases(),
             default => [self::resolveSchemaType($type)],
         };

diff --git a/src/SchemaFactory.php b/src/SchemaFactory.php
@@ -14,7 +14,7 @@
 use Cortex\JsonSchema\Types\StringSchema;
 use Cortex\JsonSchema\Types\BooleanSchema;
 use Cortex\JsonSchema\Types\IntegerSchema;
-use Cortex\JsonSchema\Converters\FromClosure;
+use Cortex\JsonSchema\Converters\ClosureConverter;
 
 class SchemaFactory
 {
@@ -68,6 +68,6 @@ public static function mixed(?string $title = null): UnionSchema
 
     public static function fromClosure(Closure $closure): ObjectSchema
     {
-        return FromClosure::convert($closure);
+        return (new ClosureConverter($closure))->convert();
     }
 }
diff --git a/tests/Unit/Converters/FromClosureTest.php → .../Unit/Converters/ClosureConverterTest.php b/tests/Unit/Converters/FromClosureTest.php → .../Unit/Converters/ClosureConverterTest.php
@@ -5,11 +5,11 @@
 namespace Cortex\JsonSchema\Tests\Unit\Converters;
 
 use Cortex\JsonSchema\Types\ObjectSchema;
-use Cortex\JsonSchema\Converters\FromClosure;
+use Cortex\JsonSchema\Converters\ClosureConverter;
 
 it('can create a schema from a closure', function (): void {
     $closure = function (string $name, array $fooArray, ?int $age = null): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -44,7 +44,7 @@ enum MyEnum: string
     }
 
     $closure = function (MyEnum $myEnum, bool $foo = true): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -78,7 +78,7 @@ enum Status: int
     }
 
     $closure = function (Status $status): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -102,7 +102,7 @@ enum Status: int
 
 it('can create a schema from a closure with a union type', function (): void {
     $closure = function (int|string $foo): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -124,7 +124,7 @@ enum Status: int
 
 it('can create a schema from a closure with a nullable union type', function (): void {
     $closure = function (int|string|null $foo): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -147,7 +147,7 @@ enum Status: int
 
 it('can create a schema from a closure with array type hints', function (): void {
     $closure = function (array $items, array $tags = ['default']): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -170,7 +170,7 @@ enum Status: int
 
 it('can create a schema from a closure with mixed type', function (): void {
     $closure = function (mixed $data): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -197,7 +197,7 @@ enum Status: int
 
 it('can create a schema from a closure with object type', function (): void {
     $closure = function (object $data): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -216,7 +216,7 @@ enum Status: int
 
 it('can create a schema from a closure with float type', function (): void {
     $closure = function (float $amount = 0.0): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -240,7 +240,7 @@ enum Status: int
         bool $active = true,
     ): void {};
 
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([
@@ -277,7 +277,7 @@ enum Status: int
 
 it('can create a schema from a closure with array type', function (): void {
     $closure = function (array $items = ['default']): void {};
-    $schema = FromClosure::convert($closure);
+    $schema = (new ClosureConverter($closure))->convert();
 
     expect($schema)->toBeInstanceOf(ObjectSchema::class);
     expect($schema->toArray())->toBe([

diff --git a/tests/Unit/SchemaFactoryTest.php b/tests/Unit/SchemaFactoryTest.php
@@ -50,3 +50,32 @@
     expect($schemaArray)->toHaveKey('readOnly', true);
     expect($schemaArray)->toHaveKey('writeOnly', true);
 });
+
+it('can create a schema from a closure', function (): void {
+    $closure = function (string $name, array $fooArray, ?int $age = null): void {};
+    $schema = Schema::fromClosure($closure);
+
+    expect($schema)->toBeInstanceOf(ObjectSchema::class);
+    expect($schema->toArray())->toBe([
+        'type' => 'object',
+        '$schema' => 'http://json-schema.org/draft-07/schema#',
+        'properties' => [
+            'name' => [
+                'type' => 'string',
+            ],
+            'fooArray' => [
+                'type' => 'array',
+            ],
+            'age' => [
+                'type' => [
+                    'integer',
+                    'null',
+                ],
+            ],
+        ],
+        'required' => [
+            'name',
+            'fooArray',
+        ],
+    ]);
+});