Implementing code review requested changes

Author: ldusan84

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

@@ -8,7 +8,7 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\Rss\DataProviderInterface;
 use Magento\Framework\Serialize\SerializerInterface;
-use Magento\Framework\App\FeedImporterInterface;
+use Magento\Framework\App\FeedFactoryInterface;
 
 class Rss
 {
@@ -23,9 +23,9 @@ class Rss
     protected $cache;
 
     /**
-     * @var \Magento\Framework\App\FeedImporterInterface
+     * @var \Magento\Framework\App\FeedFactoryInterface
      */
-    private $feedImporter;
+    private $feedFactory;
 
     /**
      * @var SerializerInterface
@@ -37,16 +37,16 @@ class Rss
      *
      * @param \Magento\Framework\App\CacheInterface $cache
      * @param SerializerInterface|null $serializer
-     * @param FeedImporterInterface|null $feedImporter
+     * @param FeedFactoryInterface|null $feedFactory
      */
     public function __construct(
         \Magento\Framework\App\CacheInterface $cache,
         SerializerInterface $serializer = null,
-        FeedImporterInterface $feedImporter = null
+        FeedFactoryInterface $feedFactory = null
     ) {
         $this->cache = $cache;
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);
-        $this->feedImporter = $feedImporter ?: ObjectManager::getInstance()->get(FeedImporterInterface::class);
+        $this->feedFactory = $feedFactory ?: ObjectManager::getInstance()->get(FeedFactoryInterface::class);
     }
 
     /**
@@ -95,7 +95,13 @@ public function setDataProvider(DataProviderInterface $dataProvider)
      */
     public function createRssXml()
     {
-        $rssFeed = $this->feedImporter->importArray($this->getFeeds(), 'rss');
-        return $rssFeed->asXML();
+        $feed = $this->feedFactory->importArray(
+            $this->getFeeds(), 
+            \Magento\Framework\App\FeedFormatsInterface::DEFAULT_FORMAT
+        );
+
+        return $feed->getFormatedContentAs(
+            \Magento\Framework\App\FeedOutputFormatsInterface::DEFAULT_FORMAT
+        );
     }
 }

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

@@ -65,9 +65,9 @@ class RssTest extends \PHPUnit_Framework_TestCase
     private $cacheMock;
 
     /**
-     * @var \Magento\Framework\App\FeedImporterInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Framework\App\FeedFactoryInterface|\PHPUnit_Framework_MockObject_MockObject
      */
-    private $feedImporterMock;
+    private $feedFactoryMock;
 
     /**
      * @var \Magento\Framework\App\FeedInterface|\PHPUnit_Framework_MockObject_MockObject
@@ -83,15 +83,15 @@ protected function setUp()
     {
         $this->cacheMock = $this->getMock(\Magento\Framework\App\CacheInterface::class);
         $this->serializerMock = $this->getMock(SerializerInterface::class);
-        $this->feedImporterMock = $this->getMock(\Magento\Framework\App\FeedImporterInterface::class);
+        $this->feedFactoryMock = $this->getMock(\Magento\Framework\App\FeedFactoryInterface::class);
         $this->feedMock = $this->getMock(\Magento\Framework\App\FeedInterface::class);
 
         $this->objectManagerHelper = new ObjectManagerHelper($this);
         $this->rss = $this->objectManagerHelper->getObject(
             \Magento\Rss\Model\Rss::class,
             [
                 'cache' => $this->cacheMock,
-                'feedImporter' => $this->feedImporterMock,
+                'feedFactory' => $this->feedFactoryMock,
                 'serializer' => $this->serializerMock
             ]
         );
@@ -152,12 +152,13 @@ public function testCreateRssXml()
         $dataProvider->expects($this->any())->method('getRssData')->will($this->returnValue($this->feedData));
 
         $this->feedMock->expects($this->once())
-            ->method('asXml')
+            ->method('getFormatedContentAs')
+            ->with(\Magento\Framework\App\FeedOutputFormatsInterface::DEFAULT_FORMAT)
             ->will($this->returnValue($this->feedXml));
 
-        $this->feedImporterMock->expects($this->once())
+        $this->feedFactoryMock->expects($this->once())
             ->method('importArray')
-            ->with($this->feedData)
+            ->with($this->feedData, \Magento\Framework\App\FeedFormatsInterface::DEFAULT_FORMAT)
             ->will($this->returnValue($this->feedMock));
 
         $this->rss->setDataProvider($dataProvider);

app/etc/di.xml

@@ -171,7 +171,7 @@
     <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\FeedImporterInterface" type="Magento\Framework\App\Feed\Importer" />
+    <preference for="Magento\Framework\App\FeedFactoryInterface" type="Magento\Framework\App\FeedFactory" />
     <type name="Magento\Framework\Model\ResourceModel\Db\TransactionManager" shared="false" />
     <type name="Magento\Framework\Acl\Data\Cache">
         <arguments>

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

@@ -8,7 +8,7 @@
 class Feed implements \Magento\Framework\App\FeedInterface
 {
     /**
-     * @var \Magento\Framework\App\FeedImporterInterface
+     * @var \Zend_Feed_Abstract
      */
     private $feed;
 
@@ -25,8 +25,15 @@ public function __construct(\Zend_Feed_Abstract $feed)
      *
      * @return string
      */
-    public function asXml()
-    {
-        return $this->feed->saveXml();
+    public function getFormatedContentAs(
+        $format = FeedOutputFormatsInterface::DEFAULT_FORMAT
+    ) {
+        if ($format === FeedOutputFormatsInterface::DEFAULT_FORMAT) {
+            return $this->feed->saveXml();
+        }
+        throw new \Magento\Framework\Exception\RuntimeException(
+            __('Given feed format is not supported'),
+            $e
+        );
     }
 }

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

@@ -9,9 +9,9 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * Feed importer
+ * Feed factory
  */
-class FeedFactory implements \Magento\Framework\App\FeedImporterInterface
+class FeedFactory implements \Magento\Framework\App\FeedFactoryInterface
 {
     /**
      * @var \Zend_Feed
@@ -43,9 +43,8 @@ public function __construct(
      * @param  string $format
      * @return \Magento\Framework\App\FeedInterface
      */
-    public function importArray(array $data, $format = 'atom')
+    public function importArray(array $data, $format = FeedFormatsInterface::DEFAULT_FORMAT)
     {
-
         try {
             return $this->feedProcessor->importArray($data, $format);
         } catch (\Zend_Feed_Exception $e) {

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

@@ -7,5 +7,5 @@
 
 interface FeedFormatsInterface
 {
-    const DEFAULT_FORMAT = 'atom';
+    const DEFAULT_FORMAT = 'rss';
 }

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

@@ -10,5 +10,7 @@ interface FeedInterface
     /**
      * @return string
      */
-    public function asXml();
+    public function getFormatedContentAs(
+        $format = FeedOutputFormatsInterface::DEFAULT_FORMAT
+    );
 }

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

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\App;
+
+interface FeedOutputFormatsInterface
+{
+    const DEFAULT_FORMAT = 'xml';
+}