MAGETWO-33665 : Refactor Quote module to use mutable data object interfaces

 -- fixes from code review
 -- fixes to testcases

Author: Robert He

app/code/Magento/Quote/Api/Data/AddressInterface.php

@@ -83,14 +83,14 @@ public function setRegion($region);
     /**
      * Get region id
      *
-     * @return string
+     * @return int
      */
     public function getRegionId();
 
     /**
      * Set region id
      *
-     * @param string $regionId
+     * @param int $regionId
      * @return $this
      */
     public function setRegionId($regionId);
@@ -308,14 +308,14 @@ public function setVatId($vatId);
     /**
      * Get customer id
      *
-     * @return string|null
+     * @return int
      */
     public function getCustomerId();
 
     /**
      * Set customer id
      *
-     * @param string $customerId
+     * @param int $customerId
      * @return $this
      */
     public function setCustomerId($customerId);

app/code/Magento/Quote/Api/Data/CartInterface.php

@@ -62,7 +62,7 @@ public function getId();
     /**
      * Sets the cart/quote ID.
      *
-     * @param string $id
+     * @param int $id
      * @return $this
      */
     public function setId($id);
@@ -74,13 +74,29 @@ public function setId($id);
      */
     public function getCreatedAt();
 
+    /**
+     * Sets the cart creation date and time.
+     *
+     * @param string $createdAt
+     * @return $this
+     */
+    public function setCreatedAt($createdAt);
+
     /**
      * Returns the cart last update date and time.
      *
      * @return string|null Cart last update date and time. Otherwise, null.
      */
     public function getUpdatedAt();
 
+    /**
+     * Sets the cart last update date and time.
+     *
+     * @param string $updatedAt
+     * @return $this
+     */
+    public function setUpdatedAt($updatedAt);
+
     /**
      * Returns the cart conversion date and time.
      *
@@ -228,29 +244,29 @@ public function setBillingAddress(\Magento\Quote\Api\Data\AddressInterface $bill
     /**
      * Returns the reserved order ID for the cart.
      *
-     * @return string|null Reserved order ID. Otherwise, null.
+     * @return int|null Reserved order ID. Otherwise, null.
      */
     public function getReservedOrderId();
 
     /**
      * Sets the reserved order ID for the cart.
      *
-     * @param string $reservedOrderId
+     * @param int $reservedOrderId
      * @return $this
      */
     public function setReservedOrderId($reservedOrderId);
 
     /**
      * Returns the original order ID for the cart.
      *
-     * @return string|null Original order ID. Otherwise, null.
+     * @return int|null Original order ID. Otherwise, null.
      */
     public function getOrigOrderId();
 
     /**
      * Sets the original order ID for the cart.
      *
-     * @param string $origOrderId
+     * @param int $origOrderId
      * @return $this
      */
     public function setOrigOrderId($origOrderId);
@@ -318,14 +334,14 @@ public function setCustomerNoteNotify($customerNoteNotify);
     /**
      * Get customer tax class ID.
      *
-     * @return string|null
+     * @return int|null
      */
     public function getCustomerTaxClassId();
 
     /**
      * Set customer tax class ID.
      *
-     * @param string $customerTaxClassId
+     * @param int $customerTaxClassId
      * @return $this
      */
     public function setCustomerTaxClassId($customerTaxClassId);

app/code/Magento/Quote/Api/Data/CartItemInterface.php

@@ -59,14 +59,14 @@ public function setSku($sku);
     /**
      * Returns the product quantity.
      *
-     * @return int Product quantity.
+     * @return float Product quantity.
      */
     public function getQty();
 
     /**
      * Sets the product quantity.
      *
-     * @param int $qty
+     * @param float $qty
      * @return $this
      */
     public function setQty($qty);

app/code/Magento/Quote/Api/Data/TotalsItemInterface.php

