MCP-288: [Load Cart Section] Replace Zend_Currency component with Intl NumberFormatter

adifucan · adifucan · commit e71bf779fc76 · 2021-03-31T00:44:17.000-05:00
- Fix integration test &amp; update unit test;
diff --git a/app/code/Magento/Directory/Model/Currency.php b/app/code/Magento/Directory/Model/Currency.php
@@ -118,7 +118,7 @@ public function __construct(
         array $data = [],
         CurrencyConfig $currencyConfig = null,
         LocalResolverInterface $localeResolver = null,
-        \Magento\Framework\NumberFormatter $numberFormatterFactory = null
+        \Magento\Framework\NumberFormatterFactory $numberFormatterFactory = null
     ) {
         parent::__construct(
             $context,
@@ -366,11 +366,24 @@ public function formatTxt($price, $options = [])
      */
     private function useNumberFormatter(array $options): bool
     {
-        return (empty($options) || array_key_exists(LocaleCurrency::CURRENCY_OPTION_SYMBOL, $options)
-                || (array_key_exists(LocaleCurrency::CURRENCY_OPTION_DISPLAY, $options)
-                    && ($options[LocaleCurrency::CURRENCY_OPTION_DISPLAY] === \Magento\Framework\Currency::NO_SYMBOL
-                    || $options[LocaleCurrency::CURRENCY_OPTION_DISPLAY] === \Magento\Framework\Currency::USE_SYMBOL))
-            || array_key_exists('precision', $options));
+        $allowedOptions = [
+            'precision',
+            LocaleCurrency::CURRENCY_OPTION_DISPLAY,
+            LocaleCurrency::CURRENCY_OPTION_SYMBOL
+        ];
+
+        if (!empty(array_diff(array_keys($options), $allowedOptions))) {
+            return false;
+        }
+
+        if (array_key_exists('display', $options)
+            && $options['display'] !== \Magento\Framework\Currency::NO_SYMBOL
+            && $options['display'] !== \Magento\Framework\Currency::USE_SYMBOL
+        ) {
+            return false;
+        }
+
+        return true;
     }
 
     /**
@@ -396,7 +409,9 @@ private function formatCurrency(string $price, array $options): string
 
         $this->setOptions($options);
 
-        $formattedCurrency = $this->numberFormatter->formatCurrency($price, $this->getCode());
+        $formattedCurrency = $this->numberFormatter->formatCurrency(
+            $price, $this->getCode() ?? LocaleCurrency::DEFAULT_CURRENCY
+        );
 
         if (array_key_exists(LocaleCurrency::CURRENCY_OPTION_DISPLAY, $options)
             && $options[LocaleCurrency::CURRENCY_OPTION_DISPLAY] === \Magento\Framework\Currency::NO_SYMBOL) {
diff --git a/app/code/Magento/Directory/Test/Unit/Model/CurrencyTest.php b/app/code/Magento/Directory/Test/Unit/Model/CurrencyTest.php
@@ -9,6 +9,8 @@
 
 use Magento\Directory\Model\Currency;
 use Magento\Framework\Locale\CurrencyInterface;
+use Magento\Framework\Locale\ResolverInterface as LocalResolverInterface;
+use Magento\Framework\NumberFormatterFactory;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -27,82 +29,165 @@ class CurrencyTest extends TestCase
      */
     protected $localeCurrencyMock;
 
+    /**
+     * @var LocalResolverInterface
+     */
+    private $localeResolver;
+
+    /**
+     * @var NumberFormatterFactory
+     */
+    private $numberFormatterFactory;
+
     protected function setUp(): void
     {
         $this->localeCurrencyMock = $this->getMockForAbstractClass(CurrencyInterface::class);
+        $currencyFilterFactory = $this->getMockBuilder(\Magento\Directory\Model\Currency\FilterFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->localeResolver = $this->getMockBuilder(LocalResolverInterface::class)
+            ->getMockForAbstractClass();
+        $this->numberFormatterFactory = $this->getMockBuilder(NumberFormatterFactory::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['create'])
+            ->getMock();
 
         $objectManager = new ObjectManager($this);
         $this->currency = $objectManager->getObject(
             Currency::class,
             [
                 'localeCurrency' => $this->localeCurrencyMock,
+                'currencyFilterFactory' => $currencyFilterFactory,
+                'localeResolver' => $this->localeResolver,
+                'numberFormatterFactory' => $this->numberFormatterFactory,
                 'data' => [
                     'currency_code' => $this->currencyCode,
                 ]
             ]
         );
     }
 
-    public function testGetCurrencySymbol()
+    public function testGetCurrencySymbol(): void
     {
         $currencySymbol = '$';
 
         $currencyMock = $this->getMockBuilder(\Magento\Framework\Currency::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $currencyMock->expects($this->once())
+        $currencyMock->expects(self::once())
             ->method('getSymbol')
             ->willReturn($currencySymbol);
 
-        $this->localeCurrencyMock->expects($this->once())
+        $this->localeCurrencyMock->expects(self::once())
             ->method('getCurrency')
             ->with($this->currencyCode)
             ->willReturn($currencyMock);
-        $this->assertEquals($currencySymbol, $this->currency->getCurrencySymbol());
+        self::assertEquals($currencySymbol, $this->currency->getCurrencySymbol());
     }
 
     /**
      * @dataProvider getOutputFormatDataProvider
-     * @param $withCurrency
-     * @param $noCurrency
      * @param $expected
+     * @param $locale
      */
-    public function testGetOutputFormat($withCurrency, $noCurrency, $expected)
+    public function testGetOutputFormat($expected, $locale): void
     {
-        $currencyMock = $this->getMockBuilder(\Magento\Framework\Currency::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $currencyMock->expects($this->at(0))
-            ->method('toCurrency')
-            ->willReturn($withCurrency);
-        $currencyMock->expects($this->at(1))
-            ->method('toCurrency')
-            ->willReturn($noCurrency);
-        $this->localeCurrencyMock->expects($this->atLeastOnce())
-            ->method('getCurrency')
-            ->with($this->currencyCode)
-            ->willReturn($currencyMock);
-        $this->assertEquals($expected, $this->currency->getOutputFormat());
+        $this->localeResolver->method('getLocale')->willReturn($locale);
+        $this->numberFormatterFactory
+            ->method('create')
+            ->with(['locale' => $locale, 'style' => 2])
+            ->willReturn(new \NumberFormatter($locale, 2));
+        self::assertEquals($expected, $this->currency->getOutputFormat());
     }
 
     /**
-     * Return data sets for testGetCurrencySymbol()
+     * Return data sets for testGetOutputFormat()
      *
      * @return array
      */
-    public function getOutputFormatDataProvider()
+    public function getOutputFormatDataProvider(): array
     {
         return [
             'no_unicode' => [
-                'withCurrency' => '$0.00',
-                'noCurrency' => '0.00',
                 'expected' => '$%s',
+                'locale' => 'en_US'
             ],
             'arabic_unicode' => [
-                'withCurrency' => json_decode('"\u200E"') . '$0.00',
-                'noCurrency' => json_decode('"\u200E"') . '0.00',
                 'expected' => json_decode('"\u200E"') . '$%s',
+                'locale' => 'fa_IR'
             ]
         ];
     }
+
+    /**
+     * @dataProvider getFormatTxtNumberFormatterDataProvider
+     * @param string $price
+     * @param array $options
+     * @param string $locale
+     * @param string $expected
+     */
+    public function testFormatTxtWithNumberFormatter(
+        string $price,
+        array $options,
+        string $locale,
+        string $expected
+    ): void {
+        $this->localeResolver->expects(self::once())->method('getLocale')->willReturn($locale);
+        $this->numberFormatterFactory
+            ->expects(self::once())
+            ->method('create')
+            ->with(['locale' => $locale, 'style' => 2])
+            ->willReturn(new \NumberFormatter($locale, 2));
+
+        self::assertEquals($expected, $this->currency->formatTxt($price, $options));
+    }
+
+    /**
+     * Return data sets for testFormatTxtWithNumberFormatter()
+     *
+     * @return array
+     */
+    public function getFormatTxtNumberFormatterDataProvider(): array
+    {
+        return [
+            ['9999', [], 'en_US', '$9,999.00'],
+            ['9999', ['display' => \Magento\Framework\Currency::NO_SYMBOL, 'precision' => 2], 'en_US', '9,999.00'],
+            ['9999', ['display' => \Magento\Framework\Currency::NO_SYMBOL], 'en_US', '9,999.00'],
+            ['9999', ['precision' => 1], 'en_US', '$9,999.0']
+        ];
+    }
+
+    /**
+     * @dataProvider getFormatTxtZendCurrencyDataProvider
+     * @param string $price
+     * @param array $options
+     * @param string $expected
+     * @throws \Zend_Currency_Exception
+     */
+    public function testFormatTxtWithZendCurrency(string $price, array $options, string $expected): void
+    {
+        $this->localeCurrencyMock
+            ->expects(self::once())
+            ->method('getCurrency')
+            ->with($this->currencyCode)
+            ->willReturn(new \Zend_Currency($options, 'en_US'));
+
+        self::assertEquals($expected, $this->currency->formatTxt($price, $options));
+    }
+
+    /**
+     * Return data sets for testFormatTxtWithZendCurrency()
+     *
+     * @return array
+     */
+    public function getFormatTxtZendCurrencyDataProvider(): array
+    {
+        return [
+            ['9999', ['display' => \Magento\Framework\Currency::USE_SYMBOL, 'foo' => 'bar'], '$9,999.00'],
+            ['9999', ['display' => \Magento\Framework\Currency::USE_SHORTNAME, 'foo' => 'bar'], 'USD9,999.00'],
+            ['9999', ['currency' => 'USD'], '$9,999.00'],
+            ['9999', ['currency' => 'CNY'], 'CN¥9,999.00'],
+            ['9999', ['locale' => 'fr_FR'], '9 999,00 $']
+        ];
+    }
 }
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Block/Product/View/MultiStoreCurrencyTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Block/Product/View/MultiStoreCurrencyTest.php
@@ -52,7 +52,7 @@ protected function setUp(): void
     public function testMultiStoreRenderPrice(): void
     {
         $this->localeResolver->setLocale('zh_CN');
-        $this->assertProductStorePrice('simple2', '￥70.00');
+        $this->assertProductStorePrice('simple2', '¥70.00');
 
         $this->reloadProductPriceInfo();
         $this->localeResolver->setLocale('uk_UA');
@@ -76,7 +76,7 @@ public function testMultiStoreRenderPrice(): void
     public function testMultiStoreRenderSpecialPrice(): void
     {
         $this->localeResolver->setLocale('zh_CN');
-        $this->assertProductStorePrice('simple', 'Special Price ￥41.93 Regular Price ￥70.00');
+        $this->assertProductStorePrice('simple', 'Special Price ¥41.93 Regular Price ¥70.00');
 
         $this->reloadProductPriceInfo();
         $this->localeResolver->setLocale('uk_UA');
@@ -102,7 +102,7 @@ public function testMultiStoreRenderTierPrice(): void
         $this->localeResolver->setLocale('zh_CN');
         $this->assertProductStorePrice(
             'simple-product-tax-none',
-            'Buy 2 for ￥280.00 each and save 80%',
+            'Buy 2 for ¥280.00 each and save 80%',
             'default',
             self::TIER_PRICE_BLOCK_NAME
         );
