feat(intl): add current_locale util (#1643)

Author: Bapawe

packages/datetime/src/DateTimeConvenienceMethods.php

@@ -922,7 +922,7 @@ public function isEndOfWeek(): bool
      *
      * @param null|FormatPattern|string $pattern Optional custom format pattern for the date and time. If null, uses a default pattern.
      * @param null|Timezone $timezone Optional timezone for formatting. If null, uses the current timezone.
-     * @param null|Locale $locale Optional locale for formatting. If null, uses the system's default locale.
+     * @param null|Locale $locale Optional locale for formatting. If null, uses the configured locale or system default as fallback.
      *
      * @return string The formatted date and time string, according to the specified pattern, timezone, and locale.
      *
@@ -992,7 +992,7 @@ public function toRfc3339(?SecondsStyle $secondsStyle = null, bool $useZ = false
      * @param null|DateStyle $dateStyle Optional style for the date portion of the output. If null, a default style is used.
      * @param null|TimeStyle $timeStyle Optional style for the time portion of the output. If null, a default style is used.
      * @param null|Timezone $timezone Optional timezone for formatting. If null, uses the current timezone.
-     * @param null|Locale $locale Optional locale for formatting. If null, uses the system's default locale.
+     * @param null|Locale $locale Optional locale for formatting. If null, uses the configured locale or system default as fallback.
      *
      * @return string The string representation of the date and time, formatted according to the specified styles, timezone, and locale.
      *

packages/datetime/src/functions.php

@@ -16,6 +16,7 @@
 
     use function hrtime;
     use function microtime;
+    use function Tempest\Intl\current_locale;
 
     use const Tempest\DateTime\NANOSECONDS_PER_SECOND;
 
@@ -94,7 +95,7 @@ function create_intl_date_formatter(
 
         $dateStyle ??= DateStyle::default();
         $timeStyle ??= TimeStyle::default();
-        $locale ??= Locale::default();
+        $locale ??= current_locale();
         $timezone ??= Timezone::default();
 
         return new IntlDateFormatter(

packages/intl/src/functions.php

@@ -4,6 +4,7 @@
 
 use Countable;
 use Stringable;
+use Tempest\Container\GenericContainer;
 use Tempest\Intl\Locale;
 use Tempest\Intl\Pluralizer\Pluralizer;
 use Tempest\Intl\Translator;
@@ -57,3 +58,13 @@ function pluralize_last_word(Stringable|string $value, int|array|Countable $coun
 {
     return get(Pluralizer::class)->pluralizeLastWord($value, $count);
 }
+
+/**
+ * Returns the configured locale from the container, or the system default if not configured.
+ */
+function current_locale(): Locale
+{
+    return GenericContainer::instance()?->has(IntlConfig::class)
+        ? GenericContainer::instance()->get(IntlConfig::class)->currentLocale
+        : Locale::default();
+}

packages/intl/tests/FormatterTest.php

@@ -56,7 +56,7 @@ public function test_format_datetime_function_and_parameters(): void
             $this->markTestSkipped('`tempest/datetime` is needed for this test.');
         }
 
-        $formatter = new MessageFormatter([new DateTimeFunction()]);
+        $formatter = new MessageFormatter([$this->createDateTimeFunction()]);
 
         $value = $formatter->format(<<<'TXT'
         Today is {$today :datetime pattern=|yyyy/MM/dd|}.
@@ -367,7 +367,7 @@ public function test_multiple_selectors(): void
     {
         $formatter = new MessageFormatter([
             $this->createNumberFunction(),
-            new DateTimeFunction(),
+            $this->createDateTimeFunction(),
         ]);
 
         $value = $formatter->format(<<<'TXT'
@@ -417,4 +417,11 @@ private function createNumberFunction(): NumberFunction
             new IntlConfig(Locale::default(), Locale::default()),
         );
     }
+
+    private function createDateTimeFunction(): DateTimeFunction
+    {
+        return new DateTimeFunction(
+            new IntlConfig(Locale::default(), Locale::default()),
+        );
+    }
 }

packages/intl/tests/GenericTranslatorTest.php

@@ -37,7 +37,7 @@ protected function setUp(): void
             formatter: new MessageFormatter([
                 new StringFunction(),
                 new NumberFunction($this->config),
-                new DateTimeFunction(),
+                new DateTimeFunction($this->config),
             ]),
         );
     }

packages/intl/tests/LocaleTest.php

@@ -11,6 +11,7 @@
 
 use function locale_get_default;
 use function locale_set_default;
+use function Tempest\Intl\current_locale;
 use function Tempest\Support\Str\replace_every;
 
 final class LocaleTest extends TestCase
@@ -252,4 +253,13 @@ public function test_it_does_not_returns_the_region(Locale $locale): void
         $this->assertNull($locale->getRegion());
         $this->assertNull($locale->getDisplayRegion());
     }
+
+    public function test_current_locale(): void
+    {
+        foreach (Locale::cases() as $locale) {
+            locale_set_default($locale->value);
+
+            $this->assertSame($locale, current_locale());
+        }
+    }
 }

tests/Fixtures/Config/i18n.config.php

@@ -0,0 +1,9 @@
+<?php
+
+use Tempest\Intl\IntlConfig;
+use Tempest\Intl\Locale;
+
+return new IntlConfig(
+    currentLocale: Locale::ENGLISH_UNITED_STATES,
+    fallbackLocale: Locale::ENGLISH_UNITED_STATES,
+);

tests/Integration/Intl/FunctionsTest.php

@@ -45,4 +45,9 @@ public function test_pluralize_last_word(): void
         $this->assertEquals('Multiple Migrations', Intl\pluralize_last_word('Multiple Migrations'));
         $this->assertEquals('Multiple Aircraft', Intl\pluralize_last_word('Multiple Aircraft'));
     }
+
+    public function test_current_locale(): void
+    {
+        $this->assertSame(Intl\Locale::ENGLISH_UNITED_STATES, Intl\current_locale());
+    }
 }

tests/Integration/Intl/TranslatorTest.php

@@ -19,8 +19,6 @@ final class TranslatorTest extends FrameworkIntegrationTestCase
 {
     protected function setUp(): void
     {
-        ini_set('intl.default_locale', 'en-US'); // @mago-expect lint:no-ini-set
-
         parent::setUp();
 
         $config = $this->container->get(IntlConfig::class);
@@ -46,13 +44,6 @@ public function test_function(): void
         $this->assertSame('Passer à la caisse', translate_locale(Locale::FRENCH, 'cart.checkout'));
     }
 
-    public function test_default_locale(): void
-    {
-        $config = $this->container->get(IntlConfig::class);
-
-        $this->assertSame(Locale::default(), $config->currentLocale);
-    }
-
     public function test_event_miss(): void
     {
         /** @var TranslationMiss|null $received */