Improve empty string handling and validation value exception format

⛑ In default strategy ensure that `empty string` values are converted to null in all value types
🚀 Improve validation exception text with value description: `(null)`, `(array with count X)`, `(empty string)`, string value with maximum of 30 characters.

Author: pionl

README.md

@@ -16,6 +16,7 @@ composer require wrkflow/php-get-typed-value
 - 🏆 **Makes PHPStan / IDE** happy due the type strict return types.
 - 🤹‍ **Validation:** Ensures that desired value is in correct type (without additional loop validation).
 - 🛠 **Transformers:** Ensures that values are in expected type.
+- ⛑ Converts empty string values to null (can be disabled, see transformers).
 
 ```php
 use Wrkflow\GetValue\GetValue;

docs/content/en/index.md

@@ -14,6 +14,7 @@ position: 1
 - 🏆 **Makes PHPStan / IDE** happy due the type strict return types.
 - 🤹‍ **Validation:** Ensures that desired value is in correct type (without additional loop validation).
 - 🛠 **Transformers:** Ensures that values are in expected type.
+- ⛑ Converts empty string values to null (can be disabled, see transformers).
 
 ```php
 use Wrkflow\GetValue\GetValue;

docs/content/en/laravel.md

@@ -57,7 +57,7 @@ $test = app(TestAction::class)->execute();
 
 To change the implementation using dependency injection just bind contracts below in your framework container:
 
-- `Wrkflow\GetValue\Contracts\TransformerStrategy $transformerStrategy`
+- `Wrkflow\GetValue\Contracts\TransformerStrategyContract $transformerStrategy`
 - `Wrkflow\GetValue\Contracts\ExceptionBuilderContract $exceptionBuilder`
 
 *Example for Laravel:*
@@ -67,7 +67,7 @@ class MyServiceProvider extends ServiceProvider {
     public function register (): void {
         parent::register();
 
-        $this->app->bind(Wrkflow\GetValue\Contracts\TransformerStrategy::class, MyTransformerStrategy::class);
+        $this->app->bind(Wrkflow\GetValue\Contracts\TransformerStrategyContract::class, MyTransformerStrategy::class);
         $this->app->bind(Wrkflow\GetValue\Contracts\ExceptionBuilderContract::class, MyExceptionBuilder::class);
     }
 }

src/Actions/ValidateAction.php

