forked from Skillshare/formatphp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDateTimeFormatTest.php
More file actions
652 lines (611 loc) · 24.3 KB
/
DateTimeFormatTest.php
File metadata and controls
652 lines (611 loc) · 24.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
<?php
declare(strict_types=1);
namespace FormatPHP\Test\Intl;
use DateTimeImmutable;
use FormatPHP\Exception\InvalidArgumentException;
use FormatPHP\Intl\DateTimeFormat;
use FormatPHP\Intl\DateTimeFormatOptions;
use FormatPHP\Intl\Locale;
use FormatPHP\Test\TestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use function array_merge;
use function date_default_timezone_get;
use function date_default_timezone_set;
/**
* @phpstan-import-type OptionsType from DateTimeFormatOptions
*/
class DateTimeFormatTest extends TestCase
{
/**
* Timestamp taken from FormatJS tests for DateTimeFormat
*
* @link https://github.com/formatjs/formatjs/blob/da104e8421dcc5480e38aeec4a32891f8941332f/packages/intl-datetimeformat/tests/format.test.ts#L277
*/
private const TS = 1592282900;
private const TEST_TIMEZONE = 'America/Chicago';
private string $defaultTimezone;
protected function setUp(): void
{
$this->defaultTimezone = date_default_timezone_get();
date_default_timezone_set(self::TEST_TIMEZONE);
}
protected function tearDown(): void
{
date_default_timezone_set($this->defaultTimezone);
}
/**
* @param OptionsType $options
*/
#[DataProvider('formatProvider')]
public function testFormat(array $options, string $ko, string $en, string $skeleton, bool $skip = false): void
{
if ($skip) {
$this->markTestSkipped('Skipped due to differences in ICU version output.');
}
$koLocale = new Locale('ko');
$enLocale = new Locale('en');
$formatOptions = new DateTimeFormatOptions($options);
$koFormatter = new DateTimeFormat($koLocale, $formatOptions);
$enFormatter = new DateTimeFormat($enLocale, $formatOptions);
$date = new DateTimeImmutable('@' . self::TS);
$this->assertSame($en, $enFormatter->format($date));
$this->assertSame($ko, $koFormatter->format($date));
$this->assertSame($skeleton, $enFormatter->getSkeleton());
$this->assertSame($skeleton, $koFormatter->getSkeleton());
// We change the default timezone within the SUT, so let's assert
// that is changed back to the value we set in this test's setUp().
$this->assertSame(self::TEST_TIMEZONE, date_default_timezone_get());
}
public function testUnknownTimeZoneThrowsException(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Unknown time zone "America/Foobar"');
new DateTimeFormat(new Locale('en'), new DateTimeFormatOptions([
'timeZone' => 'America/Foobar',
]));
}
/**
* @param OptionsType $additionalOptions
*/
#[DataProvider('formatThrowsExceptionWhenDateStyleOrTimeStyleMixedWithStylePropertyProvider')]
public function testFormatThrowsExceptionWhenDateStyleOrTimeStyleMixedWithStyleProperty(
?string $dateStyle,
?string $timeStyle,
array $additionalOptions
): void {
/** @var OptionsType $combinedOptions */
$combinedOptions = array_merge(
[
'dateStyle' => $dateStyle,
'timeStyle' => $timeStyle,
],
$additionalOptions,
);
$options = new DateTimeFormatOptions($combinedOptions);
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('dateStyle and timeStyle may not be used with other DateTimeFormat options');
new DateTimeFormat(null, $options);
}
public function testHour12OverridesHourCycle(): void
{
$enLocale = new Locale('en-u-hc-h11');
$enLocale = $enLocale->withHourCycle('h23');
$formatOptions = new DateTimeFormatOptions([
'hour' => '2-digit',
// Specify both hourCycle and hour12 to show that hour12 overrides hourCycle.
'hour12' => true,
'hourCycle' => 'h24',
'minute' => '2-digit',
'second' => '2-digit',
'timeZone' => 'America/Denver',
]);
$enFormatter = new DateTimeFormat($enLocale, $formatOptions);
$date = new DateTimeImmutable('@' . self::TS);
$this->assertSame("10:48:20\xE2\x80\xAFPM", $enFormatter->format($date));
$this->assertSame('hhmmss', $enFormatter->getSkeleton());
$this->assertSame('en-u-hc-h12', $enFormatter->getEvaluatedLocale());
}
public function testEvaluatedLocaleWithNoOptions(): void
{
$locale = new Locale('en-US');
$formatter = new DateTimeFormat($locale);
// We automatically look up the locale's preferred hour cycle and add it.
$this->assertSame('en-US-u-hc-h12', $formatter->getEvaluatedLocale());
}
public function testEvaluatedLocaleWithOptionsUsingHour12(): void
{
$locale = new Locale('en-US');
$formatter = new DateTimeFormat($locale, new DateTimeFormatOptions([
'hour12' => false,
'hourCycle' => 'h12',
'calendar' => 'islamic',
'numberingSystem' => 'thai',
]));
$this->assertSame('en-US-u-ca-islamic-nu-thai-hc-h23', $formatter->getEvaluatedLocale());
}
public function testEvaluatedLocaleWithOptionsUsingHourCycle(): void
{
$locale = new Locale('en-US');
$formatter = new DateTimeFormat($locale, new DateTimeFormatOptions([
'hourCycle' => 'h24',
'calendar' => 'coptic',
'numberingSystem' => 'mathmono',
]));
$this->assertSame('en-US-u-ca-coptic-nu-mathmono-hc-h24', $formatter->getEvaluatedLocale());
}
public function testUseHourCycleFromLocale(): void
{
$enLocale = new Locale('en');
$enLocale = $enLocale->withHourCycle('h23');
$formatOptions = new DateTimeFormatOptions([
'hour' => '2-digit',
'minute' => '2-digit',
'second' => '2-digit',
'timeZone' => 'America/Denver',
]);
$enFormatter = new DateTimeFormat($enLocale, $formatOptions);
$date = new DateTimeImmutable('@' . self::TS);
$this->assertSame('22:48:20', $enFormatter->format($date));
$this->assertSame('HHmmss', $enFormatter->getSkeleton());
$this->assertSame('en-u-hc-h23', $enFormatter->getEvaluatedLocale());
}
/**
* Tests taken from FormatJS tests for DateTimeFormat
*
* @link https://github.com/formatjs/formatjs/blob/da104e8421dcc5480e38aeec4a32891f8941332f/packages/intl-datetimeformat/tests/format.test.ts#L15-L275
*
* @return array<array{options: OptionsType, ko: string, en: string}>
*/
public static function formatProvider(): array
{
return [
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => 'numeric',
'month' => 'numeric',
'day' => 'numeric',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'hour12' => true,
'timeZone' => 'UTC',
'timeZoneName' => 'long',
],
'ko' => '서기 2020년 6 16일 화요일 오전 4시 48분 20초 협정 세계시',
'en' => "Tuesday, 6 16, 2020 Anno Domini, 4:48:20\xE2\x80\xAFAM Coordinated Universal Time",
'skeleton' => 'GGGGyyyyMdEEEEhmszzzz',
],
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => 'numeric',
'month' => 'numeric',
'day' => 'numeric',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'hour12' => true,
'timeZone' => 'America/New_York',
'timeZoneName' => 'short',
],
'ko' => '서기 2020년 6 16일 화요일 오전 12시 48분 20초 GMT-4',
'en' => "Tuesday, 6 16, 2020 Anno Domini, 12:48:20\xE2\x80\xAFAM EDT",
'skeleton' => 'GGGGyyyyMdEEEEhmsz',
],
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => 'numeric',
'month' => 'numeric',
'day' => '2-digit',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'hour12' => true,
'timeZone' => 'America/New_York',
'timeZoneName' => 'short',
],
'ko' => '서기 2020년 6 16일 화요일 오전 12시 48분 20초 GMT-4',
'en' => "Tuesday, 6 16, 2020 Anno Domini, 12:48:20\xE2\x80\xAFAM EDT",
'skeleton' => 'GGGGyyyyMddEEEEhmsz',
],
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => 'numeric',
'month' => 'numeric',
'day' => '2-digit',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/New_York',
'timeZoneName' => 'short',
],
'ko' => '서기 2020년 6 16일 화요일 오전 12시 48분 20초 GMT-4',
'en' => "Tuesday, 6 16, 2020 Anno Domini, 12:48:20\xE2\x80\xAFAM EDT",
'skeleton' => 'GGGGyyyyMddEEEEhmsz',
],
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => 'numeric',
'month' => 'numeric',
'day' => '2-digit',
'hour' => '2-digit',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Los_Angeles',
'timeZoneName' => 'short',
],
'ko' => '서기 2020년 6 15일 월요일 오후 9시 48분 20초 GMT-7',
'en' => "Monday, 6 15, 2020 Anno Domini, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'GGGGyyyyMddEEEEhhmsz',
],
// This test produces different output, depending on the version
// of ICU, so skip it for now.
//[
// 'options' => [
// 'weekday' => 'long',
// 'era' => 'long',
// 'year' => '2-digit',
// 'month' => 'long',
// 'day' => '2-digit',
// 'hour' => '2-digit',
// 'minute' => 'numeric',
// 'second' => 'numeric',
// 'timeZone' => 'America/Los_Angeles',
// 'timeZoneName' => 'short',
// ],
// 'ko' => '서기 20년 6월 15일 월요일 오후 9시 48분 20초 GMT-7',
// 'en' => 'Monday, June 15, 20 Anno Domini at 9:48:20 PM PDT',
// 'skeleton' => 'GGGGyyMMMMddEEEEhhmsz',
//],
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => '2-digit',
'month' => 'short',
'day' => '2-digit',
'hour' => '2-digit',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Los_Angeles',
'timeZoneName' => 'short',
],
'ko' => '서기 20년 6월 15일 월요일 오후 9시 48분 20초 GMT-7',
'en' => "Monday, Jun 15, 20 Anno Domini, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'GGGGyyMMMddEEEEhhmsz',
],
[
'options' => [
'weekday' => 'long',
'era' => 'long',
'year' => '2-digit',
'month' => 'narrow',
'day' => '2-digit',
'hour' => '2-digit',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Los_Angeles',
'timeZoneName' => 'short',
],
'ko' => '서기 20년 6월 15일 월요일 오후 9시 48분 20초 GMT-7',
'en' => "Monday, J 15, 20 Anno Domini, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'GGGGyyMMMMMddEEEEhhmsz',
],
[
'options' => [
'weekday' => 'long',
'era' => 'short',
'year' => '2-digit',
'month' => 'narrow',
'day' => '2-digit',
'hour' => '2-digit',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Los_Angeles',
'timeZoneName' => 'short',
],
'ko' => 'AD 20년 6월 15일 월요일 오후 9시 48분 20초 GMT-7',
'en' => "Monday, J 15, 20 AD, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'GyyMMMMMddEEEEhhmsz',
],
[
'options' => [
'weekday' => 'narrow',
'era' => 'short',
'year' => '2-digit',
'month' => 'narrow',
'day' => '2-digit',
'hour' => '2-digit',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Los_Angeles',
'timeZoneName' => 'short',
],
'ko' => 'AD 20년 6월 15일 (월) 오후 9시 48분 20초 GMT-7',
'en' => "M, J 15, 20 AD, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'GyyMMMMMddEEEEEhhmsz',
],
[
'options' => [
'weekday' => 'short',
'era' => 'short',
'year' => '2-digit',
'month' => 'narrow',
'day' => '2-digit',
'hour' => '2-digit',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Los_Angeles',
'timeZoneName' => 'short',
],
'ko' => 'AD 20년 6월 15일 (월) 오후 9시 48분 20초 GMT-7',
'en' => "Mon, J 15, 20 AD, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'GyyMMMMMddEhhmsz',
],
[
'options' => [
'dateStyle' => 'full',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '2020년 6월 15일 월요일',
'en' => 'Monday, June 15, 2020',
'skeleton' => 'EEEEMMMMdy',
],
[
'options' => [
'dateStyle' => 'long',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '2020년 6월 15일',
'en' => 'June 15, 2020',
'skeleton' => 'MMMMdy',
],
[
'options' => [
'dateStyle' => 'medium',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '2020. 6. 15.',
'en' => 'Jun 15, 2020',
'skeleton' => 'MMMdy',
],
[
'options' => [
'dateStyle' => 'short',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '20. 6. 15.',
'en' => '6/15/20',
'skeleton' => 'Mdyy',
],
[
'options' => [
'timeStyle' => 'full',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '오후 9시 48분 20초 미 태평양 하계 표준시',
'en' => "9:48:20\xE2\x80\xAFPM Pacific Daylight Time",
'skeleton' => 'hmmssazzzz',
'skip' => true,
],
[
'options' => [
'timeStyle' => 'long',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '오후 9시 48분 20초 GMT-7',
'en' => "9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'hmmssaz',
'skip' => true,
],
[
'options' => [
'timeStyle' => 'medium',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '오후 9:48:20',
'en' => "9:48:20\xE2\x80\xAFPM",
'skeleton' => 'hmmssa',
],
[
'options' => [
'timeStyle' => 'short',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '오후 9:48',
'en' => "9:48\xE2\x80\xAFPM",
'skeleton' => 'hmma',
],
[
'options' => [
'dateStyle' => 'long',
'timeStyle' => 'full',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '2020년 6월 15일 오후 9시 48분 20초 미 태평양 하계 표준시',
'en' => "June 15, 2020 at 9:48:20\xE2\x80\xAFPM Pacific Daylight Time",
'skeleton' => 'MMMMdyhmmssazzzz',
'skip' => true,
],
[
'options' => [
'dateStyle' => 'medium',
'timeStyle' => 'long',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '2020. 6. 15. 오후 9시 48분 20초 GMT-7',
'en' => "Jun 15, 2020, 9:48:20\xE2\x80\xAFPM PDT",
'skeleton' => 'MMMdyhmmssaz',
'skip' => true,
],
[
'options' => [
'dateStyle' => 'short',
'timeStyle' => 'medium',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '20. 6. 15. 오후 9:48:20',
'en' => "6/15/20, 9:48:20\xE2\x80\xAFPM",
'skeleton' => 'Mdyyhmmssa',
],
[
'options' => [
'dateStyle' => 'full',
'timeStyle' => 'short',
'timeZone' => 'America/Los_Angeles',
],
'ko' => '2020년 6월 15일 월요일 오후 9:48',
'en' => "Monday, June 15, 2020 at 9:48\xE2\x80\xAFPM",
'skeleton' => 'EEEEMMMMdyhmma',
],
[
'options' => [
'dateStyle' => 'full',
'timeStyle' => 'full',
'calendar' => 'buddhist',
'timeZone' => 'America/Denver',
],
'ko' => '불기 2563년 6월 15일 월요일 오후 10시 48분 20초 미 산지 하계 표준시',
'en' => "Monday, June 15, 2563 BE at 10:48:20\xE2\x80\xAFPM Mountain Daylight Time",
'skeleton' => 'EEEEMMMMdyhmmssazzzz',
'skip' => true,
],
[
'options' => [
'dateStyle' => 'full',
'timeStyle' => 'full',
'numberingSystem' => 'hant',
'timeZone' => 'America/Denver',
],
'ko' => '二千零二十년 六월 十五일 월요일 오후 十시 四十八분 二十초 미 산지 하계 표준시',
'en' => "Monday, June 十五, 二千零二十 at 十:四十八:二十\xE2\x80\xAFPM Mountain Daylight Time",
'skeleton' => 'EEEEMMMMdyhmmssazzzz',
'skip' => true,
],
[
'options' => [
'dateStyle' => 'full',
'timeStyle' => 'full',
'hourCycle' => 'h23',
'timeZone' => 'America/Denver',
],
'ko' => '2020년 6월 15일 월요일 오후 10시 48분 20초 미 산지 하계 표준시',
'en' => "Monday, June 15, 2020 at 10:48:20\xE2\x80\xAFPM Mountain Daylight Time",
'skeleton' => 'EEEEMMMMdyhmmssazzzz',
'skip' => true,
],
[
'options' => [
'dayPeriod' => 'long',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Chicago',
],
'ko' => '밤 11:48:20',
'en' => '11:48:20 at night',
'skeleton' => 'hmsB',
],
[
'options' => [
'dayPeriod' => 'short',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Chicago',
],
'ko' => '오후 11:48:20',
'en' => "11:48:20\xE2\x80\xAFPM",
'skeleton' => 'hmsb',
],
[
'options' => [
'dayPeriod' => 'narrow',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'America/Chicago',
],
'ko' => 'PM 11:48:20',
'en' => "11:48:20\xE2\x80\xAFp",
'skeleton' => 'hmsbbbbb',
],
[
'options' => [
'dayPeriod' => 'long',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'Asia/Kolkata',
],
'ko' => '오전 10:18:20',
'en' => '10:18:20 in the morning',
'skeleton' => 'hmsB',
],
[
'options' => [
'dayPeriod' => 'short',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'Asia/Kolkata',
],
'ko' => '오전 10:18:20',
'en' => "10:18:20\xE2\x80\xAFAM",
'skeleton' => 'hmsb',
],
[
'options' => [
'dayPeriod' => 'narrow',
'hour' => 'numeric',
'minute' => 'numeric',
'second' => 'numeric',
'timeZone' => 'Asia/Kolkata',
],
'ko' => 'AM 10:18:20',
'en' => "10:18:20\xE2\x80\xAFa",
'skeleton' => 'hmsbbbbb',
],
];
}
/**
* @return array<array{dateStyle: string | null, timeStyle: string | null, additionalOptions: OptionsType}>
*/
public static function formatThrowsExceptionWhenDateStyleOrTimeStyleMixedWithStylePropertyProvider(): array
{
$styleProperties = [
'era' => 'short',
'year' => 'numeric',
'month' => 'numeric',
'weekday' => 'long',
'day' => 'numeric',
'hour' => '2-digit',
'minute' => '2-digit',
'second' => '2-digit',
];
$tests = [];
foreach ($styleProperties as $property => $value) {
$tests[] = [
'dateStyle' => 'full',
'timeStyle' => null,
'additionalOptions' => [$property => $value],
];
$tests[] = [
'dateStyle' => null,
'timeStyle' => 'full',
'additionalOptions' => [$property => $value],
];
}
/** @phpstan-ignore return.type */
return $tests;
}
}