chore: use named constructor for exceptions in AbstractBaseType class

brotkrueml · Feb 20, 2025 · be6b0a3 · be6b0a3
1 parent 0a31871
commit be6b0a3
Show file tree

Hide file tree

Showing 8 changed files with 203 additions and 30 deletions.
diff --git a/Classes/Core/Exception/InvalidIdValueException.php b/Classes/Core/Exception/InvalidIdValueException.php
@@ -0,0 +1,26 @@
+<?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\Core\Exception;
+
+final class InvalidIdValueException extends \InvalidArgumentException
+{
+    public static function fromValueType(string $valueType): self
+    {
+        return new self(
+            \sprintf(
+                'Value for id has not a valid data type (given: "%s"). Valid types are: null, string, instanceof NodeIdentifierInterface',
+                $valueType,
+            ),
+            1620654936,
+        );
+    }
+}
diff --git a/Classes/Core/Exception/InvalidPropertyValueException.php b/Classes/Core/Exception/InvalidPropertyValueException.php
@@ -0,0 +1,27 @@
+<?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\Core\Exception;
+
+final class InvalidPropertyValueException extends \InvalidArgumentException
+{
+    public static function fromValueType(string $propertyName, string $propertyValueType): self
+    {
+        return new self(
+            \sprintf(
+                'Value for property "%s" has not a valid data type (given: "%s"). Valid types are: null, string, int, array, bool, instanceof TypeInterface, instanceof NodeIdentifierInterface',
+                $propertyName,
+                $propertyValueType,
+            ),
+            1561830012,
+        );
+    }
+}
diff --git a/Classes/Core/Exception/UnknownPropertyException.php b/Classes/Core/Exception/UnknownPropertyException.php
@@ -0,0 +1,30 @@
+<?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\Core\Exception;
+
+final class UnknownPropertyException extends \DomainException
+{
+    /**
+     * @param string|string[] $type
+     */
+    public static function fromPropertyName(string|array $type, string $propertyName): self
+    {
+        return new self(
+            \sprintf(
+                'Property "%s" is unknown for type "%s"',
+                $propertyName,
+                \is_array($type) ? \implode(' / ', $type) : $type,
+            ),
+            1561829996,
+        );
+    }
+}
diff --git a/Classes/Core/Model/AbstractBaseType.php b/Classes/Core/Model/AbstractBaseType.php
@@ -11,6 +11,10 @@
 
 namespace Brotkrueml\Schema\Core\Model;
 
