ContextStateManager can handle context current locale

PrestaShop · Nov 8, 2023 · d200141 · d200141
1 parent ecb4866
commit d200141
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 0 deletions.
diff --git a/src/Adapter/ContextStateManager.php b/src/Adapter/ContextStateManager.php
@@ -34,6 +34,7 @@
 use Currency;
 use Customer;
 use Language;
+use PrestaShop\PrestaShop\Core\Localization\LocaleInterface;
 use Shop;
 
 /**
@@ -51,6 +52,7 @@ class ContextStateManager
         'country',
         'currency',
         'language',
+        'currentLocale',
         'customer',
         'shop',
         'shopContext',
@@ -145,6 +147,21 @@ public function setLanguage(?Language $language): self
         return $this;
     }
 
+    /**
+     * Sets context localization locale and saves previous value
+     *
+     * @param LocaleInterface|null $locale
+     *
+     * @return $this
+     */
+    public function setCurrentLocale(?LocaleInterface $locale): self
+    {
+        $this->saveContextField('currentLocale');
+        $this->getContext()->currentLocale = $locale;
+
+        return $this;
+    }
+
     /**
      * Sets context customer and saves previous value
      *

diff --git a/tests/TestCase/ContextStateTestCase.php b/tests/TestCase/ContextStateTestCase.php
@@ -76,6 +76,14 @@ protected function createContextMock(array $contextFields): Context
             if ($fieldName === 'language' && $contextValue instanceof Language) {
                 $contextMock->getTranslator()->setLocale('test' . $contextValue->id);
             }
+            if ($fieldName === 'currentLocale') {
+                $contextMock
+                    ->method('getCurrentLocale')
+                    ->willReturnCallback(static function () use ($contextMock) {
+                        return $contextMock->currentLocale;
+                    })
+                ;
+            }
         }
         LegacyContext::setInstanceForTesting($contextMock);
 

diff --git a/tests/Unit/Adapter/ContextStateManagerTest.php b/tests/Unit/Adapter/ContextStateManagerTest.php
@@ -31,8 +31,10 @@
 use Currency;
 use Customer;
 use Language;
+use PHPUnit\Framework\MockObject\MockObject;
 use PrestaShop\PrestaShop\Adapter\ContextStateManager;
 use PrestaShop\PrestaShop\Adapter\LegacyContext;
+use PrestaShop\PrestaShop\Core\Localization\LocaleInterface;
 use Tests\TestCase\ContextStateTestCase;
 
 class ContextStateManagerTest extends ContextStateTestCase
@@ -174,6 +176,35 @@ public function testLanguageState()
         $this->assertEquals('test42', $context->getTranslator()->getLocale());
     }
 
+    public function testLocalizationLocaleState()
+    {
+        $context = $this->createContextMock([
+            'currentLocale' => $this->createLocalizationLocaleMock('fr-FR'),
+        ]);
+        $this->assertEquals('fr-FR', $context->currentLocale->getCode());
+        $this->assertEquals('fr-FR', $context->getCurrentLocale()->getCode());
+
+        $contextStateManager = new ContextStateManager($this->legacyContext);
+        $this->assertNull($contextStateManager->getContextFieldsStack());
+
+        $contextStateManager->setCurrentLocale($this->createLocalizationLocaleMock('en-US'));
+        $this->assertEquals('en-US', $context->currentLocale->getCode());
+        $this->assertEquals('en-US', $context->getCurrentLocale()->getCode());
+        $this->assertIsArray($contextStateManager->getContextFieldsStack());
+        $this->assertCount(1, $contextStateManager->getContextFieldsStack());
+
+        $contextStateManager->setCurrentLocale($this->createLocalizationLocaleMock('en-GB'));
+        $this->assertEquals('en-GB', $context->currentLocale->getCode());
+        $this->assertEquals('en-GB', $context->getCurrentLocale()->getCode());
+        $this->assertIsArray($contextStateManager->getContextFieldsStack());
+        $this->assertCount(1, $contextStateManager->getContextFieldsStack());
+
+        $contextStateManager->restorePreviousContext();
+        $this->assertEquals('fr-FR', $context->currentLocale->getCode());
+        $this->assertEquals('fr-FR', $context->getCurrentLocale()->getCode());
+        $this->assertNull($contextStateManager->getContextFieldsStack());
+    }
+
     public function testNullField()
     {
         $context = $this->createContextMock([
@@ -306,12 +337,15 @@ public function testMultipleSavedContextFields()
             'currency' => $this->createContextFieldMock(Currency::class, 42),
             'customer' => $this->createContextFieldMock(Customer::class, 42),
             'language' => $this->createContextFieldMock(Language::class, 42),
+            'currentLocale' => $this->createLocalizationLocaleMock('fr-FR'),
         ]);
         $this->assertEquals(42, $context->cart->id);
         $this->assertEquals(42, $context->country->id);
         $this->assertEquals(42, $context->currency->id);
         $this->assertEquals(42, $context->customer->id);
         $this->assertEquals(42, $context->language->id);
+        $this->assertEquals('fr-FR', $context->currentLocale->getCode());
+        $this->assertEquals('fr-FR', $context->getCurrentLocale()->getCode());
 
         $contextStateManager = new ContextStateManager($this->legacyContext);
         $this->assertNull($contextStateManager->getContextFieldsStack());
@@ -320,6 +354,7 @@ public function testMultipleSavedContextFields()
             ->setCart($this->createContextFieldMock(Cart::class, 51))
             ->setCurrency($this->createContextFieldMock(Currency::class, 51))
             ->setCustomer($this->createContextFieldMock(Customer::class, 51))
+            ->setCurrentLocale($this->createLocalizationLocaleMock('en-US'))
         ;
         $this->assertIsArray($contextStateManager->getContextFieldsStack());
         $this->assertCount(1, $contextStateManager->getContextFieldsStack());
@@ -329,20 +364,25 @@ public function testMultipleSavedContextFields()
         $this->assertEquals(51, $context->currency->id);
         $this->assertEquals(51, $context->customer->id);
         $this->assertEquals(42, $context->language->id);
+        $this->assertEquals('en-US', $context->currentLocale->getCode());
+        $this->assertEquals('en-US', $context->getCurrentLocale()->getCode());
 
         $contextStateManager->saveCurrentContext();
         $this->assertCount(2, $contextStateManager->getContextFieldsStack());
 
         $contextStateManager
             ->setCart($this->createContextFieldMock(Cart::class, 69))
             ->setCurrency($this->createContextFieldMock(Currency::class, 69))
+            ->setCurrentLocale($this->createLocalizationLocaleMock('en-GB'))
         ;
 
         $this->assertEquals(69, $context->cart->id);
         $this->assertEquals(42, $context->country->id);
         $this->assertEquals(69, $context->currency->id);
         $this->assertEquals(51, $context->customer->id);
         $this->assertEquals(42, $context->language->id);
+        $this->assertEquals('en-GB', $context->currentLocale->getCode());
+        $this->assertEquals('en-GB', $context->getCurrentLocale()->getCode());
         $this->assertCount(2, $contextStateManager->getContextFieldsStack());
 
         $contextStateManager->restorePreviousContext();
@@ -352,6 +392,8 @@ public function testMultipleSavedContextFields()
         $this->assertEquals(51, $context->currency->id);
         $this->assertEquals(51, $context->customer->id);
         $this->assertEquals(42, $context->language->id);
+        $this->assertEquals('en-US', $context->currentLocale->getCode());
+        $this->assertEquals('en-US', $context->getCurrentLocale()->getCode());
         $this->assertIsArray($contextStateManager->getContextFieldsStack());
         $this->assertCount(1, $contextStateManager->getContextFieldsStack());
 
@@ -362,6 +404,8 @@ public function testMultipleSavedContextFields()
         $this->assertEquals(42, $context->currency->id);
         $this->assertEquals(42, $context->customer->id);
         $this->assertEquals(42, $context->language->id);
+        $this->assertEquals('fr-FR', $context->currentLocale->getCode());
+        $this->assertEquals('fr-FR', $context->getCurrentLocale()->getCode());
         $this->assertNull($contextStateManager->getContextFieldsStack());
     }
 
@@ -457,4 +501,15 @@ public function testSavedContextsFirst()
         $this->assertEquals(42, $context->language->id);
         $this->assertNull($contextStateManager->getContextFieldsStack());
     }
+
+    private function createLocalizationLocaleMock(string $code): LocaleInterface|MockObject
+    {
+        $locale = $this->createMock(LocaleInterface::class);
+        $locale
+            ->method('getCode')
+            ->willReturn($code)
+        ;
+
+        return $locale;
+    }
 }