@@ -126,14 +126,14 @@ public function setBasePrice($basePrice);
     /**
      * Returns the item quantity.
      *
-     * @return int Item quantity.
+     * @return float Item quantity.
      */
     public function getQty();
 
     /**
      * Sets the item quantity.
      *
-     * @param int $qty
+     * @param float $qty
      * @return $this
      */
     public function setQty($qty);
@@ -216,14 +216,14 @@ public function setBaseTaxAmount($baseTaxAmount);
     /**
      * Returns the tax percent.
      *
-     * @return int|null Tax percent. Otherwise, null.
+     * @return float|null Tax percent. Otherwise, null.
      */
     public function getTaxPercent();
 
     /**
      * Sets the tax percent.
      *
-     * @param int $taxPercent
+     * @param float $taxPercent
      * @return $this
      */
     public function setTaxPercent($taxPercent);
@@ -261,14 +261,14 @@ public function setBaseDiscountAmount($baseDiscountAmount);
     /**
      * Returns the discount percent.
      *
-     * @return int|null Discount percent. Otherwise, null.
+     * @return float|null Discount percent. Otherwise, null.
      */
     public function getDiscountPercent();
 
     /**
      * Sets the discount percent.
      *
-     * @param int $discountPercent
+     * @param float $discountPercent
      * @return $this
      */
     public function setDiscountPercent($discountPercent);

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

@@ -27,8 +27,6 @@
  *  sales_quote_delete_after
  *
  * @method Quote setStoreId(int $value)
- * @method Quote setCreatedAt(string $value)
- * @method Quote setUpdatedAt(string $value)
  * @method Quote setIsVirtual(int $value)
  * @method int getIsMultiShipping()
  * @method Quote setIsMultiShipping(int $value)
@@ -502,6 +500,14 @@ public function getCreatedAt()
         return $this->_getData(self::KEY_CREATED_AT);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function setCreatedAt($createdAt)
+    {
+        return $this->setData(self::KEY_CREATED_AT, $createdAt);
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -510,6 +516,14 @@ public function getUpdatedAt()
         return $this->_getData(self::KEY_UPDATED_AT);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function setUpdatedAt($updatedAt)
+    {
+        return $this->setData(self::KEY_UPDATED_AT, $updatedAt);
+    }
+
     /**
      * {@inheritdoc}
      */

app/code/Magento/Quote/Model/Quote/Item.php

@@ -330,6 +330,31 @@ public function addQty($qty)
         return $this;
     }
 
+    /**
+     * Declare quote item quantity
+     *
+     * @param float $qty
+     * @return $this
+     */
+    public function setQty($qty)
+    {
+        $qty = $this->_prepareQty($qty);
+        $oldQty = $this->_getData(self::KEY_QTY);
+        $this->setData(self::KEY_QTY, $qty);
+
+        $this->_eventManager->dispatch('sales_quote_item_qty_set_after', ['item' => $this]);
+
+        if ($this->getQuote() && $this->getQuote()->getIgnoreOldQty()) {
+            return $this;
+        }
+
+        if ($this->getUseOldQty()) {
+            $this->setData(self::KEY_QTY, $oldQty);
+        }
+
+        return $this;
+    }
+
     /**
      * Retrieve option product with Qty
      *
@@ -481,6 +506,25 @@ public function compare($item)
         return $this->quoteItemCompare->compare($this, $item);
     }
 
+    /**
+     * Get item product type
+     *
+     * @return string
+     */
+    public function getProductType()
+    {
+        $option = $this->getOptionByCode(self::KEY_PRODUCT_TYPE);
+        if ($option) {
+            return $option->getValue();
+        }
+        $product = $this->getProduct();
+        if ($product) {
+            return $product->getTypeId();
+        }
+        // $product should always exist or there will be an error in getProduct()
+        return $this->_getData(self::KEY_PRODUCT_TYPE);
+    }
+
     /**
      * Return real product type of item
      *
@@ -902,31 +946,6 @@ public function getQty()
         return $this->getData(self::KEY_QTY);
     }
 
-    /**
-     * Declare quote item quantity
-     *
-     * @param float $qty
-     * @return $this
-     */
-    public function setQty($qty)
-    {
-        $qty = $this->_prepareQty($qty);
-        $oldQty = $this->_getData(self::KEY_QTY);
-        $this->setData(self::KEY_QTY, $qty);
-
-        $this->_eventManager->dispatch('sales_quote_item_qty_set_after', ['item' => $this]);
-
-        if ($this->getQuote() && $this->getQuote()->getIgnoreOldQty()) {
-            return $this;
-        }
-
-        if ($this->getUseOldQty()) {
-            $this->setData(self::KEY_QTY, $oldQty);
-        }
-
-        return $this;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -959,25 +978,6 @@ public function setPrice($price)
         return $this->setData(self::KEY_PRICE, $price);
     }
 
