Zend feed refactoring

app/code/Magento/Rss/Model/Rss.php

@@ -8,6 +8,8 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\Rss\DataProviderInterface;
 use Magento\Framework\Serialize\SerializerInterface;
+use Magento\Framework\App\FeedInterface;
+use Magento\Framework\App\FeedFactoryInterface;
 
 /**
  * Provides functionality to work with RSS feeds
@@ -27,6 +29,11 @@ class Rss
      */
     protected $cache;
 
+    /**
+     * @var \Magento\Framework\App\FeedFactoryInterface
+     */
+    private $feedFactory;
+
     /**
      * @var SerializerInterface
      */
@@ -37,13 +44,16 @@ class Rss
      *
      * @param \Magento\Framework\App\CacheInterface $cache
      * @param SerializerInterface|null $serializer
+     * @param FeedFactoryInterface|null $feedFactory
      */
     public function __construct(
         \Magento\Framework\App\CacheInterface $cache,
-        SerializerInterface $serializer = null
+        SerializerInterface $serializer = null,
+        FeedFactoryInterface $feedFactory = null
     ) {
         $this->cache = $cache;
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);
+        $this->feedFactory = $feedFactory ?: ObjectManager::getInstance()->get(FeedFactoryInterface::class);
     }
 
     /**
@@ -92,7 +102,13 @@ public function setDataProvider(DataProviderInterface $dataProvider)
      */
     public function createRssXml()
     {
-        $rssFeedFromArray = \Zend_Feed::importArray($this->getFeeds(), 'rss');
-        return $rssFeedFromArray->saveXML();
+        $feed = $this->feedFactory->create(
+            $this->getFeeds(), 
+            FeedFactoryInterface::DEFAULT_FORMAT
+        );
+
+        return $feed->getFormattedContentAs(
+            FeedInterface::DEFAULT_FORMAT
+        );
     }
 }

app/code/Magento/Rss/Test/Unit/Controller/Adminhtml/Feed/IndexTest.php

@@ -103,14 +103,22 @@ public function testExecuteWithException()
         $dataProvider = $this->createMock(\Magento\Framework\App\Rss\DataProviderInterface::class);
         $dataProvider->expects($this->once())->method('isAllowed')->will($this->returnValue(true));
 
-        $rssModel = $this->createPartialMock(\Magento\Rss\Model\Rss::class, ['setDataProvider']);
+        $rssModel = $this->createPartialMock(\Magento\Rss\Model\Rss::class, ['setDataProvider', 'createRssXml']);
         $rssModel->expects($this->once())->method('setDataProvider')->will($this->returnSelf());
 
+        $exceptionMock = new \Magento\Framework\Exception\RuntimeException(
+            new \Magento\Framework\Phrase('Any message')
+        );
+
+        $rssModel->expects($this->once())->method('createRssXml')->will(
+            $this->throwException($exceptionMock)
+        );
+
         $this->response->expects($this->once())->method('setHeader')->will($this->returnSelf());
         $this->rssFactory->expects($this->once())->method('create')->will($this->returnValue($rssModel));
         $this->rssManager->expects($this->once())->method('getProvider')->will($this->returnValue($dataProvider));
 
-        $this->expectException('\Zend_Feed_Builder_Exception');
+        $this->expectException(\Magento\Framework\Exception\RuntimeException::class);
         $this->controller->execute();
     }
 }

app/code/Magento/Rss/Test/Unit/Controller/Feed/IndexTest.php

@@ -52,6 +52,7 @@ protected function setUp()
             ->disableOriginalConstructor()->getMock();
 
         $objectManagerHelper = new ObjectManagerHelper($this);
+
         $this->controller = $objectManagerHelper->getObject(
             \Magento\Rss\Controller\Feed\Index::class,
             [
@@ -90,14 +91,22 @@ public function testExecuteWithException()
         $dataProvider = $this->createMock(\Magento\Framework\App\Rss\DataProviderInterface::class);
         $dataProvider->expects($this->once())->method('isAllowed')->will($this->returnValue(true));
 
-        $rssModel = $this->createPartialMock(\Magento\Rss\Model\Rss::class, ['setDataProvider']);
+        $rssModel = $this->createPartialMock(\Magento\Rss\Model\Rss::class, ['setDataProvider', 'createRssXml']);
         $rssModel->expects($this->once())->method('setDataProvider')->will($this->returnSelf());
 
+        $exceptionMock = new \Magento\Framework\Exception\RuntimeException(
+            new \Magento\Framework\Phrase('Any message')
+        );
+
+        $rssModel->expects($this->once())->method('createRssXml')->will(
+            $this->throwException($exceptionMock)
+        );
+
         $this->response->expects($this->once())->method('setHeader')->will($this->returnSelf());
         $this->rssFactory->expects($this->once())->method('create')->will($this->returnValue($rssModel));
         $this->rssManager->expects($this->once())->method('getProvider')->will($this->returnValue($dataProvider));
 
-        $this->expectException('\Zend_Feed_Builder_Exception');
+        $this->expectException(\Magento\Framework\Exception\RuntimeException::class);
         $this->controller->execute();
     }
 }

