Merge pull request #610 from magento-extensibility/MAGETWO-42977-use-factories-to-inject-dependencies

MAGETWO-42977: Use factories to inject dependencies on Zend classes in \Magento\CacheInvalidate\Model\PurgeCache

Author: He, Joan(johe)

app/code/Magento/CacheInvalidate/Model/PurgeCache.php

@@ -16,14 +16,14 @@
 class PurgeCache
 {
     /**
-     * @var Uri
+     * @var UriFactory
      */
-    protected $uri;
+    protected $uriFactory;
 
     /**
-     * @var Socket
+     * @var SocketFactory
      */
-    protected $socketAdapter;
+    protected $socketAdapterFactory;
 
     /**
      * @var InvalidateLogger
@@ -45,21 +45,21 @@ class PurgeCache
     /**
      * Constructor
      *
-     * @param Uri $uri
-     * @param Socket $socketAdapter
+     * @param UriFactory $uriFactory
+     * @param SocketFactory $socketAdapterFactory
      * @param InvalidateLogger $logger
      * @param Reader $configReader
      * @param RequestInterface $request
      */
     public function __construct(
-        Uri $uri,
-        Socket $socketAdapter,
+        UriFactory $uriFactory,
+        SocketFactory $socketAdapterFactory,
         InvalidateLogger $logger,
         DeploymentConfig $config,
         RequestInterface $request
     ) {
-        $this->uri = $uri;
-        $this->socketAdapter = $socketAdapter;
+        $this->uriFactory = $uriFactory;
+        $this->socketAdapterFactory = $socketAdapterFactory;
         $this->logger = $logger;
         $this->config = $config;
         $this->request = $request;
@@ -74,24 +74,26 @@ public function __construct(
      */
     public function sendPurgeRequest($tagsPattern)
     {
+        $uri = $this->uriFactory->create();
+        $socketAdapter = $this->socketAdapterFactory->create();
         $servers = $this->config->get(ConfigOptionsListConstants::CONFIG_PATH_CACHE_HOSTS)
             ?: [['host' => $this->request->getHttpHost()]];
         $headers = ['X-Magento-Tags-Pattern' => $tagsPattern];
-        $this->socketAdapter->setOptions(['timeout' => 10]);
+        $socketAdapter->setOptions(['timeout' => 10]);
         foreach ($servers as $server) {
             $port = isset($server['port']) ? $server['port'] : self::DEFAULT_PORT;
-            $this->uri->setScheme('http')
+            $uri->setScheme('http')
                 ->setHost($server['host'])
                 ->setPort($port);
             try {
-                $this->socketAdapter->connect($server['host'], $port);
-                $this->socketAdapter->write(
+                $socketAdapter->connect($server['host'], $port);
+                $socketAdapter->write(
                     'PURGE',
-                    $this->uri,
+                    $uri,
                     '1.1',
                     $headers
                 );
-                $this->socketAdapter->close();
+                $socketAdapter->close();
             } catch (Exception $e) {
                 $this->logger->critical($e->getMessage(), compact('server', 'tagsPattern'));
             }

app/code/Magento/CacheInvalidate/Model/SocketFactory.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CacheInvalidate\Model;
+
+class SocketFactory
+{
+
+    /**
+     * @return \Zend\Http\Client\Adapter\Socket
+     */
+    public function create()
+    {
+        return new \Zend\Http\Client\Adapter\Socket();
+    }
+}

app/code/Magento/CacheInvalidate/Model/UriFactory.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CacheInvalidate\Model;
+
+class UriFactory
+{
+
+    /**
+     * @return \Zend\Uri\Uri
+     */
+    public function create()
+    {
+        return new \Zend\Uri\Uri();
+    }
+}

app/code/Magento/CacheInvalidate/Test/Unit/Model/PurgeCacheTest.php

@@ -5,8 +5,6 @@
  */
 namespace Magento\CacheInvalidate\Test\Unit\Model;
 
-use \Magento\Framework\Config\ConfigOptionsListConstants;
-
 class PurgeCacheTest extends \PHPUnit_Framework_TestCase
 {
     /** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\CacheInvalidate\Model\PurgeCache */
@@ -32,17 +30,25 @@ class PurgeCacheTest extends \PHPUnit_Framework_TestCase
      */
     public function setUp()
     {
+        $this->uriFactoryMock = $this->getMock('Magento\CacheInvalidate\Model\UriFactory', [], [], '', false);
         $this->uriMock = $this->getMock('\Zend\Uri\Uri', [], [], '', false);
+        $this->socketFactoryMock = $this->getMock('Magento\CacheInvalidate\Model\SocketFactory', [], [], '', false);
         $this->socketAdapterMock = $this->getMock('\Zend\Http\Client\Adapter\Socket', [], [], '', false);
         $this->configMock = $this->getMock('Magento\Framework\App\DeploymentConfig', [], [], '', false);
         $this->loggerMock = $this->getMock('Magento\Framework\Cache\InvalidateLogger', [], [], '', false);
         $this->requestMock = $this->getMock('Magento\Framework\App\Request\Http', [], [], '', false);
         $this->socketAdapterMock->expects($this->once())
             ->method('setOptions')
             ->with(['timeout' => 10]);
+        $this->uriFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($this->uriMock);
+        $this->socketFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($this->socketAdapterMock);
         $this->model = new \Magento\CacheInvalidate\Model\PurgeCache(
-            $this->uriMock,
-            $this->socketAdapterMock,
+            $this->uriFactoryMock,
+            $this->socketFactoryMock,
             $this->loggerMock,
             $this->configMock,
             $this->requestMock

app/code/Magento/CacheInvalidate/Test/Unit/Model/SocketFactoryTest.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CacheInvalidate\Test\Unit\Model;
+
+class SocketFactoryTest extends \PHPUnit_Framework_TestCase
+{
+
+    public function testCreate()
+    {
+        $factory = new \Magento\CacheInvalidate\Model\SocketFactory();
+        $this->assertInstanceOf('\Zend\Http\Client\Adapter\Socket', $factory->create());
+    }
+}

app/code/Magento/CacheInvalidate/Test/Unit/Model/UriFactoryTest.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CacheInvalidate\Test\Unit\Model;
+
+class UriFactoryTest extends \PHPUnit_Framework_TestCase
+{
+
+    public function testCreate()
+    {
+        $factory = new \Magento\CacheInvalidate\Model\UriFactory();
+        $this->assertInstanceOf('\Zend\Uri\Uri', $factory->create());
+    }
+}

lib/internal/Magento/Framework/Cache/Test/Unit/InvalidateLoggerTest.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 /**
  * \Magento\Framework\Cache\InvalidateLogger test case
  */
@@ -68,7 +66,7 @@ public function testExecute()
 
     public function testMakeParams()
     {
-        $expected = ['method' => $this->method, 'url' => $this->url, 'invalidateInfo' => $this->params];;
+        $expected = ['method' => $this->method, 'url' => $this->url, 'invalidateInfo' => $this->params];
         $method = new \ReflectionMethod($this->invalidateLogger, 'makeParams');
         $method->setAccessible(true);
         $this->assertEquals(