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

 - relax parameter on setItems(...)
 - enhance unit test

Author: Mike Weis

app/code/Magento/Sales/Api/Data/InvoiceInterface.php

@@ -856,7 +856,7 @@ public function setDiscountDescription($description);
      * @param \Magento\Sales\Api\Data\InvoiceItemInterface[] $items
      * @return $this
      */
-    public function setItems(array $items = null);
+    public function setItems($items);
 
     /**
      * Sets the comments, if any, for the invoice.

app/code/Magento/Sales/Model/Order/Invoice.php

@@ -104,11 +104,6 @@ class Invoice extends AbstractModel implements EntityInterface, InvoiceInterface
      */
     protected $_invoiceItemCollectionFactory;
 
-    /**
-     * @var \Magento\Sales\Model\Resource\Order\Invoice\Item\Collection
-     */
-    protected $_invoiceItemCollection;
-
     /**
      * @var \Magento\Sales\Model\Order\Invoice\CommentFactory
      */
@@ -482,39 +477,22 @@ public function roundPrice($price, $type = 'regular', $negative = false)
     }
 
     /**
-     * Get invoice items collection.
-     * If needed, performs additional processing for these items.
+     * Get invoice items collection
      *
      * @return \Magento\Sales\Model\Resource\Order\Invoice\Item\Collection
      */
     public function getItemsCollection()
     {
-        $collection = $this->_getItemsCollectionInstance();
         if (!$this->hasData(InvoiceInterface::ITEMS)) {
-            $this->setItems($collection->getItems());
+            $this->setItems($this->_invoiceItemCollectionFactory->create()->setInvoiceFilter($this->getId()));
 
             if ($this->getId()) {
                 foreach ($this->getItems() as $item) {
                     $item->setInvoice($this);
                 }
             }
         }
-        return $collection;
-    }
-
-    /**
-     * Returns the invoice item collection
-     *
-     * @return $this|\Magento\Sales\Model\Resource\Order\Invoice\Item\Collection
-     */
-    protected function _getItemsCollectionInstance()
-    {
-        $collection = $this->_invoiceItemCollection;
-        if (empty($collection)) {
-            $collection = $this->_invoiceItemCollectionFactory->create()->setInvoiceFilter($this->getId());
-            $this->_invoiceItemCollection = $collection;
-        }
-        return $collection;
+        return $this->getItems();
     }
 
     /**
@@ -555,15 +533,6 @@ public function addItem(\Magento\Sales\Model\Order\Invoice\Item $item)
 
         if (!$item->getId()) {
             $this->getItemsCollection()->addItem($item);
-
-            $item->setInvoice($this);
-
-            $items = $this->getData(InvoiceInterface::ITEMS);
-            if (empty($items)) {
-                $items = [];
-            }
-            $items[] = $item;
-            $this->setData(InvoiceInterface::ITEMS, $items);
         }
         return $this;
     }
@@ -824,9 +793,8 @@ public function getDiscountDescription()
      */
     public function getItems()
     {
-        $items = $this->getData(InvoiceInterface::ITEMS);
-        if (($items === null || empty($items)) && $this->getId()) {
-            $collection = $this->_getItemsCollectionInstance();
+        if ($this->getData(InvoiceInterface::ITEMS) === null && $this->getId()) {
+            $collection = $this->_invoiceItemCollectionFactory->create()->setInvoiceFilter($this->getId());
             foreach ($collection as $item) {
                 $item->setInvoice($this);
             }
@@ -1584,7 +1552,7 @@ public function setDiscountDescription($description)
     /**
      * {@inheritdoc}
      */
-    public function setItems(array $items = null)
+    public function setItems($items)
     {
         return $this->setData(InvoiceInterface::ITEMS, $items);
     }

dev/tests/unit/testsuite/Magento/Quote/Model/QuoteManagementTest.php

@@ -91,11 +91,7 @@ protected function setUp()
         $this->eventManager = $this->getMockForAbstractClass('Magento\Framework\Event\ManagerInterface');
         $this->orderFactory = $this->getMock(
             'Magento\Sales\Api\Data\OrderInterfaceFactory',
-            [
-                'populate', 'setShippingAddress', 'setBillingAddress', 'setAddresses', 'setPayments',
-                'setItems', 'setCustomerId', 'setQuoteId', 'create', 'setCustomerEmail', 'setCustomerFirstname',
-                'setCustomerMiddlename', 'setCustomerLastname'
-            ],
+            [ 'create' ],
             [],
             '',
             false
@@ -500,7 +496,10 @@ public function testSubmit()
         $convertedPayment = $this->getMock('Magento\Sales\Api\Data\OrderPaymentInterface', [], [], '', false);
         $convertedQuoteItem = $this->getMock('Magento\Sales\Api\Data\OrderItemInterface', [], [], '', false);
 
+        $addresses = [$convertedShippingAddress, $convertedBillingAddress];
+        $payments = [$convertedPayment];
         $quoteItems = [$quoteItem];
+        $convertedItems = [$convertedQuoteItem];
 
         $quote = $this->getQuote(
             $isGuest,
@@ -553,6 +552,10 @@ public function testSubmit()
         $order = $this->prepareOrderFactory(
             $baseOrder,
             $convertedBillingAddress,
+            $addresses,
+            $payments,
+            $convertedItems,
+            $quoteId,
             $convertedShippingAddress
         );
 
@@ -649,12 +652,16 @@ protected function getQuote(
     protected function prepareOrderFactory(
         \Magento\Sales\Api\Data\OrderInterface $baseOrder,
         \Magento\Sales\Api\Data\OrderAddressInterface $billingAddress,
+        array $addresses,
+        array $payments,
+        array $items,
+        $quoteId,
         \Magento\Sales\Api\Data\OrderAddressInterface $shippingAddress = null
     ) {
         $order = $this->getMock(
             'Magento\Sales\Model\Order',
             ['setShippingAddress', 'getAddressesCollection', 'getAddresses', 'getBillingAddress', 'addAddresses',
-            'setBillingAddress'],
+            'setBillingAddress', 'setAddresses', 'setPayments', 'setItems', 'setQuoteId'],
             [],
             '',
             false
@@ -668,17 +675,18 @@ protected function prepareOrderFactory(
             ->with($baseOrder);
 
         if ($shippingAddress) {
-            $order->expects($this->once())
-                ->method('setShippingAddress')
-                ->with($shippingAddress);
+            $order->expects($this->once())->method('setShippingAddress')->with($shippingAddress);
         }
         $order->expects($this->any())->method('getAddressesCollection');
         $order->expects($this->any())->method('getAddresses');
         $order->expects($this->any())->method('getBillingAddress')->willReturn(false);
         $order->expects($this->any())->method('addAddresses')->withAnyParameters()->willReturnSelf();
-        $order->expects($this->once())
-            ->method('setBillingAddress')
-            ->with($billingAddress);
+        $order->expects($this->once())->method('setBillingAddress')->with($billingAddress);
+        $order->expects($this->once())->method('setAddresses')->with($addresses);
+        $order->expects($this->once())->method('setPayments')->with($payments);
+        $order->expects($this->once())->method('setItems')->with($items);
+        $order->expects($this->once())->method('setQuoteId')->with($quoteId);
+
         return $order;
     }