MAGETWO-33664: Refactor Sales module to use mutable data object interfaces

 - updated per code review comments

Author: Mike Weis

app/code/Magento/Quote/Model/Quote/Address/ToOrderAddress.php

@@ -59,13 +59,13 @@ public function convert(Address $object, $data = [])
             $object
         );
 
-        $order = $this->orderAddressFactory->create();
+        $orderAddress = $this->orderAddressFactory->create();
         $this->dataObjectHelper->populateWithArray(
-            $order,
+            $orderAddress,
             array_merge($orderAddressData, $data),
             '\Magento\Sales\Api\Data\OrderAddressInterface'
         );
 
-        return $order;
+        return $orderAddress;
     }
 }

dev/tests/unit/testsuite/Magento/Quote/Model/Quote/Address/ToOrderAddressTest.php

@@ -32,25 +32,30 @@ class ToOrderAddressTest extends \PHPUnit_Framework_TestCase
      */
     protected $converter;
 
+    /**
+     * @var \Magento\Framework\Api\DataObjectHelper
+     */
+    protected $dataObjectHelper;
+
     protected function setUp()
     {
         $this->orderAddressFactoryMock = $this->getMock(
             'Magento\Sales\Api\Data\OrderAddressInterfaceFactory',
-            ['populateWithArray', 'create'],
+            ['create'],
             [],
             '',
             false
         );
         $this->objectCopyMock = $this->getMock('Magento\Framework\Object\Copy', [], [], '', false);
-        $this->orderInterfaceMock = $this->getMock('Magento\Sales\Api\Data\OrderInterface', [], [], '', false);
-        $dataObjectHelper = $this->getMock('\Magento\Framework\Api\DataObjectHelper', [], [], '', false);
+        $this->orderInterfaceMock = $this->getMock('Magento\Sales\Api\Data\OrderAddressInterface', [], [], '', false);
+        $this->dataObjectHelper = $this->getMock('\Magento\Framework\Api\DataObjectHelper', [], [], '', false);
         $objectManager = new ObjectManager($this);
         $this->converter = $objectManager->getObject(
             'Magento\Quote\Model\Quote\Address\ToOrderAddress',
             [
                 'orderAddressFactory' => $this->orderAddressFactoryMock,
                 'objectCopyService' => $this->objectCopyMock,
-                'dataObjectHelper' => $dataObjectHelper
+                'dataObjectHelper' => $this->dataObjectHelper
             ]
         );
     }
@@ -68,8 +73,8 @@ public function testConvert()
             'to_order_address',
             $object
         )->willReturn($orderData);
-        $this->orderAddressFactoryMock->expects($this->never())->method('populateWithArray')
-            ->with(['test' => 'beer'])
+        $this->dataObjectHelper->expects($this->once())->method('populateWithArray')
+            ->with($this->orderInterfaceMock, ['test' => 'beer'], '\Magento\Sales\Api\Data\OrderAddressInterface')
             ->willReturnSelf();
         $this->orderAddressFactoryMock->expects($this->once())
             ->method('create')

dev/tests/unit/testsuite/Magento/Quote/Model/Quote/Address/ToOrderTest.php

@@ -37,6 +37,11 @@ class ToOrderTest extends \PHPUnit_Framework_TestCase
      */
     protected $eventManagerMock;
 
+    /**
+     * @var \Magento\Framework\Api\DataObjectHelper
+     */
+    protected $dataObjectHelper;
+
     protected function setUp()
     {
         $this->orderDataFactoryMock = $this->getMock(
@@ -57,15 +62,15 @@ protected function setUp()
             ['setStoreId', 'setQuoteId']
         );
         $this->eventManagerMock = $this->getMock('Magento\Framework\Event\ManagerInterface', [], [], '', false);
-        $dataObjectHelper = $this->getMock('\Magento\Framework\Api\DataObjectHelper', [], [], '', false);
+        $this->dataObjectHelper = $this->getMock('\Magento\Framework\Api\DataObjectHelper', [], [], '', false);
         $objectManager = new ObjectManager($this);
         $this->converter = $objectManager->getObject(
             'Magento\Quote\Model\Quote\Address\ToOrder',
             [
                 'orderFactory' => $this->orderDataFactoryMock,
                 'objectCopyService' => $this->objectCopyMock,
                 'eventManager' => $this->eventManagerMock,
-                'dataObjectHelper' => $dataObjectHelper
+                'dataObjectHelper' => $this->dataObjectHelper
             ]
         );
     }
@@ -87,8 +92,8 @@ public function testConvert()
             'to_order',
             $object
         )->willReturn($orderData);
