mirror of
https://github.com/danog/Valinor.git
synced 2024-12-04 02:27:54 +01:00
676 lines
27 KiB
Markdown
676 lines
27 KiB
Markdown
<!--- BEGIN HEADER -->
|
|
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
<!--- END HEADER -->
|
|
|
|
## [0.9.0](https://github.com/CuyZ/Valinor/compare/0.8.0...0.9.0) (2022-05-23)
|
|
|
|
### Notable changes
|
|
|
|
**Cache injection and warmup**
|
|
|
|
The cache feature has been revisited, to give more control to the user on how
|
|
and when to use it.
|
|
|
|
The method `MapperBuilder::withCacheDir()` has been deprecated in favor of a new
|
|
method `MapperBuilder::withCache()` which accepts any PSR-16 compliant
|
|
implementation.
|
|
|
|
> **Warning**
|
|
>
|
|
> These changes lead up to the default cache not being automatically
|
|
> registered anymore. If you still want to enable the cache (which you should),
|
|
> you will have to explicitly inject it (see below).
|
|
|
|
A default implementation is provided out of the box, which saves cache entries
|
|
into the file system.
|
|
|
|
When the application runs in a development environment, the cache implementation
|
|
should be decorated with `FileWatchingCache`, which will watch the files of the
|
|
application and invalidate cache entries when a PHP file is modified by a
|
|
developer — preventing the library not behaving as expected when the signature
|
|
of a property or a method changes.
|
|
|
|
|
|
The cache can be warmed up, for instance in a pipeline during the build and
|
|
deployment of the application — kudos to @boesing for the feature!
|
|
|
|
> **Note** The cache has to be registered first, otherwise the warmup will end
|
|
> up being useless.
|
|
|
|
```php
|
|
$cache = new \CuyZ\Valinor\Cache\FileSystemCache('path/to/cache-directory');
|
|
|
|
if ($isApplicationInDevelopmentEnvironment) {
|
|
$cache = new \CuyZ\Valinor\Cache\FileWatchingCache($cache);
|
|
}
|
|
|
|
$mapperBuilder = (new \CuyZ\Valinor\MapperBuilder())->withCache($cache);
|
|
|
|
// During the build:
|
|
$mapperBuilder->warmup(SomeClass::class, SomeOtherClass::class);
|
|
|
|
// In the application:
|
|
$mapperBuilder->mapper()->map(SomeClass::class, [/* … */]);
|
|
```
|
|
|
|
---
|
|
|
|
**Message formatting & translation**
|
|
|
|
Major changes have been made to the messages being returned in case of a mapping
|
|
error: the actual texts are now more accurate and show better information.
|
|
|
|
> **Warning**
|
|
>
|
|
> 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 (see below).
|
|
>
|
|
> The signature of the method `MessageFormatter::format` has changed as well.
|
|
|
|
It is now also easier to format the messages, for instance when they need to be
|
|
translated. Placeholders can now be used in a message body, and will be replaced
|
|
with useful information.
|
|
|
|
| Placeholder | Description |
|
|
|----------------------|:-----------------------------------------------------|
|
|
| `{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) {
|
|
$node = $error->node();
|
|
$messages = new \CuyZ\Valinor\Mapper\Tree\Message\MessagesFlattener($node);
|
|
|
|
foreach ($messages as $message) {
|
|
if ($message->code() === 'some_code') {
|
|
$message = $message->withBody('new message / {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 \CuyZ\Valinor\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');
|
|
}
|
|
```
|
|
|
|
See [ICU documentation] for more information on available syntax.
|
|
|
|
> **Warning** 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 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
|
|
\CuyZ\Valinor\Mapper\Tree\Message\Formatter\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 \CuyZ\Valinor\Mapper\Tree\Message\Formatter\AggregateMessageFormatter(
|
|
new \CuyZ\Valinor\Mapper\Tree\Message\Formatter\LocaleMessageFormatter('fr'),
|
|
new \CuyZ\Valinor\Mapper\Tree\Message\Formatter\MessageMapFormatter([
|
|
// …
|
|
],
|
|
\CuyZ\Valinor\Mapper\Tree\Message\Formatter\TranslationMessageFormatter::default(),
|
|
))->format($message)
|
|
```
|
|
|
|
[ICU library]: https://unicode-org.github.io/icu/
|
|
|
|
[ICU documentation]: https://unicode-org.github.io/icu/userguide/format_parse/messages/
|
|
|
|
### ⚠ BREAKING CHANGES
|
|
|
|
* Improve message customization with formatters ([60a665](https://github.com/CuyZ/Valinor/commit/60a66561413fc0d366cae9acf57ac553bb1a919d))
|
|
* Revoke `ObjectBuilder` API access ([11e126](https://github.com/CuyZ/Valinor/commit/11e12624aad2378465122b987e53e76c744d2179))
|
|
|
|
### Features
|
|
|
|
* Allow injecting a cache implementation that is used by the mapper ([69ad3f](https://github.com/CuyZ/Valinor/commit/69ad3f47777f2bec4e565b98035f07696cd16d35))
|
|
* Extract file watching feature in own cache implementation ([2d70ef](https://github.com/CuyZ/Valinor/commit/2d70efbfbb73dfe02987de82ee7fc5bb38b3e486))
|
|
* Improve mapping error messages ([05cf4a](https://github.com/CuyZ/Valinor/commit/05cf4a4a4dc40af735ba12af5bc986ffec015c6c))
|
|
* Introduce method to warm the cache up ([ccf09f](https://github.com/CuyZ/Valinor/commit/ccf09fd33433e065ca7ad26cc90e433dc8d1ae84))
|
|
|
|
### Bug Fixes
|
|
|
|
* Make interface type match undefined object type ([105eef](https://github.com/CuyZ/Valinor/commit/105eef473821f6f6990a080c5e14a78ed5be24db))
|
|
|
|
### Other
|
|
|
|
* Change `InvalidParameterIndex` exception inheritance type ([b75adb](https://github.com/CuyZ/Valinor/commit/b75adb7c7ceba2382cab5f265d93ed46bcfd8f4e))
|
|
* Introduce layer for object builder arguments ([48f936](https://github.com/CuyZ/Valinor/commit/48f936275e7f8af937e0740cdbbac0f9557ab4a3))
|
|
|
|
|
|
---
|
|
|
|
## [0.8.0](https://github.com/CuyZ/Valinor/compare/0.7.1...0.8.0) (2022-05-09)
|
|
|
|
### Notable changes
|
|
|
|
**Float values handling**
|
|
|
|
Allows the usage of float values, as follows:
|
|
|
|
```php
|
|
class Foo
|
|
{
|
|
/** @var 404.42|1337.42 */
|
|
public readonly float $value;
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
**Literal boolean `true` / `false` values handling**
|
|
|
|
Thanks @danog for this feature!
|
|
|
|
Allows the usage of boolean values, as follows:
|
|
|
|
```php
|
|
class Foo
|
|
{
|
|
/** @var int|false */
|
|
public readonly int|bool $value;
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
**Class string of union of object handling**
|
|
|
|
Allows to declare several class names in a `class-string`:
|
|
|
|
```php
|
|
class Foo
|
|
{
|
|
/** @var class-string<SomeClass|SomeOtherClass> */
|
|
public readonly string $className;
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
**Allow `psalm` and `phpstan` prefix in docblocks**
|
|
|
|
Thanks @boesing for this feature!
|
|
|
|
The following annotations are now properly handled: `@psalm-param`,
|
|
`@phpstan-param`, `@psalm-return` and `@phpstan-return`.
|
|
|
|
If one of those is found along with a basic `@param` or `@return` annotation, it
|
|
will take precedence over the basic value.
|
|
|
|
### Features
|
|
|
|
* Allow `psalm` and `phpstan` prefix in docblocks ([64e0a2](https://github.com/CuyZ/Valinor/commit/64e0a2d5ac727062c7c9c45f636081d1065f2bb9))
|
|
* Handle class string of union of object ([b7923b](https://github.com/CuyZ/Valinor/commit/b7923bc383f55095683e38a6da760a90df156edd))
|
|
* Handle filename in function definition ([0b042b](https://github.com/CuyZ/Valinor/commit/0b042bc495caf30f3a4d6e72547f65dae69282ec))
|
|
* Handle float value type ([790df8](https://github.com/CuyZ/Valinor/commit/790df8a3b8e9b608e33086f673372b8dff7775c7))
|
|
* Handle literal boolean `true` / `false` types ([afcedf](https://github.com/CuyZ/Valinor/commit/afcedf9e56100e3e69c340172b40cd6deb471f64))
|
|
* Introduce composite types ([892f38](https://github.com/CuyZ/Valinor/commit/892f3831c221c93f74edc4ec14b56c281cf2438e))
|
|
|
|
### Bug Fixes
|
|
|
|
* Call value altering function only if value is accepted ([2f08e1](https://github.com/CuyZ/Valinor/commit/2f08e1a9b306a1d1ae0e9636049816a9c8bd0b92))
|
|
* Handle function definition cache invalidation when file is modified ([511a0d](https://github.com/CuyZ/Valinor/commit/511a0dfee8ab51f9d220df03f063aead603298ba))
|
|
|
|
### Other
|
|
|
|
* Add configuration for Composer allowed plugins ([2f310c](https://github.com/CuyZ/Valinor/commit/2f310cf5ab9f36bf98d338a99a536279049d1cef))
|
|
* Add Psalm configuration file to `.gitattributes` ([979272](https://github.com/CuyZ/Valinor/commit/9792722e4f17507c73cd243ad3f23053e24278aa))
|
|
* Bump dev-dependencies ([844384](https://github.com/CuyZ/Valinor/commit/8443847cb8a7c4810ff8f71cb88487762f1532c1))
|
|
* Declare code type in docblocks ([03c84a](https://github.com/CuyZ/Valinor/commit/03c84a1f09b5e4cc567a5640f660a60db860c23c))
|
|
* Ignore `Polyfill` coverage ([c08fe5](https://github.com/CuyZ/Valinor/commit/c08fe5a3c53618a9e67d2aaa5f6c9d51f7d482c9))
|
|
* Remove `symfony/polyfill-php80` dependency ([368737](https://github.com/CuyZ/Valinor/commit/368737921787a12cd0bd04b5161f36c487e62b64))
|
|
|
|
|
|
---
|
|
|
|
## [0.7.0](https://github.com/CuyZ/Valinor/compare/0.6.0...0.7.0) (2022-03-24)
|
|
|
|
### Notable changes
|
|
|
|
> **Warning** This release introduces a major breaking change that must be
|
|
considered before updating
|
|
|
|
**Constructor registration**
|
|
|
|
**The automatic named constructor discovery has been disabled**. It is now
|
|
mandatory to explicitly register custom constructors that can be used by the
|
|
mapper.
|
|
|
|
This decision was made because of a security issue reported by @Ocramius and
|
|
described in advisory [GHSA-xhr8-mpwq-2rr2].
|
|
|
|
As a result, existing code must list all named constructors that were previously
|
|
automatically used by the mapper, and registerer them using the
|
|
method `MapperBuilder::registerConstructor()`.
|
|
|
|
The method `MapperBuilder::bind()` has been deprecated in favor of the method
|
|
above that should be used instead.
|
|
|
|
```php
|
|
final class SomeClass
|
|
{
|
|
public static function namedConstructor(string $foo): self
|
|
{
|
|
// …
|
|
}
|
|
}
|
|
|
|
(new \CuyZ\Valinor\MapperBuilder())
|
|
->registerConstructor(
|
|
SomeClass::namedConstructor(...),
|
|
// …or for PHP < 8.1:
|
|
[SomeClass::class, 'namedConstructor'],
|
|
)
|
|
->mapper()
|
|
->map(SomeClass::class, [
|
|
// …
|
|
]);
|
|
```
|
|
|
|
See [documentation](https://github.com/CuyZ/Valinor#custom-constructor) for more
|
|
information.
|
|
|
|
---
|
|
|
|
**Source builder**
|
|
|
|
The `Source` class is a new entry point for sources that are not plain array or
|
|
iterable. It allows accessing other features like camel-case keys or custom
|
|
paths mapping in a convenient way.
|
|
|
|
It should be used as follows:
|
|
|
|
```php
|
|
$source = \CuyZ\Valinor\Mapper\Source\Source::json($jsonString)
|
|
->camelCaseKeys()
|
|
->map([
|
|
'towns' => 'cities',
|
|
'towns.*.label' => 'name',
|
|
]);
|
|
|
|
$result = (new \CuyZ\Valinor\MapperBuilder())
|
|
->mapper()
|
|
->map(SomeClass::class, $source);
|
|
```
|
|
|
|
See [documentation](https://github.com/CuyZ/Valinor#source) for more details
|
|
about its usage.
|
|
|
|
### ⚠ BREAKING CHANGES
|
|
|
|
* Change `Attributes::ofType` return type to `array` ([1a599b](https://github.com/CuyZ/Valinor/commit/1a599b0bdf5cf07385ed120817f1a4720064e4dc))
|
|
* Introduce method to register constructors used during mapping ([ecafba](https://github.com/CuyZ/Valinor/commit/ecafba3b21cd48f38a5e5d2b5b7f97012342536a))
|
|
|
|
### Features
|
|
|
|
* Introduce a path-mapping source modifier ([b7a7d2](https://github.com/CuyZ/Valinor/commit/b7a7d22993eb2758f5beb80e58e599df60258bf3))
|
|
* Introduce a source builder ([ad5103](https://github.com/CuyZ/Valinor/commit/ad51039cc3f76245eb96fab21a0f2709fcf13bdb))
|
|
|
|
### Bug Fixes
|
|
|
|
* Handle numeric key with camel case source key modifier ([b8a18f](https://github.com/CuyZ/Valinor/commit/b8a18feadcbb564d80a34ca004c584c56ac0de04))
|
|
* Handle parameter default object value compilation ([fdef93](https://github.com/CuyZ/Valinor/commit/fdef93074c32cf36072446da8a3466a1bf781dbb))
|
|
* Handle variadic arguments in callable constructors ([b646cc](https://github.com/CuyZ/Valinor/commit/b646ccecf25ca17ecf8fec4e03bb91748db9527d))
|
|
* Properly handle alias types for function reflection ([e5b515](https://github.com/CuyZ/Valinor/commit/e5b5157eaf0b60e10f1060bf22cc4e2bd7d828c7))
|
|
|
|
### Other
|
|
|
|
* Add Striker HTML report when running infection ([79c7a4](https://github.com/CuyZ/Valinor/commit/79c7a4563d545d5513f96ec1b5f00abbd50b5881))
|
|
* Handle class name in function definition ([e2451d](https://github.com/CuyZ/Valinor/commit/e2451df2c1857a935a1fc2e88c056d6b414ed924))
|
|
* Introduce functions container to wrap definition handling ([fd1117](https://github.com/CuyZ/Valinor/commit/fd11177b06c9740c621155c2f635e012c2f8651e))
|
|
|
|
|
|
---
|
|
|
|
## [0.6.0](https://github.com/CuyZ/Valinor/compare/0.5.0...0.6.0) (2022-02-24)
|
|
### ⚠ BREAKING CHANGES
|
|
|
|
* Improve interface inferring API ([1eb6e6](https://github.com/CuyZ/Valinor/commit/1eb6e6191368453b2c982068a4ceac42681dcbe8))
|
|
* Improve object binding API ([6d4270](https://github.com/CuyZ/Valinor/commit/6d427088f7141a860ce89e5874fdcdf3abb528b6))
|
|
|
|
### Features
|
|
|
|
* Handle variadic parameters in constructors ([b6b329](https://github.com/CuyZ/Valinor/commit/b6b329663853aec3597041eea3d936186c410621))
|
|
* Improve value altering API ([422e6a](https://github.com/CuyZ/Valinor/commit/422e6a8b272ee1955fef904a43c8bf3721b70ae1))
|
|
* Introduce a camel case source key modifier ([d94652](https://github.com/CuyZ/Valinor/commit/d9465222f463896f84379f6e6f1cfef016a0470d))
|
|
* Introduce function definition repository ([b49ebf](https://github.com/CuyZ/Valinor/commit/b49ebf37be630d4a26e3525ecaedf89fbaa53520))
|
|
* Introduce method to get parameter by index ([380961](https://github.com/CuyZ/Valinor/commit/380961247e065155ce2fdd212f8a51bbe82e931e))
|
|
|
|
### Bug Fixes
|
|
|
|
* Change license in `composer.json` ([6fdd62](https://github.com/CuyZ/Valinor/commit/6fdd62dfc2fd68b29b6d915e1f3a81f54e5aea51))
|
|
* Ensure native mixed types remain valid ([18ccbe](https://github.com/CuyZ/Valinor/commit/18ccbebb9a4484e4efb4db2c5c9405e853578e7d))
|
|
* Remove string keys when unpacking variadic parameter values ([cbf4e1](https://github.com/CuyZ/Valinor/commit/cbf4e11154ae428323099db7e689494624f63293))
|
|
* Transform exception thrown during object binding into a message ([359e32](https://github.com/CuyZ/Valinor/commit/359e32d03d062610aab4c171a943b28a09cbaf0f))
|
|
* Write temporary cache file inside cache subdirectory ([1b80a1](https://github.com/CuyZ/Valinor/commit/1b80a1df9d64e4c835362b34b1dec9b38ad083d3))
|
|
|
|
### Other
|
|
|
|
* Check value acceptance in separate node builder ([30d447](https://github.com/CuyZ/Valinor/commit/30d4479aefdeb09c7cea20cb4daea1f2b724871b))
|
|
* Narrow union types during node build ([06e9de](https://github.com/CuyZ/Valinor/commit/06e9dedfd8742be8946b57aedc8d03945eae36fc))
|
|
|
|
|
|
---
|
|
|
|
## [0.5.0](https://github.com/CuyZ/Valinor/compare/0.4.0...0.5.0) (2022-01-27)
|
|
### Features
|
|
|
|
* Introduce automatic named constructor resolution ([718d3c](https://github.com/CuyZ/Valinor/commit/718d3c1bc2ea7d28b4b1f6c062addcd1dde8660b))
|
|
* Set up dependabot for automated weekly dependency upgrades ([23b611](https://github.com/CuyZ/Valinor/commit/23b6113869abbcf8d13f4702b69fca59f61b9205))
|
|
* Simplify type signature of `TreeMapper#map()` ([e28003](https://github.com/CuyZ/Valinor/commit/e2800339411b68a24eebc266377184c76ef2701e))
|
|
|
|
### Bug Fixes
|
|
|
|
* Correct regex that detects [*@internal*](https://github.com/internal) or [*@api*](https://github.com/api) annotations ([39f0b7](https://github.com/CuyZ/Valinor/commit/39f0b71b94fa762ae7eb4cf9b1d7c871a70a31ef))
|
|
* Improve type definitions to allow Psalm automatic inferring ([f9b04c](https://github.com/CuyZ/Valinor/commit/f9b04c5c2717eaca1b7bb86fc6311917f05c82b0))
|
|
* Return indexed list of attributes when filtering on type ([66aa4d](https://github.com/CuyZ/Valinor/commit/66aa4d688ac162093b9fde3579d08795e1e61cc9))
|
|
|
|
|
|
---
|
|
|
|
## [0.4.0](https://github.com/CuyZ/Valinor/compare/0.3.0...0.4.0) (2022-01-07)
|
|
|
|
### Notable changes
|
|
|
|
**Allow mapping to any type**
|
|
|
|
Previously, the method `TreeMapper::map` would allow mapping only to an object.
|
|
It is now possible to map to any type handled by the library.
|
|
|
|
It is for instance possible to map to an array of objects:
|
|
|
|
```php
|
|
$objects = (new MapperBuilder())->mapper()->map(
|
|
'array<' . SomeClass::class . '>',
|
|
[/* … */]
|
|
);
|
|
```
|
|
|
|
For simple use-cases, an array shape can be used:
|
|
|
|
```php
|
|
$array = (new MapperBuilder())->mapper()->map(
|
|
'array{foo: string, bar: int}',
|
|
[/* … */]
|
|
);
|
|
|
|
echo $array['foo'];
|
|
echo $array['bar'] * 2;
|
|
```
|
|
|
|
This new feature changes the possible behaviour of the mapper, meaning static
|
|
analysis tools need help to understand the types correctly. An extension for
|
|
PHPStan and a plugin for Psalm are now provided and can be included in a project
|
|
to automatically increase the type coverage.
|
|
|
|
---
|
|
|
|
**Better handling of messages**
|
|
|
|
When working with messages, it can sometimes be useful to customize the content
|
|
of a message — for instance to translate it.
|
|
|
|
The helper
|
|
class `\CuyZ\Valinor\Mapper\Tree\Message\Formatter\MessageMapFormatter` can be
|
|
used to provide a list of new formats. It can be instantiated with an array
|
|
where each key represents either:
|
|
|
|
- The code of the message to be replaced
|
|
- The content of the message to be replaced
|
|
- The class name of the message to be replaced
|
|
|
|
If none of those is found, the content of the message will stay unchanged unless
|
|
a default one is given to the class.
|
|
|
|
If one of these keys is found, the array entry will be used to replace the
|
|
content of the message. This entry can be either a plain text or a callable that
|
|
takes the message as a parameter and returns a string; it is for instance
|
|
advised to use a callable in cases where a translation service is used — to
|
|
avoid useless greedy operations.
|
|
|
|
In any case, the content can contain placeholders that will automatically be
|
|
replaced by, in order:
|
|
|
|
1. The original code of the message
|
|
2. The original content of the message
|
|
3. A string representation of the node type
|
|
4. The name of the node
|
|
5. The path of the node
|
|
|
|
```php
|
|
try {
|
|
(new \CuyZ\Valinor\MapperBuilder())
|
|
->mapper()
|
|
->map(SomeClass::class, [/* … */]);
|
|
} catch (\CuyZ\Valinor\Mapper\MappingError $error) {
|
|
$node = $error->node();
|
|
$messages = new \CuyZ\Valinor\Mapper\Tree\Message\MessagesFlattener($node);
|
|
|
|
$formatter = (new MessageMapFormatter([
|
|
// Will match if the given message has this exact code
|
|
'some_code' => 'new content / previous code was: %1$s',
|
|
|
|
// Will match if the given message has this exact content
|
|
'Some message content' => 'new content / previous message: %2$s',
|
|
|
|
// Will match if the given message is an instance of `SomeError`
|
|
SomeError::class => '
|
|
- Original code of the message: %1$s
|
|
- Original content of the message: %2$s
|
|
- Node type: %3$s
|
|
- Node name: %4$s
|
|
- Node path: %5$s
|
|
',
|
|
|
|
// A callback can be used to get access to the message instance
|
|
OtherError::class => function (NodeMessage $message): string {
|
|
if ((string)$message->type() === 'string|int') {
|
|
// …
|
|
}
|
|
|
|
return 'Some message content';
|
|
},
|
|
|
|
// For greedy operation, it is advised to use a lazy-callback
|
|
'bar' => fn () => $this->translator->translate('foo.bar'),
|
|
]))
|
|
->defaultsTo('some default message')
|
|
// …or…
|
|
->defaultsTo(fn () => $this->translator->translate('default_message'));
|
|
|
|
foreach ($messages as $message) {
|
|
echo $formatter->format($message);
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
**Automatic union of objects inferring during mapping**
|
|
|
|
When the mapper needs to map a source to a union of objects, it will try to
|
|
guess which object it will map to, based on the needed arguments of the objects,
|
|
and the values contained in the source.
|
|
|
|
```php
|
|
final class UnionOfObjects
|
|
{
|
|
public readonly SomeFooObject|SomeBarObject $object;
|
|
}
|
|
|
|
final class SomeFooObject
|
|
{
|
|
public readonly string $foo;
|
|
}
|
|
|
|
final class SomeBarObject
|
|
{
|
|
public readonly string $bar;
|
|
}
|
|
|
|
// Will map to an instance of `SomeFooObject`
|
|
(new \CuyZ\Valinor\MapperBuilder())
|
|
->mapper()
|
|
->map(UnionOfObjects::class, ['foo' => 'foo']);
|
|
|
|
// Will map to an instance of `SomeBarObject`
|
|
(new \CuyZ\Valinor\MapperBuilder())
|
|
->mapper()
|
|
->map(UnionOfObjects::class, ['bar' => 'bar']);
|
|
```
|
|
|
|
### ⚠ BREAKING CHANGES
|
|
|
|
* Add access to root node when error occurs during mapping ([54f608](https://github.com/CuyZ/Valinor/commit/54f608e5b1a4bbd508246c063a3e79df48c1ddeb))
|
|
* Allow mapping to any type ([b2e810](https://github.com/CuyZ/Valinor/commit/b2e810e3ce997181b7cfcc96d2bccb9c56a5bdd8))
|
|
* Allow object builder to yield arguments without source ([8a7414](https://github.com/CuyZ/Valinor/commit/8a74147d4c1f78696049c2dfb9acf979ef6e4689))
|
|
* Wrap node messages in proper class ([a805ba](https://github.com/CuyZ/Valinor/commit/a805ba0442f9ac8dd6b2499426ffa6fcb190d4be))
|
|
|
|
### Features
|
|
|
|
* Introduce automatic union of objects inferring during mapping ([79d7c2](https://github.com/CuyZ/Valinor/commit/79d7c266ecabc069b11120338ae1e62a8f3dca97))
|
|
* Introduce helper class `MessageMapFormatter` ([ddf69e](https://github.com/CuyZ/Valinor/commit/ddf69efaaa4eeab87126bdc7f43b92d5faa06f46))
|
|
* Introduce helper class `MessagesFlattener` ([a97b40](https://github.com/CuyZ/Valinor/commit/a97b406154fa5bccc2f874634ed24af69401cd4a))
|
|
* Introduce helper `NodeTraverser` for recursive operations on nodes ([cc1bc6](https://github.com/CuyZ/Valinor/commit/cc1bc66bbece7f79dfec093e33e96d3e31bca4e9))
|
|
|
|
### Bug Fixes
|
|
|
|
* Handle nested attributes compilation ([d2795b](https://github.com/CuyZ/Valinor/commit/d2795bc6b9ee53f9896889cabc1006be2586b008))
|
|
* Treat forbidden mixed type as invalid type ([36bd36](https://github.com/CuyZ/Valinor/commit/36bd3638c8e48d2c43d247991b8d2055e8ab56bb))
|
|
* Treat union type resolving error as message ([e834cd](https://github.com/CuyZ/Valinor/commit/e834cdc5d3384d4295582f8d602b5da5f656e83a))
|
|
* Use locked package versions for quality assurance workflow ([626f13](https://github.com/CuyZ/Valinor/commit/626f135eee5b4954845e954d567babd58f6ca51b))
|
|
|
|
### Other
|
|
|
|
* Ignore changelog configuration file in git export ([85a6a4](https://github.com/CuyZ/Valinor/commit/85a6a49ce20b96f2e023a7e824b8085ea198fd39))
|
|
* Raise PHPStan version ([0144bf](https://github.com/CuyZ/Valinor/commit/0144bf084a4883ecbdb65155a05b2ea90e7fca61))
|
|
|
|
|
|
---
|
|
|
|
## [0.3.0](https://github.com/CuyZ/Valinor/compare/0.2.0...0.3.0) (2021-12-18)
|
|
### Features
|
|
|
|
* Handle common database datetime formats (#40) ([179ba3](https://github.com/CuyZ/Valinor/commit/179ba3df299be62b0eac24a80e9d4d56d0bb5074))
|
|
|
|
### Other
|
|
|
|
* Change Composer scripts calls ([0b507c](https://github.com/CuyZ/Valinor/commit/0b507c9b330b76e29319dd5933aa5760df3e3c8d))
|
|
* Raise version of `friendsofphp/php-cs-fixer` ([e5ccbe](https://github.com/CuyZ/Valinor/commit/e5ccbe201b8767066e0e0510e606f9492f3270f1))
|
|
|
|
|
|
---
|
|
|
|
## [0.2.0](https://github.com/CuyZ/Valinor/compare/0.1.1...0.2.0) (2021-12-07)
|
|
### Features
|
|
|
|
* Handle integer range type ([9f99a2](https://github.com/CuyZ/Valinor/commit/9f99a2a1eff3a1a120a9fa80ecb7045eeafdbfd3))
|
|
* Handle local type aliasing in class definition ([56142d](https://github.com/CuyZ/Valinor/commit/56142dea5b7c2eb7fdd591ede2f2bd0a1dd3e7b4))
|
|
* Handle type alias import in class definition ([fa3ce5](https://github.com/CuyZ/Valinor/commit/fa3ce50dfb069a3e908d5abdb59bd70b3b7d3a90))
|
|
|
|
### Bug Fixes
|
|
|
|
* Do not accept shaped array with excessive key(s) ([5a578e](https://github.com/CuyZ/Valinor/commit/5a578ea4c26e82fe2bea0bbdba821ff2cd2de03d))
|
|
* Handle integer value match properly ([9ee2cc](https://github.com/CuyZ/Valinor/commit/9ee2cc471ebded7b0b4416d1ed245752090f32be))
|
|
|
|
### Other
|
|
|
|
* Delete commented code ([4f5612](https://github.com/CuyZ/Valinor/commit/4f561290b1ba71dc15f1b2806d2ea929429d5910))
|
|
* Move exceptions to more specific folder ([185edf](https://github.com/CuyZ/Valinor/commit/185edf60534391475da4d90a4fec4bab58c9e1c8))
|
|
* Rename `GenericAssignerLexer` to `TypeAliasLexer` ([680941](https://github.com/CuyZ/Valinor/commit/680941687b5e0488eebbfc4372162c25fab34bcb))
|
|
* Use `marcocesarato/php-conventional-changelog` for changelog ([178aa9](https://github.com/CuyZ/Valinor/commit/178aa97687bd1b2de1c21a57b20476629d2de748))
|
|
|
|
|
|
---
|
|
|
|
## [0.1.1](https://github.com/CuyZ/Valinor/compare/0.1.0...0.1.1) (2021-12-01)
|
|
### ⚠ BREAKING CHANGES
|
|
|
|
* Change license from GPL 3 to MIT ([a77b28](https://github.com/CuyZ/Valinor/commit/a77b28c5c224f6cb1232ac17de0002bff8e09ad1))
|
|
|
|
### Features
|
|
|
|
* Handle multiline type declaration ([d99c59](https://github.com/CuyZ/Valinor/commit/d99c59dfb568950be3abda683051ac9b358af78e))
|
|
|
|
### Bug Fixes
|
|
|
|
* Filter type symbols with strict string comparison ([6cdea3](https://github.com/CuyZ/Valinor/commit/6cdea31bc29e2bdbb2574ee0678e71cb42c4761b))
|
|
* Handle correctly iterable source during mapping ([dd4624](https://github.com/CuyZ/Valinor/commit/dd4624c5e0376cf1c590117dcad10c659a614701))
|
|
* Handle shaped array integer key ([5561d0](https://github.com/CuyZ/Valinor/commit/5561d018abb5b237c7cb8385c9a3032c86711738))
|
|
* Resolve single/double quotes when parsing doc-block type ([1c628b](https://github.com/CuyZ/Valinor/commit/1c628b66755497a704ae3333abc8782bac8ee02a))
|
|
|
|
### Other
|
|
|
|
* Change PHPStan stub file extension ([8fc6af](https://github.com/CuyZ/Valinor/commit/8fc6af283cebe1b317b9107d4741a5f2bddea095))
|
|
* Delete unwanted code ([e3e169](https://github.com/CuyZ/Valinor/commit/e3e169fb3c05a46a23cdf7c0c989b5c637a0bd6d))
|
|
* Syntax highlight stub files (#9) ([9ea95f](https://github.com/CuyZ/Valinor/commit/9ea95f43f3b8b750c6c147d25cc77a602a696172))
|
|
* Use composer runtime API ([1f754a](https://github.com/CuyZ/Valinor/commit/1f754a7e77c9cf3faffccddfdc5179ea1f12840b))
|
|
|
|
|
|
---
|