Infrastructure for extensible format string validators

Author: wol-soft

src/Model/GeneratorConfiguration.php

@@ -7,6 +7,8 @@
 use PHPModelGenerator\Exception\InvalidFilterException;
 use PHPModelGenerator\Filter\FilterInterface;
 use PHPModelGenerator\Filter\TransformingFilterInterface;
+use PHPModelGenerator\Format\FormatValidatorFromRegEx;
+use PHPModelGenerator\Format\FormatValidatorInterface;
 use PHPModelGenerator\PropertyProcessor\Filter\DateTimeFilter;
 use PHPModelGenerator\PropertyProcessor\Filter\NotEmptyFilter;
 use PHPModelGenerator\PropertyProcessor\Filter\TrimFilter;
@@ -39,10 +41,14 @@ class GeneratorConfiguration
     protected $errorRegistryClass = ErrorRegistryException::class;
     /** @var bool */
     protected $serialization = false;
+
     /** @var ClassNameGeneratorInterface */
     protected $classNameGenerator;
+
     /** @var FilterInterface[] */
     protected $filter;
+    /** @var FormatValidatorInterface[] */
+    protected $formats;
 
     /**
      * GeneratorConfiguration constructor.
@@ -51,10 +57,9 @@ public function __construct()
     {
         $this->classNameGenerator = new ClassNameGenerator();
 
-        $this
-            ->addFilter(new DateTimeFilter())
-            ->addFilter(new NotEmptyFilter())
-            ->addFilter(new TrimFilter());
+        // add all built-in filter and format validators
+        $this->initFilter();
+        $this->initFormatValidator();
     }
 
     /**
@@ -90,6 +95,31 @@ public function addFilter(FilterInterface $filter): self
         return $this;
     }
 
+    /**
+     * Add an additional format
+     *
+     * @param string $formatKey
+     * @param FormatValidatorInterface $format
+     *
+     * @return $this
+     */
+    public function addFormat(string $formatKey, FormatValidatorInterface $format): self
+    {
+        $this->formats[$formatKey] = $format;
+
+        return $this;
+    }
+
+    /**
+     * @param string $formatKey
+     *
+     * @return FormatValidatorInterface|null
+     */
+    public function getFormat(string $formatKey): ?FormatValidatorInterface
+    {
+        return $this->formats[$formatKey] ?? null;
+    }
+
     /**
      * @param array $callback
      * @param string $message
@@ -318,4 +348,17 @@ public function setImplicitNull(bool $allowImplicitNull): self
 
         return $this;
     }
+
+    private function initFilter(): void
+    {
+        $this
+            ->addFilter(new DateTimeFilter())
+            ->addFilter(new NotEmptyFilter())
+            ->addFilter(new TrimFilter());
+    }
+
+    // TODO: add builtin format validators
+    private function initFormatValidator(): void
+    {
+    }
 }

src/Model/Validator/FormatValidator.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Model\Validator;
+
+use PHPModelGenerator\Exception\String\FormatException;
+use PHPModelGenerator\Format\FormatValidatorFromRegEx;
+use PHPModelGenerator\Format\FormatValidatorInterface;
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+/**
+ * Class FormatValidator
+ *
+ * @package PHPModelGenerator\Model\Validator
+ */
+class FormatValidator extends AbstractPropertyValidator
+{
+    /** @var FormatValidatorInterface */
+    protected $validator;
+
+    /**
+     * FormatValidator constructor.
+     *
+     * @param PropertyInterface $property
+     * @param FormatValidatorInterface $validator
+     * @param array $exceptionParams
+     */
+    public function __construct(
+        PropertyInterface $property,
+        FormatValidatorInterface $validator,
+        array $exceptionParams = []
+    ) {
+        $this->validator = $validator;
+
+        parent::__construct($property, FormatException::class, $exceptionParams);
+    }
+
+    /**
+     * Get the source code for the check to perform
+     *
+     * @return string
+     */
+    public function getCheck(): string
+    {
+        return $this->validator instanceof FormatValidatorFromRegEx
+            ? sprintf(
+                '!\%s::validate($value, %s)',
+                get_class($this->validator),
+                var_export($this->validator->getPattern(), true)
+            )
+            : sprintf('!\%s::validate($value)', get_class($this->validator));
+    }
+}

src/Model/Validator/PropertyValidator.php

@@ -36,7 +36,7 @@ public function __construct(
     }
 
     /**
-     * Get the source code for the coeck to perform
+     * Get the source code for the check to perform
      *
      * @return string
      */

src/PropertyProcessor/Property/StringProcessor.php

@@ -10,6 +10,7 @@
 use PHPModelGenerator\Exception\String\PatternException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\SchemaDefinition\JsonSchema;
+use PHPModelGenerator\Model\Validator\FormatValidator;
 use PHPModelGenerator\Model\Validator\PropertyValidator;
 
 /**
@@ -22,6 +23,7 @@ class StringProcessor extends AbstractTypedValueProcessor
     protected const TYPE = 'string';
 
     protected const JSON_FIELD_PATTERN = 'pattern';
+    protected const JSON_FIELD_FORMAT = 'format';
     protected const JSON_FIELD_MIN_LENGTH = 'minLength';
     protected const JSON_FIELD_MAX_LENGTH = 'maxLength';
 
@@ -100,23 +102,38 @@ protected function addLengthValidator(PropertyInterface $property, JsonSchema $p
     }
 
     /**
-     * TODO: implement format validations
-     *
      * @param PropertyInterface $property
      * @param JsonSchema $propertySchema
      *
      * @throws SchemaException
      */
     protected function addFormatValidator(PropertyInterface $property, JsonSchema $propertySchema): void
     {
-        if (isset($propertySchema->getJson()['format'])) {
+        if (!isset($propertySchema->getJson()[self::JSON_FIELD_FORMAT])) {
+            return;
+        }
+
+        $formatValidator = $this->schemaProcessor
+            ->getGeneratorConfiguration()
+            ->getFormat($propertySchema->getJson()[self::JSON_FIELD_FORMAT]);
+
+        if (!$formatValidator) {
             throw new SchemaException(
                 sprintf(
-                    'Format is currently not supported for property %s in file %s',
+                    'Unsupported format %s for property %s in file %s',
+                    $propertySchema->getJson()[self::JSON_FIELD_FORMAT],
                     $property->getName(),
                     $propertySchema->getFile()
                 )
             );
         }
+
+        $property->addValidator(
+            new FormatValidator(
+                $property,
+                $formatValidator,
+                [$propertySchema->getJson()[self::JSON_FIELD_FORMAT]]
+            )
+        );
     }
 }