MAGETWO-58568: [SalesOrder] HTML tags displayed on the price field.

Robert He · Robert He · commit eb5d1a795982 · 2016-09-22T10:40:03.000-05:00
- use NumberFormatter to strip tags if necessary in currency-type fields
diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/Currency.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/Currency.php
@@ -4,14 +4,10 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block\Widget\Grid\Column\Renderer;
 
 /**
  * Backend grid item renderer currency
- *
- * @author     Magento Core Team <core@magentocommerce.com>
  */
 class Currency extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {
@@ -49,6 +45,11 @@ class Currency extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\Abstra
      */
     protected $_localeCurrency;
 
+    /**
+     * @var \Magento\Framework\Intl\NumberFormatterFactory
+     */
+    private $numberFormatterFactory;
+
     /**
      * @param \Magento\Backend\Block\Context $context
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
@@ -76,6 +77,23 @@ public function __construct(
         $this->_defaultBaseCurrency = $currencyFactory->create()->load($defaultBaseCurrencyCode);
     }
 
+    /**
+     * Get number formatter factory
+     *
+     * @return \Magento\Framework\Intl\NumberFormatterFactory
+     *
+     * @deprecated
+     */
+    private function getNumberFormatterFactory()
+    {
+        if ($this->numberFormatterFactory === null) {
+            $this->numberFormatterFactory = \Magento\Framework\App\ObjectManager::getInstance()->get(
+                \Magento\Framework\Intl\NumberFormatterFactory::class
+            );
+        }
+        return $this->numberFormatterFactory;
+    }
+
     /**
      * Renders grid column
      *
@@ -86,10 +104,20 @@ public function render(\Magento\Framework\DataObject $row)
     {
         if ($data = (string)$this->_getValue($row)) {
             $currency_code = $this->_getCurrencyCode($row);
-            $data = floatval($data) * $this->_getRate($row);
+            $currency = $this->_localeCurrency->getCurrency($currency_code);
+            $numberFormatter = $this->getNumberFormatterFactory()
+                ->create($currency->getLocale(), \NumberFormatter::CURRENCY);
+            // Optionally need to strip tags from the column field
+            if (!$stripData = $this->stripTags($data)) {
+                $stripData = $data;
+            }
+            // Optionally need to remove currency symbols
+            if (!$price = $numberFormatter->parseCurrency($stripData, $currency_code)) {
+                $price = $stripData;
+            }
+            $convertedPrice = $price * $this->_getRate($row);
             $sign = (bool)(int)$this->getColumn()->getShowNumberSign() && $data > 0 ? '+' : '';
-            $data = sprintf("%f", $data);
-            $data = $this->_localeCurrency->getCurrency($currency_code)->toCurrency($data);
+            $data = $currency->toCurrency($convertedPrice);
             return $sign . $data;
         }
         return $this->getColumn()->getDefault();
diff --git a/app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/Column/Renderer/CurrencyTest.php b/app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/Column/Renderer/CurrencyTest.php
@@ -47,44 +47,49 @@ class CurrencyTest extends \PHPUnit_Framework_TestCase
      */
     protected $_row;
 
+    /*
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $numberFactoryMock;
+
     protected function setUp()
     {
-        $this->_storeManagerMock = $this->getMock('Magento\Store\Model\StoreManagerInterface');
-        $this->_localeMock = $this->getMock('Magento\Framework\Locale\CurrencyInterface');
-        $this->_requestMock = $this->getMock('Magento\Framework\App\RequestInterface');
+        $this->_storeManagerMock = $this->getMock(\Magento\Store\Model\StoreManagerInterface::class);
+        $this->_localeMock = $this->getMock(\Magento\Framework\Locale\CurrencyInterface::class);
+        $this->_requestMock = $this->getMock(\Magento\Framework\App\RequestInterface::class);
 
         $this->_curLocatorMock = $this->getMock(
-            'Magento\Directory\Model\Currency\DefaultLocator',
+            \Magento\Directory\Model\Currency\DefaultLocator::class,
             [],
             [],
             '',
             false
         );
         $this->_columnMock = $this->getMock(
-            'Magento\Backend\Block\Widget\Grid\Column',
+            \Magento\Backend\Block\Widget\Grid\Column::class,
             ['getIndex'],
             [],
             '',
             false
         );
         $this->_columnMock->expects($this->any())->method('getIndex')->will($this->returnValue('columnIndex'));
 
-        $this->_currencyMock = $this->getMock('Magento\Directory\Model\Currency', [], [], '', false);
+        $this->_currencyMock = $this->getMock(\Magento\Directory\Model\Currency::class, [], [], '', false);
         $this->_currencyMock->expects($this->any())->method('load')->will($this->returnSelf());
         $currencyFactoryMock = $this->getMock(
-            'Magento\Directory\Model\CurrencyFactory',
+            \Magento\Directory\Model\CurrencyFactory::class,
             ['create'],
             [],
             '',
             false
         );
         $currencyFactoryMock->expects($this->any())->method('create')->will($this->returnValue($this->_currencyMock));
 
-        $this->_row = new \Magento\Framework\DataObject(['columnIndex' => '10']);
+        $this->_row = new \Magento\Framework\DataObject(['columnIndex' => '$10.00']);
 
         $helper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
         $this->_blockCurrency = $helper->getObject(
-            'Magento\Backend\Block\Widget\Grid\Column\Renderer\Currency',
+            \Magento\Backend\Block\Widget\Grid\Column\Renderer\Currency::class,
             [
                 'storeManager' => $this->_storeManagerMock,
                 'localeCurrency' => $this->_localeMock,
@@ -95,6 +100,19 @@ protected function setUp()
         );
 
         $this->_blockCurrency->setColumn($this->_columnMock);
+
+        $this->numberFormatterFactoryMock = $this->getMock(
+            \Magento\Framework\Intl::class,
+            ['create'],
+            [],
+            '',
+            false
+        );
+        $helper->setBackwardCompatibleProperty(
+            $this->_blockCurrency,
+            'numberFormatterFactory',
+            $this->numberFormatterFactoryMock
+        );
     }
 
     protected function tearDown()
@@ -113,46 +131,40 @@ protected function tearDown()
      */
     public function testRenderWithDefaultCurrency()
     {
-        $this->_currencyMock->expects(
-            $this->once()
-        )->method(
-            'getRate'
-        )->with(
-            'defaultCurrency'
-        )->will(
-            $this->returnValue(1.5)
-        );
-
-        $this->_curLocatorMock->expects(
-            $this->any()
-        )->method(
-            'getDefaultCurrency'
-        )->with(
-            $this->_requestMock
-        )->will(
-            $this->returnValue('defaultCurrency')
-        );
-
-        $currLocaleMock = $this->getMock('Zend_Currency', [], [], '', false);
-        $currLocaleMock->expects(
-            $this->once()
-        )->method(
-            'toCurrency'
-        )->with(
-            15.0000
-        )->will(
-            $this->returnValue('15USD')
-        );
-        $this->_localeMock->expects(
-            $this->once()
-        )->method(
-            'getCurrency'
-        )->with(
-            'defaultCurrency'
-        )->will(
-            $this->returnValue($currLocaleMock)
-        );
-
-        $this->assertEquals('15USD', $this->_blockCurrency->render($this->_row));
+        $this->_currencyMock->expects($this->once())
+            ->method('getRate')
+            ->with('USD')
+            ->willReturn(1.5);
+        $currLocaleMock = $this->getMock(\Magento\Framework\Currency::class, ['getLocale','toCurrency'], [], '', false);
+        $currLocaleMock->expects($this->once())
+            ->method('getLocale')
+            ->willReturn('en_US');
+        $this->_localeMock->expects($this->once())
+            ->method('getCurrency')
+            ->with('USD')
+            ->will($this->returnValue($currLocaleMock));
+
+        $numberFormatterMock = $this->getMock(\NumberFormatter::class, ['parseCurrency'], [], '', false);
+        $this->numberFormatterFactoryMock->expects($this->once())
+            ->method('create')
+            ->with('en_US', \NumberFormatter::CURRENCY)
+            ->will($this->returnValue($numberFormatterMock));
+
+        $numberFormatterMock->expects($this->once())
+            ->method('parseCurrency')
+            ->with('$10.00', 'USD')
+            ->willReturn(10);
+
+        $this->_curLocatorMock->expects($this->any())
+            ->method('getDefaultCurrency')
+            ->with($this->_requestMock)
+            ->willReturn('USD');
+
+        $currLocaleMock->expects($this->once())
+            ->method('toCurrency')
+            ->with(15.0000)
+            ->willReturn('$15.00');
+
+        $this->assertEquals('$15.00', $this->_blockCurrency->render($this->_row));
     }
 }
