Valinor/tests/Integration/Mapping/Object/ScalarValuesMappingTest.php

218 lines
7.8 KiB
PHP
Raw Normal View History

2021-11-28 17:43:02 +01:00
<?php
declare(strict_types=1);
namespace CuyZ\Valinor\Tests\Integration\Mapping\Object;
2021-11-28 17:43:02 +01:00
use CuyZ\Valinor\Mapper\MappingError;
use CuyZ\Valinor\MapperBuilder;
2021-11-28 17:43:02 +01:00
use CuyZ\Valinor\Tests\Integration\IntegrationTest;
use CuyZ\Valinor\Tests\Integration\Mapping\Fixture\SimpleObject;
use DateTime;
use DateTimeImmutable;
use DateTimeInterface;
use stdClass;
use stdClass as ObjectAlias;
final class ScalarValuesMappingTest extends IntegrationTest
{
public function test_values_are_mapped_properly(): void
{
$source = [
'boolean' => true,
'float' => 42.404,
'positiveFloatValue' => 42.404,
'negativeFloatValue' => -42.404,
2021-11-28 17:43:02 +01:00
'integer' => 1337,
'positiveInteger' => 1337,
'negativeInteger' => -1337,
'integerRangeWithPositiveValue' => 1337,
'integerRangeWithNegativeValue' => -1337,
'integerRangeWithMinAndMax' => 42,
'positiveIntegerValue' => 42,
'negativeIntegerValue' => -42,
2021-11-28 17:43:02 +01:00
'string' => 'foo',
'nonEmptyString' => 'bar',
'stringValueWithSingleQuote' => 'baz',
'stringValueWithDoubleQuote' => 'fiz',
2021-11-28 17:43:02 +01:00
'classString' => self::class,
'classStringOfDateTime' => DateTimeImmutable::class,
'classStringOfAlias' => stdClass::class,
];
foreach ([ScalarValues::class, ScalarValuesWithConstructor::class] as $class) {
try {
$result = (new MapperBuilder())->mapper()->map($class, $source);
2021-11-28 17:43:02 +01:00
} catch (MappingError $error) {
$this->mappingFail($error);
}
self::assertSame(true, $result->boolean);
self::assertSame(42.404, $result->float);
self::assertSame(42.404, $result->positiveFloatValue); // @phpstan-ignore-line
self::assertSame(-42.404, $result->negativeFloatValue); // @phpstan-ignore-line
2021-11-28 17:43:02 +01:00
self::assertSame(1337, $result->integer);
self::assertSame(1337, $result->positiveInteger);
self::assertSame(-1337, $result->negativeInteger);
self::assertSame(1337, $result->integerRangeWithPositiveValue);
self::assertSame(-1337, $result->integerRangeWithNegativeValue);
self::assertSame(42, $result->integerRangeWithMinAndMax);
self::assertSame(42, $result->positiveIntegerValue); // @phpstan-ignore-line
self::assertSame(-42, $result->negativeIntegerValue); // @phpstan-ignore-line
2021-11-28 17:43:02 +01:00
self::assertSame('foo', $result->string);
self::assertSame('bar', $result->nonEmptyString);
2022-05-06 13:56:16 +02:00
self::assertSame('baz', $result->stringValueWithSingleQuote); // @phpstan-ignore-line
self::assertSame('fiz', $result->stringValueWithDoubleQuote); // @phpstan-ignore-line
2021-11-28 17:43:02 +01:00
self::assertSame(self::class, $result->classString);
self::assertSame(DateTimeImmutable::class, $result->classStringOfDateTime);
self::assertSame(stdClass::class, $result->classStringOfAlias);
}
}
public function test_value_that_cannot_be_casted_throws_exception(): void
{
try {
(new MapperBuilder())->mapper()->map(SimpleObject::class, [
2021-11-28 17:43:02 +01:00
'value' => new stdClass(),
]);
} catch (MappingError $exception) {
feat!: add access to root node when error occurs during mapping When an error occurs during mapping, the root instance of `Node` can now be accessed from the exception. This recursive object allows retrieving all needed information through the whole mapping tree: path, values, types and messages, including the issues that caused the exception. It can be used like the following: ```php try { (new \CuyZ\Valinor\MapperBuilder()) ->mapper() ->map(SomeClass::class, [/* ... */]); } catch (\CuyZ\Valinor\Mapper\MappingError $error) { // Do something with `$error->node()` // See README for more information } ``` This change removes the method `MappingError::describe()` which provided a flattened view of messages of all the errors that were encountered during the mapping. The same behaviour can still be retrieved, see the example below: ```php use CuyZ\Valinor\Mapper\Tree\Message\Message; use CuyZ\Valinor\Mapper\Tree\Node; /** * @implements \IteratorAggregate<string, array<\Throwable&Message>> */ final class MappingErrorList implements \IteratorAggregate { private Node $node; public function __construct(Node $node) { $this->node = $node; } /** * @return \Traversable<string, array<\Throwable&Message>> */ public function getIterator(): \Traversable { yield from $this->errors($this->node); } /** * @return \Traversable<string, array<\Throwable&Message>> */ private function errors(Node $node): \Traversable { $errors = array_filter( $node->messages(), static fn (Message $m) => $m instanceof \Throwable ); if (! empty($errors)) { yield $node->path() => array_values($errors); } foreach ($node->children() as $child) { yield from $this->errors($child); } } } try { (new \CuyZ\Valinor\MapperBuilder()) ->mapper() ->map(SomeClass::class, [/* ... */]); } catch (\CuyZ\Valinor\Mapper\MappingError $error) { $errors = iterator_to_array(new MappingErrorList($error->node())); } ``` The class `CannotMapObject` is deleted, as it does not provide any value; this means that `MappingError` which was previously an interface becomes a class.
2021-12-16 00:00:45 +01:00
$error = $exception->node()->children()['value']->messages()[0];
self::assertSame('1618736242', $error->code());
self::assertSame('Cannot cast object(stdClass) to `string`.', (string)$error);
2021-11-28 17:43:02 +01:00
}
}
public function test_empty_mandatory_value_throws_exception(): void
{
try {
(new MapperBuilder())->mapper()->map(SimpleObject::class, [
2021-11-28 17:43:02 +01:00
'value' => null,
]);
} catch (MappingError $exception) {
feat!: add access to root node when error occurs during mapping When an error occurs during mapping, the root instance of `Node` can now be accessed from the exception. This recursive object allows retrieving all needed information through the whole mapping tree: path, values, types and messages, including the issues that caused the exception. It can be used like the following: ```php try { (new \CuyZ\Valinor\MapperBuilder()) ->mapper() ->map(SomeClass::class, [/* ... */]); } catch (\CuyZ\Valinor\Mapper\MappingError $error) { // Do something with `$error->node()` // See README for more information } ``` This change removes the method `MappingError::describe()` which provided a flattened view of messages of all the errors that were encountered during the mapping. The same behaviour can still be retrieved, see the example below: ```php use CuyZ\Valinor\Mapper\Tree\Message\Message; use CuyZ\Valinor\Mapper\Tree\Node; /** * @implements \IteratorAggregate<string, array<\Throwable&Message>> */ final class MappingErrorList implements \IteratorAggregate { private Node $node; public function __construct(Node $node) { $this->node = $node; } /** * @return \Traversable<string, array<\Throwable&Message>> */ public function getIterator(): \Traversable { yield from $this->errors($this->node); } /** * @return \Traversable<string, array<\Throwable&Message>> */ private function errors(Node $node): \Traversable { $errors = array_filter( $node->messages(), static fn (Message $m) => $m instanceof \Throwable ); if (! empty($errors)) { yield $node->path() => array_values($errors); } foreach ($node->children() as $child) { yield from $this->errors($child); } } } try { (new \CuyZ\Valinor\MapperBuilder()) ->mapper() ->map(SomeClass::class, [/* ... */]); } catch (\CuyZ\Valinor\Mapper\MappingError $error) { $errors = iterator_to_array(new MappingErrorList($error->node())); } ``` The class `CannotMapObject` is deleted, as it does not provide any value; this means that `MappingError` which was previously an interface becomes a class.
2021-12-16 00:00:45 +01:00
$error = $exception->node()->children()['value']->messages()[0];
self::assertSame('1618736242', $error->code());
feat!: improve message customization with formatters The way messages can be customized has been totally revisited, requiring several breaking changes. All existing error messages have been rewritten to better fit the actual meaning of the error. The content of a message can be changed to fit custom use cases; it can contain placeholders that will be replaced with useful information. The placeholders below are always available; even more may be used depending on the original message. - `{message_code}` — the code of the message - `{node_name}` — name of the node to which the message is bound - `{node_path}` — path of the node to which the message is bound - `{node_type}` — type of the node to which the message is bound - `{original_value}` — the source value that was given to the node - `{original_message}` — the original message before being customized ```php try { (new \CuyZ\Valinor\MapperBuilder()) ->mapper() ->map(SomeClass::class, [/* … */]); } catch (\CuyZ\Valinor\Mapper\MappingError $error) { $messages = new MessagesFlattener($error->node()); foreach ($messages as $message) { if ($message->code() === 'some_code') { $message = $message->withBody('new / {original_message}'); } echo $message; } } ``` The messages are formatted using the ICU library, enabling the placeholders to use advanced syntax to perform proper translations, for instance currency support. ```php try { (new MapperBuilder())->mapper()->map('int<0, 100>', 1337); } catch (\CuyZ\Valinor\Mapper\MappingError $error) { $message = $error->node()->messages()[0]; if (is_numeric($message->value())) { $message = $message->withBody( 'Invalid amount {original_value, number, currency}' ); } // Invalid amount: $1,337.00 echo $message->withLocale('en_US'); // Invalid amount: £1,337.00 echo $message->withLocale('en_GB'); // Invalid amount: 1 337,00 € echo $message->withLocale('fr_FR'); } ``` If the `intl` extension is not installed, a shim will be available to replace the placeholders, but it won't handle advanced syntax as described above. --- The new formatter `TranslationMessageFormatter` can be used to translate the content of messages. The library provides a list of all messages that can be returned; this list can be filled or modified with custom translations. ```php TranslationMessageFormatter::default() // Create/override a single entry… ->withTranslation( 'fr', 'some custom message', 'un message personnalisé' ) // …or several entries. ->withTranslations([ 'some custom message' => [ 'en' => 'Some custom message', 'fr' => 'Un message personnalisé', 'es' => 'Un mensaje personalizado', ], 'some other message' => [ // … ], ]) ->format($message); ``` It is possible to join several formatters into one formatter by using the `AggregateMessageFormatter`. This instance can then easily be injected in a service that will handle messages. The formatters will be called in the same order they are given to the aggregate. ```php (new AggregateMessageFormatter( new LocaleMessageFormatter('fr'), new MessageMapFormatter([ // … ], TranslationMessageFormatter::default(), ))->format($message) ``` BREAKING CHANGE: The method `NodeMessage::format` has been removed, message formatters should be used instead. If needed, the old behaviour can be retrieved with the formatter `PlaceHolderMessageFormatter`, although it is strongly advised to use the new placeholders feature. BREAKING CHANGE: The signature of the method `MessageFormatter::format` has changed.
2022-05-18 23:15:08 +02:00
self::assertSame('Cannot be empty and must be filled with a value matching type `string`.', (string)$error);
2021-11-28 17:43:02 +01:00
}
}
}
class ScalarValues
{
public bool $boolean = false;
public float $float = -1.0;
/** @var 42.404 */
public float $positiveFloatValue;
/** @var -42.404 */
public float $negativeFloatValue;
2021-11-28 17:43:02 +01:00
public int $integer = -1;
/** @var positive-int */
public int $positiveInteger = 1;
/** @var negative-int */
public int $negativeInteger = -1;
/** @var int<-1337, 1337> */
public int $integerRangeWithPositiveValue = -1;
/** @var int<-1337, 1337> */
public int $integerRangeWithNegativeValue = -1;
/** @var int<min, max> */
public int $integerRangeWithMinAndMax = -1;
/** @var 42 */
public int $positiveIntegerValue;
/** @var -42 */
public int $negativeIntegerValue;
2021-11-28 17:43:02 +01:00
public string $string = 'Schwifty!';
/** @var non-empty-string */
public string $nonEmptyString = 'Schwifty!';
/** @var 'baz' */
public string $stringValueWithSingleQuote;
/** @var "fiz" */
public string $stringValueWithDoubleQuote;
2021-11-28 17:43:02 +01:00
/** @var class-string */
public string $classString = stdClass::class;
/** @var class-string<DateTimeInterface> */
public string $classStringOfDateTime = DateTime::class;
/** @var class-string<ObjectAlias> */
public string $classStringOfAlias;
}
class ScalarValuesWithConstructor extends ScalarValues
{
/**
* @param 42.404 $positiveFloatValue
* @param -42.404 $negativeFloatValue
2021-11-28 17:43:02 +01:00
* @param positive-int $positiveInteger
* @param negative-int $negativeInteger
* @param int<-1337, 1337> $integerRangeWithPositiveValue
* @param int<-1337, 1337> $integerRangeWithNegativeValue
* @param int<min, max> $integerRangeWithMinAndMax
* @param 42 $positiveIntegerValue
* @param -42 $negativeIntegerValue
2021-11-28 17:43:02 +01:00
* @param non-empty-string $nonEmptyString
* @param 'baz' $stringValueWithSingleQuote
* @param "fiz" $stringValueWithDoubleQuote
2021-11-28 17:43:02 +01:00
* @param class-string $classString
* @param class-string<DateTimeInterface> $classStringOfDateTime
* @param class-string<ObjectAlias> $classStringOfAlias
*/
public function __construct(
bool $boolean,
float $float,
float $positiveFloatValue,
float $negativeFloatValue,
2021-11-28 17:43:02 +01:00
int $integer,
int $positiveInteger,
int $negativeInteger,
int $integerRangeWithPositiveValue,
int $integerRangeWithNegativeValue,
int $integerRangeWithMinAndMax,
int $positiveIntegerValue,
int $negativeIntegerValue,
2021-11-28 17:43:02 +01:00
string $string,
string $nonEmptyString,
string $stringValueWithSingleQuote,
string $stringValueWithDoubleQuote,
2021-11-28 17:43:02 +01:00
string $classString,
string $classStringOfDateTime,
string $classStringOfAlias
) {
$this->boolean = $boolean;
$this->float = $float;
$this->positiveFloatValue = $positiveFloatValue;
$this->negativeFloatValue = $negativeFloatValue;
2021-11-28 17:43:02 +01:00
$this->integer = $integer;
$this->positiveInteger = $positiveInteger;
$this->negativeInteger = $negativeInteger;
$this->integerRangeWithPositiveValue = $integerRangeWithPositiveValue;
$this->integerRangeWithNegativeValue = $integerRangeWithNegativeValue;
$this->integerRangeWithMinAndMax = $integerRangeWithMinAndMax;
$this->positiveIntegerValue = $positiveIntegerValue;
$this->negativeIntegerValue = $negativeIntegerValue;
2021-11-28 17:43:02 +01:00
$this->string = $string;
$this->nonEmptyString = $nonEmptyString;
$this->stringValueWithSingleQuote = $stringValueWithSingleQuote;
$this->stringValueWithDoubleQuote = $stringValueWithDoubleQuote;
2021-11-28 17:43:02 +01:00
$this->classString = $classString;
$this->classStringOfDateTime = $classStringOfDateTime;
$this->classStringOfAlias = $classStringOfAlias;
}
}