Support namespace definition on JSON schema type - close #11

Author: sandrokeil

src/Shorthand/Shorthand.php

@@ -126,18 +126,26 @@ private static function convertShorthandStringToJsonSchema(string $shorthandStr)
             ];
         }
 
+        $type = $parts[0];
+        $namespace = '';
+        $namespaceDetected = false !== \strpos($parts[0], '/');
+
+        if ($namespaceDetected) {
+            $namespace = self::extractNamespace($type);
+            $type = self::extractType($type);
+        }
+
         switch (true) {
-            case \mb_strpos($parts[0], 'string') === 0:
-            case \mb_strpos($parts[0], 'integer') === 0:
-            case \mb_strpos($parts[0], 'number') === 0:
-            case \mb_strpos($parts[0], 'boolean') === 0:
-            case \mb_strpos($parts[0], 'enum:') === 0:
-                $type = $parts[0];
+            case \mb_strpos($type, 'string') === 0:
+            case \mb_strpos($type, 'integer') === 0:
+            case \mb_strpos($type, 'number') === 0:
+            case \mb_strpos($type, 'boolean') === 0:
+            case \mb_strpos($type, 'enum:') === 0:
                 $typeKey = 'type';
                 $typeValue = $type;
 
-                if (\mb_strpos($parts[0], 'enum:') === 0) {
-                    $typeValue = \explode(',', \mb_substr($parts[0], 5));
+                if (\mb_strpos($type, 'enum:') === 0) {
+                    $typeValue = \explode(',', \mb_substr($type, 5));
                     $typeKey = 'enum';
                 }
 
@@ -150,13 +158,19 @@ private static function convertShorthandStringToJsonSchema(string $shorthandStr)
                 $schema = self::populateSchema($parts);
                 $schema[$typeKey] = $typeValue;
 
+                if ($namespaceDetected) {
+                    $schema['namespace'] = \strlen($namespace) > 1 ? \rtrim($namespace, '/') : $namespace;
+                }
+
                 return $schema;
             default:
-                $type = $parts[0];
-
                 $schema = self::populateSchema($parts);
 
-                $schema['$ref'] = '#/definitions/'.$type;
+                $schema['$ref'] = '#/definitions/' . \ltrim($namespace, '/') . $type;
+
+                if ($namespaceDetected) {
+                    $schema['namespace'] = \strlen($namespace) > 1 ? \rtrim($namespace, '/') : $namespace;
+                }
 
                 return $schema;
         }
@@ -218,4 +232,14 @@ private static function parseShorthandValidation(string $shorthandValidation): a
 
         return [$validationKey, $value];
     }
+
+    private static function extractType(string $type): string
+    {
+        return \trim(\substr($type, \strrpos($type, '/') + 1), '/');
+    }
+
+    private static function extractNamespace(string $type): string
+    {
+        return \substr($type, 0, \strrpos($type, '/') + 1);
+    }
 }

tests/Type/ObjectTypeTest.php

@@ -140,6 +140,65 @@ public function it_supports_definition_of_objects_shorthand(): void
         $this->assertSame(['namespace' => 'Order'], $address->custom());
     }
 
+    /**
+     * @test
+     */
+    public function it_supports_definition_of_objects_shorthand_type_ns(): void
+    {
+        $json = \file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'schema_with_objects_shorthand_type_ns.json');
+        $decodedJson = \json_decode($json, true, 512, \JSON_BIGINT_AS_STRING | \JSON_THROW_ON_ERROR);
+
+        $typeSet = Type::fromShorthand($decodedJson);
+
+        $this->assertCount(1, $typeSet);
+
+        /** @var ObjectType $type */
+        $type = $typeSet->first();
+        $this->assertInstanceOf(ObjectType::class, $type);
+        $this->assertFalse($type->additionalProperties());
+
+        $required = $type->required();
+        $this->assertCount(4, $required);
+        $this->assertContains('uuid', $required);
+        $this->assertContains('salutation', $required);
+        $this->assertContains('billing_address', $required);
+        $this->assertContains('shipping_address', $required);
+
+        $properties = $type->properties();
+        $this->assertCount(4, $properties);
+        $this->assertArrayHasKey('uuid', $properties);
+        $this->assertArrayHasKey('salutation', $properties);
+        $this->assertArrayHasKey('shipping_address', $properties);
+        $this->assertArrayHasKey('shipping_address', $properties);
+
+        /** @var StringType $uuid */
+        $uuid = $properties['uuid']->first();
+        $this->assertInstanceOf(StringType::class, $uuid);
+        $this->assertSame('uuid', $uuid->format());
+        $this->assertSame(['namespace' => '/'], $uuid->custom());
+
+        /** @var StringType $salutation */
+        $salutation = $properties['salutation']->first();
+        $this->assertInstanceOf(StringType::class, $salutation);
+        $this->assertSame(['MR', 'MRS'], $salutation->enum());
+        $this->assertSame(['namespace' => '/Contact'], $salutation->custom());
+
+        /** @var ReferenceType $billingAddress */
+        $billingAddress = $properties['billing_address']->first();
+        $this->assertInstanceOf(ReferenceType::class, $billingAddress);
+        $this->assertSame(['namespace' => 'Order'], $billingAddress->custom());
+
+        /** @var ArrayType $shippingAddress */
+        $shippingAddress = $properties['shipping_address']->first();
+        $this->assertInstanceOf(ArrayType::class, $shippingAddress);
+        $this->assertSame([], $shippingAddress->custom());
+
+        /** @var ReferenceType $address */
+        $address = $shippingAddress->items()[0]->first();
+        $this->assertInstanceOf(ReferenceType::class, $address);
+        $this->assertSame(['namespace' => 'Order'], $address->custom());
+    }
+
     /**
      * @test
      */

tests/Type/_files/schema_with_objects_shorthand_type_ns.json

@@ -0,0 +1,6 @@
+{
+    "uuid": "/string|format:uuid",
+    "salutation": "/Contact/enum:MR,MRS",
+    "billing_address": "Order/Address",
+    "shipping_address": "Order/Address[]"
+}