[TASK] Extract UserTsConfigGenerator into own service

Author: nhovratov

Classes/EventListener/AddUserTsConfig.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\ContentBlocks\EventListener;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use TYPO3\CMS\ContentBlocks\Generator\UserTsConfigGenerator;
+use TYPO3\CMS\Core\Attribute\AsEventListener;
+use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
+use TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
+use TYPO3\CMS\Core\TypoScript\IncludeTree\Event\BeforeLoadedUserTsConfigEvent;
+
+readonly class AddUserTsConfig
+{
+    public function __construct(
+        /** @var PhpFrontend */
+        #[Autowire(service: 'cache.core')]
+        protected FrontendInterface $cache,
+        protected UserTsConfigGenerator $userTsConfigGenerator,
+    ) {
+    }
+
+    #[AsEventListener(identifier: 'content-blocks-user-ts-config')]
+    public function __invoke(BeforeLoadedUserTsConfigEvent $event): void
+    {
+        $userTsConfig = $this->create();
+        $event->addTsConfig($userTsConfig);
+    }
+
+    protected function create(): string
+    {
+        $typoScriptFromCache = $this->cache->require('ContentBlocks_UserTsConfig');
+        if ($typoScriptFromCache !== false) {
+            return $typoScriptFromCache;
+        }
+        $userTsConfig = $this->userTsConfigGenerator->generate();
+        $this->cache->set('ContentBlocks_UserTsConfig', 'return ' . var_export($userTsConfig, true) . ';');
+        return $userTsConfig;
+    }
+}

Classes/Generator/UserTsConfigGenerator.php

@@ -17,41 +17,19 @@
 
 namespace TYPO3\CMS\ContentBlocks\Generator;
 
-use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use TYPO3\CMS\ContentBlocks\Definition\ContentType\PageTypeDefinition;
 use TYPO3\CMS\ContentBlocks\Definition\TableDefinitionCollection;
-use TYPO3\CMS\Core\Attribute\AsEventListener;
-use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
-use TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
-use TYPO3\CMS\Core\TypoScript\IncludeTree\Event\BeforeLoadedUserTsConfigEvent;
 
+/**
+ * @internal Not part of TYPO3's public API.
+ */
 readonly class UserTsConfigGenerator
 {
     public function __construct(
-        /** @var PhpFrontend */
-        #[Autowire(service: 'cache.core')]
-        protected FrontendInterface $cache,
         protected TableDefinitionCollection $tableDefinitionCollection,
     ) {}
 
-    #[AsEventListener(identifier: 'content-blocks-user-ts-config')]
-    public function __invoke(BeforeLoadedUserTsConfigEvent $event): void
-    {
-        $userTsConfig = $this->create();
-        $concatenatedTypoScript = implode(LF, $userTsConfig);
-        $event->addTsConfig($concatenatedTypoScript);
-    }
-
-    protected function create(): array
-    {
-        $typoScriptFromCache = $this->cache->require('ContentBlocks_UserTsConfig');
-        if ($typoScriptFromCache !== false) {
-            return $typoScriptFromCache;
-        }
-        return $this->createUncached();
-    }
-
-    protected function createUncached(): array
+    public function generate(): string
     {
         $userTsConfig = [];
         foreach ($this->tableDefinitionCollection as $tableDefinition) {
@@ -62,7 +40,7 @@ protected function createUncached(): array
                 }
             }
         }
-        $this->cache->set('ContentBlocks_UserTsConfig', 'return ' . var_export($userTsConfig, true) . ';');
-        return $userTsConfig;
+        $concatenatedTypoScript = implode(LF, $userTsConfig);
+        return $concatenatedTypoScript;
     }
 }

Tests/Functional/Generator/UserTsConfigGeneratorTest.php

@@ -32,13 +32,10 @@ class UserTsConfigGeneratorTest extends FunctionalTestCase
     #[Test]
     public function userTsConfigIsGenerated(): void
     {
+        /** @var UserTsConfigGenerator $userTsConfigGenerator */
         $userTsConfigGenerator = $this->get(UserTsConfigGenerator::class);
-        $beforeLoadedUserTsConfigEvent = new BeforeLoadedUserTsConfigEvent();
-
-        $userTsConfigGenerator->__invoke($beforeLoadedUserTsConfigEvent);
-
-        $expected = ['options.pageTree.doktypesToShowInNewPageDragArea := addToList(942)'];
-        $result = $beforeLoadedUserTsConfigEvent->getTsConfig();
+        $result = $userTsConfigGenerator->generate();
+        $expected = 'options.pageTree.doktypesToShowInNewPageDragArea := addToList(942)';
         self::assertSame($expected, $result);
     }
 }