Extract parameter processor into multiple classes

By extracting them into different processors, the code in the rendered becomes much more straightforward, and the design makes it possible to create processors easily. This change will allow users to customize that behavior if they want to. Signed-off-by: Henrique Moody <[email protected]>
Respect · Feb 22, 2024 · d25557c · d25557c
1 parent 955a554
commit d25557c
Show file tree

Hide file tree

Showing 17 changed files with 409 additions and 147 deletions.
diff --git a/library/Factory.php b/library/Factory.php
@@ -16,8 +16,10 @@
 use Respect\Validation\Exceptions\ComponentException;
 use Respect\Validation\Exceptions\InvalidClassException;
 use Respect\Validation\Exceptions\ValidationException;
-use Respect\Validation\Message\ParameterStringifier;
-use Respect\Validation\Message\Stringifier\KeepOriginalStringName;
+use Respect\Validation\Message\Parameter\Processor;
+use Respect\Validation\Message\Parameter\Raw;
+use Respect\Validation\Message\Parameter\Stringify;
+use Respect\Validation\Message\Parameter\Trans;
 use Respect\Validation\Message\TemplateCollector;
 use Respect\Validation\Message\TemplateRenderer;
 
@@ -37,17 +39,18 @@ final class Factory
     /**
      * @var callable
      */
-    private $translator = 'strval';
+    private $translator;
 
-    private ParameterStringifier $parameterStringifier;
+    private Processor $processor;
 
     private TemplateCollector $templateCollector;
 
     private static Factory $defaultInstance;
 
     public function __construct()
     {
-        $this->parameterStringifier = new KeepOriginalStringName();
+        $this->translator = static fn (string $message) => $message;
+        $this->processor = new Raw(new Trans($this->translator, new Stringify()));
         $this->templateCollector = new TemplateCollector();
     }
 
@@ -72,14 +75,15 @@ public function withTranslator(callable $translator): self
     {
         $clone = clone $this;
         $clone->translator = $translator;
+        $clone->processor = new Raw(new Trans($translator, new Stringify()));
 
         return $clone;
     }
 
-    public function withParameterStringifier(ParameterStringifier $parameterStringifier): self
+    public function withParameterProcessor(Processor $processor): self
     {
         $clone = clone $this;
-        $clone->parameterStringifier = $parameterStringifier;
+        $clone->processor = $processor;
 
         return $clone;
     }
@@ -121,7 +125,7 @@ public function exception(Validatable $validatable, mixed $input, array $extraPa
         }
         $template = $validatable->getTemplate($input);
         $templates = $this->templateCollector->extract($validatable);