app/code/Magento/Rss/Test/Unit/Model/RssTest.php

@@ -19,7 +19,7 @@ class RssTest extends \PHPUnit\Framework\TestCase
     /**
      * @var array
      */
-    protected $feedData = [
+    private $feedData = [
         'title' => 'Feed Title',
         'link' => 'http://magento.com/rss/link',
         'description' => 'Feed Description',
@@ -33,6 +33,27 @@ class RssTest extends \PHPUnit\Framework\TestCase
         ],
     ];
 
+    /**
+     * @var string
+     */
+    private $feedXml = '<?xml version="1.0" encoding="UTF-8"?>
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
+  <channel>
+    <title><![CDATA[Feed Title]]></title>
+    <link>http://magento.com/rss/link</link>
+    <description><![CDATA[Feed Description]]></description>
+    <pubDate>Sat, 22 Apr 2017 13:21:12 +0200</pubDate>
+    <generator>Zend_Feed</generator>
+    <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+    <item>
+      <title><![CDATA[Feed 1 Title]]></title>
+      <link>http://magento.com/rss/link/id/1</link>
+      <description><![CDATA[Feed 1 Description]]></description>
+      <pubDate>Sat, 22 Apr 2017 13:21:12 +0200</pubDate>
+    </item>
+  </channel>
+</rss>';
+
     /**
      * @var ObjectManagerHelper
      */
@@ -43,6 +64,16 @@ class RssTest extends \PHPUnit\Framework\TestCase
      */
     private $cacheMock;
 
+    /**
+     * @var \Magento\Framework\App\FeedFactoryInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $feedFactoryMock;
+
+    /**
+     * @var \Magento\Framework\App\FeedInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $feedMock;
+
     /**
      * @var SerializerInterface|\PHPUnit_Framework_MockObject_MockObject
      */
