#10045 Rename item resolver to item provider

piotrkwiecinski · piotrkwiecinski · commit 16b77ca932fc · 2017-08-04T22:18:48.000+01:00
diff --git a/app/code/Magento/Sitemap/Helper/Data.php b/app/code/Magento/Sitemap/Helper/Data.php
@@ -10,9 +10,9 @@
  */
 namespace Magento\Sitemap\Helper;
 
-use Magento\Sitemap\Model\ItemResolver\CategoryConfigReader;
-use Magento\Sitemap\Model\ItemResolver\CmsPageConfigReader;
-use Magento\Sitemap\Model\ItemResolver\ProductConfigReader;
+use Magento\Sitemap\Model\ItemProvider\CategoryConfigReader;
+use Magento\Sitemap\Model\ItemProvider\CmsPageConfigReader;
+use Magento\Sitemap\Model\ItemProvider\ProductConfigReader;
 use Magento\Sitemap\Model\SitemapConfigReader;
 use Magento\Store\Model\ScopeInterface;
 
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/Category.php b/app/code/Magento/Sitemap/Model/ItemProvider/Category.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Sitemap\Model\ResourceModel\Catalog\CategoryFactory;
 use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
 
-class Category implements ItemResolverInterface
+class Category implements ItemProviderInterface
 {
     /**
      * Category factory
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/CategoryConfigReader.php b/app/code/Magento/Sitemap/Model/ItemProvider/CategoryConfigReader.php
@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/CmsPage.php b/app/code/Magento/Sitemap/Model/ItemProvider/CmsPage.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Sitemap\Model\ResourceModel\Cms\PageFactory;
 use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
 
-class CmsPage implements ItemResolverInterface
+class CmsPage implements ItemProviderInterface
 {
     /**
      * Cms page factory
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/CmsPageConfigReader.php b/app/code/Magento/Sitemap/Model/ItemProvider/CmsPageConfigReader.php
@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/Composite.php b/app/code/Magento/Sitemap/Model/ItemProvider/Composite.php
@@ -4,25 +4,25 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
-class Composite implements ItemResolverInterface
+class Composite implements ItemProviderInterface
 {
     /**
      * Item resolvers
      *
-     * @var ItemResolverInterface[]
+     * @var ItemProviderInterface[]
      */
-    private $itemResolvers;
+    private $itemProviders;
 
     /**
      * Composite constructor.
      *
-     * @param ItemResolverInterface[] $itemResolvers
+     * @param ItemProviderInterface[] $itemProviders
      */
-    public function __construct($itemResolvers = [])
+    public function __construct($itemProviders = [])
     {
-        $this->itemResolvers = $itemResolvers;
+        $this->itemProviders = $itemProviders;
     }
 
     /**
@@ -32,7 +32,7 @@ public function getItems($storeId)
     {
         $items = [];
 
-        foreach ($this->itemResolvers as $resolver) {
+        foreach ($this->itemProviders as $resolver) {
             foreach ($resolver->getItems($storeId) as $item) {
                 $items[] = $item;
             }
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/ConfigReaderInterface.php b/app/code/Magento/Sitemap/Model/ItemProvider/ConfigReaderInterface.php
@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 /**
  * Item resolver config reader interface
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/ItemProviderInterface.php b/app/code/Magento/Sitemap/Model/ItemProvider/ItemProviderInterface.php
@@ -3,16 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Sitemap\Model\SitemapItemInterface;
 
 /**
- * Sitemap item resolver interface
+ * Sitemap item provider interface
  *
  * @api
  */
-interface ItemResolverInterface
+interface ItemProviderInterface
 {
     /**
      * Get sitemap items
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/Product.php b/app/code/Magento/Sitemap/Model/ItemProvider/Product.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Sitemap\Model\ResourceModel\Catalog\ProductFactory;
 use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
 
-class Product implements ItemResolverInterface
+class Product implements ItemProviderInterface
 {
     /**
      * Product factory
diff --git a/app/code/Magento/Sitemap/Model/ItemProvider/ProductConfigReader.php b/app/code/Magento/Sitemap/Model/ItemProvider/ProductConfigReader.php
@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Model\ItemResolver;
+namespace Magento\Sitemap\Model\ItemProvider;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
diff --git a/app/code/Magento/Sitemap/Model/Sitemap.php b/app/code/Magento/Sitemap/Model/Sitemap.php
@@ -14,7 +14,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\UrlInterface;
 use Magento\Robots\Model\Config\Value;
-use Magento\Sitemap\Model\ItemResolver\ItemResolverInterface;
+use Magento\Sitemap\Model\ItemProvider\ItemProviderInterface;
 use Magento\Sitemap\Model\ResourceModel\Sitemap as SitemapResource;
 
 /**
@@ -164,9 +164,9 @@ class Sitemap extends \Magento\Framework\Model\AbstractModel implements \Magento
     /**
      * Item resolver
      *
-     * @var ItemResolverInterface
+     * @var ItemProviderInterface
      */
-    private $itemResolver;
+    private $itemProvider;
 
     /**
      * Sitemap config reader
@@ -201,7 +201,7 @@ class Sitemap extends \Magento\Framework\Model\AbstractModel implements \Magento
      * @param \Magento\Framework\Data\Collection\AbstractDb|null $resourceCollection
      * @param array $data
      * @param DocumentRoot|null $documentRoot
-     * @param ItemResolverInterface|null $itemResolver
+     * @param ItemProviderInterface|null $itemProvider
      * @param SitemapConfigReaderInterface|null $configReader
      * @param \Magento\Sitemap\Model\SitemapItemInterfaceFactory|null $sitemapItemFactory
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -223,7 +223,7 @@ public function __construct(
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = [],
         \Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot $documentRoot = null,
-        ItemResolverInterface $itemResolver = null,
+        ItemProviderInterface $itemProvider = null,
         SitemapConfigReaderInterface $configReader = null,
         \Magento\Sitemap\Model\SitemapItemInterfaceFactory $sitemapItemFactory = null
     ) {
@@ -238,7 +238,7 @@ public function __construct(
         $this->_storeManager = $storeManager;
         $this->_request = $request;
         $this->dateTime = $dateTime;
-        $this->itemResolver = $itemResolver ?: ObjectManager::getInstance()->get(ItemResolverInterface::class);
+        $this->itemProvider = $itemProvider ?: ObjectManager::getInstance()->get(ItemProviderInterface::class);
         $this->configReader = $configReader ?: ObjectManager::getInstance()->get(SitemapConfigReaderInterface::class);
         $this->sitemapItemFactory = $sitemapItemFactory ?: ObjectManager::getInstance()->get(
             \Magento\Sitemap\Model\SitemapItemInterfaceFactory::class
@@ -278,7 +278,7 @@ protected function _getStream()
      * @param DataObject $sitemapItem
      * @return $this
      * @deprecated
-     * @see ItemResolverInterface
+     * @see ItemProviderInterface
      */
     public function addSitemapItem(DataObject $sitemapItem)
     {
@@ -292,7 +292,7 @@ public function addSitemapItem(DataObject $sitemapItem)
      *
      * @return void
      * @deprecated
-     * @see ItemResolverInterface
+     * @see ItemProviderInterface
      */
     public function collectSitemapItems()
     {
@@ -332,7 +332,7 @@ public function collectSitemapItems()
      */
     protected function _initSitemapItems()
     {
-        $sitemapItems = $this->itemResolver->getItems($this->getStoreId());
+        $sitemapItems = $this->itemProvider->getItems($this->getStoreId());
         $mappedItems = $this->mapToSitemapItem();
         $this->_sitemapItems = array_merge($sitemapItems, $mappedItems);
 
diff --git a/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/CategoryTest.php b/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/CategoryTest.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Test\Unit\Model\ItemResolver;
+namespace Magento\Sitemap\Test\Unit\Model\ItemProvider;
 
 use Magento\Framework\DataObject;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
-use Magento\Sitemap\Model\ItemResolver\Category as CategoryItemResolver;
-use Magento\Sitemap\Model\ItemResolver\ConfigReaderInterface;
+use Magento\Sitemap\Model\ItemProvider\Category as CategoryItemResolver;
+use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
 use Magento\Sitemap\Model\ResourceModel\Catalog\Category as CategoryResource;
 use Magento\Sitemap\Model\ResourceModel\Catalog\CategoryFactory;
 use Magento\Sitemap\Model\SitemapItem;
diff --git a/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/CmsPageTest.php b/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/CmsPageTest.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Test\Unit\Model\ItemResolver;
+namespace Magento\Sitemap\Test\Unit\Model\ItemProvider;
 
 use Magento\Framework\DataObject;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
-use Magento\Sitemap\Model\ItemResolver\CmsPage as CmsPageItemResolver;
-use Magento\Sitemap\Model\ItemResolver\ConfigReaderInterface;
+use Magento\Sitemap\Model\ItemProvider\CmsPage as CmsPageItemResolver;
+use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
 use Magento\Sitemap\Model\ResourceModel\Cms\Page as CmsPageResource;
 use Magento\Sitemap\Model\ResourceModel\Cms\PageFactory;
 use Magento\Sitemap\Model\SitemapItem;
diff --git a/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/CompositeTest.php b/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/CompositeTest.php
@@ -4,10 +4,10 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Test\Unit\Model\ItemResolver;
+namespace Magento\Sitemap\Test\Unit\Model\ItemProvider;
 
-use Magento\Sitemap\Model\ItemResolver\Composite as CompositeItemResolver;
-use Magento\Sitemap\Model\ItemResolver\ItemResolverInterface;
+use Magento\Sitemap\Model\ItemProvider\Composite as CompositeItemResolver;
+use Magento\Sitemap\Model\ItemProvider\ItemProviderInterface;
 use Magento\Sitemap\Model\SitemapItemInterface;
 
 class CompositeTest extends \PHPUnit_Framework_TestCase
@@ -28,7 +28,7 @@ public function testGetItems($itemResolverData, $expectedItems)
         $mockResolvers = [];
 
         foreach ($itemResolverData as $data) {
-            $mockResolver = $this->getMockForAbstractClass(ItemResolverInterface::class);
+            $mockResolver = $this->getMockForAbstractClass(ItemProviderInterface::class);
             $mockResolver->expects(self::once())
                 ->method('getItems')
                 ->willReturn($data);
diff --git a/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/ProductTest.php b/app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/ProductTest.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sitemap\Test\Unit\Model\ItemResolver;
+namespace Magento\Sitemap\Test\Unit\Model\ItemProvider;
 
 use Magento\Framework\DataObject;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
-use Magento\Sitemap\Model\ItemResolver\ConfigReaderInterface;
-use Magento\Sitemap\Model\ItemResolver\Product as ProductItemResolver;
+use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
+use Magento\Sitemap\Model\ItemProvider\Product as ProductItemResolver;
 use Magento\Sitemap\Model\ResourceModel\Catalog\Product as ProductResource;
 use Magento\Sitemap\Model\ResourceModel\Catalog\ProductFactory;
 use Magento\Sitemap\Model\SitemapItem;
diff --git a/app/code/Magento/Sitemap/Test/Unit/Model/SitemapTest.php b/app/code/Magento/Sitemap/Test/Unit/Model/SitemapTest.php
@@ -11,8 +11,8 @@
 use Magento\Framework\Filesystem\File\Write;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Sitemap\Helper\Data;
-use Magento\Sitemap\Model\ItemResolver\ConfigReaderInterface;
-use Magento\Sitemap\Model\ItemResolver\ItemResolverInterface;
+use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
+use Magento\Sitemap\Model\ItemProvider\ItemProviderInterface;
 use Magento\Sitemap\Model\ResourceModel\Catalog\Category;
 use Magento\Sitemap\Model\ResourceModel\Catalog\CategoryFactory;
 use Magento\Sitemap\Model\ResourceModel\Catalog\Product;
@@ -77,9 +77,9 @@ class SitemapTest extends \PHPUnit_Framework_TestCase
     private $storeManagerMock;
 
     /**
-     * @var ItemResolverInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var ItemProviderInterface|\PHPUnit_Framework_MockObject_MockObject
      */
-    private $itemResolverMock;
+    private $itemProviderMock;
 
     /**
      * @var ConfigReaderInterface|\PHPUnit_Framework_MockObject_MockObject
@@ -146,7 +146,7 @@ protected function setUp()
             ->willReturn($this->directoryMock);
 
         $this->configReaderMock = $this->getMockForAbstractClass(SitemapConfigReaderInterface::class);
-        $this->itemResolverMock = $this->getMockForAbstractClass(ItemResolverInterface::class);
+        $this->itemProviderMock = $this->getMockForAbstractClass(ItemProviderInterface::class);
     }
 
     /**
@@ -525,7 +525,7 @@ protected function getModelMock($mockBeforeSave = false)
 
         $storeBaseMediaUrl = 'http://store.com/pub/media/catalog/product/cache/c9e0b0ef589f3508e5ba515cde53c5ff/';
 
-        $this->itemResolverMock->expects($this->any())
+        $this->itemProviderMock->expects($this->any())
             ->method('getItems')
             ->willReturn([
                 new SitemapItem('category.html', '1.0', 'daily', '2012-12-21 00:00:00'),
@@ -610,7 +610,7 @@ private function getModelConstructorArgs()
                 'storeManager' => $this->storeManagerMock,
                 'sitemapData' => $this->helperMockSitemap,
                 'filesystem' => $this->filesystemMock,
-                'itemResolver' => $this->itemResolverMock,
+                'itemProvider' => $this->itemProviderMock,
                 'configReader' => $this->configReaderMock,
             ]
         );
diff --git a/app/code/Magento/Sitemap/etc/di.xml b/app/code/Magento/Sitemap/etc/di.xml
diff --git a/dev/tests/integration/testsuite/Magento/Sitemap/Model/ItemProvider/CategoryConfigReaderTest.php b/dev/tests/integration/testsuite/Magento/Sitemap/Model/ItemProvider/CategoryConfigReaderTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Sitemap/Model/ItemProvider/CmsPageConfigReaderTest.php b/dev/tests/integration/testsuite/Magento/Sitemap/Model/ItemProvider/CmsPageConfigReaderTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Sitemap/Model/ItemProvider/ProductConfigReaderTest.php b/dev/tests/integration/testsuite/Magento/Sitemap/Model/ItemProvider/ProductConfigReaderTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,25 +4,25 @@`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
`6`	`6`
`7`		`-namespace Magento\Sitemap\Model\ItemResolver;`
	`7`	`+namespace Magento\Sitemap\Model\ItemProvider;`
`8`	`8`
`9`		`-class Composite implements ItemResolverInterface`
	`9`	`+class Composite implements ItemProviderInterface`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`	`12`	`* Item resolvers`
`13`	`13`	`*`
`14`		`- * @var ItemResolverInterface[]`
	`14`	`+ * @var ItemProviderInterface[]`
`15`	`15`	`*/`
`16`		`- private $itemResolvers;`
	`16`	`+ private $itemProviders;`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* Composite constructor.`
`20`	`20`	`*`
`21`		`- * @param ItemResolverInterface[] $itemResolvers`
	`21`	`+ * @param ItemProviderInterface[] $itemProviders`
`22`	`22`	`*/`
`23`		`- public function __construct($itemResolvers = [])`
	`23`	`+ public function __construct($itemProviders = [])`
`24`	`24`	`{`
`25`		`- $this->itemResolvers = $itemResolvers;`
	`25`	`+ $this->itemProviders = $itemProviders;`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`/**`
`@@ -32,7 +32,7 @@ public function getItems($storeId)`
`32`	`32`	`{`
`33`	`33`	`$items = [];`
`34`	`34`
`35`		`- foreach ($this->itemResolvers as $resolver) {`
	`35`	`+ foreach ($this->itemProviders as $resolver) {`
`36`	`36`	`foreach ($resolver->getItems($storeId) as $item) {`
`37`	`37`	`$items[] = $item;`
`38`	`38`	`}`