MAGETWO-43788: [GITHUB] Weight units are hardcoded to LBS #1702

Author: Michail Slabko

app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Weight.php

@@ -26,6 +26,9 @@ class Weight extends \Magento\Framework\Data\Form\Element\Text
      */
     protected $localeFormat;
 
+    /** @var \Magento\Directory\Helper\Data */
+    protected $directoryHelper;
+
     /**
      * @param \Magento\Framework\Data\Form\Element\Factory $factoryElement
      * @param \Magento\Framework\Data\Form\Element\CollectionFactory $factoryCollection
@@ -38,8 +41,10 @@ public function __construct(
         \Magento\Framework\Data\Form\Element\CollectionFactory $factoryCollection,
         \Magento\Framework\Escaper $escaper,
         \Magento\Framework\Locale\Format $localeFormat,
+        \Magento\Directory\Helper\Data $directoryHelper,
         array $data = []
     ) {
+        $this->directoryHelper = $directoryHelper;
         $this->localeFormat = $localeFormat;
         $this->weightSwitcher = $factoryElement->create('radios');
         $this->weightSwitcher->setValue(
@@ -85,7 +90,7 @@ public function getElementHtml()
                 '<label class="admin__addon-suffix" for="' .
                 $this->getHtmlId() .
                 '"><span>' .
-                __('lbs') .
+                $this->directoryHelper->getWeightUnit() .
                 '</span></label>' .
             '</div>' .
         '</div>';

app/code/Magento/Directory/Helper/Data.php

@@ -9,6 +9,8 @@
  */
 namespace Magento\Directory\Helper;
 
+use Magento\Store\Model\ScopeInterface;
+
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {
     /**
@@ -40,6 +42,11 @@ class Data extends \Magento\Framework\App\Helper\AbstractHelper
      */
     const XML_PATH_TOP_COUNTRIES = 'general/country/destinations';
 
+    /**
+     * Path to config value that contains weight unit
+     */
+    const XML_PATH_WEIGHT_UNIT = 'general/locale/weight_unit';
+
     /**
      * Country collection
      *
@@ -214,7 +221,7 @@ public function getCountriesWithOptionalZip($asJson = false)
             $value = trim(
                 $this->scopeConfig->getValue(
                     self::OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH,
-                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+                    ScopeInterface::SCOPE_STORE
                 )
             );
             $this->_optZipCountries = preg_split('/\,/', $value, 0, PREG_SPLIT_NO_EMPTY);
@@ -248,7 +255,7 @@ public function getCountriesWithStatesRequired($asJson = false)
         $value = trim(
             $this->scopeConfig->getValue(
                 self::XML_PATH_STATES_REQUIRED,
-                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+                ScopeInterface::SCOPE_STORE
             )
         );
         $countryList = preg_split('/\,/', $value, 0, PREG_SPLIT_NO_EMPTY);
@@ -267,7 +274,7 @@ public function isShowNonRequiredState()
     {
         return (bool)$this->scopeConfig->getValue(
             self::XML_PATH_DISPLAY_ALL_STATES,
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+            ScopeInterface::SCOPE_STORE
         );
     }
 
@@ -306,7 +313,7 @@ public function getDefaultCountry($store = null)
     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_DEFAULT_COUNTRY,
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
+            ScopeInterface::SCOPE_STORE,
             $store
         );
     }
@@ -352,8 +359,18 @@ public function getTopCountryCodes()
     {
         $configValue = (string)$this->scopeConfig->getValue(
             self::XML_PATH_TOP_COUNTRIES,
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+            ScopeInterface::SCOPE_STORE
         );
         return !empty($configValue) ? explode(',', $configValue) : [];
     }
+
+    /**
+     * Retrieve weight unit
+     *
+     * @return string
+     */
+    public function getWeightUnit()
+    {
+        return $this->scopeConfig->getValue(self::XML_PATH_WEIGHT_UNIT, ScopeInterface::SCOPE_STORE);
+    }
 }