@@ -52,11 +83,15 @@ protected function setUp()
     {
         $this->cacheMock = $this->createMock(\Magento\Framework\App\CacheInterface::class);
         $this->serializerMock = $this->createMock(SerializerInterface::class);
+        $this->feedFactoryMock = $this->createMock(\Magento\Framework\App\FeedFactoryInterface::class);
+        $this->feedMock = $this->createMock(\Magento\Framework\App\FeedInterface::class);
+
         $this->objectManagerHelper = new ObjectManagerHelper($this);
         $this->rss = $this->objectManagerHelper->getObject(
             \Magento\Rss\Model\Rss::class,
             [
                 'cache' => $this->cacheMock,
+                'feedFactory' => $this->feedFactoryMock,
                 'serializer' => $this->serializerMock
             ]
         );
@@ -116,6 +151,16 @@ public function testCreateRssXml()
         $dataProvider->expects($this->any())->method('getCacheLifetime')->will($this->returnValue(100));
         $dataProvider->expects($this->any())->method('getRssData')->will($this->returnValue($this->feedData));
 
+        $this->feedMock->expects($this->once())
+            ->method('getFormattedContentAs')
+            ->with(\Magento\Framework\App\FeedInterface::DEFAULT_FORMAT)
+            ->will($this->returnValue($this->feedXml));
+
+        $this->feedFactoryMock->expects($this->once())
+            ->method('create')
+            ->with($this->feedData, \Magento\Framework\App\FeedFactoryInterface::DEFAULT_FORMAT)
+            ->will($this->returnValue($this->feedMock));
+
         $this->rss->setDataProvider($dataProvider);
         $result = $this->rss->createRssXml();
         $this->assertContains('<?xml version="1.0" encoding="UTF-8"?>', $result);

app/etc/di.xml

@@ -171,6 +171,8 @@
     <preference for="Magento\Framework\App\View\Deployment\Version\StorageInterface" type="Magento\Framework\App\View\Deployment\Version\Storage\File"/>
     <preference for="Magento\Framework\View\Page\FaviconInterface" type="Magento\Theme\Model\Favicon\Favicon" />
     <preference for="Magento\Framework\View\Element\Message\InterpretationStrategyInterface" type="Magento\Framework\View\Element\Message\InterpretationMediator" />
+    <preference for="Magento\Framework\App\FeedInterface" type="Magento\Framework\App\Feed" />
+    <preference for="Magento\Framework\App\FeedFactoryInterface" type="Magento\Framework\App\FeedFactory" />
     <preference for="Magento\Framework\Indexer\Config\DependencyInfoProviderInterface" type="Magento\Framework\Indexer\Config\DependencyInfoProvider" />
     <type name="Magento\Framework\Model\ResourceModel\Db\TransactionManager" shared="false" />
     <type name="Magento\Framework\Acl\Data\Cache">
@@ -241,6 +243,13 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Framework\FeedFactory">
+        <arguments>
+            <argument name="formats" xsi:type="array">
+                <item name="rss" xsi:type="string">Magento\Framework\App\Feed</item>
+            </argument>
+        </arguments>
+    </type>
     <type name="Magento\Framework\Session\SaveHandler\Redis">
         <arguments>
             <argument name="config" xsi:type="object">Cm\RedisSession\Handler\ConfigInterface</argument>

lib/internal/Magento/Framework/App/Feed.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\App;
+
+/**
+ * Default XML feed class
+ */
+class Feed implements FeedInterface
+{
+    /**
+     * @param Zend_Feed $feed
+     * @param array $data
+     */
+    public function __construct(
+        \Zend_Feed $feed,
+        array $data
+    ) {
+       $this->feed = $feed;
+       $this->data = $data;
+    }
+
+    /**
+     * Returns the formatted feed content
+     * 
+     * @return string
+     */
+    public function getFormattedContentAs(
+        $format = self::FORMAT_XML
+    ) {
+        $feed = $this->feed::importArray(
+            $this->data, 
+            FeedFactoryInterface::FORMAT_RSS
+        );
+        return $this->feed->saveXml();
+    }
+}

lib/internal/Magento/Framework/App/FeedFactory.php

@@ -0,0 +1,86 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\App;
+
+use Magento\Framework\App\FeedFactoryInterface;
+use Magento\Framework\ObjectManagerInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Feed factory
+ */
+class FeedFactory implements FeedFactoryInterface
+{
+    /**
+     * @var FeedProcessorInterface
+     */
+    private $feedProcessor;
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * @param ObjectManagerInterface $objectManger
+     * @param LoggerInterface $logger
+     * @param array $formats
+     */
+    public function __construct(
+        ObjectManagerInterface $objectManger,
+        LoggerInterface $logger,
+        array $formats
+    ) {
+        $this->objectManager = $objectManger;
+        $this->logger = $logger;
+        $this->formats = $formats;
+    }
+
+    /**
+     * Get a new \Magento\Framework\App\FeedInterface object from a custom array
+     *
+     * @throws \Magento\Framework\Exception\InputException
+     * @param  array  $data
+     * @param  string $format
+     * @return \Magento\Framework\App\FeedInterface
+     */
+    public function create(
+        array $data, 
+        $format = FeedFactoryInterface::FORMAT_RSS
+    ) {
+        if (!isset($this->formats[$format])) {
+            throw new \Magento\Framework\Exception\InputException(
+                __('The format is not supported'),
+                $e
+            );
+        }
+
+        if (!is_subclass_of($this->formats[$format], '\Magento\Framework\App\FeedInterface')) {
+            throw new \Magento\Framework\Exception\InputException(
+                __('Wrong format handler type'),
+                $e
+            );   
+        }
+
+        try {
+            return $this->objectManager->create(
+                $this->formats[$format],
+                $data
+            );
+        } catch (\Exception $e) {
+            $this->logger->error($e->getMessage());
+            throw new \Magento\Framework\Exception\RuntimeException(
+                __('There has been an error with import'),
+                $e
+            );
+        }
+    }
+}

lib/internal/Magento/Framework/App/FeedFactoryInterface.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\App;
+
+interface FeedFactoryInterface
+{
+
+    const FORMAT_RSS = 'rss';
+
+    /**
+     * Returns FeedInterface object from a custom array
+     * 
+     * @throws \Magento\Framework\Exception\InputException
+     * @param  array  $data
+     * @param  string $format
+     * @return FeedInterface
+     */
+    public function create(
+        array $data, 
+        $format = self::FORMAT_RSS
+    );
+}

lib/internal/Magento/Framework/App/FeedInterface.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\App;
+
+interface FeedInterface
+{
+    const FORMAT_XML = 'xml';
+
+    /**
+     * @return string
+     */
+    public function getFormattedContentAs(
+        $format = self::FORMAT_XML
+    );
+}