WIP: Improve messages in an array format

- Name: That's what is in the placeholder, and could be used for path and id as well - Id: Tha could be the name of the rule, just a means to identify it and be able to build templates for it on that level. - Path: That's the real path of the rule, which will be useful when dealing with arrays or objects.
Respect · Dec 18, 2024 · 399be98 · 399be98
1 parent aa293de
commit 399be98
Show file tree

Hide file tree

Showing 25 changed files with 219 additions and 136 deletions.
diff --git a/library/Message/StandardFormatter.php b/library/Message/StandardFormatter.php
@@ -14,12 +14,14 @@
 
 use function array_filter;
 use function array_key_exists;
+use function array_merge;
 use function array_reduce;
 use function array_values;
 use function count;
 use function current;
 use function is_array;
 use function is_string;
+use function key;
 use function Respect\Stringifier\stringify;
 use function rtrim;
 use function sprintf;
@@ -97,26 +99,45 @@ public function full(
      */
     public function array(Result $result, array $templates, Translator $translator): array
     {
+        $whoamid = sprintf('%s.%s.%s', $result->rule::class, $result->id, $result->name);
         $selectedTemplates = $this->selectTemplates($result, $templates);
         $deduplicatedChildren = $this->extractDeduplicatedChildren($result);
         if (count($deduplicatedChildren) === 0 || $this->isFinalTemplate($result, $selectedTemplates)) {
             return [
-                $result->id => $this->renderer->render($this->getTemplated($result, $selectedTemplates), $translator),
+                $result->path ?? $result->id => $this->renderer->render(
+                    $this->getTemplated($result, $selectedTemplates),
+                    $translator
+                ),
             ];
         }
 
         $messages = [];
         foreach ($deduplicatedChildren as $child) {
-            $messages[$child->id] = $this->array(
+            $childKey = $child->path ?? $child->id;
+
+            $messages[$childKey] = $this->array(
                 $child,
                 $this->selectTemplates($child, $selectedTemplates),
                 $translator
             );
-            if (count($messages[$child->id]) !== 1) {
+
+            if ($childKey == 'each' && is_array($messages['each'])) {
+                $messages = array_merge($messages, $messages['each']);
+                unset($messages['each']);
+                continue;
+            }
+
+            if (count($messages[$childKey]) !== 1) {
                 continue;
             }
 
-            $messages[$child->id] = current($messages[$child->id]);
+            $grantChildKey = key($messages[$childKey]);
+            if ($grantChildKey != $childKey) {
+                continue;
+            }
+
+
+            $messages[$grantChildKey] = current($messages[$grantChildKey]);
         }
 
         if (count($messages) > 1) {
@@ -172,21 +193,27 @@ private function getTemplated(Result $result, array $templates): Result
             return $result;
         }
 
-        if (!isset($templates[$result->id]) && isset($templates['__root__'])) {
-            return $result->withTemplate($templates['__root__']);
+        $keys = [$result->name, $result->path, $result->id];
+        foreach ($keys as $key) {
+            if (isset($templates[$key]) && is_string($templates[$key])) {
+                return $result->withTemplate($templates[$key]);
+            }
         }
 
-        if (!isset($templates[$result->id])) {
-            return $result;
+        if (isset($templates['__root__'])) {
+            return $result->withTemplate($templates['__root__']);
         }
 
-        $template = $templates[$result->id];
-        if (is_string($template)) {
-            return $result->withTemplate($template);
+        if (!isset($templates[$result->id]) && !isset($templates[$result->path]) && !isset($templates[$result->name])) {
+            return $result;
         }
 
         throw new ComponentException(
-            sprintf('Template for "%s" must be a string, %s given', $result->id, stringify($template))
+            sprintf(
+                'Template for "%s" must be a string, %s given',
+                $result->path ?? $result->name ?? $result->id,
+                stringify($templates)
+            )
         );
     }
 
@@ -195,26 +222,37 @@ private function getTemplated(Result $result, array $templates): Result
      */
     private function isFinalTemplate(Result $result, array $templates): bool
     {
-        if (isset($templates[$result->id]) && is_string($templates[$result->id])) {
-            return true;
+        $keys = [$result->name, $result->path, $result->id];
+        foreach ($keys as $key) {
+            if (isset($templates[$key]) && is_string($templates[$key])) {
+                return true;
+            }
         }
 
         if (count($templates) !== 1) {
             return false;
         }
 
-        return isset($templates['__root__']) || isset($templates[$result->id]);
+        foreach ($keys as $key) {
+            if (isset($templates[$key])) {
+                return true;
+            }
+        }
+
+        return isset($templates['__root__']);
     }
 
     /**
      * @param array<string, mixed> $templates
      *
      * @return array<string, mixed>
      */
-    private function selectTemplates(Result $message, array $templates): array
+    private function selectTemplates(Result $result, array $templates): array
     {
-        if (isset($templates[$message->id]) && is_array($templates[$message->id])) {
-            return $templates[$message->id];
+        foreach ([$result->name, $result->path, $result->id] as $key) {
+            if (isset($templates[$key]) && is_array($templates[$key])) {
+                return $templates[$key];
+            }
         }
 
         return $templates;
@@ -227,7 +265,7 @@ private function extractDeduplicatedChildren(Result $result): array
         $deduplicatedResults = [];
         $duplicateCounters = [];
         foreach ($result->children as $child) {
-            $id = $child->id;
+            $id = $child->path ?? $child->id;
             if (isset($duplicateCounters[$id])) {
                 $id .= '.' . ++$duplicateCounters[$id];
             } elseif (array_key_exists($id, $deduplicatedResults)) {
@@ -236,7 +274,7 @@ private function extractDeduplicatedChildren(Result $result): array
                 $duplicateCounters[$id] = 2;
                 $id .= '.2';
             }
-            $deduplicatedResults[$id] = $child->isValid ? null : $child->withId($id);
+            $deduplicatedResults[$id] = $child->isValid ? null : $child->withId((string) $id);
         }
 
         return array_values(array_filter($deduplicatedResults));

diff --git a/library/Result.php b/library/Result.php
@@ -39,8 +39,8 @@ public function __construct(
         public readonly Mode $mode = Mode::DEFAULT,
         ?string $name = null,
         ?string $id = null,
+        public readonly string|int|null $path = null,
         public readonly ?Result $subsequent = null,
-        public readonly bool $unchangeableId = false,
         Result ...$children,
     ) {
         $this->name = $rule->getName() ?? $name;
@@ -76,21 +76,17 @@ public function withTemplate(string $template): self
 
     public function withId(string $id): self
     {
-        if ($this->unchangeableId) {
-            return $this;
-        }
-
         return $this->clone(id: $id);
     }
 
-    public function withUnchangeableId(string $id): self
+    public function withPath(string|int $path): self
     {
-        return $this->clone(id: $id, unchangeableId: true);
+        return $this->clone(path: $path);
     }
 
-    public function withPrefixedId(string $prefix): self
+    public function withPrefix(string $prefix): self
     {
-        if ($this->id === $this->name || $this->unchangeableId) {
+        if ($this->id === $this->name || $this->path !== null) {
             return $this;
         }
 
@@ -176,8 +172,8 @@ private function clone(
         ?Mode $mode = null,
         ?string $name = null,
         ?string $id = null,
+        string|int|null $path = null,
         ?Result $subsequent = null,
-        ?bool $unchangeableId = null,
         ?array $children = null
     ): self {
         return new self(
@@ -189,8 +185,8 @@ private function clone(
             $mode ?? $this->mode,
             $name ?? $this->name,
             $id ?? $this->id,
+            $path ?? $this->path,
             $subsequent ?? $this->subsequent,
-            $unchangeableId ?? $this->unchangeableId,
             ...($children ?? $this->children)
         );
     }

diff --git a/library/Rules/DateTimeDiff.php b/library/Rules/DateTimeDiff.php
@@ -105,7 +105,7 @@ private function enrichResult(string $now, mixed $input, Result $result): Result
         $template = $now === 'now' ? self::TEMPLATE_STANDARD : self::TEMPLATE_CUSTOMIZED;
 
         return (new Result($result->isValid, $input, $this, $parameters, $template, id: $result->id))
-            ->withPrefixedId('dateTimeDiff')
+            ->withPrefix('dateTimeDiff')
             ->withSubsequent($result->withNameIfMissing($name));
     }
 

diff --git a/library/Rules/Each.php b/library/Rules/Each.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Result;
 use Respect\Validation\Rules\Core\FilteredNonEmptyArray;
 
-use function array_map;
 use function array_reduce;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
@@ -27,7 +26,10 @@ final class Each extends FilteredNonEmptyArray
     /** @param non-empty-array<mixed> $input */
     protected function evaluateNonEmptyArray(array $input): Result
     {
-        $children = array_map(fn ($item) => $this->rule->evaluate($item), $input);
+        $children = [];
+        foreach ($input as $key => $value) {
+            $children[] = $this->rule->evaluate($value)->withPath($key);
+        }
         $isValid = array_reduce($children, static fn ($carry, $childResult) => $carry && $childResult->isValid, true);
         if ($isValid) {
             return Result::passed($input, $this)->withChildren(...$children);

diff --git a/library/Rules/Key.php b/library/Rules/Key.php
@@ -41,7 +41,7 @@ public function evaluate(mixed $input): Result
 
         return $this->rule
             ->evaluate($input[$this->key])
-            ->withUnchangeableId((string) $this->key)
+            ->withPath($this->key)
             ->withNameIfMissing($this->rule->getName() ?? (string) $this->key);
     }
 }
diff --git a/library/Rules/KeyOptional.php b/library/Rules/KeyOptional.php
@@ -41,7 +41,7 @@ public function evaluate(mixed $input): Result
 
         return $this->rule
             ->evaluate($input[$this->key])
-            ->withUnchangeableId((string) $this->key)
+            ->withPath($this->key)
             ->withNameIfMissing($this->rule->getName() ?? (string) $this->key);
     }
 }
diff --git a/library/Rules/Length.php b/library/Rules/Length.php
@@ -59,7 +59,7 @@ private function enrichResult(mixed $input, Result $result): Result
         }
 
         return (new Result($result->isValid, $input, $this, id: $result->id))
-            ->withPrefixedId('length')
+            ->withPrefix('length')
             ->withSubsequent($result->withInput($input));
     }
 

diff --git a/library/Rules/Max.php b/library/Rules/Max.php
@@ -26,9 +26,10 @@ final class Max extends FilteredNonEmptyArray
     /** @param non-empty-array<mixed> $input */
     protected function evaluateNonEmptyArray(array $input): Result
     {
-        $result = $this->rule->evaluate(max($input))->withPrefixedId('max');
+        $result = $this->rule->evaluate(max($input))->withPrefix('max');
         $template = $this->getName() === null ? self::TEMPLATE_STANDARD : self::TEMPLATE_NAMED;
 
-        return (new Result($result->isValid, $input, $this, [], $template, id: $result->id))->withSubsequent($result);
+        return (new Result($result->isValid, $input, $this, [], $template, id: $result->id))
+            ->withSubsequent($result);
     }
 }
diff --git a/library/Rules/Min.php b/library/Rules/Min.php
@@ -26,7 +26,7 @@ final class Min extends FilteredNonEmptyArray
     /** @param non-empty-array<mixed> $input */
     protected function evaluateNonEmptyArray(array $input): Result
     {
-        $result = $this->rule->evaluate(min($input))->withPrefixedId('min');
+        $result = $this->rule->evaluate(min($input))->withPrefix('min');
         $template = $this->getName() === null ? self::TEMPLATE_STANDARD : self::TEMPLATE_NAMED;
 
         return (new Result($result->isValid, $input, $this, [], $template, id: $result->id))->withSubsequent($result);

diff --git a/library/Rules/Not.php b/library/Rules/Not.php
@@ -18,6 +18,6 @@ final class Not extends Wrapper
 {
     public function evaluate(mixed $input): Result
     {
-        return $this->rule->evaluate($input)->withInvertedMode()->withPrefixedId('not');
+        return $this->rule->evaluate($input)->withInvertedMode()->withPrefix('not');
     }
 }
diff --git a/library/Rules/NullOr.php b/library/Rules/NullOr.php
@@ -41,7 +41,7 @@ private function enrichResult(Result $result): Result
     {
         if ($result->allowsSubsequent()) {
             return $result
-                ->withPrefixedId('nullOr')
+                ->withPrefix('nullOr')
                 ->withSubsequent(new Result($result->isValid, $result->input, $this));
         }
 

diff --git a/library/Rules/Property.php b/library/Rules/Property.php
@@ -38,7 +38,7 @@ public function evaluate(mixed $input): Result
 
         return $this->rule
             ->evaluate($this->extractPropertyValue($input, $this->propertyName))
-            ->withUnchangeableId($this->propertyName)
+            ->withPath($this->propertyName)
             ->withNameIfMissing($this->rule->getName() ?? $this->propertyName);
     }
 }
diff --git a/library/Rules/PropertyOptional.php b/library/Rules/PropertyOptional.php
@@ -38,7 +38,7 @@ public function evaluate(mixed $input): Result
 
         return $this->rule
             ->evaluate($this->extractPropertyValue($input, $this->propertyName))
-            ->withUnchangeableId($this->propertyName)
+            ->withPath($this->propertyName)
             ->withNameIfMissing($this->rule->getName() ?? $this->propertyName);
     }
 }
diff --git a/library/Rules/Size.php b/library/Rules/Size.php
@@ -110,7 +110,7 @@ private function enrichResult(mixed $input, Result $result): Result
         $parameters = ['unit' => self::DATA_STORAGE_UNITS[$this->unit]['name']];
 
         return (new Result($result->isValid, $input, $this, $parameters, id: $result->id))
-            ->withPrefixedId('size')
+            ->withPrefix('size')
             ->withSubsequent($result->withInput($input));
     }
 }
diff --git a/library/Rules/UndefOr.php b/library/Rules/UndefOr.php
@@ -44,7 +44,7 @@ private function enrichResult(Result $result): Result
     {
         if ($result->allowsSubsequent()) {
             return $result
-                ->withPrefixedId('undefOr')
+                ->withPrefix('undefOr')
                 ->withSubsequent(new Result($result->isValid, $result->input, $this));
         }
 

diff --git a/tests/feature/Issues/Issue1033Test.php b/tests/feature/Issues/Issue1033Test.php
@@ -18,8 +18,8 @@
     FULL_MESSAGE,
     [
         '__root__' => 'Each item in `["A", "B", "B"]` must be valid',
-        'equals.1' => '"A" must be equal to 1',
-        'equals.2' => '"B" must be equal to 1',
-        'equals.3' => '"B" must be equal to 1',
+        0 => '"A" must be equal to 1',
+        1 => '"B" must be equal to 1',
+        2 => '"B" must be equal to 1',
     ]
 ));
diff --git a/tests/feature/Issues/Issue1289Test.php b/tests/feature/Issues/Issue1289Test.php
@@ -54,7 +54,7 @@
       - description must be a string value
     FULL_MESSAGE,
     [
-        'allOf' => [
+        0 => [
             '__root__' => 'These rules must pass for `["default": 2, "description": [], "children": ["nope"]]`',
             'default' => [
                 '__root__' => 'Only one of these rules must pass for default',