wip: introduce TypeFactorySubstitute

todo: - add unit tests - add documentation
brotkrueml · Feb 15, 2025 · c141e25 · c141e25
1 parent 42cf072
commit c141e25
Show file tree

Hide file tree

Showing 21 changed files with 123 additions and 36 deletions.
diff --git a/Classes/EventListener/AddBreadcrumbList.php b/Classes/EventListener/AddBreadcrumbList.php
@@ -14,7 +14,7 @@
 use Brotkrueml\Schema\Configuration\Configuration;
 use Brotkrueml\Schema\Core\Model\TypeInterface;
 use Brotkrueml\Schema\Event\RenderAdditionalTypesEvent;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 use TYPO3\CMS\Core\Domain\Repository\PageRepository;
 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
@@ -33,7 +33,7 @@ final class AddBreadcrumbList
     public function __construct(
         private readonly Configuration $configuration,
         private readonly ContentObjectRenderer $contentObjectRenderer,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function __invoke(RenderAdditionalTypesEvent $event): void

diff --git a/Classes/EventListener/AddWebPageType.php b/Classes/EventListener/AddWebPageType.php
@@ -13,7 +13,7 @@
 
 use Brotkrueml\Schema\Configuration\Configuration;
 use Brotkrueml\Schema\Event\RenderAdditionalTypesEvent;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
 /**
@@ -25,7 +25,7 @@ final class AddWebPageType
 
     public function __construct(
         private readonly Configuration $configuration,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function __invoke(RenderAdditionalTypesEvent $event): void

diff --git a/Classes/Testing/TypeFactorySubstitute.php b/Classes/Testing/TypeFactorySubstitute.php
@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the "schema" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace Brotkrueml\Schema\Testing;
+
+use Brotkrueml\Schema\Core\Model\MultipleType;
+use Brotkrueml\Schema\Core\Model\TypeInterface;
+use Brotkrueml\Schema\Type\ModelClassNotFoundException;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
+
+final class TypeFactorySubstitute implements TypeFactoryInterface
+{
+    /**
+     * @var array<string, TypeInterface>
+     */
+    private array $types = [];
+
+    public function addType(string $name, TypeInterface $class): void
+    {
+        $this->types[$name] = $class;
+    }
+
+    public function create(string ...$type): TypeInterface
+    {
+        if ($type === []) {
+            throw new \DomainException(
+                'At least one type has to be given as argument',
+                1621787452,
+            );
+        }
+
+        $type = \array_unique($type);
+        if (\count($type) === 1) {
+            return $this->createSingle($type[0]);
+        }
+
+        return $this->createMultiple($type);
+    }
+
+    private function createSingle($type): TypeInterface
+    {
+        if (isset($this->types[$type])) {
+            return $this->types[$type];
+        }
+
+        throw ModelClassNotFoundException::fromType($type);
+    }
+
+    /**
+     * @param list<string> $types
+     */
+    private function createMultiple(array $types): MultipleType
+    {
+        return new MultipleType(...\array_map(
+            fn(string $type): TypeInterface => $this->createSingle($type),
+            $types,
+        ));
+    }
+}
diff --git a/Classes/Type/TypeFactory.php b/Classes/Type/TypeFactory.php
@@ -15,7 +15,7 @@
 use Brotkrueml\Schema\Core\Model\TypeInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
-final class TypeFactory
+final class TypeFactory implements TypeFactoryInterface
 {
     public function create(string ...$type): TypeInterface
     {
@@ -60,7 +60,7 @@ private function createSingle(string $type): TypeInterface
     }
 
     /**
-     * @param string[] $types
+     * @param list<string> $types
      */
     private function createMultiple(array $types): MultipleType
     {

diff --git a/Classes/Type/TypeFactoryInterface.php b/Classes/Type/TypeFactoryInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the "schema" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace Brotkrueml\Schema\Type;
+
+use Brotkrueml\Schema\Core\Model\TypeInterface;
+
+interface TypeFactoryInterface
+{
+    public function create(string ...$type): TypeInterface;
+}
diff --git a/Configuration/Services.php b/Configuration/Services.php
@@ -40,6 +40,7 @@
 
     $excludes = [
         __DIR__ . '/../Classes/Extension.php',
+        __DIR__ . '/../Classes/Testing',
     ];
     if (! $builder->hasDefinition(AdminPanelConfigurationService::class)) {
         $excludes[] = __DIR__ . '/../Classes/AdminPanel';

diff --git a/Documentation/Developer/_Api/_MyController1.php b/Documentation/Developer/_Api/_MyController1.php
@@ -4,12 +4,12 @@
 
 namespace MyVendor\MyExtension\Controller;
 
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyController2.php b/Documentation/Developer/_Api/_MyController2.php
@@ -5,12 +5,12 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Model\Enumeration\GenderType;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyController3.php b/Documentation/Developer/_Api/_MyController3.php
@@ -4,12 +4,12 @@
 
 namespace MyVendor\MyExtension\Controller;
 
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyController4.php b/Documentation/Developer/_Api/_MyController4.php
@@ -4,12 +4,12 @@
 
 namespace MyVendor\MyExtension\Controller;
 
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyController5.php b/Documentation/Developer/_Api/_MyController5.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyControllerBlankNodeIdentifier.php b/Documentation/Developer/_Api/_MyControllerBlankNodeIdentifier.php
@@ -6,13 +6,13 @@
 
 use Brotkrueml\Schema\Core\Model\BlankNodeIdentifier;
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyControllerMultiple.php b/Documentation/Developer/_Api/_MyControllerMultiple.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Api/_MyControllerNodeIdentifier.php b/Documentation/Developer/_Api/_MyControllerNodeIdentifier.php
@@ -6,13 +6,13 @@
 
 use Brotkrueml\Schema\Core\Model\NodeIdentifier;
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Breadcrumb/_MyController.php b/Documentation/Developer/_Breadcrumb/_MyController.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function createBreadcrumb(array $breadcrumb): void

diff --git a/Documentation/Developer/_ExtendingVocabulary/_MyController.php b/Documentation/Developer/_ExtendingVocabulary/_MyController.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function createVirtualLocation(): void

diff --git a/Documentation/Developer/_Index/_MyController1.php b/Documentation/Developer/_Index/_MyController1.php
@@ -4,12 +4,12 @@
 
 namespace MyVendor\MyExtension\Controller;
 
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_Index/_MyController2.php b/Documentation/Developer/_Index/_MyController2.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_MainEntity/_MyController.php b/Documentation/Developer/_MainEntity/_MyController.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function addMainEntity(): void

diff --git a/Documentation/Developer/_WebPage/_MyController1.php b/Documentation/Developer/_WebPage/_MyController1.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void

diff --git a/Documentation/Developer/_WebPage/_MyController2.php b/Documentation/Developer/_WebPage/_MyController2.php
@@ -5,13 +5,13 @@
 namespace MyVendor\MyExtension\Controller;
 
 use Brotkrueml\Schema\Manager\SchemaManager;
-use Brotkrueml\Schema\Type\TypeFactory;
+use Brotkrueml\Schema\Type\TypeFactoryInterface;
 
 final class MyController
 {
     public function __construct(
         private readonly SchemaManager $schemaManager,
-        private readonly TypeFactory $typeFactory,
+        private readonly TypeFactoryInterface $typeFactory,
     ) {}
 
     public function doSomething(): void