-        $formatter = new TemplateRenderer($this->translator, $this->parameterStringifier);
+        $formatter = new TemplateRenderer($this->translator, $this->processor);
 
         $attributes = $reflection->getAttributes(ExceptionClass::class);
         if (count($attributes) === 0) {

diff --git a/library/Message/Parameter/Processor.php b/library/Message/Parameter/Processor.php
@@ -0,0 +1,15 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Message\Parameter;
+
+interface Processor
+{
+    public function process(string $name, mixed $value, ?string $modifier = null): string;
+}
diff --git a/library/Message/Parameter/Raw.php b/library/Message/Parameter/Raw.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Message\Parameter;
+
+use function is_bool;
+use function is_scalar;
+
+final class Raw implements Processor
+{
+    public function __construct(
+        private readonly Processor $nextProcessor,
+    ) {
+    }
+
+    public function process(string $name, mixed $value, ?string $modifier = null): string
+    {
+        if ($modifier === 'raw' && is_scalar($value)) {
+            return is_bool($value) ? (string) (int) $value : (string) $value;
+        }
+
+        return $this->nextProcessor->process($name, $value, $modifier);
+    }
+}
diff --git a/...ge/Stringifier/KeepOriginalStringName.php → library/Message/Parameter/Stringify.php b/...ge/Stringifier/KeepOriginalStringName.php → library/Message/Parameter/Stringify.php
@@ -7,16 +7,14 @@
 
 declare(strict_types=1);
 
-namespace Respect\Validation\Message\Stringifier;
-
-use Respect\Validation\Message\ParameterStringifier;
+namespace Respect\Validation\Message\Parameter;
 
 use function is_string;
 use function Respect\Stringifier\stringify;
 
-final class KeepOriginalStringName implements ParameterStringifier
+final class Stringify implements Processor
 {
-    public function stringify(string $name, mixed $value): string
+    public function process(string $name, mixed $value, ?string $modifier = null): string
     {
         if ($name === 'name' && is_string($value)) {
             return $value;

diff --git a/library/Message/Parameter/Trans.php b/library/Message/Parameter/Trans.php
@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Message\Parameter;
+
+use function call_user_func;
+use function is_string;
+
+final class Trans implements Processor
+{
+    /** @var callable */
+    private $translator;
+
+    public function __construct(
+        callable $translator,
+        private readonly Processor $nextProcessor,
+    ) {
+        $this->translator = $translator;
+    }
+
+    public function process(string $name, mixed $value, ?string $modifier = null): string
+    {
+        if ($modifier === 'trans' && is_string($value)) {
+            return call_user_func($this->translator, $value);
+        }
+
+        return $this->nextProcessor->process($name, $value, $modifier);
+    }
+}
diff --git a/library/Message/ParameterStringifier.php b/library/Message/ParameterStringifier.php
diff --git a/library/Message/TemplateRenderer.php b/library/Message/TemplateRenderer.php
@@ -10,12 +10,11 @@
 namespace Respect\Validation\Message;
 
 use Respect\Validation\Exceptions\ComponentException;
+use Respect\Validation\Message\Parameter\Processor;
 use Throwable;
 
 use function call_user_func;
-use function is_scalar;
 use function preg_replace_callback;
-use function Respect\Stringifier\stringify;
 use function sprintf;
 
 final class TemplateRenderer
@@ -25,7 +24,7 @@ final class TemplateRenderer
 
     public function __construct(
         callable $translator,
-        private readonly ParameterStringifier $parameterStringifier
+        private readonly Processor $processor
     ) {
         $this->translator = $translator;
     }
@@ -35,36 +34,23 @@ public function __construct(
      */
     public function render(string $template, mixed $input, array $parameters): string
     {
-        $parameters['name'] ??= $this->parameterStringifier->stringify('input', $input);
+        $parameters['name'] ??= $this->processor->process('input', $input);
 
         return (string) preg_replace_callback(
-            '/{{(\w+)(\|(trans|raw))?}}/',
-            function (array $matches) use ($parameters): string {
+            '/{{(\w+)(\|([^}]+))?}}/',
+            function (array $matches) use ($parameters) {
                 if (!isset($parameters[$matches[1]])) {
                     return $matches[0];
                 }
 
-                $modifier = $matches[3] ?? null;
-                if ($modifier === 'raw' && is_scalar($parameters[$matches[1]])) {
-                    return (string) $parameters[$matches[1]];
-                }
-
-                if ($modifier === 'trans') {
-                    return $this->translate($parameters[$matches[1]]);
-                }
-
-                return $this->parameterStringifier->stringify($matches[1], $parameters[$matches[1]]);
+                return $this->processor->process($matches[1], $parameters[$matches[1]], $matches[3] ?? null);
             },
             $this->translate($template)
         );
     }
 
     private function translate(mixed $message): string
     {
-        if (!is_scalar($message)) {
-            throw new ComponentException(sprintf('Cannot translate scalar value "%s"', stringify($message)));
-        }
-
         try {
             return call_user_func($this->translator, (string) $message);
         } catch (Throwable $throwable) {

diff --git a/tests/library/Message/Parameter/TestingProcessor.php b/tests/library/Message/Parameter/TestingProcessor.php
@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Test\Message\Parameter;
+
+use Respect\Validation\Message\Parameter\Processor;
+
+use function json_encode;
+use function sprintf;
+
+final class TestingProcessor implements Processor
+{
+    public function process(string $name, mixed $value, ?string $modifier = null): string
+    {
+        if ($modifier !== null) {
+            return sprintf('%s(<%s:%s>)', $modifier, $name, $modifier);
+        }
+
+        return sprintf('<%s:%s>', $name, json_encode($value));
+    }
+}
diff --git a/tests/library/Message/TestingParameterStringifier.php b/tests/library/Message/TestingParameterStringifier.php
diff --git a/tests/library/Stubs/CompositeSub.php b/tests/library/Stubs/CompositeSub.php
@@ -9,7 +9,7 @@
 
 namespace Respect\Validation\Test\Stubs;
 
-use Respect\Validation\Message\Stringifier\KeepOriginalStringName;
+use Respect\Validation\Message\Parameter\Stringify;
 use Respect\Validation\Message\TemplateRenderer;
 use Respect\Validation\Rules\AbstractComposite;
 use Respect\Validation\Test\Exceptions\CompositeStubException;
@@ -33,7 +33,7 @@ public function reportError(mixed $input, array $extraParameters = []): Composit
             params: $extraParameters,
             template: Validatable::TEMPLATE_STANDARD,
             templates: [],
-            formatter: new TemplateRenderer(static fn ($value) => $value, new KeepOriginalStringName())
+            formatter: new TemplateRenderer(static fn ($value) => $value, new Stringify())
         );
     }
 }