MAGETWO-33112: Refactor code that uses customer builders in Sales module

 - refactored

Author: Mike Weis

app/code/Magento/Sales/Model/AdminOrder/Create.php

@@ -143,9 +143,9 @@ class Create extends \Magento\Framework\Object implements \Magento\Checkout\Mode
     protected $addressRepository;
 
     /**
-     * @var \Magento\Customer\Api\Data\AddressDataBuilder
+     * @var \Magento\Customer\Api\Data\AddressInterfaceFactory
      */
-    protected $addressBuilder;
+    protected $addressFactory;
 
     /**
      * @var \Magento\Customer\Model\Metadata\FormFactory
@@ -188,9 +188,9 @@ class Create extends \Magento\Framework\Object implements \Magento\Checkout\Mode
     protected $accountManagement;
 
     /**
-     * @var \Magento\Customer\Api\Data\CustomerDataBuilder
+     * @var \Magento\Customer\Api\Data\CustomerInterfaceFactory
      */
-    protected $customerBuilder;
+    protected $customerFactory;
 
     /**
      * Constructor
@@ -209,6 +209,11 @@ class Create extends \Magento\Framework\Object implements \Magento\Checkout\Mode
      */
     protected $quoteManagement;
 
+    /**
+     * @var \Magento\Framework\Api\DataObjectHelper
+     */
+    protected $dataObjectHelper;
+
     /**
      * @param \Magento\Framework\ObjectManagerInterface $objectManager
      * @param \Magento\Framework\Event\ManagerInterface $eventManager
@@ -221,7 +226,7 @@ class Create extends \Magento\Framework\Object implements \Magento\Checkout\Mode
      * @param Product\Quote\Initializer $quoteInitializer
      * @param \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository
      * @param \Magento\Customer\Api\AddressRepositoryInterface $addressRepository
-     * @param \Magento\Customer\Api\Data\AddressDataBuilder $addressBuilder
+     * @param \Magento\Customer\Api\Data\AddressInterfaceFactory $addressFactory
      * @param \Magento\Customer\Model\Metadata\FormFactory $metadataFormFactory
      * @param \Magento\Customer\Api\GroupRepositoryInterface $groupRepository
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
@@ -231,9 +236,10 @@ class Create extends \Magento\Framework\Object implements \Magento\Checkout\Mode
      * @param \Magento\Framework\Object\Factory $objectFactory
      * @param \Magento\Quote\Model\QuoteRepository $quoteRepository
      * @param \Magento\Customer\Api\AccountManagementInterface $accountManagement
-     * @param \Magento\Customer\Api\Data\CustomerDataBuilder $customerBuilder
+     * @param \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerFactory
      * @param \Magento\Customer\Model\Customer\Mapper $customerMapper
      * @param \Magento\Quote\Model\QuoteManagement $quoteManagement
+     * @param \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
      * @param array $data
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -249,7 +255,7 @@ public function __construct(
         Product\Quote\Initializer $quoteInitializer,
         \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository,
         \Magento\Customer\Api\AddressRepositoryInterface $addressRepository,
-        \Magento\Customer\Api\Data\AddressDataBuilder $addressBuilder,
+        \Magento\Customer\Api\Data\AddressInterfaceFactory $addressFactory,
         \Magento\Customer\Model\Metadata\FormFactory $metadataFormFactory,
         \Magento\Customer\Api\GroupRepositoryInterface $groupRepository,
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
@@ -259,9 +265,10 @@ public function __construct(
         \Magento\Framework\Object\Factory $objectFactory,
         \Magento\Quote\Model\QuoteRepository $quoteRepository,
         \Magento\Customer\Api\AccountManagementInterface $accountManagement,
-        \Magento\Customer\Api\Data\CustomerDataBuilder $customerBuilder,
+        \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerFactory,
         \Magento\Customer\Model\Customer\Mapper $customerMapper,
         \Magento\Quote\Model\QuoteManagement $quoteManagement,
+        \Magento\Framework\Api\DataObjectHelper $dataObjectHelper,
         array $data = []
     ) {
         $this->_objectManager = $objectManager;
@@ -275,9 +282,9 @@ public function __construct(
         $this->messageManager = $messageManager;
         $this->customerRepository = $customerRepository;
         $this->addressRepository = $addressRepository;
-        $this->addressBuilder = $addressBuilder;
+        $this->addressFactory = $addressFactory;
         $this->_metadataFormFactory = $metadataFormFactory;
-        $this->customerBuilder = $customerBuilder;
+        $this->customerFactory = $customerFactory;
         $this->groupRepository = $groupRepository;
         $this->_scopeConfig = $scopeConfig;
         $this->emailSender = $emailSender;
@@ -288,6 +295,7 @@ public function __construct(
         $this->accountManagement = $accountManagement;
         $this->customerMapper = $customerMapper;
         $this->quoteManagement = $quoteManagement;
+        $this->dataObjectHelper = $dataObjectHelper;
         parent::__construct($data);
     }
 
@@ -1539,8 +1547,8 @@ public function setAccountData($accountData)
         $request = $form->prepareRequest($accountData);
         $data = $form->extractData($request);
         $data = $form->restoreData($data);
-        $customer = $this->customerBuilder->mergeDataObjectWithArray($customer, $data)
-            ->create();
+        $customer = $this->customerFactory->create();
+        $this->dataObjectHelper->populateWithArray($customer, $data);
         $this->getQuote()->updateCustomerData($customer);
         $data = [];
 
@@ -1658,8 +1666,8 @@ protected function _validateCustomerData(\Magento\Customer\Api\Data\CustomerInte
             }
         }
 
-        return $this->customerBuilder->mergeDataObjectWithArray($customer, $data)
-            ->create();
+        $this->dataObjectHelper->populateWithArray($customer, $data);
+        return $customer;
     }
 
     /**
@@ -1683,24 +1691,21 @@ public function _prepareCustomer()
         if ($customer->getId() && !$this->_customerIsInStore($store)) {
             /** Create a new customer record if it is not available in the specified store */
             /** Unset customer ID to ensure that new customer will be created */
