Trace paths instead of IDs

henriquemoody · henriquemoody · commit 22cc8697dccd · 2025-05-18T14:09:35.000+02:00
diff --git a/library/FailedResultIterator.php b/library/FailedResultIterator.php
@@ -0,0 +1,140 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Respect\Validation;
+
+use Countable;
+use Iterator;
+use RecursiveIterator;
+
+use function array_filter;
+use function array_key_exists;
+use function array_map;
+use function array_values;
+use function count;
+use function current;
+use function key;
+use function next;
+use function reset;
+
+/**
+ * @implements Iterator<int, Result>
+ * @implements RecursiveIterator<int, Result>
+ */
+final class FailedResultIterator implements Iterator, Countable, RecursiveIterator
+{
+    /**
+     * @var array<int, Result>
+     */
+    private array $children;
+
+    public function __construct(
+        private readonly Result $result,
+    ) {
+        $this->children = $this->extractDeduplicatedChildren();
+    }
+
+    public function current(): Result|false
+    {
+        return current($this->children);
+    }
+
+    /**
+     * @return array<int, Result>
+     */
+    public function getArrayCopy(): array
+    {
+        return $this->children;
+    }
+
+    public function next(): void
+    {
+        next($this->children);
+    }
+
+    public function key(): ?int
+    {
+        return key($this->children);
+    }
+
+    public function valid(): bool
+    {
+        return key($this->children) !== null;
+    }
+
+    public function rewind(): void
+    {
+        reset($this->children);
+    }
+
+    public function count(): int
+    {
+        return count($this->children);
+    }
+
+    public function hasChildren(): bool
+    {
+        return $this->result->children !== [];
+    }
+
+    /**
+     * @return null|RecursiveIterator<int, Result>
+     */
+    public function getChildren(): ?RecursiveIterator
+    {
+        if (!$this->hasChildren()) {
+            return null;
+        }
+
+        return new self($this->result);
+    }
+
+    /**
+     * @return array<int, Result>
+     */
+    private function extractDeduplicatedChildren(): array
+    {
+        /** @var array<string, Result> $deduplicatedResults */
+        $deduplicatedResults = [];
+        $duplicateCounters = [];
+        foreach ($this->result->children as $child) {
+            if ($child->path !== null) {
+                $deduplicatedResults[$child->path] = $child->hasPassed ? null : $child;
+                continue;
+            }
+
+            $id = $child->id;
+            if (isset($duplicateCounters[$id])) {
+                $id .= '.' . ++$duplicateCounters[$id];
+            } elseif (array_key_exists($id, $deduplicatedResults)) {
+                $deduplicatedResults[$id . '.1'] = $deduplicatedResults[$id]?->withId($id . '.1');
+                unset($deduplicatedResults[$id]);
+                $duplicateCounters[$id] = 2;
+                $id .= '.2';
+            }
+
+            $deduplicatedResults[$id] = $child->hasPassed ? null : $child->withId($id);
+        }
+
+        return array_map(
+            function (Result $child): Result {
+                if ($this->result->path !== null && $child->path !== null && $child->path !== $this->result->path) {
+                    return $child->withPath($this->result->path);
+                }
+
+                if ($this->result->path !== null && $child->path === null) {
+                    return $child->withPath($this->result->path);
+                }
+
+                return $child;
+            },
+            array_values(array_filter($deduplicatedResults))
+        );
+    }
+}
diff --git a/library/Message/Placeholder/Path.php b/library/Message/Placeholder/Path.php
@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Message\Placeholder;
+
+final class Path
+{
+    public function __construct(
+        private readonly int|string $value
+    ) {
+    }
+
+    public function getValue(): int|string
+    {
+        return $this->value;
+    }
+}
diff --git a/library/Message/StandardFormatter.php b/library/Message/StandardFormatter.php
@@ -10,13 +10,11 @@
 namespace Respect\Validation\Message;
 
 use Respect\Validation\Exceptions\ComponentException;
+use Respect\Validation\FailedResultIterator;
 use Respect\Validation\Result;
 
 use function array_filter;
-use function array_key_exists;
-use function array_map;
 use function array_reduce;
-use function array_values;
 use function count;
 use function current;
 use function is_array;
