Use Path object

Author: henriquemoody

library/FailedResultIterator.php

@@ -11,8 +11,8 @@
 
 use Countable;
 use Iterator;
-
 use RecursiveIterator;
+
 use function array_filter;
 use function array_key_exists;
 use function array_map;
@@ -26,7 +26,7 @@
 /**
  * @implements Iterator<int, Result>
  */
-final class FailedResultIterator implements Iterator, Countable, \RecursiveIterator
+final class FailedResultIterator implements Iterator, Countable, RecursiveIterator
 {
     private array $children;
 
@@ -43,7 +43,7 @@ public function extractDeduplicatedChildren(): array
         $duplicateCounters = [];
         foreach ($this->result->children as $child) {
             if ($child->path !== null) {
-                $deduplicatedResults[$child->path] = $child->isValid ? null : $child;
+                $deduplicatedResults[$child->path->value] = $child->isValid ? null : $child;
                 continue;
             }
 
@@ -62,7 +62,7 @@ public function extractDeduplicatedChildren(): array
 
         return array_map(
             function (Result $child): Result {
-                if ($this->result->path !== null && $child->path !== null && $child->path !== $this->result->path) {
+                if ($this->result->path !== null && $child->path !== null && $child->path->isEqual($this->result->path)) {
                     return $child->withPath($this->result->path);
                 }
 
@@ -116,7 +116,7 @@ public function hasChildren(): bool
         return $this->result->children !== [];
     }
 
-    public function getChildren(): ?RecursiveIterator
+    public function getChildren(): ?self
     {
         if (!$this->hasChildren()) {
             return null;

library/Message/Placeholder/Path.php

@@ -12,12 +12,24 @@
 final class Path
 {
     public function __construct(
-        private readonly int|string $value
+        public readonly int|string $value,
+        public readonly ?Path $child = null
     ) {
     }
 
-    public function getValue(): int|string
+    public function withParent(int|string $value): self
     {
-        return $this->value;
+        return new self($value, $this);
+    }
+
+    public function isEqual(Path $path): bool
+    {
+        return $this->value === $path->value
+            && $this->child?->isEqual($path->child) ?? true;
+    }
+
+    public function getDeepest(): Path
+    {
+        return $this->child?->getDeepest() ?? $this;
     }
 }

library/Message/StandardFormatter.php

@@ -10,8 +10,8 @@
 namespace Respect\Validation\Message;
 
 use Respect\Validation\Exceptions\ComponentException;
-use Respect\Validation\Result;
 use Respect\Validation\FailedResultIterator;
+use Respect\Validation\Result;
 
 use function array_filter;
 use function array_reduce;
@@ -103,7 +103,7 @@ public function array(Result $result, array $templates, Translator $translator):
         $deduplicatedChildren = new FailedResultIterator($result);
         if (count($deduplicatedChildren) === 0 || $this->isFinalTemplate($result, $selectedTemplates)) {
             return [
-                $result->getDeepestPath() ?? $result->id => $this->renderer->render(
+                $result->path?->getDeepest()->value ?? $result->id => $this->renderer->render(
                     $this->getTemplated($result->withDeepestPath(), $selectedTemplates),
                     $translator
                 ),
@@ -112,7 +112,7 @@ public function array(Result $result, array $templates, Translator $translator):
 
         $messages = [];
         foreach ($deduplicatedChildren as $child) {
-            $key = $child->getDeepestPath() ?? $child->id;
+            $key = $child?->path?->getDeepest()->value ?? $child->id;
             $messages[$key] = $this->array(
                 $this->resultWithPath($result, $child),
                 $this->selectTemplates($child, $selectedTemplates),
@@ -139,7 +139,7 @@ public function array(Result $result, array $templates, Translator $translator):
         return $messages;
     }
 
-    public function resultWithPath(Result $parent, Result $child): Result
+    private function resultWithPath(Result $parent, Result $child): Result
     {
         if ($parent->path !== null && $child->path !== null && $child->path !== $parent->path) {
             return $child->withPath($parent->path);
@@ -194,7 +194,7 @@ private function getTemplated(Result $result, array $templates): Result
             return $result;
         }
 
-        foreach ([$result->path, $result->name, $result->id, '__root__'] as $key) {
+        foreach ([$result->path?->value, $result->name, $result->id, '__root__'] as $key) {
             if (!isset($templates[$key])) {
                 continue;
             }
@@ -216,7 +216,7 @@ private function getTemplated(Result $result, array $templates): Result
      */
     private function isFinalTemplate(Result $result, array $templates): bool
     {
-        $keys = [$result->path, $result->name, $result->id];
+        $keys = [$result->path?->value, $result->name, $result->id];
         foreach ($keys as $key) {
             if (isset($templates[$key]) && is_string($templates[$key])) {
                 return true;
@@ -243,7 +243,7 @@ private function isFinalTemplate(Result $result, array $templates): bool
      */
     private function selectTemplates(Result $result, array $templates): array
     {
-        foreach ([$result->path, $result->name, $result->id] as $key) {
+        foreach ([$result->path?->value, $result->name, $result->id] as $key) {
             if (isset($templates[$key]) && is_array($templates[$key])) {
                 return $templates[$key];
             }

library/Message/StandardRenderer.php

@@ -37,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 ? new Path($result->path) : null;
+        $parameters['path'] = $result->path;
         $parameters['input'] = $result->input;
 
         $builtName = $result->name ?? $parameters['path'] ?? $this->placeholder('input', $result->input, $translator);

library/Message/Stringifier/PathStringifier.php

@@ -26,6 +26,12 @@ public function stringify(mixed $raw, int $depth): ?string
             return null;
         }
 
-        return $this->quoter->quote('.' . $raw->getValue(), $depth);
+        $path = $raw;
+        $string = $path->value;
+        while ($path = $path->child) {
+            $string .= '.' . $path->value;
+        }
+
+        return $this->quoter->quote('.' . $string, $depth);
     }
 }

library/Result.php

@@ -9,6 +9,7 @@
 
 namespace Respect\Validation;
 
+use Respect\Validation\Message\Placeholder\Path;
 use Respect\Validation\Rules\Core\Nameable;
 
 use function array_filter;
@@ -40,7 +41,7 @@ public function __construct(
         public readonly ?string $name = null,
         ?string $id = null,
         public readonly ?Result $adjacent = null,
-        public readonly string|int|null $path = null,
+        public readonly ?Path $path = null,
         Result ...$children,
     ) {
         $this->id = $id ?? lcfirst(substr((string) strrchr($rule::class, '\\'), 1));
@@ -111,39 +112,40 @@ public function withIdFrom(Rule $rule): self
         return $this->clone(id: lcfirst(substr((string) strrchr($rule::class, '\\'), 1)));
     }
 
-    public function withPath(string|int $path): self
+    public function withPath(Path $path): self
     {
         return $this->clone(
             adjacent: $this->adjacent?->withPath($path),
-            path: $this->path === null ? $path : $path . '.' . $this->path,
+            path: $path,
         );
     }
 
-    public function withDeepestPath(): self
+    public function withChildPath(string|int $path): self
     {
-        $path = $this->getDeepestPath();
-        if ($path === null || $path === (string) $this->path) {
-            return $this;
-        }
-
         return $this->clone(
-            adjacent: $this->adjacent?->withPath($path),
-            path: $path,
+            adjacent: $this->adjacent?->withChildPath($path),
+            path: new Path($path, $this->path),
         );
     }
 
-    public function getDeepestPath(): ?string
+    public function withParentPath(string|int $path): self
     {
-        if ($this->path === null) {
-            return null;
-        }
+        return $this->clone(
+            adjacent: $this->adjacent?->withParentPath($path),
+            path: $this->path?->withParent($path) ?? new Path($path),
+        );
+    }
 
-        $paths = explode('.', (string) $this->path);
-        if (count($paths) === 1) {
-            return (string) $this->path;
+    public function withDeepestPath(): self
+    {
+        if ($this->path === null || $this->path->child === null || $this->path->getDeepest() === $this->path) {
+            return $this;
         }
 
-        return end($paths);
+        return $this->clone(
+            adjacent: $this->adjacent?->withDeepestPath(),
+            path: $this->path?->getDeepest(),
+        );
     }
 
     public function withPrefix(string $prefix): self
@@ -250,7 +252,7 @@ private function clone(
         ?string $name = null,
         ?string $id = null,
         ?Result $adjacent = null,
-        string|int|null $path = null,
+        ?Path $path = null,
         ?array $children = null
     ): self {
         return new self(

library/Rules/Each.php

@@ -28,7 +28,7 @@ protected function evaluateNonEmptyArray(array $input): Result
     {
         $children = [];
         foreach ($input as $key => $value) {
-            $children[] = $this->rule->evaluate($value)->withPath($key);
+            $children[] = $this->rule->evaluate($value)->withParentPath($key);
         }
         $isValid = array_reduce($children, static fn ($carry, $childResult) => $carry && $childResult->isValid, true);
 

library/Rules/Key.php

@@ -37,6 +37,6 @@ public function evaluate(mixed $input): Result
             return $keyExistsResult->withNameFrom($this->rule);
         }
 
-        return $this->rule->evaluate($input[$this->key])->withPath($this->key);
+        return $this->rule->evaluate($input[$this->key])->withParentPath($this->key);
     }
 }

library/Rules/KeyExists.php

@@ -11,6 +11,7 @@
 
 use ArrayAccess;
 use Attribute;
+use Respect\Validation\Message\Placeholder\Path;
 use Respect\Validation\Message\Template;
 use Respect\Validation\Result;
 use Respect\Validation\Rules\Core\KeyRelated;
@@ -38,7 +39,7 @@ public function getKey(): int|string
 
     public function evaluate(mixed $input): Result
     {
-        return new Result($this->hasKey($input), $input, $this, path: $this->key);
+        return new Result($this->hasKey($input), $input, $this, path: new Path($this->key));
     }
 
     private function hasKey(mixed $input): bool

library/Rules/Property.php

@@ -34,7 +34,7 @@ public function evaluate(mixed $input): Result
 
         return $this->rule
             ->evaluate($this->extractPropertyValue($input, $this->propertyName))
-            ->withPath($this->propertyName);
+            ->withParentPath($this->propertyName);
     }
 
     private function extractPropertyValue(object $input, string $property): mixed