@@ -8,14 +8,31 @@
 
 class ValidateAction
 {
+    private const MaxStringLength = 30;
+
     public function __construct(
         private readonly ExceptionBuilderContract $exceptionBuilder,
     ) {
     }
 
     public function execute(array $rules, mixed $value, string $key): void
     {
-        $valueForLog = (is_string($value) || is_numeric($value)) ? (string) $value : null;
+        if ($value === '') {
+            $valueForLog = '(empty string)';
+        } elseif (is_string($value) || is_numeric($value)) {
+            // Length does not need to be exact (no need for ext-mbstring)
+            $valueForLog = (string) $value;
+            if (strlen($valueForLog) > self::MaxStringLength) {
+                $valueForLog = substr($valueForLog, 0, self::MaxStringLength - 3) . '...';
+            }
+        } elseif ($value === null) {
+            $valueForLog = '(null)';
+        } elseif (is_array($value)) {
+            $valueForLog = '(array with count ' . count($value) . ')';
+        } else {
+            $valueForLog = null;
+        }
+
         foreach ($rules as $rule) {
             if ($rule->passes($value) === false) {
                 throw $this->exceptionBuilder->validationFailed($key, $rule::class, $valueForLog);

src/Builders/ExceptionBuilder.php

@@ -34,7 +34,7 @@ public function validationFailed(string $key, string $ruleClassName, ?string $va
         $classNameParts = explode('\\', $ruleClassName);
         $shortClassName = end($classNameParts);
 
-        $valueMessage = $value === null ? '' : (' with value ' . $value);
+        $valueMessage = $value === null ? '' : (' with value <' . $value . '>');
         return new ValidationFailedException($key, $shortClassName . ' failed' . $valueMessage);
     }
 

src/Contracts/TransformerStrategy.php renamed to src/Contracts/TransformerStrategyContract.php

@@ -4,7 +4,7 @@
 
 namespace Wrkflow\GetValue\Contracts;
 
-interface TransformerStrategy
+interface TransformerStrategyContract
 {
     /**
      * @return array<TransformerContract>

src/GetValue.php

@@ -18,7 +18,7 @@
 use Wrkflow\GetValue\Contracts\GetValueTransformerContract;
 use Wrkflow\GetValue\Contracts\RuleContract;
 use Wrkflow\GetValue\Contracts\TransformerContract;
-use Wrkflow\GetValue\Contracts\TransformerStrategy;
+use Wrkflow\GetValue\Contracts\TransformerStrategyContract;
 use Wrkflow\GetValue\DataHolders\AbstractData;
 use Wrkflow\GetValue\DataHolders\ArrayData;
 use Wrkflow\GetValue\DataHolders\XMLAttributesData;
@@ -37,7 +37,7 @@ class GetValue
 
     public function __construct(
         public readonly AbstractData $data,
-        public readonly TransformerStrategy $transformerStrategy = new DefaultTransformerStrategy(),
+        public readonly TransformerStrategyContract $transformerStrategy = new DefaultTransformerStrategy(),
         public readonly ExceptionBuilderContract $exceptionBuilder = new ExceptionBuilder(),
         GetValidatedValueAction $getValidatedValueAction = null,
     ) {
@@ -255,16 +255,24 @@ public function getDateTime(string|array $key, array $rules = [], ?array $transf
             transformers: $transformers ?? $this->transformerStrategy->dateTime()
         );
 
-        if ($value === null || $value === '') {
-            return null;
-        }
-
         // Transformer built the date time
         if ($value instanceof DateTime) {
             return $value;
         }
 
-        return new DateTime($value);
+        if ($value === null) {
+            return null;
+        }
+
+        if ($value === '') {
+            throw $this->exceptionBuilder->validationFailed(
+                $this->data->getKey($key),
+                StringRule::class,
+                '(empty string)'
+            );
+        }
+
+        return new DateTime((string) $value);
     }
 
     /**

src/GetValueFactory.php

@@ -9,7 +9,7 @@
 use SimpleXMLElement;
 use Wrkflow\GetValue\Builders\ExceptionBuilder;
 use Wrkflow\GetValue\Contracts\ExceptionBuilderContract;
-use Wrkflow\GetValue\Contracts\TransformerStrategy;
+use Wrkflow\GetValue\Contracts\TransformerStrategyContract;
 use Wrkflow\GetValue\DataHolders\AbstractData;
 use Wrkflow\GetValue\DataHolders\ArrayData;
 use Wrkflow\GetValue\DataHolders\XMLData;
@@ -18,7 +18,7 @@
 class GetValueFactory
 {
     public function __construct(
-        public readonly TransformerStrategy $transformerStrategy = new DefaultTransformerStrategy(),
+        public readonly TransformerStrategyContract $transformerStrategy = new DefaultTransformerStrategy(),
         public readonly ExceptionBuilderContract $exceptionBuilder = new ExceptionBuilder(),
     ) {
     }

src/Strategies/DefaultTransformerStrategy.php

@@ -4,11 +4,11 @@
 
 namespace Wrkflow\GetValue\Strategies;
 
-use Wrkflow\GetValue\Contracts\TransformerStrategy;
+use Wrkflow\GetValue\Contracts\TransformerStrategyContract;
 use Wrkflow\GetValue\Transformers\TransformToBool;
 use Wrkflow\GetValue\Transformers\TrimAndEmptyStringToNull;
 
-class DefaultTransformerStrategy implements TransformerStrategy
+class DefaultTransformerStrategy implements TransformerStrategyContract
 {
     public function string(): array
     {
@@ -17,7 +17,7 @@ public function string(): array
 
     public function int(): array
     {
-        return [];
+        return [new TrimAndEmptyStringToNull()];
     }
 
     public function bool(): array
@@ -27,21 +27,21 @@ public function bool(): array
 
     public function dateTime(): array
     {
-        return [];
+        return [new TrimAndEmptyStringToNull()];
     }
 
     public function float(): array
     {
-        return [];
+        return [new TrimAndEmptyStringToNull()];
     }
 
     public function array(): array
     {
-        return [];
+        return [new TrimAndEmptyStringToNull()];
     }
 
     public function xml(): array
     {
-        return [];
+        return [new TrimAndEmptyStringToNull()];
     }
 }

src/Strategies/NoTransformerStrategy.php

@@ -4,9 +4,9 @@
 
 namespace Wrkflow\GetValue\Strategies;
 
-use Wrkflow\GetValue\Contracts\TransformerStrategy;
+use Wrkflow\GetValue\Contracts\TransformerStrategyContract;
 
-class NoTransformerStrategy implements TransformerStrategy
+class NoTransformerStrategy implements TransformerStrategyContract
 {
     public function string(): array
     {

tests/Actions/ValidateActionTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wrkflow\GetValueTests\Actions;
+
+use Exception;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use Wrkflow\GetValue\Actions\ValidateAction;
+use Wrkflow\GetValueTests\Builders\CustomExceptionBuilder;
+use Wrkflow\GetValueTests\Rules\TestRule;
+
+class ValidateActionTest extends TestCase
+{
+    public function data(): array
+    {
+        return [
+            ['', '(empty string)'],
+            ['fail', 'fail'],
+            [
+                'very long string that will be cut off with. This can contain max 30 characters with the dots.',
+                'very long string that will ...',
+            ],
+            [1, '1'],
+            [null, '(null)'],
+            [[], '(array with count 0)'],
+            [[1, 2], '(array with count 2)'],
+            [[
+                'marco' => 1,
+                'polo' => 2,
+                3,
+            ], '(array with count 3)'],
+            [new stdClass(), ''],
+        ];
+    }
+
+    /**
+     * @dataProvider data
+     */
+    public function testConvertsValuesToHumanDescription(mixed $value, string $expectedValueMessage): void
+    {
+        $action = new ValidateAction(new CustomExceptionBuilder());
+        try {
+            $action->execute([new TestRule()], $value, 'test');
+        } catch (Exception $exception) {
+            $this->assertStringContainsString('value: <' . $expectedValueMessage . '>', $exception->getMessage());
+        }
+    }
+}

tests/Builders/CustomExceptionBuilder.php

@@ -26,7 +26,7 @@ public function notAnArray(string $key): Exception
 
     public function validationFailed(string $key, string $ruleClassName, ?string $value): Exception
     {
-        return new Exception('validationFailed: ' . $key . ' ' . $ruleClassName);
+        return new Exception('validationFailed: ' . $key . ' ' . $ruleClassName . ' value: <' . $value . '>');
     }
 
     public function notXML(string $key): Exception