mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 23:05:45 +01:00
5b00d69766Currently, the templates that a user provides when running `assert()` can significantly impact how the message is displayed. Because of this, the formatters become complex as they all need to handle similar conditions to format results. This commit changes this behaviour, letting only the `InterpolationRenderer` handle the templates. This makes the code simpler and allows people to use the `InterpolationRenderer` directly, without needing to figure out how to handle templates. Thinking about it further, I believe handling templates is a concern for the `Renderer` anyway, and this will open the way to other improvements using the renderer. I also removed the exception that is thrown when the template is not a string, because I think that after validation has failed, we should not throw any other exceptions, as that could cause unexpected errors for users.
72 lines
2.7 KiB
PHP
72 lines
2.7 KiB
PHP
<?php
|
|
|
|
/*
|
|
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Respect\Validation\Message\Formatter;
|
|
|
|
use PHPUnit\Framework\Attributes\CoversClass;
|
|
use PHPUnit\Framework\Attributes\DataProvider;
|
|
use PHPUnit\Framework\Attributes\Test;
|
|
use Respect\Validation\Message\StandardFormatter\ResultCreator;
|
|
use Respect\Validation\Result;
|
|
use Respect\Validation\Rule;
|
|
use Respect\Validation\Test\Builders\ResultBuilder;
|
|
use Respect\Validation\Test\Message\TestingMessageRenderer;
|
|
use Respect\Validation\Test\TestCase;
|
|
|
|
#[CoversClass(FirstResultStringFormatter::class)]
|
|
final class FirstResultStringFormatterTest extends TestCase
|
|
{
|
|
use ResultCreator;
|
|
|
|
/** @param array<string, mixed> $templates */
|
|
#[Test]
|
|
#[DataProvider('provideForMain')]
|
|
public function itShouldFormatMainMessage(Result $result, string $expected, array $templates = []): void
|
|
{
|
|
$renderer = new TestingMessageRenderer();
|
|
$formatter = new FirstResultStringFormatter();
|
|
|
|
self::assertSame($expected, $formatter->format($result, $renderer, $templates));
|
|
}
|
|
|
|
/** @return array<string, array{0: Result, 1: string, 2?: array<string, mixed>}> */
|
|
public static function provideForMain(): array
|
|
{
|
|
return [
|
|
'without children' => [
|
|
(new ResultBuilder())->build(),
|
|
Rule::TEMPLATE_STANDARD,
|
|
],
|
|
'with children' => [
|
|
(new ResultBuilder())
|
|
->id('parent')->id('parent')->template('__parent_original__')
|
|
->children(
|
|
(new ResultBuilder())->id('1st')->template('__1st_original__')->build(),
|
|
(new ResultBuilder())->id('1st')->template('__2nd_original__')->build(),
|
|
)
|
|
->build(),
|
|
'__1st_original__',
|
|
],
|
|
'with nested children' => [
|
|
(new ResultBuilder())->id('parent')->template('__parent_original__')
|
|
->children(
|
|
(new ResultBuilder())->id('1st')->template('__1st_original__')
|
|
->children(
|
|
(new ResultBuilder())->id('1st_1st')->template('__1st_1st_original__')->build(),
|
|
(new ResultBuilder())->id('1st_2nd')->template('__1st_2nd_original__')->build(),
|
|
)
|
|
->build(),
|
|
(new ResultBuilder())->id('1st')->template('__2nd_original__')->build(),
|
|
)
|
|
->build(),
|
|
'__1st_1st_original__',
|
|
],
|
|
];
|
|
}
|
|
}
|