+use Brotkrueml\Schema\Core\Exception\InvalidIdValueException;
+use Brotkrueml\Schema\Core\Exception\InvalidPropertyValueException;
+use Brotkrueml\Schema\Core\Exception\UnknownPropertyException;
+
 /**
  * This class provides the logic for both, a single type and a multiple type.
  * It is not for use in custom extensions. Use AbstractType instead.
@@ -37,13 +41,7 @@ abstract class AbstractBaseType implements TypeInterface
     public function setId($id): static
     {
         if (! $this->isValidDataTypeForId($id)) {
-            throw new \InvalidArgumentException(
-                \sprintf(
-                    'Value for id has not a valid data type (given: "%s"). Valid types are: null, string, instanceof NodeIdentifierInterface',
-                    \get_debug_type($id),
-                ),
-                1620654936,
-            );
+            throw InvalidIdValueException::fromValueType(\get_debug_type($id));
         }
 
         if ($id === '') {
@@ -95,15 +93,7 @@ public function getProperty(string $propertyName): mixed
     private function checkPropertyExists(string $propertyName): void
     {
         if (! \array_key_exists($propertyName, $this->properties)) {
-            $type = $this->getType();
-            throw new \DomainException(
-                \sprintf(
-                    'Property "%s" is unknown for type "%s"',
-                    $propertyName,
-                    \is_array($type) ? \implode(' / ', $type) : $type,
-                ),
-                1561829996,
-            );
+            throw UnknownPropertyException::fromPropertyName($this->getType(), $propertyName);
         }
     }
 
@@ -141,14 +131,7 @@ private function checkProperty(string $propertyName, mixed $propertyValue): void
         $this->checkPropertyExists($propertyName);
 
         if (! $this->isValidDataTypeForPropertyValue($propertyValue)) {
-            throw new \InvalidArgumentException(
-                \sprintf(
-                    'Value for property "%s" has not a valid data type (given: "%s"). Valid types are: null, string, int, array, bool, instanceof TypeInterface, instanceof NodeIdentifierInterface',
-                    $propertyName,
-                    \get_debug_type($propertyValue),
-                ),
-                1561830012,
-            );
+            throw InvalidPropertyValueException::fromValueType($propertyName, \get_debug_type($propertyValue));
         }
     }
 

diff --git a/Tests/Unit/Core/Exception/InvalidIdValueExceptionTest.php b/Tests/Unit/Core/Exception/InvalidIdValueExceptionTest.php
@@ -0,0 +1,33 @@
+<?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\Tests\Unit\Core\Exception;
+
+use Brotkrueml\Schema\Core\Exception\InvalidIdValueException;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(InvalidIdValueException::class)]
+final class InvalidIdValueExceptionTest extends TestCase
+{
+    #[Test]
+    public function fromDebugType(): void
+    {
+        $actual = InvalidIdValueException::fromValueType('invalid_type');
+
+        self::assertSame(
+            'Value for id has not a valid data type (given: "invalid_type"). Valid types are: null, string, instanceof NodeIdentifierInterface',
+            $actual->getMessage(),
+        );
+        self::assertSame(1620654936, $actual->getCode());
+    }
+}
diff --git a/Tests/Unit/Core/Exception/InvalidPropertyValueExceptionTest.php b/Tests/Unit/Core/Exception/InvalidPropertyValueExceptionTest.php
@@ -0,0 +1,33 @@
+<?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\Tests\Unit\Core\Exception;
+
+use Brotkrueml\Schema\Core\Exception\InvalidPropertyValueException;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(InvalidPropertyValueException::class)]
+final class InvalidPropertyValueExceptionTest extends TestCase
+{
+    #[Test]
+    public function fromValueType(): void
+    {
+        $actual = InvalidPropertyValueException::fromValueType('someProperty', 'invalid_type');
+
+        self::assertSame(
+            'Value for property "someProperty" has not a valid data type (given: "invalid_type"). Valid types are: null, string, int, array, bool, instanceof TypeInterface, instanceof NodeIdentifierInterface',
+            $actual->getMessage(),
+        );
+        self::assertSame(1561830012, $actual->getCode());
+    }
+}
diff --git a/Tests/Unit/Core/Exception/UnknownPropertyExceptionTest.php b/Tests/Unit/Core/Exception/UnknownPropertyExceptionTest.php
@@ -0,0 +1,39 @@
+<?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\Tests\Unit\Core\Exception;
+
+use Brotkrueml\Schema\Core\Exception\UnknownPropertyException;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(UnknownPropertyException::class)]
+final class UnknownPropertyExceptionTest extends TestCase
+{
+    #[Test]
+    public function fromPropertyNameWithTypeAsString(): void
+    {
+        $actual = UnknownPropertyException::fromPropertyName('SomeType', 'someProperty');
+
+        self::assertSame('Property "someProperty" is unknown for type "SomeType"', $actual->getMessage());
+        self::assertSame(1561829996, $actual->getCode());
+    }
+
+    #[Test]
+    public function fromPropertyNameWithTypeAsArray(): void
+    {
+        $actual = UnknownPropertyException::fromPropertyName(['SomeType', 'AnotherType'], 'someProperty');
+
+        self::assertSame('Property "someProperty" is unknown for type "SomeType / AnotherType"', $actual->getMessage());
+        self::assertSame(1561829996, $actual->getCode());
+    }
+}
diff --git a/Tests/Unit/Core/Model/AbstractTypeTest.php b/Tests/Unit/Core/Model/AbstractTypeTest.php
@@ -11,6 +11,9 @@
 
 namespace Brotkrueml\Schema\Tests\Unit\Core\Model;
 
+use Brotkrueml\Schema\Core\Exception\InvalidIdValueException;
+use Brotkrueml\Schema\Core\Exception\InvalidPropertyValueException;
+use Brotkrueml\Schema\Core\Exception\UnknownPropertyException;
 use Brotkrueml\Schema\Core\Model\AbstractType;
 use Brotkrueml\Schema\Core\Model\EnumerationInterface;
 use Brotkrueml\Schema\Core\Model\NodeIdentifierInterface;
@@ -110,9 +113,8 @@ public function getId(): ?string
     #[Test]
     public function setIdThrowsExceptionWhenInvalidTypeGiven(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidIdValueException::class);
         $this->expectExceptionCode(1620654936);
-        $this->expectExceptionMessage('Value for id has not a valid data type (given: "bool"). Valid types are: null, string, instanceof NodeIdentifierInterface');
 
         $this->subject->setId(true);
     }
@@ -169,7 +171,7 @@ public function canonical(): string
     #[Test]
     public function setPropertyThrowsDomainExceptionIfPropertyNameNotValid(): void
     {
-        $this->expectException(\DomainException::class);
+        $this->expectException(UnknownPropertyException::class);
         $this->expectExceptionCode(1561829996);
 
         $this->subject->setProperty('invalidProperty', 'some value');
@@ -178,7 +180,7 @@ public function setPropertyThrowsDomainExceptionIfPropertyNameNotValid(): void
     #[Test]
     public function setPropertyThrowsInvalidArgumentExceptionIfPropertyNotValid(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidPropertyValueException::class);
         $this->expectExceptionCode(1561830012);
 
         $this->subject->setProperty('image', new \stdClass());
@@ -205,7 +207,7 @@ public function getPropertyReturnsCorrectValue(): void
     #[Test]
     public function getPropertyThrowsDomainExceptionIfPropertyNameDoesNotExist(): void
     {
-        $this->expectException(\DomainException::class);
+        $this->expectException(UnknownPropertyException::class);
         $this->expectExceptionCode(1561829996);
 
         $this->subject->getProperty('invalidPropertyName');
@@ -383,7 +385,7 @@ public function clearPropertySetsValueToNull(): void
     #[Test]
     public function clearPropertyThrowsDomainExceptionIfPropertyNameDoesNotExist(): void
     {
-        $this->expectException(\DomainException::class);
+        $this->expectException(UnknownPropertyException::class);
         $this->expectExceptionCode(1561829996);
 
         $this->subject->clearProperty('invalidPropertyName');