MAGETWO-56941: CLONE - CLONE - [Github] Allowed countries for customer address in admin using storeview configuration #2946

Author: Sergey Kovalenko

app/code/Magento/Customer/Model/CountryHandler.php

@@ -7,22 +7,19 @@
 namespace Magento\Customer\Model;
 
 use Magento\Customer\Model\Config\Share;
+use Magento\Directory\Model\CountryHandlerInterface;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Data\Collection\AbstractDb;
 use Magento\Store\Api\Data\WebsiteInterface;
 use Magento\Store\Model\ScopeInterface;
-use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
-use Magento\Store\Model\Website;
 
 /**
  * Class CountryHandler.
  * @package Magento\Customer\Model
  */
-class CountryHandler
+class CountryHandler implements CountryHandlerInterface
 {
-    const ALLOWED_COUNTRIES_PATH = 'general/country/allow';
-
     /**
      * @var ScopeConfigInterface
      */

app/code/Magento/Customer/Setup/UpgradeData.php

@@ -7,16 +7,13 @@
 namespace Magento\Customer\Setup;
 
 use Magento\Customer\Model\Customer;
-use Magento\Customer\Model\CountryHandler;
-use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Directory\Model\CountryHandlerInterface;
 use Magento\Framework\Encryption\Encryptor;
 use Magento\Framework\Indexer\IndexerRegistry;
-use Magento\Framework\ObjectManager\ObjectManager;
 use Magento\Framework\Setup\SetupInterface;
 use Magento\Framework\Setup\UpgradeDataInterface;
 use Magento\Framework\Setup\ModuleContextInterface;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
-use Magento\Store\Api\Data\WebsiteInterface;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\StoreManagerInterface;
 
@@ -142,11 +139,11 @@ private function getStoreManager()
 
     /**
      * @deprecated
-     * @return CountryHandler
+     * @return CountryHandlerInterface
      */
     private function getCountryHandler()
     {
-        return \Magento\Framework\App\ObjectManager::getInstance()->get(CountryHandler::class);
+        return \Magento\Framework\App\ObjectManager::getInstance()->get(CountryHandlerInterface::class);
     }
 
     /**
@@ -197,7 +194,7 @@ private function migrateStoresAllowedCountriesToWebsite(SetupInterface $setup)
         $connection->delete(
             $setup->getTable('core_config_data'),
             [
-                'path = ?' => CountryHandler::ALLOWED_COUNTRIES_PATH,
+                'path = ?' => CountryHandlerInterface::ALLOWED_COUNTRIES_PATH,
                 'scope = ?' => ScopeInterface::SCOPE_STORES
             ]
         );
@@ -210,7 +207,7 @@ private function migrateStoresAllowedCountriesToWebsite(SetupInterface $setup)
                     'value' => implode(',', $countries)
                 ],
                 [
-                    'path = ?' => CountryHandler::ALLOWED_COUNTRIES_PATH,
+                    'path = ?' => CountryHandlerInterface::ALLOWED_COUNTRIES_PATH,
                     'scope_id = ?' => $scopeId,
                     'scope = ?' => ScopeInterface::SCOPE_WEBSITES
                 ]

app/code/Magento/Customer/Test/Unit/Model/CountryHandlerTest.php

@@ -8,13 +8,14 @@
 
 use Magento\Customer\Model\Config\Share;
 use Magento\Customer\Model\CountryHandler;
+use Magento\Directory\Model\CountryHandlerInterface;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Data\Collection\AbstractDb;
 use Magento\Store\Api\Data\WebsiteInterface;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\StoreManagerInterface;
 
-class CountryHandlerTest extends \PHPUnit_Framework_TestCase
+class CountryHandlerInterfaceTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject | ScopeConfigInterface
@@ -32,7 +33,7 @@ class CountryHandlerTest extends \PHPUnit_Framework_TestCase
     private $configShareMock;
 
     /**
-     * @var CountryHandler
+     * @var CountryHandlerInterface
      */
     private $countryHandler;
 
@@ -75,12 +76,12 @@ public function testGetAllowedCountriesInGlobalScope()
         $this->scopeConfigMock->expects($this->exactly(2))
             ->method('getValue')
             ->withConsecutive(
-                [CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 1],
-                [CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 2]
+                [CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 1],
+                [CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 2]
             )
             ->willReturnMap([
-                [CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 1, 'AZ,AM'],
-                [CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 2, 'AF,AM']
+                [CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 1, 'AZ,AM'],
+                [CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 2, 'AF,AM']
             ]);
 
         $expected = [
@@ -103,7 +104,7 @@ public function testGetAllowedCountriesWithEmptyFilter()
             ->willReturn($website1);
         $this->scopeConfigMock->expects($this->once())
             ->method('getValue')
-            ->with(CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 1)
+            ->with(CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 1)
             ->willReturn('AM');
 
         $this->assertEquals(['AM' => 'AM'], $this->countryHandler->getAllowedCountries());
@@ -113,7 +114,7 @@ public function testGetAllowedCountriesWithoutGlobalScope()
     {
         $this->scopeConfigMock->expects($this->once())
             ->method('getValue')
-            ->with(CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 1)
+            ->with(CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 1)
             ->willReturn('AM');
 
         $this->configShareMock->expects($this->atLeastOnce())
@@ -129,7 +130,7 @@ public function testLoadByScope()
     {
         $this->scopeConfigMock->expects($this->once())
             ->method('getValue')
-            ->with(CountryHandler::ALLOWED_COUNTRIES_PATH, 'website', 1)
+            ->with(CountryHandlerInterface::ALLOWED_COUNTRIES_PATH, 'website', 1)
             ->willReturn('AM');
 
         $collectionMock = $this->getMockBuilder(AbstractDb::class)

app/code/Magento/Customer/Test/Unit/Model/ResourceModel/Address/Attribute/Source/CountryWithWebsitesTest.php

@@ -7,7 +7,7 @@
 namespace Magento\Customer\Test\Unit\Model\ResourceModel\Address\Attribute\Source;
 
 use Magento\Customer\Model\ResourceModel\Address\Attribute\Source\CountryWithWebsites;
-use Magento\Customer\Model\CountryHandler;
+use Magento\Directory\Model\CountryHandlerInterface;
 use Magento\Framework\Data\Collection\AbstractDb;
 use Magento\Store\Api\Data\WebsiteInterface;
 use Magento\Store\Model\StoreManagerInterface;
@@ -41,7 +41,7 @@ public function setUp()
                 ->setMethods(['create'])
                 ->disableOriginalConstructor()
                 ->getMock();
-        $this->countryHandlerMock = $this->getMockBuilder(CountryHandler::class)
+        $this->countryHandlerMock = $this->getMockBuilder(CountryHandlerInterface::class)
             ->disableOriginalConstructor()
             ->getMock();
         $eavCollectionFactoryMock =

app/code/Magento/Customer/etc/di.xml

@@ -51,6 +51,8 @@
                 type="Magento\Customer\Helper\View" />
     <preference for="Magento\Customer\Model\Address\CustomAttributeListInterface"
                 type="Magento\Customer\Model\Address\CustomAttributeList" />
+    <preference for="\Magento\Directory\Model\CountryHandlerInterface"
+                type="Magento\Customer\Model\CountryHandler" />
     <type name="Magento\Customer\Model\Session">
         <arguments>
             <argument name="configShare" xsi:type="object">Magento\Customer\Model\Config\Share\Proxy</argument>

app/code/Magento/Directory/Model/CountryHandlerInterface.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Directory\Model;
+
+use Magento\Framework\Data\Collection\AbstractDb;
+use Magento\Store\Model\ScopeInterface;
+
+/**
+ * Interface CountryHandlerInterface.
+ * @package Magento\Directory\Model
+ */
+interface CountryHandlerInterface
+{
+    const ALLOWED_COUNTRIES_PATH = 'general/country/allow';
+
+    /**
+     * Retrieve all allowed in current scope countries.
+     * @param null $filter
+     * @param string $scope
+     * @param bool $ignoreGlobalScope
+     * @return array
+     */
+    public function getAllowedCountries(
+        $filter = null,
+        $scope = ScopeInterface::SCOPE_WEBSITE,
+        $ignoreGlobalScope = false
+    );
+
+    /**
+     * Filter directory collection by allowed in website countries.
+     * @param $filter
+     * @param string $scope
+     * @param \Magento\Framework\Data\Collection\AbstractDb $collection
+     * @return AbstractDb
+     */
+    public function loadByScope($filter, $scope = ScopeInterface::SCOPE_STORE, AbstractDb $collection);
+}

app/code/Magento/Directory/Model/ResourceModel/Country/Collection.php

@@ -10,7 +10,7 @@
  * Directory Country Resource Collection
  */
 namespace Magento\Directory\Model\ResourceModel\Country;
-use Magento\Customer\Model\CountryHandler;
+use Magento\Directory\Model\CountryHandlerInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Store\Model\ScopeInterface;
 
@@ -123,11 +123,11 @@ protected function _construct()
 
     /**
      * @deprecated
-     * @return CountryHandler
+     * @return \Magento\Directory\Model\CountryHandlerInterface
      */
     private function getCountryHandler()
     {
-        return ObjectManager::getInstance()->get(CountryHandler::class);
+        return ObjectManager::getInstance()->get(CountryHandlerInterface::class);
     }
 
     /**

app/code/Magento/Sales/Block/Adminhtml/Order/Create/Form/Address.php

@@ -7,6 +7,7 @@
 
 use Magento\Backend\Model\Session\Quote;
 use Magento\Customer\Model\CountryHandler;
+use Magento\Directory\Model\CountryHandlerInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
@@ -308,11 +309,11 @@ private function getCountriesCollection()
 
     /**
      * @deprecated
-     * @return CountryHandler
+     * @return CountryHandlerInterface
      */
     private function getCountryHandler()
     {
-        return ObjectManager::getInstance()->get(CountryHandler::class);
+        return ObjectManager::getInstance()->get(CountryHandlerInterface::class);
     }
 
     /**