Extract page type configurations from Filters

Signed-off-by: Anton Fedurtsya <[email protected]>

composer.json

@@ -36,8 +36,8 @@
         "phpcbf": "phpcbf --standard=tests/phpcs.xml",
         "phpstan": "phpstan -ctests/PhpStan/phpstan.neon analyse src/",
         "phpstan-report": "phpstan -ctests/PhpStan/phpstan.neon analyse src/ --error-format=json > phpstan.report.json",
-        "phpmd": "phpmd src text cleancode,codesize,design,naming,unusedcode",
-        "phpmd-report": "phpmd src json cleancode,codesize,design,naming,unusedcode --reportfile phpmd.report.json",
+        "phpmd": "phpmd src text cleancode,codesize,design,unusedcode",
+        "phpmd-report": "phpmd src json cleancode,codesize,design,unusedcode --reportfile phpmd.report.json",
         "static": [
             "@phpcs",
             "@phpstan",

services.yaml

@@ -1,6 +1,7 @@
 imports:
   - { resource: src/ChangeFilter/services.yaml }
   - { resource: src/Command/services.yaml }
+  - { resource: src/PageType/services.yaml }
   - { resource: src/Repository/services.yaml }
   - { resource: src/Service/services.yaml }
   - { resource: src/Settings/services.yaml }

src/ChangeFilter/CategoryChangeFilter.php

@@ -14,26 +14,11 @@
 
 class CategoryChangeFilter extends ChangeFilterTemplate implements ChangeFilterInterface
 {
-    public function getObjectType(): string
-    {
-        return 'category';
-    }
-
     protected function getModelClass(): string
     {
         return Category::class;
     }
 
-    protected function getChangeFrequency(): string
-    {
-        return 'daily';
-    }
-
-    protected function getPriority(): float
-    {
-        return 0.7;
-    }
-
     protected function filterAndQueryItems(int $limit): Result
     {
         $query = "SELECT c.OXID

src/ChangeFilter/ChangeFilterTemplate.php

@@ -14,6 +14,7 @@
 use Doctrine\DBAL\ForwardCompatibility\Result;
 use FreshAdvance\Sitemap\DataStructure\ObjectUrl;
 use FreshAdvance\Sitemap\DataStructure\PageUrl;
+use FreshAdvance\Sitemap\PageType\PageTypeConfigurationInterface;
 use OxidEsales\EshopCommunity\Core\Contract\IUrl;
 use OxidEsales\EshopCommunity\Core\Model\BaseModel;
 use OxidEsales\EshopCommunity\Internal\Framework\Database\ConnectionProviderInterface;
@@ -23,12 +24,16 @@ abstract class ChangeFilterTemplate
     protected Connection $connection;
 
     public function __construct(
-        ConnectionProviderInterface $connectionProvider
+        ConnectionProviderInterface $connectionProvider,
+        protected PageTypeConfigurationInterface $pageTypeConfiguration
     ) {
         $this->connection = $connectionProvider->get();
     }
 
-    abstract public function getObjectType(): string;
+    public function getObjectType(): string
+    {
+        return $this->pageTypeConfiguration->getObjectType();
+    }
 
     public function getUpdatedUrls(int $limit): iterable
     {
@@ -61,7 +66,13 @@ abstract protected function filterAndQueryItems(int $limit): Result;
      */
     abstract protected function getModelClass(): string;
 
-    abstract protected function getChangeFrequency(): string;
+    protected function getChangeFrequency(): string
+    {
+        return $this->pageTypeConfiguration->getChangeFrequency();
+    }
 
-    abstract protected function getPriority(): float;
+    protected function getPriority(): float
+    {
+        return $this->pageTypeConfiguration->getPriority();
+    }
 }

src/ChangeFilter/ContentChangeFilter.php

@@ -14,9 +14,9 @@
 
 class ContentChangeFilter extends ChangeFilterTemplate implements ChangeFilterInterface
 {
-    public function getObjectType(): string
+    protected function getModelClass(): string
     {
-        return 'content';
+        return Content::class;
     }
 
     protected function filterAndQueryItems(int $limit): Result
@@ -44,19 +44,4 @@ protected function filterAndQueryItems(int $limit): Result
 
         return $result;
     }
-
-    protected function getModelClass(): string
-    {
-        return Content::class;
-    }
-
-    protected function getChangeFrequency(): string
-    {
-        return 'weekly';
-    }
-
-    protected function getPriority(): float
-    {
-        return 0.3;
-    }
 }

src/ChangeFilter/ProductChangeFilter.php

@@ -14,9 +14,9 @@
 
 class ProductChangeFilter extends ChangeFilterTemplate implements ChangeFilterInterface
 {
-    public function getObjectType(): string
+    protected function getModelClass(): string
     {
-        return 'product';
+        return Article::class;
     }
 
     protected function filterAndQueryItems(int $limit): Result
@@ -42,19 +42,4 @@ protected function filterAndQueryItems(int $limit): Result
 
         return $result;
     }
-
-    protected function getModelClass(): string
-    {
-        return Article::class;
-    }
-
-    protected function getChangeFrequency(): string
-    {
-        return 'daily';
-    }
-
-    protected function getPriority(): float
-    {
-        return 0.5;
-    }
 }

src/ChangeFilter/services.yaml

@@ -10,13 +10,19 @@ services:
       $filters: !tagged 'sitemap.change_filter'
 
   FreshAdvance\Sitemap\ChangeFilter\ContentChangeFilter:
+    arguments:
+      $pageTypeConfiguration: '@FreshAdvance\Sitemap\PageType\ContentConfiguration'
     tags:
       - 'sitemap.change_filter'
 
   FreshAdvance\Sitemap\ChangeFilter\ProductChangeFilter:
+    arguments:
+      $pageTypeConfiguration: '@FreshAdvance\Sitemap\PageType\ProductConfiguration'
     tags:
       - 'sitemap.change_filter'
 
   FreshAdvance\Sitemap\ChangeFilter\CategoryChangeFilter:
+    arguments:
+      $pageTypeConfiguration: '@FreshAdvance\Sitemap\PageType\CategoryConfiguration'
     tags:
       - 'sitemap.change_filter'

src/Command/UpdateTypeCommand.php

@@ -9,6 +9,7 @@
 
 namespace FreshAdvance\Sitemap\Command;
 
+use FreshAdvance\Sitemap\ChangeFilter\FilterFactoryInterface;
 use FreshAdvance\Sitemap\Service\SynchronizerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -18,7 +19,8 @@
 class UpdateTypeCommand extends Command
 {
     public function __construct(
-        private SynchronizerInterface $synchronizer
+        protected SynchronizerInterface $synchronizer,
+        protected FilterFactoryInterface $filterFactory,
     ) {
         parent::__construct();
     }

src/Exception/PageTypeConfigurationFactorySetupException.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © MB Arbatos Klubas. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace FreshAdvance\Sitemap\Exception;
+
+class PageTypeConfigurationFactorySetupException extends \Exception
+{
+}

src/PageType/PageTypeConfiguration.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Copyright © MB Arbatos Klubas. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace FreshAdvance\Sitemap\PageType;
+
+class PageTypeConfiguration implements PageTypeConfigurationInterface
+{
+    public function __construct(
+        protected string $objectType,
+        protected string $changeFrequency,
+        protected float $priority
+    ) {
+    }
+
+    public function getObjectType(): string
+    {
+        return $this->objectType;
+    }
+
+    public function getChangeFrequency(): string
+    {
+        return $this->changeFrequency;
+    }
+
+    public function getPriority(): float
+    {
+        return $this->priority;
+    }
+}

src/PageType/PageTypeConfigurationFactory.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * Copyright © MB Arbatos Klubas. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace FreshAdvance\Sitemap\PageType;
+
+use FreshAdvance\Sitemap\Exception\PageTypeConfigurationFactorySetupException;
+
+class PageTypeConfigurationFactory implements PageTypeConfigurationFactoryInterface
+{
+    protected array $configurations = [];
+
+    /**
+     * @param iterable<PageTypeConfigurationInterface> $configurations
+     * @throws PageTypeConfigurationFactorySetupException
+     */
+    public function __construct(
+        iterable $configurations,
+        protected PageTypeConfigurationInterface $defaultConfiguration
+    ) {
+        foreach ($configurations as $oneConfiguration) {
+            if (!$oneConfiguration instanceof PageTypeConfigurationInterface) {
+                throw new PageTypeConfigurationFactorySetupException();
+            }
+
+            $this->configurations[$oneConfiguration->getObjectType()] = $oneConfiguration;
+        }
+    }
+
+    public function getConfiguration(string $string): PageTypeConfigurationInterface
+    {
+        return $this->configurations[$string] ?? $this->defaultConfiguration;
+    }
+}

src/PageType/PageTypeConfigurationFactoryInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Copyright © MB Arbatos Klubas. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace FreshAdvance\Sitemap\PageType;
+
+interface PageTypeConfigurationFactoryInterface
+{
+    public function getConfiguration(string $string): PageTypeConfigurationInterface;
+}

src/PageType/PageTypeConfigurationInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Copyright © MB Arbatos Klubas. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace FreshAdvance\Sitemap\PageType;
+
+interface PageTypeConfigurationInterface
+{
+    public function getObjectType(): string;
+
+    public function getChangeFrequency(): string;
+
+    public function getPriority(): float;
+}

src/PageType/services.yaml

@@ -0,0 +1,45 @@
+services:
+
+  _defaults:
+    public: false
+    autowire: true
+
+  FreshAdvance\Sitemap\PageType\PageTypeConfigurationFactoryInterface:
+    class: FreshAdvance\Sitemap\PageType\PageTypeConfigurationFactory
+    arguments:
+      $configurations: !tagged 'sitemap.page_type_configuration'
+      $defaultConfiguration: '@FreshAdvance\Sitemap\PageType\DefaultConfiguration'
+
+  FreshAdvance\Sitemap\PageType\DefaultConfiguration:
+    class: FreshAdvance\Sitemap\PageType\PageTypeConfiguration
+    arguments:
+      $objectType: 'default'
+      $changeFrequency: 'daily'
+      $priority: 0.5
+
+  FreshAdvance\Sitemap\PageType\ProductConfiguration:
+    class: FreshAdvance\Sitemap\PageType\PageTypeConfiguration
+    arguments:
+      $objectType: 'product'
+      $changeFrequency: 'daily'
+      $priority: 0.4
+    tags:
+      - 'sitemap.page_type_configuration'
+
+  FreshAdvance\Sitemap\PageType\CategoryConfiguration:
+    class: FreshAdvance\Sitemap\PageType\PageTypeConfiguration
+    arguments:
+      $objectType: 'category'
+      $changeFrequency: 'daily'
+      $priority: 0.7
+    tags:
+      - 'sitemap.page_type_configuration'
+
+  FreshAdvance\Sitemap\PageType\ContentConfiguration:
+    class: FreshAdvance\Sitemap\PageType\PageTypeConfiguration
+    arguments:
+      $objectType: 'content'
+      $changeFrequency: 'weekly'
+      $priority: 0.3
+    tags:
+      - 'sitemap.page_type_configuration'

tests/Integration/ChangeFilter/ProductChangeFilterTest.php

@@ -64,6 +64,6 @@ protected function checkCurrentUrlItem(ObjectUrlInterface $objectUrl, string $va
         $this->assertSame('http://localhost.local/' . $value . '.html', $url->getLocation());
         $this->assertNotEmpty($url->getLastModified());
         $this->assertSame('daily', $url->getChangeFrequency());
-        $this->assertSame(0.5, $url->getPriority());
+        $this->assertSame(0.4, $url->getPriority());
     }
 }

tests/Integration/Command/UpdateTypeCommandTest.php

@@ -9,6 +9,7 @@
 
 namespace Command;
 
+use FreshAdvance\Sitemap\ChangeFilter\FilterFactoryInterface;
 use FreshAdvance\Sitemap\Command\UpdateTypeCommand;
 use FreshAdvance\Sitemap\Service\Synchronizer;
 use Symfony\Component\Console\Tester\CommandTester;
@@ -21,7 +22,8 @@ class UpdateTypeCommandTest extends \PHPUnit\Framework\TestCase
     public function testUpdateTypeUrls(): void
     {
         $command = new UpdateTypeCommand(
-            synchronizer: $dataSynchronizerMock = $this->createMock(Synchronizer::class)
+            synchronizer: $dataSynchronizerMock = $this->createMock(Synchronizer::class),
+            filterFactory: $filterFactoryMock = $this->createMock(FilterFactoryInterface::class),
         );
 
         $dataSynchronizerMock->expects($this->once())->method('updateTypeUrls')->with('someType');