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/CartSearchResultsInterface.php

@@ -12,6 +12,10 @@ interface CartSearchResultsInterface extends \Magento\Framework\Api\SearchResult
      */
     const KEY_ITEMS = 'items';
 
+    const KEY_SEARCH_CRITERIA = 'search_criteria';
+
+    const KEY_TOTAL_COUNT = 'total_count';
+
     /**#@-*/
 
     /**
@@ -28,4 +32,34 @@ public function getItems();
      * @return $this
      */
     public function setItems(array $items = null);
+
+    /**
+     * Get search criteria.
+     *
+     * @return \Magento\Framework\Api\SearchCriteriaInterface
+     */
+    public function getSearchCriteria();
+
+    /**
+     * Set search criteria.
+     *
+     * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
+     * @return $this
+     */
+    public function setSearchCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
+
+    /**
+     * Get total count.
+     *
+     * @return int
+     */
+    public function getTotalCount();
+
+    /**
+     * Set total count.
+     *
+     * @param int $totalCount
+     * @return $this
+     */
+    public function setTotalCount($totalCount);
 }

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

@@ -41,25 +41,25 @@ class QuoteRepository implements \Magento\Quote\Api\CartRepositoryInterface
     protected $quoteCollection;
 
     /**
-     * @var \Magento\Quote\Api\Data\CartSearchResultsDataBuilder
+     * @var \Magento\Quote\Api\Data\CartSearchResultsInterfaceFactory
      */
-    protected $searchResultsBuilder;
+    protected $searchResultsDataFactory;
 
     /**
      * @param QuoteFactory $quoteFactory
      * @param StoreManagerInterface $storeManager
      * @param \Magento\Quote\Model\Resource\Quote\Collection $quoteCollection
-     * @param \Magento\Quote\Api\Data\CartSearchResultsDataBuilder $searchResultsBuilder
+     * @param \Magento\Quote\Api\Data\CartSearchResultsInterfaceFactory $searchResultsDataFactory
      */
     public function __construct(
         QuoteFactory $quoteFactory,
         StoreManagerInterface $storeManager,
         \Magento\Quote\Model\Resource\Quote\Collection $quoteCollection,
-        \Magento\Quote\Api\Data\CartSearchResultsDataBuilder $searchResultsBuilder
+        \Magento\Quote\Api\Data\CartSearchResultsInterfaceFactory $searchResultsDataFactory
     ) {
         $this->quoteFactory = $quoteFactory;
         $this->storeManager = $storeManager;
-        $this->searchResultsBuilder = $searchResultsBuilder;
+        $this->searchResultsDataFactory = $searchResultsDataFactory;
         $this->quoteCollection = $quoteCollection;
     }
 
@@ -201,13 +201,14 @@ protected function loadQuote($loadMethod, $loadField, $identifier, array $shared
      */
     public function getList(\Magento\Framework\Api\SearchCriteria $searchCriteria)
     {
-        $this->searchResultsBuilder->setSearchCriteria($searchCriteria);
+        $searchData = $this->searchResultsDataFactory->create();
+        $searchData->setSearchCriteria($searchCriteria);
 
         foreach ($searchCriteria->getFilterGroups() as $group) {
             $this->addFilterGroupToCollection($group, $this->quoteCollection);
         }
 
-        $this->searchResultsBuilder->setTotalCount($this->quoteCollection->getSize());
+        $searchData->setTotalCount($this->quoteCollection->getSize());
         $sortOrders = $searchCriteria->getSortOrders();
         if ($sortOrders) {
             foreach ($sortOrders as $sortOrder) {
@@ -220,9 +221,9 @@ public function getList(\Magento\Framework\Api\SearchCriteria $searchCriteria)
         $this->quoteCollection->setCurPage($searchCriteria->getCurrentPage());
         $this->quoteCollection->setPageSize($searchCriteria->getPageSize());
 
-        $this->searchResultsBuilder->setItems($this->quoteCollection->getItems());
+        $searchData->setItems($this->quoteCollection->getItems());
 
-        return $this->searchResultsBuilder->create();
+        return $searchData;
     }
 
     /**

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

@@ -39,7 +39,7 @@ class QuoteRepositoryTest extends \PHPUnit_Framework_TestCase
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject
      */
-    protected $searchResultsBuilderMock;
+    protected $searchResultsDataFactory;
 
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject
@@ -61,8 +61,8 @@ protected function setUp()
             false
         );
         $this->storeMock = $this->getMock('\Magento\Store\Model\Store', [], [], '', false);
-        $this->searchResultsBuilderMock = $this->getMock(
-            '\Magento\Quote\Api\Data\CartSearchResultsDataBuilder',
+        $this->searchResultsDataFactory = $this->getMock(
+            '\Magento\Quote\Api\Data\CartSearchResultsInterfaceFactory',
             ['setSearchCriteria', 'setTotalCount', 'setItems', 'create'],
             [],
             '',
@@ -76,7 +76,7 @@ protected function setUp()
             [
                 'quoteFactory' => $this->quoteFactoryMock,
                 'storeManager' => $this->storeManagerMock,
-                'searchResultsBuilder' => $this->searchResultsBuilderMock,
+                'searchResultsDataFactory' => $this->searchResultsDataFactory,
                 'quoteCollection' => $this->quoteCollectionMock,
             ]
         );
@@ -316,7 +316,12 @@ public function testGetListSuccess($direction, $expectedDirection)
         $filterMock = $this->getMock('\Magento\Framework\Api\Filter', [], [], '', false);
         $pageSize = 10;
 
-        $this->searchResultsBuilderMock
+        $this->searchResultsDataFactory
+            ->expects($this->once())
+            ->method('create')
+            ->will($this->returnValue($searchResult));
+
+        $searchResult
             ->expects($this->once())
             ->method('setSearchCriteria');
 
@@ -334,7 +339,7 @@ public function testGetListSuccess($direction, $expectedDirection)
 
         //back in getList()
         $this->quoteCollectionMock->expects($this->once())->method('getSize')->willReturn($pageSize);
-        $this->searchResultsBuilderMock->expects($this->once())->method('setTotalCount')->with($pageSize);
+        $searchResult->expects($this->once())->method('setTotalCount')->with($pageSize);
         $sortOrderMock = $this->getMockBuilder('Magento\Framework\Api\SortOrder')
             ->setMethods(['getField', 'getDirection'])
             ->disableOriginalConstructor()
@@ -357,11 +362,8 @@ public function testGetListSuccess($direction, $expectedDirection)
 
 
         $this->quoteCollectionMock->expects($this->once())->method('getItems')->willReturn([$cartMock]);
-        $this->searchResultsBuilderMock->expects($this->once())->method('setItems')->with([$cartMock]);
-        $this->searchResultsBuilderMock
-            ->expects($this->once())
-            ->method('create')
-            ->will($this->returnValue($searchResult));
+        $searchResult->expects($this->once())->method('setItems')->with([$cartMock]);
+
         $this->assertEquals($searchResult, $this->model->getList($searchCriteriaMock));
     }