Improve shorthand syntax - Close #8

Author: sandrokeil

src/Shorthand/Shorthand.php

@@ -17,9 +17,10 @@ final class Shorthand
 {
     /**
      * @param array<string, mixed> $shorthand
+     * @param string|null $namespace
      * @return array<string, mixed>
      */
-    public static function convertToJsonSchema(array $shorthand): array
+    public static function convertToJsonSchema(array $shorthand, ?string $namespace = null): array
     {
         $schema = [
             'type' => 'object',
@@ -30,6 +31,10 @@ public static function convertToJsonSchema(array $shorthand): array
             'additionalProperties' => false,
         ];
 
+        if ($namespace !== null) {
+            $schema['namespace'] = $namespace;
+        }
+
         foreach ($shorthand as $property => $shorthandDefinition) {
             if (! \is_string($property) || empty($property)) {
                 throw InvalidShorthand::emptyString($shorthand);
@@ -100,10 +105,6 @@ private static function convertShorthandStringToJsonSchema(string $shorthandStr)
 
         $parts = \explode('|', $shorthandStr);
 
-        if ($parts[0] === 'enum') {
-            return ['enum' => \array_slice($parts, 1)];
-        }
-
         if (\mb_substr($parts[0], -2) === '[]') {
             $itemsParts = [\mb_substr($parts[0], 0, -2)];
             \array_push($itemsParts, ...\array_slice($parts, 1));
@@ -114,39 +115,63 @@ private static function convertShorthandStringToJsonSchema(string $shorthandStr)
             ];
         }
 
-        switch ($parts[0]) {
-            case 'string':
-            case 'integer':
-            case 'number':
-            case 'boolean':
+        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];
+                $typeKey = 'type';
+                $typeValue = $type;
+
+                if (\mb_strpos($parts[0], 'enum:') === 0) {
+                    $typeValue = \explode(',', \mb_substr($parts[0], 5));
+                    $typeKey = 'enum';
+                }
 
                 if (isset($parts[1]) && $parts[1] === 'null') {
-                    $type = [$type, 'null'];
+                    $typeValue = [$type, 'null'];
 
                     \array_splice($parts, 1, 1);
                 }
 
-                $schema = ['type' => $type];
+                $schema = self::populateSchema($parts);
+                $schema[$typeKey] = $typeValue;
 
-                if (\count($parts) > 1) {
-                    $parts = \array_slice($parts, 1);
+                return $schema;
+            default:
+                $type = $parts[0];
 
-                    foreach ($parts as $part) {
-                        [$validationKey, $validationValue] = self::parseShorthandValidation($part);
+                $schema = self::populateSchema($parts);
 
-                        $schema[$validationKey] = $validationValue;
-                    }
-                }
+                $schema['$ref'] = '#/definitions/'.$type;
 
                 return $schema;
-            default:
-                return [
-                    '$ref' => '#/definitions/'.$parts[0],
-                ];
         }
     }
 
+    /**
+     * @param array<int, mixed> $parts
+     * @return array<string, mixed>
+     */
+    private static function populateSchema(array $parts): array
+    {
+        $schema = [];
+
+        if (\count($parts) > 1) {
+            $parts = \array_slice($parts, 1);
+
+            foreach ($parts as $part) {
+                [$validationKey, $validationValue] = self::parseShorthandValidation($part);
+
+                $schema[$validationKey] = $validationValue;
+            }
+        }
+
+        return $schema;
+    }
+
     /**
      * @param string $shorthandValidation
      * @return array<mixed>

tests/Shorthand/ShorthandTest.php

@@ -35,7 +35,7 @@ public function it_converts_empty_shorthand_string_to_json_schema_string(): void
      */
     public function it_converts_enum_shorthand_to_json_schema_string(): void
     {
-        $schema = Shorthand::convertToJsonSchema(['test' => 'enum|available|blocked|bought']);
+        $schema = Shorthand::convertToJsonSchema(['test' => 'enum:available,blocked,bought']);
 
         $this->assertEquals($this->jsonSchemaObject(
             ['test' => ['enum' => ['available', 'blocked', 'bought']]],

tests/Type/TypeTest.php

@@ -43,7 +43,7 @@ public function it_supports_shorthand_definition(): void
      */
     public function it_supports_string_enums_without_type(): void
     {
-        $typeSet = Type::fromShorthand(['contentLanguage' => 'enum|de-DE|en-US'], 'Content');
+        $typeSet = Type::fromShorthand(['contentLanguage' => 'enum:de-DE,en-US'], 'Content');
 
         $this->assertCount(1, $typeSet);