Improve Schema API

Author: nyamsprod

src/Schema/JsonFieldTest.php

@@ -130,11 +130,11 @@ public function testInvalidConstructorArgumentsThrow(): void
 
     public function test_metadata_contains_expected_structure(): void
     {
-        $field = new JsonField(depth: 0, flags: JSON_BIGINT_AS_STRING);
+        $field = new JsonField(depth: 2, flags: JSON_BIGINT_AS_STRING);
 
         self::assertSame([
             'flags' => JSON_BIGINT_AS_STRING,
-            'depth' => 0,
+            'depth' => 2,
         ], $field->metadata()->all());
     }
 }

src/Schema/StructuredStringField.php

@@ -19,16 +19,9 @@
 
 final class StructuredStringField extends FieldEvaluator implements Field
 {
-    /** @var non-empty-string */
-    public readonly string $name;
-    public readonly string $pattern;
-
-    public function __construct(StructuredStringFieldDefinition $definition)
+    public function __construct(public readonly StructuredStringFieldDefinition $definition)
     {
         parent::__construct($definition->confidenceThreshold);
-
-        $this->name = $definition->name;
-        $this->pattern = $definition->pattern;
     }
 
     public static function uuid(float $confidenceThreshold = 0.8): self
@@ -80,7 +73,7 @@ public function type(): FieldType
 
     public function name(): string
     {
-        return $this->name;
+        return $this->definition->fieldTypeName;
     }
 
     public function parse(mixed $value): ?string
@@ -91,13 +84,13 @@ public function parse(mixed $value): ?string
 
         $value = trim($value);
 
-        return ('' === $value || 1 !== preg_match($this->pattern, $value)) ? null : $value;
+        return ('' === $value || 1 !== preg_match($this->definition->pattern, $value)) ? null : $value;
     }
 
     public function metadata(): FieldMetadata
     {
         return new FieldMetadata([
-            'pattern' => $this->pattern,
+            'pattern' => $this->definition->pattern,
         ]);
     }
 }

src/Schema/StructuredStringFieldDefinition.php

@@ -19,29 +19,24 @@
 
 final readonly class StructuredStringFieldDefinition
 {
-    /** @var non-empty-string */
-    public string $name;
-    public string $pattern;
-    public float $confidenceThreshold;
-
+    /**
+     * @param non-empty-string $fieldTypeName
+     * @param non-empty-string $pattern
+     */
     public function __construct(
-        string $name,
-        string $pattern,
-        float $confidenceThreshold,
+        public string $fieldTypeName,
+        public string $pattern,
+        public float $confidenceThreshold,
     ) {
         ($confidenceThreshold >= 0 && $confidenceThreshold <= 1) || throw new ValueError('the confidence threshold must be between 0 and 1.');
-        false !== @preg_match($pattern, '') || throw new ValueError('the regular expression pattern "'.$pattern.'" is not valid. Did you forget the delimiter?');
-        ('' !== $name && 1 === preg_match('/^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/', $name)) || throw new ValueError('The name "'.$name.'" is not a valid snake case variable name.');
-
-        $this->name = $name;
-        $this->pattern = $pattern;
-        $this->confidenceThreshold = $confidenceThreshold;
+        ('' !== $pattern && false !== @preg_match($pattern, '')) || throw new ValueError('the regular expression pattern "'.$pattern.'" is not valid. Did you forget the delimiter?');
+        ('' !== $fieldTypeName && 1 === preg_match('/^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/', $fieldTypeName)) || throw new ValueError('The name "'.$fieldTypeName.'" is not a valid snake case variable name.');
     }
 
     public static function uuid(float $confidenceThreshold = 0.8): self
     {
         return new self(
-            name: 'uuid',
+            fieldTypeName: 'uuid',
             pattern: '/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i',
             confidenceThreshold: $confidenceThreshold,
         );
@@ -50,7 +45,7 @@ public static function uuid(float $confidenceThreshold = 0.8): self
     public static function ulid(float $confidenceThreshold = 0.8): self
     {
         return new self(
-            name: 'ulid',
+            fieldTypeName: 'ulid',
             pattern: '/^[0-9A-HJKMNP-TV-Z]{26}$/i',
             confidenceThreshold: $confidenceThreshold,
         );
@@ -59,7 +54,7 @@ public static function ulid(float $confidenceThreshold = 0.8): self
     public static function jwtToken(float $confidenceThreshold = 0.8): self
     {
         return new self(
-            name: 'jwt_token',
+            fieldTypeName: 'jwt_token',
             pattern: '/^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$/i',
             confidenceThreshold: $confidenceThreshold,
         );
@@ -68,7 +63,7 @@ public static function jwtToken(float $confidenceThreshold = 0.8): self
     public static function hexColor(float $confidenceThreshold = 0.8): self
     {
         return new self(
-            name: 'hex_color',
+            fieldTypeName: 'hex_color',
             pattern: '/^#(?:[0-9a-fA-F]{3}){1,2}$/i',
             confidenceThreshold: $confidenceThreshold,
         );
@@ -77,7 +72,7 @@ public static function hexColor(float $confidenceThreshold = 0.8): self
     public static function md5(float $confidenceThreshold = 0.8): self
     {
         return new self(
-            name: 'md5',
+            fieldTypeName: 'md5',
             pattern: '/^[a-fA-F0-9]{32}$/',
             confidenceThreshold: $confidenceThreshold,
         );
@@ -86,7 +81,7 @@ public static function md5(float $confidenceThreshold = 0.8): self
     public static function sha1(float $confidenceThreshold = 0.8): self
     {
         return new self(
-            name: 'sha1',
+            fieldTypeName: 'sha1',
             pattern: '/^[a-fA-F0-9]{40}$/',
             confidenceThreshold: $confidenceThreshold,
         );
@@ -96,6 +91,10 @@ public function withConfidenceThreshold(float $confidenceThreshold): self
     {
         return $this->confidenceThreshold === $confidenceThreshold
             ? $this
-            : new self(name: $this->name, pattern: $this->pattern, confidenceThreshold: $confidenceThreshold);
+            : new self(
+                fieldTypeName: $this->fieldTypeName,
+                pattern: $this->pattern,
+                confidenceThreshold: $confidenceThreshold
+            );
     }
 }

src/Schema/StructuredStringFieldTest.php

@@ -154,6 +154,6 @@ public function test_metadata_contains_expected_structure(): void
     {
         $field = StructuredStringField::hexColor();
 
-        self::assertSame(['pattern' => $field->pattern], $field->metadata()->all());
+        self::assertSame(['pattern' => $field->definition->pattern], $field->metadata()->all());
     }
 }