Skip to content

Commit

Permalink
feat: add microseconds support to timestamp format
Browse files Browse the repository at this point in the history
Prior to this patch, this would require a custom constructor in the form
of:

```php
static fn(float | int $timestamp): DateTimeImmutable => new
DateTimeImmutable(sprintf("@%d", $timestamp)),
```
This bypasses the datetime format support of Valinor entirely. This is
required because the library does not support floats as valid
DateTimeInterface input values.

This PR adds support for floats and registers timestamp.microseconds
(U.u) as a valid default format.
  • Loading branch information
Rick Kerkhof committed May 1, 2024
1 parent 40e6fa3 commit 8a0a7be
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/pages/how-to/deal-with-dates.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

When the mapper builds a date object, it has to know which format(s) are
supported. By default, any valid timestamp or RFC 3339-formatted value will be
accepted.
accepted with or without microseconds.

If other formats are to be supported, they need to be registered using the
following method:
Expand Down
1 change: 1 addition & 0 deletions src/Library/Settings.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ final class Settings
'Y-m-d\\TH:i:sP', // RFC 3339
'Y-m-d\\TH:i:s.uP', // RFC 3339 with microseconds
'U', // Unix Timestamp
'U.u', // Unix Timestamp with microseconds
];

/** @var array<class-string|interface-string, callable> */
Expand Down
4 changes: 2 additions & 2 deletions src/Mapper/Object/DateTimeFormatConstructor.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ public function __construct(string $format, string ...$formats)

/**
* @param class-string<DateTime|DateTimeImmutable> $className
* @param non-empty-string|int $value
* @param non-empty-string|int|float $value
*/
#[DynamicConstructor]
public function __invoke(string $className, string|int $value): DateTimeInterface
public function __invoke(string $className, string|int|float $value): DateTimeInterface
{
foreach ($this->formats as $format) {
$date = $className::createFromFormat($format, (string)$value) ?: null;
Expand Down
15 changes: 14 additions & 1 deletion tests/Integration/Mapping/Object/DateTimeMappingTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,19 @@ public function test_default_date_constructor_with_valid_timestamp_format_source
self::assertSame('1659688380', $result->format('U'));
}

public function test_default_date_constructor_with_valid_timestamp_with_microseconds_format_source_returns_datetime(): void
{
try {
$result = $this->mapperBuilder()
->mapper()
->map(DateTimeInterface::class, 1659688380.654000);
} catch (MappingError $error) {
$this->mappingFail($error);
}

self::assertSame('1659688380.654000', $result->format('U.u'));
}

public function test_default_date_constructor_with_timestamp_at_0_source_returns_datetime(): void
{
try {
Expand Down Expand Up @@ -129,7 +142,7 @@ public function test_default_date_constructor_with_invalid_source_throws_excepti
$error = $exception->node()->messages()[0];

self::assertSame('1630686564', $error->code());
self::assertSame("Value 'invalid datetime' does not match any of the following formats: `Y-m-d\TH:i:sP`, `Y-m-d\TH:i:s.uP`, `U`.", (string)$error);
self::assertSame("Value 'invalid datetime' does not match any of the following formats: `Y-m-d\TH:i:sP`, `Y-m-d\TH:i:s.uP`, `U`, `U.u`.", (string)$error);
}
}

Expand Down
2 changes: 1 addition & 1 deletion tests/Unit/MapperBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public function test_mapper_instance_is_the_same(): void

public function test_get_supported_date_formats_returns_defaults_formats_when_not_overridden(): void
{
self::assertSame(['Y-m-d\\TH:i:sP', 'Y-m-d\\TH:i:s.uP', 'U'], $this->mapperBuilder->supportedDateFormats());
self::assertSame(['Y-m-d\\TH:i:sP', 'Y-m-d\\TH:i:s.uP', 'U', 'U.u'], $this->mapperBuilder->supportedDateFormats());
}

public function test_get_supported_date_formats_returns_configured_values(): void
Expand Down

0 comments on commit 8a0a7be

Please sign in to comment.