CustomerData class refactor

Author: Jan Polak

app/code/Magento/OneTouchOrdering/Controller/Button/PlaceOrder.php

@@ -12,7 +12,8 @@
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Data\Form\FormKey\Validator;
 use Magento\Framework\Exception\NoSuchEntityException;
-use Magento\OneTouchOrdering\Model\CustomerData;
+use Magento\OneTouchOrdering\Model\CustomerDataGetter;
+use Magento\OneTouchOrdering\Model\CustomerDataGetterFactory;
 use Magento\OneTouchOrdering\Model\PlaceOrder as PlaceOrderModel;
 use Magento\Store\Model\StoreManagerInterface;
 
@@ -40,7 +41,7 @@ class PlaceOrder extends \Magento\Framework\App\Action\Action
      */
     private $customerSession;
     /**
-     * @var CustomerData
+     * @var CustomerDataGetter
      */
     private $customerData;
     /**
@@ -56,7 +57,7 @@ class PlaceOrder extends \Magento\Framework\App\Action\Action
      * @param PlaceOrderModel $placeOrder
      * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository
      * @param Session $customerSession
-     * @param CustomerData $customerData
+     * @param CustomerDataGetterFactory $customerData
      * @param Validator $formKeyValidator
      */
     public function __construct(
@@ -66,7 +67,7 @@ public function __construct(
         PlaceOrderModel $placeOrder,
         \Magento\Sales\Api\OrderRepositoryInterface $orderRepository,
         Session $customerSession,
-        CustomerData $customerData,
+        CustomerDataGetterFactory $customerData,
         Validator $formKeyValidator
     ) {
         parent::__construct($context);
@@ -89,7 +90,7 @@ public function execute()
         $product = $this->initProduct();
         $params = $this->getRequest()->getParams();
         try {
-            $customerData = $this->customerData->setCustomer($this->customerSession->getCustomer());
+            $customerData = $this->customerData->create($this->customerSession->getCustomer());
             $orderId = $this->placeOrder->placeOrder($product, $customerData, $params);
         } catch (NoSuchEntityException $e) {
             return $this->createResponse($errorMsg, false);

app/code/Magento/OneTouchOrdering/Model/CustomerData.php renamed to app/code/Magento/OneTouchOrdering/Model/CustomerDataGetter.php

@@ -8,13 +8,19 @@
 use Magento\Customer\Model\Customer;
 use Magento\Framework\Exception\LocalizedException;
 
-class CustomerData
+class CustomerDataGetter
 {
     /**
      * @var Customer
      */
     private $customer;
 
+    public function __construct(
+        Customer $customer
+    ) {
+        $this->customer = $customer;
+    }
+
     /**
      * @return \Magento\Customer\Api\Data\AddressInterface
      */
@@ -56,29 +62,12 @@ public function getCustomerId(): int
         return $this->getCustomer()->getId();
     }
 
-    /**
-     * @param Customer $customer
-     * @return $this
-     */
-    public function setCustomer(Customer $customer)
-    {
-        $this->customer = $customer;
-
-        return $this;
-    }
-
     /**
      * @return Customer
      * @throws LocalizedException
      */
     private function getCustomer(): Customer
     {
-        if (!$this->customer) {
-            throw new LocalizedException(
-                __('Something went wrong. Please try again later.')
-            );
-        }
-
         return $this->customer;
     }
 }

app/code/Magento/OneTouchOrdering/Model/CustomerDataGetterFactory.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Magento\OneTouchOrdering\Model;
+
+use Magento\Customer\Model\Customer;
+use Magento\Framework\ObjectManager\ObjectManager;
+
+class CustomerDataGetterFactory
+{
+    /**
+     * @var ObjectManager
+     */
+    private $objectManager;
+
+    public function __construct(
+        ObjectManager $objectManager
+    ) {
+        $this->objectManager = $objectManager;
+    }
+
+    public function create(Customer $customer)
+    {
+        return $this->objectManager->create(CustomerDataGetter::class, ['customer' => $customer]);
+    }
+}

app/code/Magento/OneTouchOrdering/Model/PlaceOrder.php

@@ -58,12 +58,12 @@ public function __construct(
 
     /**
      * @param Product $product
-     * @param CustomerData $customerData
+     * @param CustomerDataGetter $customerData
      * @param array $params
-     * @throws \Exception
+     * @throws Exception
      * @return int
      */
-    public function placeOrder(Product $product, CustomerData $customerData, array $params): int
+    public function placeOrder(Product $product, CustomerDataGetter $customerData, array $params): int
     {
         $paramsObject = $this->getProductRequest($params);
         $quote = $this->prepareQuote->prepare($customerData, $paramsObject);

app/code/Magento/OneTouchOrdering/Model/PrepareQuote.php

@@ -44,11 +44,11 @@ public function __construct(
     }
 
     /**
-     * @param CustomerData $customerData
+     * @param CustomerDataGetter $customerData
      * @param DataObject $params
      * @return Quote
      */
-    public function prepare(CustomerData $customerData, DataObject $params): Quote
+    public function prepare(CustomerDataGetter $customerData, DataObject $params): Quote
     {
         $store = $this->storeManager->getStore();
         $quote = $this->quoteFactory->create();

app/code/Magento/OneTouchOrdering/Test/Unit/Model/CustomerDataTest.php renamed to app/code/Magento/OneTouchOrdering/Test/Unit/Model/CustomerDataGetterTest.php

@@ -8,18 +8,18 @@
 use Magento\Customer\Model\Address;
 use Magento\Customer\Model\Customer;
 use Magento\Framework\Exception\LocalizedException;
-use Magento\OneTouchOrdering\Model\CustomerData;
+use Magento\OneTouchOrdering\Model\CustomerDataGetter;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use PHPUnit\Framework\TestCase;
 
-class CustomerDataTest extends TestCase
+class CustomerDataGetterTest extends TestCase
 {
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject|Customer
      */
     private $customer;
     /**
-     * @var CustomerData
+     * @var CustomerDataGetter
      */
     private $customerData;
     /**
@@ -47,12 +47,13 @@ public function setUp()
             \Magento\Customer\Api\Data\AddressInterface::class
         );
 
-        $this->customerData = $objectManager->getObject(CustomerData::class);
+        $this->customerData = $objectManager->getObject(CustomerDataGetter::class, [
+            'customer' => $this->customer
+        ]);
     }
 
     public function testGetDefaultBillingAddressDataModel()
     {
-        $this->customerData->setCustomer($this->customer);
         $this->customer
             ->expects($this->once())
             ->method('getDefaultBillingAddress')
@@ -68,7 +69,6 @@ public function testGetDefaultBillingAddressDataModel()
 
     public function testGetDefaultShippingAddressDataModel()
     {
-        $this->customerData->setCustomer($this->customer);
         $this->customer
             ->expects($this->once())
             ->method('getDefaultShippingAddress')
@@ -85,7 +85,6 @@ public function testGetDefaultShippingAddressDataModel()
     public function testShippingAddressDataModel()
     {
         $addressId = 123;
-        $this->customerData->setCustomer($this->customer);
         $this->customer
             ->expects($this->once())
             ->method('getAddressById')
@@ -102,7 +101,6 @@ public function testShippingAddressDataModel()
 
     public function testGetCustomerDataModel()
     {
-        $this->customerData->setCustomer($this->customer);
         $this->customer
             ->expects($this->once())
             ->method('getDataModel')
@@ -114,18 +112,11 @@ public function testGetCustomerDataModel()
     public function testGetCustomerId()
     {
         $customerId = 32;
-        $this->customerData->setCustomer($this->customer);
         $this->customer
             ->expects($this->once())
             ->method('getId')
             ->willReturn($customerId);
         $result = $this->customerData->getCustomerId();
         $this->assertSame($result, $customerId);
     }
-
-    public function testNoCustomer()
-    {
-        $this->expectException(LocalizedException::class);
-        $this->customerData->getCustomerDataModel();
-    }
 }

app/code/Magento/OneTouchOrdering/Test/Unit/Model/PlaceOrderTest.php

@@ -7,7 +7,7 @@
 
 use Magento\Catalog\Model\Product;
 use Magento\Framework\DataObject;
-use Magento\OneTouchOrdering\Model\CustomerData;
+use Magento\OneTouchOrdering\Model\CustomerDataGetter;
 use Magento\OneTouchOrdering\Model\PlaceOrder;
 use Magento\OneTouchOrdering\Model\PrepareQuote;
 use Magento\OneTouchOrdering\Model\ShippingRateChooser;
@@ -23,7 +23,7 @@ class PlaceOrderTest extends TestCase
      */
     private $shippingRateChooser;
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|CustomerData
+     * @var \PHPUnit_Framework_MockObject_MockObject|CustomerDataGetter
      */
     private $customerData;
     /**
@@ -55,7 +55,7 @@ public function setUp()
     {
         $objectManager = new ObjectManager($this);
 
-        $this->customerData = $this->createMock(CustomerData::class);
+        $this->customerData = $this->createMock(CustomerDataGetter::class);
         $this->cartManagementInterface = $this->createMock(
             \Magento\Quote\Api\CartManagementInterface::class
         );

app/code/Magento/OneTouchOrdering/Test/Unit/Model/PrepareQuoteTest.php

@@ -9,7 +9,7 @@
 use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\Framework\DataObject;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
-use Magento\OneTouchOrdering\Model\CustomerData;
+use Magento\OneTouchOrdering\Model\CustomerDataGetter;
 use Magento\OneTouchOrdering\Model\PrepareQuote;
 use Magento\Quote\Model\Quote;
 use Magento\Quote\Model\Quote\Address as QuoteAddress;
@@ -21,7 +21,7 @@
 class PrepareQuoteTest extends TestCase
 {
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|CustomerData
+     * @var \PHPUnit_Framework_MockObject_MockObject|CustomerDataGetter
      */
     private $customerData;
     /**
@@ -49,7 +49,7 @@ public function setUp()
     {
         $objectManager = new ObjectManager($this);
 
-        $this->customerData = $this->createMock(CustomerData::class);
+        $this->customerData = $this->createMock(CustomerDataGetter::class);
         $this->quoteFactory = $this->createMock(QuoteFactory::class);
         $this->quote = $this->getMockBuilder(Quote::class)
             ->disableOriginalConstructor()