-            $customer = $this->customerBuilder->populate($customer)
-                ->setId(null)
+            $customer->setId(null)
                 ->setStoreId($store->getId())
                 ->setWebsiteId($store->getWebsiteId())
-                ->setCreatedAt(null)->create();
+                ->setCreatedAt(null);
             $customer = $this->_validateCustomerData($customer);
         } else if (!$customer->getId()) {
             /** Create new customer */
             $customerBillingAddressDataObject = $this->getBillingAddress()->exportCustomerAddress();
-            $customer = $this->customerBuilder->populate($customer)
-                ->setSuffix($customerBillingAddressDataObject->getSuffix())
+            $customer->setSuffix($customerBillingAddressDataObject->getSuffix())
                 ->setFirstname($customerBillingAddressDataObject->getFirstname())
                 ->setLastname($customerBillingAddressDataObject->getLastname())
                 ->setMiddlename($customerBillingAddressDataObject->getMiddlename())
                 ->setPrefix($customerBillingAddressDataObject->getPrefix())
                 ->setStoreId($store->getId())
-                ->setEmail($this->_getNewCustomerEmail())
-                ->create();
+                ->setEmail($this->_getNewCustomerEmail());
             $customer = $this->_validateCustomerData($customer);
         }
         $this->getQuote()->setCustomer($customer);
@@ -1713,10 +1718,12 @@ public function _prepareCustomer()
         }
         $this->getQuote()->updateCustomerData($this->getQuote()->getCustomer());
 
