Skip to content

Fix #25761: Site map doesn't include home page #26445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions app/code/Magento/Sitemap/Model/ItemProvider/StoreUrl.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Sitemap\Model\ItemProvider;

use Magento\Sitemap\Model\SitemapItemInterfaceFactory;

/**
* Class for adding Store Url in sitemap
*/
class StoreUrl implements ItemProviderInterface
{
/**
* Sitemap item factory
*
* @var SitemapItemInterfaceFactory
*/
private $itemFactory;

/**
* Config reader
*
* @var ConfigReaderInterface
*/
private $configReader;

/**
* StoreUrlSitemapItemResolver constructor.
*
* @param ConfigReaderInterface $configReader
* @param SitemapItemInterfaceFactory $itemFactory
*/
public function __construct(
ConfigReaderInterface $configReader,
SitemapItemInterfaceFactory $itemFactory
) {
$this->itemFactory = $itemFactory;
$this->configReader = $configReader;
}

/**
* @inheritdoc
*/
public function getItems($storeId)
{
$items[] = $this->itemFactory->create([
'url' => '',
'priority' => $this->configReader->getPriority($storeId),
'changeFrequency' => $this->configReader->getChangeFrequency($storeId),
]);

return $items;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Sitemap\Model\ItemProvider;

use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Store\Model\ScopeInterface;

/**
* Class for getting configuration for Store Url
*/
class StoreUrlConfigReader implements ConfigReaderInterface
{
/**#@+
* Xpath config settings
*/
const XML_PATH_CHANGE_FREQUENCY = 'sitemap/store/changefreq';
const XML_PATH_PRIORITY = 'sitemap/store/priority';
/**#@-*/

/**
* Scope config
*
* @var ScopeConfigInterface
*/
private $scopeConfig;

/**
* CategoryItemResolverConfigReader constructor.
*
* @param ScopeConfigInterface $scopeConfig
*/
public function __construct(ScopeConfigInterface $scopeConfig)
{
$this->scopeConfig = $scopeConfig;
}

/**
* @inheritdoc
*/
public function getPriority($storeId)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_PRIORITY,
ScopeInterface::SCOPE_STORE,
$storeId
);
}

/**
* @inheritdoc
*/
public function getChangeFrequency($storeId)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_CHANGE_FREQUENCY,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Sitemap\Test\Unit\Model\ItemProvider;

use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
use Magento\Sitemap\Model\ItemProvider\StoreUrl as StoreUrlItemResolver;
use Magento\Sitemap\Model\SitemapItem;
use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

class StoreUrlTest extends TestCase
{
/**
* test for getItems method
*/
public function testGetItems()
{
$configReaderMock = $this->getConfigReaderMock();
$itemFactoryMock = $this->getItemFactoryMock();
$resolver = new StoreUrlItemResolver($configReaderMock, $itemFactoryMock);
$items = $resolver->getItems(1);

$this->assertCount(1, $items);
foreach ($items as $item) {
$this->assertSame('daily', $item->getChangeFrequency());
$this->assertSame('1.0', $item->getPriority());
}
}

/**
* @return SitemapItemInterfaceFactory|MockObject
*/
private function getItemFactoryMock()
{
$itemFactoryMock = $this->getMockBuilder(SitemapItemInterfaceFactory::class)
->setMethods(['create'])
->disableOriginalConstructor()
->getMock();

$itemFactoryMock->expects($this->any())
->method('create')
->willReturnCallback(function ($data) {
$helper = new ObjectManager($this);

return $helper->getObject(SitemapItem::class, $data);
});

return $itemFactoryMock;
}

/**
* @return ConfigReaderInterface|MockObject
*/
private function getConfigReaderMock()
{
$configReaderMock = $this->getMockForAbstractClass(ConfigReaderInterface::class);
$configReaderMock->expects($this->any())
->method('getPriority')
->willReturn('1.0');
$configReaderMock->expects($this->any())
->method('getChangeFrequency')
->willReturn('daily');

return $configReaderMock;
}
}
18 changes: 15 additions & 3 deletions app/code/Magento/Sitemap/etc/adminhtml/system.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,19 @@
<comment>Valid values range from 0.0 to 1.0.</comment>
</field>
</group>
<group id="generate" translate="label" type="text" sortOrder="4" showInDefault="1">
<group id="store" translate="label" type="text" sortOrder="4" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Store Url Options</label>
<field id="changefreq" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Frequency</label>
<source_model>Magento\Sitemap\Model\Config\Source\Frequency</source_model>
</field>
<field id="priority" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Priority</label>
<backend_model>Magento\Sitemap\Model\Config\Backend\Priority</backend_model>
<comment>Valid values range from 0.0 to 1.0.</comment>
</field>
</group>
<group id="generate" translate="label" type="text" sortOrder="5" showInDefault="1">
<label>Generation Settings</label>
<field id="enabled" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Enabled</label>
Expand Down Expand Up @@ -94,7 +106,7 @@
</depends>
</field>
</group>
<group id="limit" translate="label" type="text" sortOrder="5" showInDefault="1" showInWebsite="1" showInStore="1">
<group id="limit" translate="label" type="text" sortOrder="6" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Sitemap File Limits</label>
<field id="max_lines" translate="label" type="text" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Maximum No of URLs Per File</label>
Expand All @@ -106,7 +118,7 @@
<validate>validate-number validate-greater-than-zero</validate>
</field>
</group>
<group id="search_engines" translate="label" type="text" sortOrder="6" showInDefault="1" showInWebsite="1" showInStore="1">
<group id="search_engines" translate="label" type="text" sortOrder="7" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Search Engine Submission Settings</label>
<field id="submission_robots" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Enable Submission to Robots.txt</label>
Expand Down
4 changes: 4 additions & 0 deletions app/code/Magento/Sitemap/etc/config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
<changefreq>daily</changefreq>
<image_include>all</image_include>
</product>
<store>
<priority>1</priority>
<changefreq>daily</changefreq>
</store>
<generate>
<enabled>0</enabled>
<error_email />
Expand Down
6 changes: 6 additions & 0 deletions app/code/Magento/Sitemap/etc/di.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,18 @@
<type name="Magento\Sitemap\Model\ItemProvider\Composite">
<arguments>
<argument name="itemProviders" xsi:type="array">
<item name="storeUrlProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\StoreUrl</item>
<item name="categoryProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\Category</item>
<item name="cmsPageProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\CmsPage</item>
<item name="productProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\Product</item>
</argument>
</arguments>
</type>
<type name="Magento\Sitemap\Model\ItemProvider\StoreUrl">
<arguments>
<argument name="configReader" xsi:type="object">Magento\Sitemap\Model\ItemProvider\StoreUrlConfigReader</argument>
</arguments>
</type>
<type name="Magento\Sitemap\Model\ItemProvider\Category">
<arguments>
<argument name="configReader" xsi:type="object">Magento\Sitemap\Model\ItemProvider\CategoryConfigReader</argument>
Expand Down
1 change: 1 addition & 0 deletions app/code/Magento/Sitemap/i18n/en_US.csv
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,4 @@ ID,ID
"Link for Google","Link for Google"
"Last Generated","Last Generated"
Action,Action
"Store Url Options","Store Url Options"