@@ -42,8 +40,8 @@ public function main(Result $result, array $templates, Translator $translator):
     {
         $selectedTemplates = $this->selectTemplates($result, $templates);
         if (!$this->isFinalTemplate($result, $selectedTemplates)) {
-            foreach ($this->extractDeduplicatedChildren($result) as $child) {
-                return $this->main($this->resultWithPath($result, $child), $selectedTemplates, $translator);
+            foreach (new FailedResultIterator($result) as $child) {
+                return $this->main($child, $selectedTemplates, $translator);
             }
         }
 
@@ -78,17 +76,14 @@ public function full(
         }
 
         if (!$isFinalTemplate) {
-            $results = array_map(
-                fn(Result $child) => $this->resultWithPath($result, $child),
-                $this->extractDeduplicatedChildren($result)
-            );
+            $results = new FailedResultIterator($result);
             foreach ($results as $child) {
                 $rendered .= $this->full(
                     $child,
                     $selectedTemplates,
                     $translator,
                     $depth,
-                    ...array_filter($results, static fn (Result $sibling) => $sibling !== $child)
+                    ...array_filter($results->getArrayCopy(), static fn (Result $sibling) => $sibling !== $child)
                 );
                 $rendered .= PHP_EOL;
             }
@@ -105,7 +100,7 @@ public function full(
     public function array(Result $result, array $templates, Translator $translator): array
     {
         $selectedTemplates = $this->selectTemplates($result, $templates);
-        $deduplicatedChildren = $this->extractDeduplicatedChildren($result);
+        $deduplicatedChildren = new FailedResultIterator($result);
         if (count($deduplicatedChildren) === 0 || $this->isFinalTemplate($result, $selectedTemplates)) {
             return [
                 $result->getDeepestPath() ?? $result->id => $this->renderer->render(
@@ -256,32 +251,4 @@ private function selectTemplates(Result $result, array $templates): array
 
         return $templates;
     }
-
-    /** @return array<Result> */
-    private function extractDeduplicatedChildren(Result $result): array
-    {
-        /** @var array<string, Result> $deduplicatedResults */
-        $deduplicatedResults = [];
-        $duplicateCounters = [];
-        foreach ($result->children as $child) {
-            $id = $child->getDeepestPath() ?? $child->id;
-            if (isset($duplicateCounters[$id])) {
-                $id .= '.' . ++$duplicateCounters[$id];
-            } elseif (array_key_exists($id, $deduplicatedResults)) {
-                $deduplicatedResults[$id . '.1'] = $deduplicatedResults[$id]?->withId($id . '.1');
-                unset($deduplicatedResults[$id]);
-                $duplicateCounters[$id] = 2;
-                $id .= '.2';
-            }
-
-            if ($child->path === null) {
-                $deduplicatedResults[$id] = $child->hasPassed ? null : $child->withId($id);
-                continue;
-            }
-
-            $deduplicatedResults[$id] = $child->hasPassed ? null : $child;
-        }
-
-        return array_values(array_filter($deduplicatedResults));
-    }
 }
diff --git a/library/Message/StandardRenderer.php b/library/Message/StandardRenderer.php
@@ -12,6 +12,7 @@
 use ReflectionClass;
 use Respect\Stringifier\Stringifier;
 use Respect\Validation\Message\Placeholder\Listed;
+use Respect\Validation\Message\Placeholder\Path;
 use Respect\Validation\Message\Placeholder\Quoted;
 use Respect\Validation\Result;
 use Respect\Validation\Rule;
@@ -36,7 +37,7 @@ public function __construct(
     public function render(Result $result, Translator $translator, ?string $template = null): string
     {
         $parameters = $result->parameters;
-        $parameters['path'] = $result->path !== null ? Quoted::fromPath($result->path) : null;
+        $parameters['path'] = $result->path !== null ? new Path($result->path) : null;
         $parameters['input'] = $result->input;
 
         $builtName = $result->name ?? $parameters['path'] ?? $this->placeholder('input', $result->input, $translator);
diff --git a/library/Message/StandardStringifier.php b/library/Message/StandardStringifier.php
@@ -32,6 +32,7 @@
 use Respect\Stringifier\Stringifiers\StringableObjectStringifier;
 use Respect\Stringifier\Stringifiers\ThrowableObjectStringifier;
 use Respect\Validation\Message\Stringifier\ListedStringifier;
+use Respect\Validation\Message\Stringifier\PathStringifier;
 use Respect\Validation\Message\Stringifier\QuotedStringifier;
 
 final class StandardStringifier implements Stringifier
@@ -88,6 +89,7 @@ private function createStringifier(Quoter $quoter): Stringifier
         $stringifier->prependStringifier(new ThrowableObjectStringifier($jsonEncodableStringifier, $quoter));
         $stringifier->prependStringifier(new DateTimeStringifier($quoter, DateTimeInterface::ATOM));
         $stringifier->prependStringifier(new IteratorObjectStringifier($stringifier, $quoter));
+        $stringifier->prependStringifier(new PathStringifier($quoter));
         $stringifier->prependStringifier(new QuotedStringifier($quoter));
         $stringifier->prependStringifier(new ListedStringifier($stringifier));
 
diff --git a/library/Message/Stringifier/PathStringifier.php b/library/Message/Stringifier/PathStringifier.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Respect\Validation\Message\Stringifier;
+
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+use Respect\Validation\Message\Placeholder\Path;
+
+final class PathStringifier implements Stringifier
+{
+    public function __construct(
+        private readonly Quoter $quoter
+    ) {
+    }
+
+    public function stringify(mixed $raw, int $depth): ?string
+    {
+        if (!$raw instanceof Path) {
+            return null;
+        }
+
+        return $this->quoter->quote('.' . $raw->getValue(), $depth);
+    }
+}
diff --git a/library/Rules/Cnh.php b/library/Rules/Cnh.php
@@ -15,6 +15,7 @@
 
 use function is_scalar;
 use function mb_strlen;
+use function preg_match;
 use function preg_replace;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
@@ -34,7 +35,11 @@ public function isValid(mixed $input): bool
         $input = (string) preg_replace('{\D}', '', (string) $input);
 
         // Validate length and invalid numbers
-        if (mb_strlen($input) != 11 || ((int) $input === 0)) {
+        if (mb_strlen($input) != 11) {
+            return false;
+        }
+
+        if (preg_match('/^(\d)\1{10}/', $input) > 0) {
             return false;
         }
 
diff --git a/library/Transformers/Deprecated/KeyValueRule.php b/library/Transformers/Deprecated/KeyValueRule.php
@@ -9,7 +9,7 @@
 
 namespace Respect\Validation\Transformers\Deprecated;
 
-use Respect\Validation\Message\Placeholder\Quoted;
+use Respect\Validation\Message\Placeholder\Path;
 use Respect\Validation\Rules\AlwaysInvalid;
 use Respect\Validation\Rules\Key;
 use Respect\Validation\Rules\KeyExists;
@@ -56,7 +56,7 @@ static function ($input) use ($comparedKey, $ruleName, $baseKey) {
                         return new Templated(
                             new AlwaysInvalid(),
                             '{{baseKey}} must be valid to validate {{comparedKey}}',
-                            ['comparedKey' => Quoted::fromPath($comparedKey), 'baseKey' => Quoted::fromPath($baseKey)]
+                            ['comparedKey' => new Path($comparedKey), 'baseKey' => new Path($baseKey)],
                         );
                     }
                 }
diff --git a/tests/feature/Issues/Issue1289Test.php b/tests/feature/Issues/Issue1289Test.php
@@ -56,11 +56,7 @@
     [
         0 => [
             '__root__' => '`.0` must pass the rules',
-            'default' => [
-                '__root__' => '`.default` must pass one of the rules',
-                'stringType' => '`.default` must be a string',
-                'boolType' => '`.default` must be a boolean',
-            ],
+            'default' => '`.default` must be a boolean',
             'description' => '`.description` must be a string value',
         ],
     ],
diff --git a/tests/feature/Issues/Issue1376Test.php b/tests/feature/Issues/Issue1376Test.php
@@ -28,11 +28,7 @@
         '__root__' => '`stdClass { +$author="foo" }` must pass all the rules',
         'title' => '`.title` must be present',
         'description' => '`.description` must be present',
-        'author' => [
-            '__root__' => '`.author` must pass all the rules',
-            'intType' => '`.author` must be an integer',
-            'lengthBetween' => 'The length of `.author` must be between 1 and 2',
-        ],
+        'author' => 'The length of `.author` must be between 1 and 2',
         'user' => '`.user` must be present',
     ],
 ));
diff --git a/tests/feature/Rules/AttributesTest.php b/tests/feature/Rules/AttributesTest.php
@@ -52,11 +52,7 @@
     [
         '__root__' => '`Respect\Validation\Test\Stubs\WithAttributes { +$name="" +$birthdate="not a date" +$email="not an email" +$phone ... }` must pass the rules',
         'name' => '`.name` must not be empty',
-        'birthdate' => [
-            '__root__' => '`.birthdate` must pass all the rules',
-            'date' => '`.birthdate` must be a valid date in the format "2005-12-30"',
-            'dateTimeDiffLessThanOrEqual' => 'For comparison with now, `.birthdate` must be a valid datetime',
-        ],
+        'birthdate' => 'For comparison with now, `.birthdate` must be a valid datetime',
         'email' => '`.email` must be a valid email address or must be null',
         'phone' => '`.phone` must be a valid telephone number or must be null',
     ],
diff --git a/tests/feature/Rules/EachTest.php b/tests/feature/Rules/EachTest.php
diff --git a/tests/unit/Rules/CnhTest.php b/tests/unit/Rules/CnhTest.php