-    /**
-     * Get item product type
-     *
-     * @return string
-     */
-    public function getProductType()
-    {
-        $option = $this->getOptionByCode(self::KEY_PRODUCT_TYPE);
-        if ($option) {
-            return $option->getValue();
-        }
-        $product = $this->getProduct();
-        if ($product) {
-            return $product->getTypeId();
-        }
-        // $product should always exist or there will be an error in getProduct()
-        return $this->_getData(self::KEY_PRODUCT_TYPE);
-    }
-
     /**
      * {@inheritdoc}
      */

dev/tests/unit/testsuite/Magento/Quote/Model/Quote/Item/RepositoryTest.php

@@ -55,9 +55,8 @@ protected function setUp()
             $this->getMock('\Magento\Quote\Model\QuoteRepository', [], [], '', false);
         $this->productRepositoryMock =
             $this->getMock('Magento\Catalog\Api\ProductRepositoryInterface', [], [], '', false);
-        $methods = ['setQuoteId', 'setItemId', 'create'];
         $this->itemDataFactoryMock =
-            $this->getMock('Magento\Quote\Api\Data\CartItemInterfaceFactory', $methods, [], '', false);
+            $this->getMock('Magento\Quote\Api\Data\CartItemInterfaceFactory', ['create'], [], '', false);
         $this->dataMock = $this->getMock('Magento\Quote\Api\Data\CartItemInterface');
         $this->quoteMock = $this->getMock('\Magento\Quote\Model\Quote', [], [], '', false);
         $this->productMock = $this->getMock('\Magento\Catalog\Model\Product', [], [], '', false);
@@ -313,10 +312,10 @@ public function testDeleteById()
     {
         $cartId = 11;
         $itemId = 5;
-        $this->itemDataFactoryMock->expects($this->once())->method('create')->willReturn($this->itemDataFactoryMock);
-        $this->itemDataFactoryMock->expects($this->once())->method('setQuoteId')
-            ->with($cartId)->willReturn($this->itemDataFactoryMock);
-        $this->itemDataFactoryMock->expects($this->once())->method('setItemId')
+        $this->itemDataFactoryMock->expects($this->once())->method('create')->willReturn($this->dataMock);
+        $this->dataMock->expects($this->once())->method('setQuoteId')
+            ->with($cartId)->willReturn($this->dataMock);
+        $this->dataMock->expects($this->once())->method('setItemId')
             ->with($itemId)->willReturn($this->dataMock);
         $this->dataMock->expects($this->once())->method('getQuoteId')->willReturn($cartId);
         $this->dataMock->expects($this->once())->method('getItemId')->willReturn($itemId);

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

@@ -63,7 +63,7 @@ protected function setUp()
         $this->storeMock = $this->getMock('\Magento\Store\Model\Store', [], [], '', false);
         $this->searchResultsDataFactory = $this->getMock(
             '\Magento\Quote\Api\Data\CartSearchResultsInterfaceFactory',
-            ['setSearchCriteria', 'setTotalCount', 'setItems', 'create'],
+            ['create'],
             [],
             '',
             false