-        $customerData = $this->customerMapper->toFlatArray(
-            $this->customerBuilder->populate($this->getQuote()->getCustomer())->setAddresses([])->create()
-        );
-        foreach ($this->_createCustomerForm($this->getQuote()->getCustomer())->getUserAttributes() as $attribute) {
+        $customer = $this->getQuote()->getCustomer();
+        $origAddresses = $customer->getAddresses(); // save original addresses
+        $customer->setAddresses([]);
+        $customerData = $this->customerMapper->toFlatArray($customer);
+        $customer->setAddresses($origAddresses); // restore original addresses
+        foreach ($this->_createCustomerForm($customer)->getUserAttributes() as $attribute) {
             if (isset($customerData[$attribute->getAttributeCode()])) {
                 $quoteCode = sprintf('customer_%s', $attribute->getAttributeCode());
                 $this->getQuote()->setData($quoteCode, $customerData[$attribute->getAttributeCode()]);
@@ -1746,36 +1753,35 @@ protected function _prepareCustomerAddress($customer, $quoteCustomerAddress)
             /** Update existing address */
             $existingAddressDataObject = $this->addressRepository->getById($quoteAddressId);
             /** Update customer address data */
-            $customerAddress = $this->addressBuilder->mergeDataObjects($existingAddressDataObject, $customerAddress)
-                ->create();
+            $this->dataObjectHelper->mergeDataObjects(
+                get_class($existingAddressDataObject),
+                $existingAddressDataObject,
+                $customerAddress
+            );
+            $customerAddress = $existingAddressDataObject;
         } elseif ($addressType == \Magento\Quote\Model\Quote\Address::ADDRESS_TYPE_SHIPPING) {
             try {
-                $billingAddressDataObject = $customer->getDefaultBilling();
+                $billingAddressDataObject = $this->accountManagement->getDefaultBillingAddress($customer->getId());
             } catch (\Exception $e) {
                 /** Billing address does not exist. */
             }
             $isShippingAsBilling = $quoteCustomerAddress->getSameAsBilling();
             if (isset($billingAddressDataObject) && $isShippingAsBilling) {
                 /** Set existing billing address as default shipping */
-                $customerAddress = $this->addressBuilder->populate($billingAddressDataObject)
-                    ->setDefaultShipping(true)
-                    ->create();
+                $customerAddress = $billingAddressDataObject;
+                $customerAddress->setDefaultShipping(true);
             }
         }
 
         switch ($addressType) {
             case \Magento\Quote\Model\Quote\Address::ADDRESS_TYPE_BILLING:
                 if (is_null($customer->getDefaultBilling())) {
-                    $customerAddress = $this->addressBuilder->populate($customerAddress)
-                        ->setDefaultBilling(true)
-                        ->create();
+                    $customerAddress->setDefaultBilling(true);
                 }
                 break;
             case \Magento\Quote\Model\Quote\Address::ADDRESS_TYPE_SHIPPING:
                 if (is_null($customer->getDefaultShipping())) {
-                    $customerAddress = $this->addressBuilder->populate($customerAddress)
-                        ->setDefaultShipping(true)
-                        ->create();
+                    $customerAddress->setDefaultShipping(true);
                 }
                 break;
             default:

dev/tests/unit/testsuite/Magento/Sales/Model/AdminOrder/CreateTest.php

@@ -26,8 +26,8 @@ class CreateTest extends \PHPUnit_Framework_TestCase
     /** @var \Magento\Customer\Model\Metadata\FormFactory|\PHPUnit_Framework_MockObject_MockObject */
     protected $formFactoryMock;
 
-    /** @var \Magento\Customer\Api\Data\CustomerDataBuilder|\PHPUnit_Framework_MockObject_MockObject */
-    protected $customerBuilderMock;
+    /** @var \Magento\Customer\Api\Data\CustomerInterfaceFactory|\PHPUnit_Framework_MockObject_MockObject */
+    protected $customerFactoryMock;
 
     /** @var \Magento\Quote\Model\Quote\Item\Updater|\PHPUnit_Framework_MockObject_MockObject */
     protected $itemUpdater;
@@ -51,9 +51,9 @@ class CreateTest extends \PHPUnit_Framework_TestCase
     protected $addressRepositoryMock;
 
     /**
-     * @var \Magento\Customer\Api\Data\AddressDataBuilder|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Customer\Api\Data\AddressInterfaceFactory|\PHPUnit_Framework_MockObject_MockObject
      */
-    protected $addressBuilderMock;
+    protected $addressFactoryMock;
 
     /**
      * @var \Magento\Customer\Api\GroupRepositoryInterface|\PHPUnit_Framework_MockObject_MockObject
@@ -100,9 +100,9 @@ protected function setUp()
             '',
             false
         );
-        $this->customerBuilderMock = $this->getMock(
-            'Magento\Customer\Api\Data\CustomerDataBuilder',
-            ['mergeDataObjectWithArray', 'populateWithArray', 'create'],
+        $this->customerFactoryMock = $this->getMock(
+            'Magento\Customer\Api\Data\CustomerInterfaceFactory',
+            ['create'],
             [],
             '',
             false
@@ -138,8 +138,8 @@ protected function setUp()
             '',
             false
         );
-        $this->addressBuilderMock = $this->getMock(
-            'Magento\Customer\Api\Data\AddressDataBuilder',
+        $this->addressFactoryMock = $this->getMock(
+            'Magento\Customer\Api\Data\AddressInterfaceFactory',
             [],
             [],
             '',
@@ -186,9 +186,9 @@ protected function setUp()
                 'quoteInitializer' => $this->quoteInitializerMock,
                 'customerRepository' => $this->customerRepositoryMock,
                 'addressRepository' => $this->addressRepositoryMock,
-                'addressBuilder' => $this->addressBuilderMock,
+                'addressFactory' => $this->addressFactoryMock,
                 'metadataFormFactory' => $this->formFactoryMock,
-                'customerBuilder' => $this->customerBuilderMock,
+                'customerFactory' => $this->customerFactoryMock,
                 'groupRepository' => $this->groupRepositoryMock,
                 'quoteItemUpdater' => $this->itemUpdater,
                 'customerMapper' => $this->customerMapper,
@@ -257,10 +257,7 @@ public function testSetAccountData()
 
         $this->formFactoryMock->expects($this->any())->method('create')->will($this->returnValue($customerFormMock));
         $this->sessionQuoteMock->expects($this->any())->method('getQuote')->will($this->returnValue($quoteMock));
-        $this->customerBuilderMock->expects($this->any())
-            ->method('mergeDataObjectWithArray')
-            ->will($this->returnSelf());
-        $this->customerBuilderMock->expects($this->any())->method('create')->will($this->returnValue($customerMock));
+        $this->customerFactoryMock->expects($this->any())->method('create')->will($this->returnValue($customerMock));
 
         $this->groupRepositoryMock->expects($this->once())
             ->method('getById')