app/code/Magento/Directory/Model/Config/Source/WeightUnit.php

@@ -0,0 +1,17 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Directory\Model\Config\Source;
+
+class WeightUnit implements \Magento\Framework\Option\ArrayInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function toOptionArray()
+    {
+        return [['value' => 'lbs', 'label' => __('lbs')], ['value' => 'kgs', 'label' => __('kgs')]];
+    }
+}

app/code/Magento/Directory/etc/adminhtml/system.xml

@@ -103,6 +103,12 @@
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
             </group>
+            <group id="locale">
+                <field id="weight_unit" translate="label" type="select" sortOrder="7" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Weight Unit</label>
+                    <source_model>Magento\Directory\Model\Config\Source\WeightUnit</source_model>
+                </field>
+            </group>
         </section>
     </system>
 </config>

app/code/Magento/Directory/etc/config.xml

@@ -44,6 +44,7 @@
                 <language>en</language>
                 <code>en_US</code>
                 <timezone>America/Los_Angeles</timezone>
+                <weight_unit>lbs</weight_unit>
             </locale>
         </general>
     </default>

app/code/Magento/Store/Model/Service/StoreConfigManager.php

@@ -34,6 +34,7 @@ class StoreConfigManager implements \Magento\Store\Api\StoreConfigManagerInterfa
         'setBaseCurrencyCode' => 'currency/options/base',
         'setDefaultDisplayCurrencyCode' => 'currency/options/default',
         'setTimezone' => 'general/locale/timezone',
+        'setWeightUnit' => \Magento\Directory\Helper\Data::XML_PATH_WEIGHT_UNIT
     ];
 
     /**
@@ -91,9 +92,6 @@ protected function getStoreConfig($store)
             $storeConfig->$methodName($configValue);
         }
 
-        //Hard code the weight unit for now
-        $storeConfig->setWeightUnit('lbs');
-
         $storeConfig->setBaseUrl($store->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_WEB, false));
         $storeConfig->setSecureBaseUrl($store->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_WEB, true));
         $storeConfig->setBaseLinkUrl($store->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_LINK, false));

app/code/Magento/Store/Test/Unit/Model/Service/StoreConfigManagerTest.php

@@ -121,6 +121,7 @@ public function testGetStoreConfigs()
         $timeZone = 'America/Los_Angeles';
         $baseCurrencyCode = 'USD';
         $defaultDisplayCurrencyCode = 'GBP';
+        $weightUnit = 'lbs';
 
         $storeMocks = [];
         $storeConfigs = [
@@ -161,6 +162,7 @@ public function testGetStoreConfigs()
             ['currency/options/base', ScopeInterface::SCOPE_STORES, $code, $baseCurrencyCode],
             ['currency/options/default', ScopeInterface::SCOPE_STORES, $code, $defaultDisplayCurrencyCode],
             ['general/locale/timezone', ScopeInterface::SCOPE_STORES, $code, $timeZone],
+            [\Magento\Directory\Helper\Data::XML_PATH_WEIGHT_UNIT, ScopeInterface::SCOPE_STORES, $code, $weightUnit]
         ];
         $this->scopeConfigMock->expects($this->any())
             ->method('getValue')
@@ -171,7 +173,7 @@ public function testGetStoreConfigs()
         $this->assertEquals(1, count($result));
         $this->assertEquals($id, $result[0]->getId());
         $this->assertEquals($code, $result[0]->getCode());
-        $this->assertEquals('lbs', $result[0]->getWeightUnit());
+        $this->assertEquals($weightUnit, $result[0]->getWeightUnit());
         $this->assertEquals($baseUrl, $result[0]->getBaseUrl());
         $this->assertEquals($secureBaseUrl, $result[0]->getSecureBaseUrl());
         $this->assertEquals($baseLinkUrl, $result[0]->getBaseLinkUrl());