Update the click and collect method instance name

- update the click and collect method instance name to remove the underscore
- ensures backwards-compatibility is maintained for orders already created using the older method instance name
- resolves a magento core bug introduced in Magento v2.1 with regards to handling shipping methods that contain an underscore in the instance name (magento/magento2#13902)

Signed-off-by: Matthew Muscat <[email protected]>

Author: matthew-muscat

Helper/Carrier/ClickAndCollect.php

@@ -20,7 +20,7 @@
 
 class ClickAndCollect extends \Shippit\Shipping\Helper\Data
 {
-    const XML_PATH_SETTINGS = 'carriers/shippit_cc/';
+    const XML_PATH_SETTINGS = 'carriers/shippitcc/';
 
     /**
      * Return store config value for key

Helper/Data.php

@@ -22,7 +22,8 @@
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {
     const CARRIER_CODE = 'shippit';
-    const CARRIER_CODE_CC = 'shippit_cc';
+    const CARRIER_CODE_CC = 'shippitcc';
+    const CARRIER_CODE_CC_LEGACY = 'shippit_cc';
     const XML_PATH_SETTINGS = 'shippit/general/';
 
     protected $_scopeConfig;

Helper/Sync/Order.php

@@ -73,7 +73,9 @@ public function getShippingMethodMapping()
     // Helper Methods
     public function getShippitShippingMethod($shippingMethod)
     {
-        if (strpos($shippingMethod, self::CARRIER_CODE_CC) !== FALSE) {
+        if (strpos($shippingMethod, self::CARRIER_CODE_CC) !== FALSE ||
+            strpos($shippingMethod, self::CARRIER_CODE_CC_LEGACY) !== FALSE
+        ) {
             return 'click_and_collect';
         }
 

Model/Config/Source/Shipping/Methods.php

@@ -2,6 +2,7 @@
 
 namespace Shippit\Shipping\Model\Config\Source\Shipping;
 
+use Shippit\Shipping\Helper\Data as ShippitHelper;
 use Magento\Store\Model\ScopeInterface;
 
 class Methods implements \Magento\Framework\Option\ArrayInterface
@@ -52,8 +53,13 @@ public function toOptionArray($showPlaceholder = false, $excludeShippit = false)
 
             // if the carrier is shippit, exclude
             // it from the returned results
-            if ($excludeShippit && ($carrierCode == 'shippit' || $carrierCode == 'shippit_cc')
-                ) {
+            if ($excludeShippit &&
+                (
+                    $carrierCode == ShippitHelper::CARRIER_CODE ||
+                    $carrierCode == ShippitHelper::CARRIER_CODE_CC ||
+                    $carrierCode == ShippitHelper::CARRIER_CODE_CC_LEGACY
+                )
+            ) {
                 continue;
             }
 

Setup/UpgradeData.php

@@ -16,29 +16,39 @@
 
 namespace Shippit\Shipping\Setup;
 
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\Config\ConfigResource\ConfigInterface;
 use Magento\Framework\Setup\ModuleContextInterface;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\UpgradeDataInterface;
+use Magento\Config\Model\ResourceModel\Config\Data\CollectionFactory;
 
 class UpgradeData implements UpgradeDataInterface
 {
     /**
-     * @var \Magento\Framework\App\Config\ConfigResource\ConfigInterface
+     * @var ConfigInterface
      */
     protected $config;
 
     /**
-     * @var \Magento\Framework\App\Config\ScopeConfigInterface
+     * @var ScopeConfigInterface
      */
-    protected $scopeConfig;
+    protected $configScope;
+
+    /**
+     * @var CollectionFactory
+     */
+    protected $configCollectionFactory;
 
     public function __construct(
-        \Magento\Framework\App\Config\ConfigResource\ConfigInterface $config,
-        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+        ConfigInterface $config,
+        ScopeConfigInterface $configScope,
+        CollectionFactory $configCollectionFactory
     )
     {
         $this->config = $config;
-        $this->scopeConfig = $scopeConfig;
+        $this->configScope = $configScope;
+        $this->configCollectionFactory = $configCollectionFactory;
     }
 
     /**
@@ -54,15 +64,17 @@ public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface
         $installer->startSetup();
 
         if (version_compare($context->getVersion(), '1.1.19') < 0) {
-            //code to upgrade to 1.1.19
             $this->upgrade_1119($installer);
         }
 
         if (version_compare($context->getVersion(), '1.2.6') < 0) {
-            //code to upgrade to 1.2.6
             $this->upgrade_126($installer);
         }
 
+        if (version_compare($context->getVersion(), '1.4.10') < 0) {
+            $this->upgrade_1410($installer);
+        }
+
         $installer->endSetup();
     }
 
@@ -80,7 +92,7 @@ public function upgrade_1119($installer)
         ];
 
         foreach ($configOptions as $configOptionOldKey => $configOptionNewKey) {
-            $configOptionValue = $this->scopeConfig->getValue($configOptionOldKey);
+            $configOptionValue = $this->configScope->getValue($configOptionOldKey);
 
             if (!empty($configOptionValue)) {
                 $this->config->saveConfig(
@@ -108,7 +120,7 @@ public function upgrade_126($installer)
         ];
 
         foreach ($configOptions as $configOptionOldKey => $configOptionNewKey) {
-            $configOptionValue = $this->scopeConfig->getValue($configOptionOldKey);
+            $configOptionValue = $this->configScope->getValue($configOptionOldKey);
 
             if (!empty($configOptionValue)) {
                 $this->config->saveConfig(
@@ -120,4 +132,38 @@ public function upgrade_126($installer)
             }
         }
     }
+
+    /**
+     * Update config data to v1.4.10
+     */
+    public function upgrade_1410($installer)
+    {
+        /**
+         * Migrate settings data to v1.4.10
+         * (new shipping method carrier path for click and collect)
+         */
+        $configOptions = $this->configCollectionFactory
+            ->create()
+            ->addFieldToFilter('path', array('like' => 'carriers/shippit_cc/%'))
+            ->load();
+
+        if ($configOptions->getSize() <= 0) {
+            return;
+        }
+
+        foreach ($configOptions->getItems() as $configOption) {
+            $newConfigPath = str_replace(
+                'shippit_cc',
+                'shippitcc',
+                $configOption->getPath()
+            );
+
+            $this->config->saveConfig(
+                $newConfigPath,
+                $configOption->getValue(),
+                $configOption->getScope(),
+                $configOption->getScopeId()
+            );
+        }
+    }
 }

etc/adminhtml/system.xml

@@ -295,7 +295,7 @@
                 </field>
             </group>
 
-            <group id="shippit_cc" translate="label" type="text" sortOrder="0" showInDefault="1" showInWebsite="1" showInStore="1">
+            <group id="shippitcc" translate="label" type="text" sortOrder="0" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Shippit - Click and Collect</label>
 
                 <field id="active" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="0">

etc/config.xml

@@ -69,15 +69,15 @@
                 <specificerrmsg>This shipping method is not available. To use this shipping method, please contact us.</specificerrmsg>
                 <sort_order>10</sort_order>
             </shippit>
-            <shippit_cc>
+            <shippitcc>
                 <model>Shippit\Shipping\Model\Carrier\ClickAndCollect</model>
                 <active>0</active>
                 <title>Click and Collect</title>
                 <method/>
                 <sallowspecific/>
                 <specificcountry/>
                 <sort_order>20</sort_order>
-            </shippit_cc>
+            </shippitcc>
         </carriers>
     </default>
 </config>