Preparations for 1.0.0

- Modify customer group provider to use proxy in DI instead of class declaration
- Add test cases for product wrapper
- Fix wrong factory used for product collection

Author: IvanChepurnyi

.gitignore

@@ -1,3 +1,4 @@
 vendor/
 composer.lock
 .idea
+.phpunit.result.cache

composer.json

@@ -12,7 +12,8 @@
   },
   "require-dev": {
     "phpstan/phpstan": "^0.12.86",
-    "squizlabs/php_codesniffer": "^3.6.0"
+    "squizlabs/php_codesniffer": "^3.6.0",
+    "phpunit/phpunit": "~8.5.15"
   },
   "license": [
     "MIT"
@@ -31,9 +32,15 @@
       "EcomDev\\ProductDataPreLoader\\": "src"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "EcomDev\\ProductDataPreLoader\\": "tests"
+    }
+  },
   "scripts": {
     "phpcs": "phpcs",
     "phpcbf": "phpcbf",
-    "phpstan": "phpstan analyze src"
+    "phpstan": "phpstan analyze src",
+    "test": "phpunit tests"
   }
 }

src/DataService/CustomerGroupProvider.php

@@ -19,7 +19,7 @@ class CustomerGroupProvider
     /**
      * Customer session instance
      *
-     * @var Session\Proxy
+     * @var Session
      */
     private $customerSession;
 
@@ -33,10 +33,10 @@ class CustomerGroupProvider
     /**
      * CustomerGroupProvider constructor.
      *
-     * @param Session\Proxy $customerSession
+     * @param Session $customerSession
      * @param SessionStartChecker $sessionChecker
      */
