File: ParseFromLocaleTest.php

package info (click to toggle)
php-nesbot-carbon 2.73.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 19,940 kB
  • sloc: php: 158,741; xml: 99; makefile: 32; sh: 14
file content (139 lines) | stat: -rw-r--r-- 5,630 bytes parent folder | download | duplicates (2)
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
<?php

declare(strict_types=1);

/**
 * This file is part of the Carbon package.
 *
 * (c) Brian Nesbitt <brian@nesbot.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tests\CarbonInterval;

use Carbon\CarbonInterval;
use Generator;
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\DataProvider;
use Tests\AbstractTestCase;

class ParseFromLocaleTest extends AbstractTestCase
{
    /**
     * @param string         $string
     * @param string         $locale
     * @param CarbonInterval $expected
     */
    #[DataProvider('dataForValidStrings')]
     public function testReturnsInterval($string, $locale, $expected)
    {
        $result = CarbonInterval::parseFromLocale($string, $locale);

        $this->assertEquals($expected, $result, "'{$string}' does not return expected interval.");
    }

    public static function dataForValidStrings(): Generator
    {
        // zero interval
        yield ['', 'en', new CarbonInterval(0)];

        // single values
        yield ['1y', 'en', new CarbonInterval(1)];
        yield ['1mo', 'en', new CarbonInterval(0, 1)];
        yield ['1w', 'en', new CarbonInterval(0, 0, 1)];
        yield ['1d', 'en', new CarbonInterval(0, 0, 0, 1)];
        yield ['1h', 'en', new CarbonInterval(0, 0, 0, 0, 1)];
        yield ['1m', 'en', new CarbonInterval(0, 0, 0, 0, 0, 1)];
        yield ['1s', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 1)];
        yield ['1ms', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 0, 1000)];
        yield ['1µs', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 0, 1)];

        // single values with space
        yield ['1 y', 'en', new CarbonInterval(1)];
        yield ['1 mo', 'en', new CarbonInterval(0, 1)];
        yield ['1 w', 'en', new CarbonInterval(0, 0, 1)];

        // fractions with integer result
        yield ['0.571428571429w', 'en', new CarbonInterval(0, 0, 0, 4)];
        yield ['0.5d', 'en', new CarbonInterval(0, 0, 0, 0, 12)];
        yield ['0.5h', 'en', new CarbonInterval(0, 0, 0, 0, 0, 30)];
        yield ['0.5m', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 30)];

        // fractions with float result
        yield ['1.5w', 'en', new CarbonInterval(0, 0, 1, 3, 12)];
        yield ['2.34d', 'en', new CarbonInterval(0, 0, 0, 2, 8, 9, 36)];
        yield ['3.12h', 'en', new CarbonInterval(0, 0, 0, 0, 3, 7, 12)];
        yield ['3.129h', 'en', new CarbonInterval(0, 0, 0, 0, 3, 7, 44, 400000)];
        yield ['4.24m', 'en', new CarbonInterval(0, 0, 0, 0, 0, 4, 14, 400000)];
        yield ['3.56s', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 3, 560000)];
        yield ['3.56ms', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 0, 3560)];

        // combinations
        yield ['2w 3d', 'en', new CarbonInterval(0, 0, 0, 17)];
        yield ['1y 2mo 1.5w 3d', 'en', new CarbonInterval(1, 2, 1, 6, 12)];

        // multi same values
        yield ['1y 2y', 'en', new CarbonInterval(3)];
        yield ['1mo 20mo', 'en', new CarbonInterval(0, 21)];
        yield ['1w 2w 3w', 'en', new CarbonInterval(0, 0, 6)];
        yield ['10d 20d 30d', 'en', new CarbonInterval(0, 0, 0, 60)];
        yield ['5h 15h 25h', 'en', new CarbonInterval(0, 0, 0, 0, 45)];
        yield ['3m 3m 3m 1m', 'en', new CarbonInterval(0, 0, 0, 0, 0, 10)];
        yield ['55s 45s 1s 2s 3s 4s', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 110)];
        yield ['1500ms 1623555µs', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 0, 3123555)];
        yield ['430 milli', 'en', new CarbonInterval(0, 0, 0, 0, 0, 0, 0, 430000)];

        // multi same values with space
        yield ['1 y 2 y', 'en', new CarbonInterval(3)];
        yield ['1 mo 20 mo', 'en', new CarbonInterval(0, 21)];
        yield ['1 w      2  w       3    w', 'en', new CarbonInterval(0, 0, 6)];

        // no-space values
        yield ['2w3d', 'en', new CarbonInterval(0, 0, 0, 17)];
        yield ['1y2mo3w4d5h6m7s', 'en', new CarbonInterval(1, 2, 3, 4, 5, 6, 7)];

        // written-out units
        yield ['1year 2month 3week 4day 5hour 6minute 7second', 'en', new CarbonInterval(1, 2, 3, 4, 5, 6, 7)];
        yield ['1 year 2 month 3 week', 'en', new CarbonInterval(1, 2, 3)];
        yield ['2 Years 3 Months 4 Weeks', 'en', new CarbonInterval(2, 3, 4)];
        yield ['5 Days 6 Hours 7 Minutes 8 Seconds', 'en', new CarbonInterval(0, 0, 0, 5, 6, 7, 8)];

        // ignore invalid format; parse only [num][char-format] or [num] [char-format]
        yield ['Hello! Please add 1y2w to ...', 'en', new CarbonInterval(1, 0, 2)];
        yield ['nothing to parse :(', 'en', new CarbonInterval(0)];

        // case insensitive
        yield ['1Y 3MO 1W 3D 12H 23M 42S', 'en', new CarbonInterval(1, 3, 1, 3, 12, 23, 42)];

        // Example for the ticket (#1756)
        yield ['2 jours 3 heures', 'fr', new CarbonInterval(0, 0, 0, 2, 3, 0, 0)];
    }

    /**
     * @param string $string
     * @param string $part
     * @param string $locale
     */
    #[DataProvider('dataForInvalidStrings')]
    public function testThrowsExceptionForUnknownValues($string, $part, $locale)
    {
        $message = null;

        try {
            CarbonInterval::parseFromLocale($string, $locale);
        } catch (InvalidArgumentException $exception) {
            $message = $exception->getMessage();
        }

        $this->assertStringContainsString($part, $message);
    }

    public static function dataForInvalidStrings(): Generator
    {
        yield ['1q', '1q', 'en'];
        yield ['about 12..14m', '12..', 'en'];
        yield ['4h 13', '13', 'en'];
    }
}