MAGETWO-70886: Zend feed refactoring #9347

Author: Stanislav Idolov

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

@@ -8,9 +8,7 @@
 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;
-use Zend\Feed\Writer\FeedFactory;
 
 /**
  * Provides functionality to work with RSS feeds
@@ -100,10 +98,12 @@ public function setDataProvider(DataProviderInterface $dataProvider)
 
     /**
      * @return string
+     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Magento\Framework\Exception\RuntimeException
      */
     public function createRssXml()
     {
-        $feed = FeedFactory::factory($this->getFeeds());
-        return $feed->export('rss');
+        $feed = $this->feedFactory->create($this->getFeeds(), FeedFactoryInterface::FORMAT_RSS);
+        return $feed->getFormattedContent();
     }
 }

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

@@ -119,7 +119,7 @@ public function testExecuteWithException()
         $this->rssFactory->expects($this->once())->method('create')->will($this->returnValue($rssModel));
         $this->rssManager->expects($this->once())->method('getProvider')->will($this->returnValue($dataProvider));
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(\Magento\Framework\Exception\RuntimeException::class);
         $this->controller->execute();
     }
 }

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

@@ -107,7 +107,7 @@ public function testExecuteWithException()
         $this->rssFactory->expects($this->once())->method('create')->will($this->returnValue($rssModel));
         $this->rssManager->expects($this->once())->method('getProvider')->will($this->returnValue($dataProvider));
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(\Magento\Framework\Exception\RuntimeException::class);
         $this->controller->execute();
     }
 }

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

@@ -152,23 +152,15 @@ public function testCreateRssXml()
         $dataProvider->expects($this->any())->method('getRssData')->will($this->returnValue($this->feedData));
 
         $this->feedMock->expects($this->once())
-            ->method('getFormattedContentAs')
-            ->with(\Magento\Framework\App\FeedInterface::FORMAT_XML)
-            ->will($this->returnValue($this->feedXml));
+            ->method('getFormattedContent')
+            ->willReturn($this->feedXml);
 
         $this->feedFactoryMock->expects($this->once())
             ->method('create')
             ->with($this->feedData, \Magento\Framework\App\FeedFactoryInterface::FORMAT_RSS)
             ->will($this->returnValue($this->feedMock));
 
         $this->rss->setDataProvider($dataProvider);
-        $result = $this->rss->createRssXml();
-        $this->assertContains('<?xml version="1.0" encoding="UTF-8"?>', $result);
-        $this->assertContains('<title>Feed Title</title>', $result);
-        $this->assertContains('<title>Feed 1 Title</title>', $result);
-        $this->assertContains('<link>http://magento.com/rss/link</link>', $result);
-        $this->assertContains('<link>http://magento.com/rss/link/id/1</link>', $result);
-        $this->assertContains('<description>Feed Description</description>', $result);
-        $this->assertContains('<description><![CDATA[Feed 1 Description]]></description>', $result);
+        $this->assertNotNull($this->rss->createRssXml());
     }
 }

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

@@ -5,47 +5,32 @@
  */
 namespace Magento\Framework\App;
 
+use Zend\Feed\Writer\FeedFactory;
+
 /**
  * Default XML feed class
  */
 class Feed implements FeedInterface
 {
-    /**
-     * @var \Zend_Feed
-     */
-    private $feedProcessor;
-
     /**
      * @var array
      */
-    private $data;
+    private $feeds;
 
     /**
-     * @param Zend_Feed $feedProcessor
-     * @param array $data
+     * Feed constructor.
+     * @param array $feeds
      */
-    public function __construct(
-        \Zend_Feed $feedProcessor,
-        array $data
-    ) {
-        $this->feedProcessor = $feedProcessor;
-        $this->data = $data;
+    public function __construct(array $feeds)
+    {
+        $this->feeds = $feeds;
     }
 
     /**
-     * Returns the formatted feed content
-     *
-     * @param string $format
-     *
-     * @return string
+     * {@inheritdoc}
      */
-    public function getFormattedContentAs(
-        $format = self::FORMAT_XML
-    ) {
-        $feed = $this->feedProcessor::importArray(
-            $this->data,
-            FeedFactoryInterface::FORMAT_RSS
-        );
-        return $feed->saveXml();
+    public function getFormattedContent() : string
+    {
+        return FeedFactory::factory($this->feeds)->export(FeedFactoryInterface::FORMAT_RSS);
     }
 }

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

@@ -5,7 +5,6 @@
  */
 namespace Magento\Framework\App;
 
-use Magento\Framework\App\FeedFactoryInterface;
 use Magento\Framework\ObjectManagerInterface;
 use Psr\Log\LoggerInterface;
 
@@ -47,21 +46,17 @@ public function __construct(
     /**
      * {@inheritdoc}
      */
-    public function create(
-        array $data,
-        $format = FeedFactoryInterface::FORMAT_RSS
-    ) {
+    public function create(array $data, $format = FeedFactoryInterface::FORMAT_RSS) : FeedInterface
+    {
         if (!isset($this->formats[$format])) {
             throw new \Magento\Framework\Exception\InputException(
-                new \Magento\Framework\Phrase('The format is not supported'),
-                $e
+                new \Magento\Framework\Phrase('The format is not supported')
             );
         }
 
         if (!is_subclass_of($this->formats[$format], \Magento\Framework\App\FeedInterface::class)) {
             throw new \Magento\Framework\Exception\InputException(
-                new \Magento\Framework\Phrase('Wrong format handler type'),
-                $e
+                new \Magento\Framework\Phrase('Wrong format handler type')
             );
         }
 

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

@@ -20,12 +20,9 @@ interface FeedFactoryInterface
      *
      * @throws \Magento\Framework\Exception\InputException
      * @throws \Magento\Framework\Exception\RuntimeException
-     * @param  array  $data
-     * @param  string $format
+     * @param array $data
+     * @param string $format
      * @return FeedInterface
      */
-    public function create(
-        array $data,
-        $format = self::FORMAT_RSS
-    );
+    public function create(array $data, $format = self::FORMAT_RSS) : FeedInterface;
 }

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

@@ -11,16 +11,9 @@
 interface FeedInterface
 {
     /**
-     * XML feed output format
-     */
-    const FORMAT_XML = 'xml';
-
-    /**
-     * @param string $format
+     * Returns the formatted feed content
      *
      * @return string
      */
-    public function getFormattedContentAs(
-        $format = self::FORMAT_XML
-    );
+    public function getFormattedContent() : string;
 }