-    public function __construct(Session\Proxy $customerSession, SessionStartChecker $sessionChecker)
+    public function __construct(Session $customerSession, SessionStartChecker $sessionChecker)
     {
         $this->customerSession = $customerSession;
         $this->sessionChecker = $sessionChecker;

src/DataService/MagentoProductWrapper.php

@@ -35,7 +35,7 @@ public function __construct(Product $product)
      */
     public function getSku(): string
     {
-        return $this->product->getSku();
+        return $this->product->getData('sku');
     }
 
 

src/DataService/MagentoProductWrapperFactory.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace EcomDev\ProductDataPreLoader\DataService;
+
+use Magento\Catalog\Model\Product;
+use Magento\Framework\ObjectManagerInterface;
+
+/**
+ * Factory for a product wrapper
+ */
+class MagentoProductWrapperFactory
+{
+    /**
+     * Object manager instance to create wrappers around product
+     *
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * MagentoProductWrapperFactory constructor.
+     *
+     * @param ObjectManagerInterface $objectManager
+     */
+    public function __construct(ObjectManagerInterface $objectManager)
+    {
+        $this->objectManager = $objectManager;
+    }
+
+    /**
+     * Crates a product wrapper instance
+     *
+     * @param Product $product
+     */
+    public function create(Product $product): ProductWrapper
+    {
+        return $this->objectManager->create(MagentoProductWrapper::class, ['product' => $product]);
+    }
+}

src/Observer/ListCollectionAfterLoad.php

@@ -9,11 +9,12 @@
 
 use EcomDev\ProductDataPreLoader\DataService\DataLoader;
 use EcomDev\ProductDataPreLoader\DataService\LoadService;
-use EcomDev\ProductDataPreLoader\DataService\ProductAdapterFactory;
+use EcomDev\ProductDataPreLoader\DataService\MagentoProductWrapperFactory;
 use EcomDev\ProductDataPreLoader\DataService\ScopeFilter;
 use EcomDev\ProductDataPreLoader\DataService\ScopeFilterFactory;
-use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Model\ResourceModel\Product\Collection;
+
+use Magento\Catalog\Model\Product;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
 
@@ -53,7 +54,7 @@ class ListCollectionAfterLoad implements ObserverInterface
     /**
      * Factory for creating product adapters
      *
-     * @var ProductAdapterFactory
+     * @var MagentoProductWrapperFactory
      */
     private $adapterFactory;
 
@@ -62,12 +63,12 @@ class ListCollectionAfterLoad implements ObserverInterface
      *
      * @param LoadService $loadService
      * @param ScopeFilterFactory $filterFactory
-     * @param ProductAdapterFactory $adapterFactory
+     * @param MagentoProductWrapperFactory $adapterFactory
      */
     public function __construct(
         LoadService $loadService,
         ScopeFilterFactory $filterFactory,
-        ProductAdapterFactory $adapterFactory
+        MagentoProductWrapperFactory $adapterFactory
     ) {
         $this->loadService = $loadService;
         $this->filterFactory = $filterFactory;
@@ -95,9 +96,9 @@ public function execute(Observer $observer)
         $collection = $observer->getData('collection');
 
         $productInfo = [];
-        /* @var ProductInterface $product */
+        /* @var Product $product */
         foreach ($collection->getItems() as $product) {
-            $productInfo[(int)$product->getId()] = $this->adapterFactory->create(['product' => $product]);
+            $productInfo[(int)$product->getId()] = $this->adapterFactory->create($product);
         }
 
         $type = DataLoader::TYPE_OTHER;

src/Observer/ProductAfterLoad.php

@@ -83,7 +83,7 @@ public function execute(Observer $observer)
         $scope = $this->filterFactory->createFromStore($product->getStoreId());
         $type = DataLoader::TYPE_CART;
 
-        $adapter = $this->productAdapterFactory->create(['product' => $product]);
+        $adapter = $this->productAdapterFactory->create($product);
 
         $productInfo = [
             $product->getId() => $adapter

src/etc/di.xml

@@ -7,4 +7,10 @@
             <argument name="loaders" xsi:type="array" />
         </arguments>
     </type>
+
+    <type name="EcomDev\ProductDataPreLoader\DataService\CustomerGroupProvider">
+        <arguments>
+            <argument name="customerSession" xsi:type="object">Magento\Customer\Model\Session\Proxy</argument>
+        </arguments>
+    </type>
 </config>

tests/FakeObjectManager.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace EcomDev\ProductDataPreLoader;
+
+use Magento\Framework\ObjectManagerInterface;
+
+/**
+ * Simplistic implementation of Object Manager for testing
+ */
+class FakeObjectManager implements ObjectManagerInterface
+{
+    /**
+     * Configuration of classes used for interfaces
+     *
+     * @var array
+     */
+    private $configuration = [];
+
+    /* @inheritDoc */
+    public function create($type, array $arguments = [])
+    {
+        $reflectionClass = new \ReflectionClass($type);
+        $constructorArguments = [];
+
+        foreach ($reflectionClass->getConstructor()->getParameters() as $parameter) {
+            if (isset($arguments[$parameter->getName()])) {
+                $constructorArguments[] = $arguments[$parameter->getName()];
+            } elseif (!$parameter->isOptional() && $parameter->getType() instanceof \ReflectionNamedType) {
+                $constructorArguments[] = $this->get($parameter->getType()->getName());
+            } elseif (!$parameter->isOptional()) {
+                throw new \RuntimeException(
+                    sprintf(
+                        'Cannot resolve constructor argument %s property for instantiating %s',
+                        $parameter->getName(),
+                        $type
+                    )
+                );
+            }
+        }
+
+        return $reflectionClass->newInstanceArgs($constructorArguments);
+    }
+
+    /* @inheritDoc */
+    public function get($type)
+    {
+        $type = $this->configuration['preferences'][$type] ?? $type;
+        return (new \ReflectionClass($type))->newInstanceWithoutConstructor();
+    }
+
+    /* @inheritDoc */
+    public function configure(array $configuration)
+    {
+        $this->configuration = $configuration;
+    }
+}

tests/MagentoProductWrapperTest.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace EcomDev\ProductDataPreLoader;
+
+use EcomDev\ProductDataPreLoader\DataService\MagentoProductWrapperFactory;
+use Magento\Catalog\Model\Product;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Tests for product wrapper
+ *
+ */
+class MagentoProductWrapperTest extends TestCase
+{
+    /* @var MagentoProductWrapperFactory */
+    private $factory;
+
+    protected function setUp(): void
+    {
+        $this->factory = new MagentoProductWrapperFactory(new FakeObjectManager());
+    }
+
+    /** @test */
+    public function verifiesThatSimpleProductIsNotAConfigurable()
+    {
+        $item = $this->factory->create($this->createProduct(['type_id' => 'simple']));
+
+        $this->assertFalse($item->isType('configurable'));
+    }
+
+    /** @test */
+    public function verifiesThatProductMatchesAtLeastOneProductTypeInArgumentList()
+    {
+        $item = $this->factory->create($this->createProduct(['type_id' => 'valid_type']));
+
+        $this->assertTrue($item->isType('simple', 'virtual', 'valid_type', 'another_type'));
+    }
+
+    /** @test */
+    public function returnsSkuFromWrappedProduct()
+    {
+        $item = $this->factory->create($this->createProduct(['sku' => 'SKU10']));
+
+        $this->assertEquals('SKU10', $item->getSku());
+    }
+
+    /** @test */
+    public function returnsIdFromWrappedProduct()
+    {
+        $item = $this->factory->create($this->createProduct(['entity_id' => '123']));
+
+        $this->assertEquals(123, $item->getId());
+    }
+
+    /** @test */
+    public function updatesFieldsInProductDataStorage()
+    {
+        $product = $this->createProduct(['some_data' => 1]);
+        $item = $this->factory->create($product);
+
+        $item->updateField('another_field', 'value1');
+        $item->updateField('final_field', 'value2');
+
+        $this->assertEquals(
+            [
+                'some_data' => 1,
+                'another_field' => 'value1',
+                'final_field' => 'value2'
+            ],
+            $product->getData()
+        );
+    }
+
+    /**
+     * Crates a new product for testing
+     *
+     * @param array $data
+     *
+     * @return Product
+     */
+    private function createProduct(array $data = []): Product
+    {
+        $product = (new FakeObjectManager())->get(Product::class);
+        $product->setData($data);
+
+        return $product;
+    }
+}