Integration testing changes for Aligent\Sitemap\Model\ItemProvider\PwaUrl class

Model/Config/ConfigReaderInterface.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * Aligent Consulting
+ * Copyright (c) Aligent Consulting (https://www.aligent.com.au)
+ */
+
+declare(strict_types=1);
+
+namespace Aligent\Sitemap\Model\Config;
+
+interface ConfigReaderInterface
+{
+    public const CONFIG_XML_PATH_SITEMAP_ENABLED = 'aligent_sitemap/general/enabled';
+    public const CONFIG_XML_PATH_SITEMAP_EXCLUDE_CMS_PAGE = 'aligent_sitemap/general/exclude_cms_page';
+    public const CONFIG_XML_PATH_SITEMAP_EXCLUDE_CATEGORY = 'aligent_sitemap/general/exclude_category';
+    public const CONFIG_XML_PATH_SITEMAP_EXCLUDE_PRODUCT = 'aligent_sitemap/general/exclude_product';
+    public const CONFIG_XML_PATH_SITEMAP_EXCLUDE_PRODUCT_IMAGES = 'aligent_sitemap/general/exclude_product_images';
+    public const CONFIG_XML_PATH_SITEMAP_INCLUDE_PWA_PAGES = 'aligent_sitemap/general/include_pwa_pages';
+    public const CONFIG_XML_PATH_SITEMAP_BASE_URL = 'aligent_sitemap/general/sitemap_base_url';
+    public const CONFIG_XML_PATH_SITEMAP_PWA_PAGES_URL_KEY = 'aligent_sitemap/general/pwa_pages_url_key';
+
+    /**
+     * Sitemap customization for the default sitemap enabled check
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isSitemapCustomizationEnabled(?int $storeId): bool;
+
+    /**
+     * Enabled CMS Page Exclude from Sitemap Xml check
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isCmsPageExcludeEnabled(?int $storeId): bool;
+
+    /**
+     * Enabled Category Exclude from Sitemap Xml check
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isCategoryExcludeEnabled(?int $storeId): bool;
+
+    /**
+     * Enabled Product Exclude from Sitemap Xml check
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isProductExcludeEnabled(?int $storeId): bool;
+
+    /**
+     * Enabled Product Images Exclude from Sitemap Xml check
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isProductImagesExcludeEnabled(?int $storeId): bool;
+
+    /**
+     * Include PWA Pages to Sitemap Xml check
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isPwaPagesInclude(?int $storeId): bool;
+
+    /**
+     * Get Sitemap Base Url
+     *
+     * @param int|null $storeId
+     * @return string
+     */
+    public function getSitemapBaseUrl(?int $storeId): string;
+
+    /**
+     * Get PWA Pages Url Key
+     *
+     * @param int|null $storeId
+     * @return array
+     */
+    public function getPwaPagesUrlKey(?int $storeId): array;
+}

Model/Config/Data.php

@@ -12,17 +12,8 @@
 use Magento\Store\Model\ScopeInterface;
 use Magento\Framework\Serialize\Serializer\Json;
 
-class Data
+class Data implements ConfigReaderInterface
 {
-    private const CONFIG_XML_PATH_SITEMAP_ENABLED = 'aligent_sitemap/general/enabled';
-    private const CONFIG_XML_PATH_SITEMAP_EXCLUDE_CMS_PAGE = 'aligent_sitemap/general/exclude_cms_page';
-    private const CONFIG_XML_PATH_SITEMAP_EXCLUDE_CATEGORY = 'aligent_sitemap/general/exclude_category';
-    private const CONFIG_XML_PATH_SITEMAP_EXCLUDE_PRODUCT = 'aligent_sitemap/general/exclude_product';
-    private const CONFIG_XML_PATH_SITEMAP_EXCLUDE_PRODUCT_IMAGES = 'aligent_sitemap/general/exclude_product_images';
-    private const CONFIG_XML_PATH_SITEMAP_INCLUDE_PWA_PAGES = 'aligent_sitemap/general/include_pwa_pages';
-    private const CONFIG_XML_PATH_SITEMAP_BASE_URL = 'aligent_sitemap/general/sitemap_base_url';
-    private const CONFIG_XML_PATH_SITEMAP_PWA_PAGES_URL_KEY = 'aligent_sitemap/general/pwa_pages_url_key';
-
     /**
      * @param ScopeConfigInterface $scopeConfig
      * @param Json $serializer
@@ -34,10 +25,7 @@ public function __construct(
     }
 
     /**
-     * Sitemap customization for the default sitemap enabled check
-     *
-     * @param int|null $storeId
-     * @return bool
+     * @inheritDoc
      */
     public function isSitemapCustomizationEnabled(?int $storeId): bool
     {
@@ -49,10 +37,7 @@ public function isSitemapCustomizationEnabled(?int $storeId): bool
     }
 
     /**
-     * Enabled CMS Page Exclude from Sitemap Xml check
-     *
-     * @param int|null $storeId
-     * @return bool
+     * @inheritDoc
      */
     public function isCmsPageExcludeEnabled(?int $storeId): bool
     {
@@ -67,10 +52,7 @@ public function isCmsPageExcludeEnabled(?int $storeId): bool
     }
 
     /**
-     * Enabled Category Exclude from Sitemap Xml check
-     *
-     * @param int|null $storeId
-     * @return bool
+     * @inheritDoc
      */
     public function isCategoryExcludeEnabled(?int $storeId): bool
     {
@@ -85,10 +67,7 @@ public function isCategoryExcludeEnabled(?int $storeId): bool
     }
 
     /**
-     * Enabled Product Exclude from Sitemap Xml check
-     *
-     * @param int|null $storeId
-     * @return bool
+     * @inheritDoc
      */
     public function isProductExcludeEnabled(?int $storeId): bool
     {
@@ -103,10 +82,7 @@ public function isProductExcludeEnabled(?int $storeId): bool
     }
 
     /**
-     * Enabled Product Images Exclude from Sitemap Xml check
-     *
-     * @param int|null $storeId
-     * @return bool
+     * @inheritDoc
      */
     public function isProductImagesExcludeEnabled(?int $storeId): bool
     {
@@ -121,10 +97,7 @@ public function isProductImagesExcludeEnabled(?int $storeId): bool
     }
 
     /**
-     * Include PWA Pages to Sitemap Xml check
-     *
-     * @param int|null $storeId
-     * @return bool
+     * @inheritDoc
      */
     public function isPwaPagesInclude(?int $storeId): bool
     {
@@ -139,10 +112,7 @@ public function isPwaPagesInclude(?int $storeId): bool
     }
 
     /**
-     * Get Sitemap Base Url
-     *
-     * @param int|null $storeId
-     * @return string
+     * @inheritDoc
      */
     public function getSitemapBaseUrl(?int $storeId): string
     {
@@ -157,10 +127,7 @@ public function getSitemapBaseUrl(?int $storeId): string
     }
 
     /**
-     * Get PWA Pages Url Key
-     *
-     * @param int|null $storeId
-     * @return array
+     * @inheritDoc
      */
     public function getPwaPagesUrlKey(?int $storeId): array
     {

Model/ItemProvider/PwaUrl.php

@@ -11,7 +11,7 @@
 use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
 use Magento\Sitemap\Model\ItemProvider\ItemProviderInterface;
 use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
-use Aligent\Sitemap\Model\Config\Data as AligentSitemapConfig;
+use Aligent\Sitemap\Model\Config\ConfigReaderInterface as AligentSitemapConfigReaderInterface;
 
 class PwaUrl implements ItemProviderInterface
 {
@@ -20,12 +20,12 @@ class PwaUrl implements ItemProviderInterface
      *
      * @param ConfigReaderInterface $configReader
      * @param SitemapItemInterfaceFactory $itemFactory
-     * @param AligentSitemapConfig $aligentSitemapConfig
+     * @param AligentSitemapConfigReaderInterface $aligentSitemapConfigReaderInterface
      */
     public function __construct(
         private readonly ConfigReaderInterface $configReader,
         private readonly SitemapItemInterfaceFactory $itemFactory,
-        private readonly AligentSitemapConfig $aligentSitemapConfig
+        private readonly AligentSitemapConfigReaderInterface $aligentSitemapConfigReaderInterface
     ) {
     }
 
@@ -35,8 +35,8 @@ public function __construct(
     public function getItems($storeId): array
     {
         $items = [];
-        if ($this->aligentSitemapConfig->isPwaPagesInclude((int)$storeId)) {
-            $pwaPagesUrlKeys = $this->aligentSitemapConfig->getPwaPagesUrlKey((int)$storeId);
+        if ($this->aligentSitemapConfigReaderInterface->isPwaPagesInclude((int)$storeId)) {
+            $pwaPagesUrlKeys = $this->aligentSitemapConfigReaderInterface->getPwaPagesUrlKey((int)$storeId);
             foreach ($pwaPagesUrlKeys as $pwaPagesUrlKey) {
                 $items[] = $this->itemFactory->create([
                     'url' => $pwaPagesUrlKey,

Model/Sitemap.php

@@ -29,7 +29,7 @@
 use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\Sitemap\Helper\Data as SitemapHelper;
-use Aligent\Sitemap\Model\Config\Data as AligentSitemapConfig;
+use Aligent\Sitemap\Model\Config\ConfigReaderInterface as AligentSitemapConfigReaderInterface;
 
 class Sitemap extends MagentoSitemap
 {
@@ -46,7 +46,7 @@ class Sitemap extends MagentoSitemap
      * @param StoreManagerInterface $storeManager
      * @param RequestInterface $request
      * @param DateTime $dateTime
-     * @param AligentSitemapConfig $aligentSitemapConfig
+     * @param AligentSitemapConfigReaderInterface $aligentSitemapConfig
      * @param AbstractResource|null $resource
      * @param AbstractDb|null $resourceCollection
      * @param array $data
@@ -68,7 +68,7 @@ public function __construct(
         StoreManagerInterface $storeManager,
         RequestInterface $request,
         DateTime $dateTime,
-        private readonly AligentSitemapConfig $aligentSitemapConfig,
+        private readonly AligentSitemapConfigReaderInterface $aligentSitemapConfig,
         AbstractResource $resource = null,
         AbstractDb $resourceCollection = null,
         array $data = [],

Plugin/Model/ResourceModel/Catalog/GetValidCategoryPagesForSitemap.php

@@ -17,7 +17,7 @@
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\Catalog\Model\ResourceModel\Category as CategoryResource;
-use Aligent\Sitemap\Model\Config\Data as AligentSitemapConfig;
+use Aligent\Sitemap\Model\Config\ConfigReaderInterface as AligentSitemapConfigReaderInterface;
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\DataObject;
 
@@ -31,13 +31,13 @@ class GetValidCategoryPagesForSitemap
     private $_attributesCache = [];
 
     /**
-     * @param AligentSitemapConfig $aligentSitemapConfig
+     * @param AligentSitemapConfigReaderInterface $aligentSitemapConfig
      * @param StoreManagerInterface $storeManager
      * @param CategoryResource $categoryResource
      * @param MetadataPool $metadataPool
      */
     public function __construct(
-        private readonly AligentSitemapConfig $aligentSitemapConfig,
+        private readonly AligentSitemapConfigReaderInterface $aligentSitemapConfig,
         private readonly StoreManagerInterface $storeManager,
         private readonly CategoryResource $categoryResource,
         private readonly MetadataPool $metadataPool

Plugin/Model/ResourceModel/Catalog/GetValidProductPagesForSitemap.php

@@ -24,7 +24,7 @@
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 use Zend_Db_Statement_Exception;
-use Aligent\Sitemap\Model\Config\Data as AligentSitemapConfig;
+use Aligent\Sitemap\Model\Config\ConfigReaderInterface as AligentSitemapConfigReaderInterface;
 use Magento\Sitemap\Model\ResourceModel\Catalog\Product;
 use Magento\Catalog\Model\Product\Visibility;
 use Magento\Catalog\Model\Product\Attribute\Source\Status;
@@ -35,7 +35,7 @@ class GetValidProductPagesForSitemap
     /**
      * Product constructor.
      *
-     * @param AligentSitemapConfig $aligentSitemapConfig
+     * @param AligentSitemapConfigReaderInterface $aligentSitemapConfig
      * @param ScopeConfigInterface $scopeConfig
      * @param StoreManagerInterface $storeManager
      * @param ProductResource $productResource
@@ -47,7 +47,7 @@ class GetValidProductPagesForSitemap
      * @param ReadHandler $mediaGalleryReadHandler
      */
     public function __construct(
-        private readonly AligentSitemapConfig $aligentSitemapConfig,
+        private readonly AligentSitemapConfigReaderInterface $aligentSitemapConfig,
         private readonly ScopeConfigInterface $scopeConfig,
         private readonly StoreManagerInterface $storeManager,
         private readonly ProductResource $productResource,

Plugin/Model/ResourceModel/Cms/Page/GetValidCmsPagesForSitemap.php

@@ -12,7 +12,7 @@
 use Magento\Cms\Api\GetUtilityPageIdentifiersInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Zend_Db_Statement_Exception;
-use Aligent\Sitemap\Model\Config\Data as AligentSitemapConfig;
+use Aligent\Sitemap\Model\Config\ConfigReaderInterface as AligentSitemapConfigReaderInterface;
 use Magento\Sitemap\Model\ResourceModel\Cms\Page;
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\DataObject;
@@ -22,13 +22,13 @@ class GetValidCmsPagesForSitemap
     /**
      * @param GetUtilityPageIdentifiersInterface $getUtilityPageIdentifiers
      * @param MetadataPool $metadataPool
-     * @param AligentSitemapConfig $aligentSitemapConfig
+     * @param AligentSitemapConfigReaderInterface $aligentSitemapConfig
      * @param Page $page
      */
     public function __construct(
         private readonly GetUtilityPageIdentifiersInterface $getUtilityPageIdentifiers,
         private readonly MetadataPool $metadataPool,
-        private readonly AligentSitemapConfig $aligentSitemapConfig,
+        private readonly AligentSitemapConfigReaderInterface $aligentSitemapConfig,
         private readonly Page $page
     ) {
     }