Map to different property name

[mariosimao]

First of all, what a useful library!

How to map properties different from JSON keys? For example:

class Thread {
    public readonly int $id;
    public readonly string $content;
    public readonly DateTimeImmutable $creationDate;
}

and

{
    "id": 1337,
    "content": "Do you like potatoes?",
    "creation_date": "1957-07-23 13:37:42"
}

[romm]

First of all, what a useful library!

🤗

How to map properties different from JSON keys?

I've already thought about this case, though I did not try a solution nor documented anything related to it.

I just tried something locally, but I spotted a bug that needs to be fixed in order for the code below to work (I'll work on it ASAP).

final class KeyReplacementSource implements IteratorAggregate
{
    /** @var mixed[] */
    private array $source;

    /**
     * @param iterable<mixed> $source
     * @param array<string, string> $keyReplacements
     */
    public function __construct(iterable $source, array $keyReplacements)
    {
        $this->source = $this->replace($source, $keyReplacements);
    }

    /**
     * @param iterable<mixed> $source
     * @param array<string, string> $keyReplacements
     */
    private function replace(iterable $source, array $keyReplacements): array
    {
        $array = [];

        foreach ($source as $key => $value) {
            if (is_iterable($value)) {
                $value = $this->replace($value, $keyReplacements);
            }

            $array[$keyReplacements[$key] ?? $key] = $value;
        }

        return $array;
    }

    /**
     * @return Iterator<mixed>
     */
    public function getIterator(): Traversable
    {
        yield from $this->source;
    }
}

// and use it like this…
$this->mapperBuilder
    ->mapper()
    ->map(Thread::class, new KeyReplacementSource(
        [
            // …
            'creation_date' => '1957-07-23 13:37:42',
        ],
        [
            'creation_date' => 'creationDate',
        ]
    ));

We could even have this kind of services for automatic snake-case to camel-case keys conversions, I'll think about it.

[romm]

Hi @mariosimao, with #23 the code above should be working. If you have time to try it, or any suggestion, don't hesitate. 😉

[brayniverse]

That's a great solution. I was just going to map over my input.

[bebetoalves]

In the meantime since this thread was created, has any solution emerged within the library itself for this case, or do I still need to implement the KeyReplacementSource? Thank you!

[romm]

Hi @bebetoalves, you should check this chapter of the documentation, that should give you answers. 😊

[romm]

Closing, as this feature was merged in #673 (see https://github.com/CuyZ/Valinor/blob/master/docs/pages/how-to/common-converters-examples.md#renaming-keys)