-        $this->orderDataFactoryMock->expects($this->never())->method('populateWithArray')
-            ->with(['test' => 'beer'])
+        $this->dataObjectHelper->expects($this->once())->method('populateWithArray')
+            ->with($this->orderInterfaceMock, ['test' => 'beer'], '\Magento\Sales\Api\Data\OrderInterface')
             ->willReturnSelf();
         $this->orderInterfaceMock->expects($this->once())->method('setStoreId')->with($storeId)->willReturnSelf();
         $this->orderInterfaceMock->expects($this->once())->method('setQuoteId')->with($quoteId)->willReturnSelf();

dev/tests/unit/testsuite/Magento/Quote/Model/Quote/Payment/ToOrderPaymentTest.php

@@ -29,6 +29,11 @@ class ToOrderPaymentTest extends \PHPUnit_Framework_TestCase
      */
     protected $paymentMock;
 
+    /**
+     * @var \Magento\Framework\Api\DataObjectHelper
+     */
+    protected $dataObjectHelper;
+
     /**
      * @var \Magento\Quote\Model\Quote\Payment\ToOrderPayment
      */
@@ -38,27 +43,27 @@ public function setUp()
     {
         $this->paymentMock = $this->getMock(
             'Magento\Quote\Model\Quote\Payment',
-            ['getCcNumber', 'getCcCidEnc', 'getMethodInstance', 'getAdditionalInformation'],
+            ['getCcNumber', 'getCcCid', 'getMethodInstance', 'getAdditionalInformation'],
             [],
             '',
             false
         );
         $this->objectCopyMock = $this->getMock('Magento\Framework\Object\Copy', [], [], '', false);
         $this->orderPaymentFactoryMock = $this->getMock(
             'Magento\Sales\Api\Data\OrderPaymentInterfaceFactory',
-            ['populateWithArray', 'create'],
+            ['create'],
             [],
             '',
             false
         );
-        $dataObjectHelper = $this->getMock('\Magento\Framework\Api\DataObjectHelper', [], [], '', false);
+        $this->dataObjectHelper = $this->getMock('\Magento\Framework\Api\DataObjectHelper', [], [], '', false);
         $objectManager = new ObjectManager($this);
         $this->converter = $objectManager->getObject(
             'Magento\Quote\Model\Quote\Payment\ToOrderPayment',
             [
                 'orderPaymentFactory' => $this->orderPaymentFactoryMock,
                 'objectCopyService' => $this->objectCopyMock,
-                'dataObjectHelper' => $dataObjectHelper
+                'dataObjectHelper' => $this->dataObjectHelper
             ]
         );
     }
@@ -82,20 +87,16 @@ public function testConvert()
             'to_order_payment',
             $this->paymentMock
         )->willReturn($paymentData);
-        $this->orderPaymentFactoryMock->expects($this->never())
-            ->method('populateWithArray')
-            ->with(array_merge($paymentData, $data))
-            ->willReturnSelf();
 
         $this->paymentMock->expects($this->once())
             ->method('getAdditionalInformation')
             ->willReturn($additionalInfo);
         $ccNumber = 123456798;
         $ccCid = 1234;
-        $this->paymentMock->expects($this->any())
+        $this->paymentMock->expects($this->once())
             ->method('getCcNumber')
             ->willReturn($ccNumber);
-        $this->paymentMock->expects($this->any())
+        $this->paymentMock->expects($this->once())
             ->method('getCcCid')
             ->willReturn($ccCid);
 
@@ -112,14 +113,18 @@ public function testConvert()
             ->method('setAdditionalInformation')
             ->with(serialize(array_merge($additionalInfo, [Substitution::INFO_KEY_TITLE => $paymentMethodTitle])))
             ->willReturnSelf();
-        $orderPayment->expects($this->any())
+        $orderPayment->expects($this->once())
             ->method('setCcNumber')
             ->willReturnSelf();
-        $orderPayment->expects($this->any())
+        $orderPayment->expects($this->once())
             ->method('setCcCid')
             ->willReturnSelf();
 
         $this->orderPaymentFactoryMock->expects($this->once())->method('create')->willReturn($orderPayment);
+        $this->dataObjectHelper->expects($this->once())
+            ->method('populateWithArray')
+            ->with($orderPayment, array_merge($paymentData, $data), '\Magento\Sales\Api\Data\OrderPaymentInterface')
+            ->willReturnSelf();
 
         $this->assertSame($orderPayment, $this->converter->convert($this->paymentMock, $data));
     }