diff --git a/app/code/Magento/Eav/Model/Entity/Attribute.php b/app/code/Magento/Eav/Model/Entity/Attribute.php
@@ -76,6 +76,11 @@ class Attribute extends \Magento\Eav\Model\Entity\Attribute\AbstractAttribute im
      */
     protected $dateTimeFormatter;
 
+    /**
+     * @var \Magento\Framework\Intl\NumberFormatterFactory
+     */
+    private $numberFormatterFactory;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -216,6 +221,23 @@ public function loadEntityAttributeIdBySet()
         return $this;
     }
 
+    /**
+     * Get number formatter factory
+     *
+     * @return \Magento\Framework\Intl\NumberFormatterFactory
+     *
+     * @deprecated
+     */
+    private function getNumberFormatterFactory()
+    {
+        if ($this->numberFormatterFactory === null) {
+            $this->numberFormatterFactory = \Magento\Framework\App\ObjectManager::getInstance()->get(
+                \Magento\Framework\Intl\NumberFormatterFactory::class
+            );
+        }
+        return $this->numberFormatterFactory;
+    }
+
     /**
      * Prepare data for save
      *
@@ -256,7 +278,8 @@ public function beforeSave()
         $hasDefaultValue = (string)$defaultValue != '';
 
         if ($this->getBackendType() == 'decimal' && $hasDefaultValue) {
-            $numberFormatter = new \NumberFormatter($this->_localeResolver->getLocale(), \NumberFormatter::DECIMAL);
+            $numberFormatter = $this->getNumberFormatterFactory()
+                ->create($this->_localeResolver->getLocale(), \NumberFormatter::DECIMAL);
             $defaultValue = $numberFormatter->parse($defaultValue);
             if ($defaultValue === false) {
                 throw new LocalizedException(__('Invalid default decimal value'));
diff --git a/lib/internal/Magento/Framework/Intl/NumberFormatterFactory.php b/lib/internal/Magento/Framework/Intl/NumberFormatterFactory.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Intl;
+
+/**
+ * Class NumberFormatterFactory
+ * @package Magento\Framework
+ */
+class NumberFormatterFactory
+{
+    /**
+     * Factory method for \NumberFormatter
+     *
+     * @param string $locale
+     * @param int $style
+     * @param string $pattern
+     * @return \NumberFormatter
+     */
+    public function create($locale, $style, $pattern = null)
+    {
+        return new \NumberFormatter($locale, $style, $pattern);
+    }
+}
