Merge pull request #2932 from tarlepp/feat/request-locale

Feat - Added support to get request locale

Author: tarlepp

src/Service/Localization.php

@@ -14,24 +14,27 @@
 use DateTimeImmutable;
 use DateTimeZone;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Cache\ItemInterface;
 use Throwable;
 use function explode;
 use function floor;
+use function in_array;
 use function str_replace;
 
 /**
  * @package App\Service
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
-class Localization
+readonly class Localization
 {
     final public const string DEFAULT_TIMEZONE = 'Europe/Helsinki';
 
     public function __construct(
-        private readonly CacheInterface $appCacheApcu,
-        private readonly LoggerInterface $logger,
+        private CacheInterface $appCacheApcu,
+        private LoggerInterface $logger,
+        private RequestStack $requestStack,
     ) {
     }
 
@@ -51,6 +54,13 @@ public function getLocales(): array
         return Locale::getValues();
     }
 
+    public function getRequestLocale(): string
+    {
+        $locale = $this->requestStack->getCurrentRequest()?->getLocale() ?? Locale::getDefault()->value;
+
+        return in_array($locale, $this->getLocales(), true) ? $locale : Locale::getDefault()->value;
+    }
+
     /**
      * @return array<int, array{timezone: string, identifier: string,  offset: string, value: string}>
      */

tests/Integration/Service/LocalizationTest.php

@@ -8,27 +8,63 @@
 
 namespace App\Tests\Integration\Service;
 
+use App\Enum\Language;
+use App\Enum\Locale;
 use App\Service\Localization;
+use DateTimeZone;
 use Exception;
 use PHPUnit\Framework\Attributes\TestDox;
-use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Contracts\Cache\CacheInterface;
+use function count;
 
 /**
  * @package App\Tests\Integration\Service
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
 class LocalizationTest extends KernelTestCase
 {
-    #[TestDox('Test that `LoggerInterface::error` method is called when `CacheInterface')]
+    #[TestDox('Test that `getLanguages` returns expected')]
+    public function testThatGetLanguagesReturnsExpected(): void
+    {
+        $cache = $this->getMockBuilder(CacheInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $requestStack = new RequestStack();
+
+        $expected = Language::getValues();
+
+        self::assertSame(
+            $expected,
+            (new Localization($cache, $logger, $requestStack))->getLanguages(),
+        );
+    }
+
+    #[TestDox('Test that `getLocales` returns expected')]
+    public function testThatGetLocalesReturnsExpected(): void
+    {
+        $cache = $this->getMockBuilder(CacheInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $requestStack = new RequestStack();
+
+        $expected = Locale::getValues();
+
+        self::assertSame(
+            $expected,
+            (new Localization($cache, $logger, $requestStack))->getLocales(),
+        );
+    }
+
+    #[TestDox('Test that `LoggerInterface::error` method is called when `CacheInterface` throws an exception')]
     public function testThatLoggerIsCalledWhenCacheThrowsAnException(): void
     {
         $exception = new Exception('test exception');
 
-        $cache = $this->getCache();
-        $logger = $this->getLogger();
+        $cache = $this->getMockBuilder(CacheInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $requestStack = new RequestStack();
 
         $cache
             ->expects($this->once())
@@ -40,23 +76,59 @@ public function testThatLoggerIsCalledWhenCacheThrowsAnException(): void
             ->method('error')
             ->with($exception->getMessage(), $exception->getTrace());
 
-        (new Localization($cache, $logger))
+        (new Localization($cache, $logger, $requestStack))
             ->getTimezones();
     }
 
-    /**
-     * @phpstan-return MockObject&CacheInterface
-     */
-    private function getCache(): MockObject
+    #[TestDox('Test that `getFormattedTimezones` method returns expected amount of results')]
+    public function testThatGetFormattedTimezonesMethodReturnsExpectedAmountOfResults(): void
     {
-        return $this->getMockBuilder(CacheInterface::class)->getMock();
+        $cache = $this->getMockBuilder(CacheInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $requestStack = new RequestStack();
+
+        $output = (new Localization($cache, $logger, $requestStack))
+            ->getFormattedTimezones();
+
+        self::assertCount(count(DateTimeZone::listIdentifiers()), $output);
     }
 
-    /**
-     * @phpstan-return MockObject&LoggerInterface
-     */
-    private function getLogger(): MockObject
+    #[TestDox('Test that `getRequestLocale` method returns expected locale when request is not set')]
+    public function testThatGetRequestLocaleReturnsDefaultLocaleIfThereIsNoCurrentRequest(): void
     {
-        return $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $cache = $this->getMockBuilder(CacheInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $requestStack = new RequestStack();
+
+        $cache
+            ->expects($this->never())
+            ->method('get');
+
+        $logger
+            ->expects($this->never())
+            ->method('error');
+
+        self::assertSame(
+            Locale::getDefault()->value,
+            (new Localization($cache, $logger, $requestStack))->getRequestLocale(),
+        );
+    }
+
+    #[TestDox('Test that `getRequestLocale` method returns expected locale when request is set')]
+    public function testThatGetRequestLocaleReturnsDefaultLocaleWhenThereIsRequest(): void
+    {
+        $cache = $this->getMockBuilder(CacheInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+
+        $request = new Request();
+        $request->setLocale('en');
+
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
+
+        self::assertSame(
+            'en',
+            (new Localization($cache, $logger, $requestStack))->getRequestLocale(),
+        );
     }
 }