Improve exception templates and replace methods to properties

Author: SerafimArts

src/Exception/Definition/DefinitionException.php

@@ -17,7 +17,10 @@ abstract class DefinitionException extends \InvalidArgumentException implements
     public readonly Template $template;
 
     public function __construct(
-        protected readonly TypeStatement $type,
+        /**
+         * Gets the type statement whose definition caused the error.
+         */
+        public readonly TypeStatement $type,
         string $template,
         int $code = 0,
         ?\Throwable $previous = null,
@@ -28,16 +31,6 @@ public function __construct(
         $this->message = $this->template = new Template($template, $this);
     }
 
-    /**
-     * Returns the type statement whose definition caused the error.
-     *
-     * @api
-     */
-    public function getType(): TypeStatement
-    {
-        return $this->type;
-    }
-
     /**
      * @api
      *

src/Exception/Definition/PropertyTypeNotFoundException.php

@@ -8,13 +8,15 @@
 
 class PropertyTypeNotFoundException extends TypeNotFoundException
 {
-    /**
-     * @param class-string $class
-     * @param non-empty-string $property
-     */
     public function __construct(
-        protected readonly string $class,
-        protected readonly string $property,
+        /**
+         * @var class-string
+         */
+        public readonly string $class,
+        /**
+         * @var non-empty-string
+         */
+        public readonly string $property,
         TypeStatement $type,
         string $template,
         int $code = 0,
@@ -44,24 +46,4 @@ class: $class,
             previous: $previous,
         );
     }
-
-    /**
-     * @api
-     *
-     * @return class-string
-     */
-    public function getClass(): string
-    {
-        return $this->class;
-    }
-
-    /**
-     * @api
-     *
-     * @return non-empty-string
-     */
-    public function getProperty(): string
-    {
-        return $this->property;
-    }
 }

src/Exception/Definition/Shape/ShapeFieldException.php

@@ -13,20 +13,12 @@
 abstract class ShapeFieldException extends ShapeFieldsException
 {
     public function __construct(
-        protected readonly FieldNode $field,
+        public readonly FieldNode $field,
         TypeStatement $type,
         string $template,
         int $code = 0,
         ?\Throwable $previous = null,
     ) {
         parent::__construct($type, $template, $code, $previous);
     }
-
-    /**
-     * @api
-     */
-    public function getField(): FieldNode
-    {
-        return $this->field;
-    }
 }

src/Exception/Definition/Template/Hint/TemplateArgumentHintException.php

@@ -13,7 +13,7 @@
  */
 abstract class TemplateArgumentHintException extends TemplateArgumentHintsException
 {
-    protected readonly ?Identifier $hint;
+    public readonly ?Identifier $hint;
 
     public function __construct(
         TemplateArgumentNode $argument,
@@ -32,12 +32,4 @@ public function __construct(
             previous: $previous,
         );
     }
-
-    /**
-     * @api
-     */
-    public function findArgumentHint(): ?Identifier
-    {
-        return $this->hint;
-    }
 }

src/Exception/Definition/Template/InvalidTemplateArgumentException.php

@@ -12,14 +12,24 @@
  */
 class InvalidTemplateArgumentException extends TemplateArgumentException
 {
+    /**
+     * Gets the type statement that causes the error.
+     */
+    public TypeStatement $actual;
+
     public function __construct(
-        private readonly TypeStatement $expected,
+        /**
+         * Gets the type statement in which the error occurred.
+         */
+        public readonly TypeStatement $expected,
         TemplateArgumentNode $argument,
         TypeStatement $type,
         string $template,
         int $code = 0,
         ?\Throwable $previous = null,
     ) {
+        $this->actual = $argument->value;
+
         parent::__construct(
             argument: $argument,
             type: $type,
@@ -29,26 +39,6 @@ public function __construct(
         );
     }
 
-    /**
-     * Returns the type statement that causes the error.
-     *
-     * @api
-     */
-    public function getActualType(): TypeStatement
-    {
-        return $this->argument->value;
-    }
-
-    /**
-     * Returns the type statement in which the error occurred.
-     *
-     * @api
-     */
-    public function getExpectedType(): TypeStatement
-    {
-        return $this->expected;
-    }
-
     public static function becauseTemplateArgumentIsInvalid(
         TypeStatement $expected,
         TemplateArgumentNode $argument,

src/Exception/Definition/Template/MissingTemplateArgumentsException.php

@@ -9,7 +9,7 @@
 /**
  * Occurs when a type requires more template arguments to be specified than required
  */
-class MissingTemplateArgumentsException extends TemplateArgumentsCountException
+class MissingTemplateArgumentsException extends TemplateArgumentsRangeException
 {
     /**
      * @param int<0, max> $minSupportedArgumentsCount

src/Exception/Definition/Template/TemplateArgumentException.php

@@ -16,10 +16,10 @@ abstract class TemplateArgumentException extends TemplateArgumentsException
     /**
      * @var int<0, max>
      */
-    protected readonly int $index;
+    public readonly int $index;
 
     public function __construct(
-        protected readonly TemplateArgumentNode $argument,
+        public readonly TemplateArgumentNode $argument,
         TypeStatement $type,
         string $template,
         int $code = 0,
@@ -51,12 +51,4 @@ private static function fetchArgumentIndex(TemplateArgumentNode $argument, TypeS
 
         return $index;
     }
-
-    /**
-     * @api
-     */
-    public function getArgument(): TemplateArgumentNode
-    {
-        return $this->argument;
-    }
 }

src/Exception/Definition/Template/TemplateArgumentsCountException.php

@@ -9,7 +9,7 @@
 /**
  * Occurs when a type does not support template arguments
  */
-class TemplateArgumentsNotSupportedException extends TemplateArgumentsCountException
+class TemplateArgumentsNotSupportedException extends TemplateArgumentsRangeException
 {
     public static function becauseTemplateArgumentsNotSupported(
         NamedTypeNode $type,

src/Exception/Definition/Template/TemplateArgumentsNotSupportedException.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Exception\Definition\Template;
+
+use TypeLang\Parser\Node\Stmt\NamedTypeNode;
+
+/**
+ * Group of errors related to incorrect number of template arguments
+ */
+abstract class TemplateArgumentsRangeException extends TemplateArgumentsException
+{
+    public function __construct(
+        /**
+         * @var int<0, max>
+         */
+        public readonly int $passedArgumentsCount,
+        /**
+         * @var int<0, max>
+         */
+        public readonly int $minSupportedArgumentsCount,
+        /**
+         * @var int<0, max>
+         */
+        public readonly int $maxSupportedArgumentsCount,
+        NamedTypeNode $type,
+        string $template,
+        int $code = 0,
+        ?\Throwable $previous = null
+    ) {
+        parent::__construct(
+            type: $type,
+            template: $template,
+            code: $code,
+            previous: $previous,
+        );
+    }
+}