Improve serialization logic

Author: Kirill Nesmeyanov

src/Exception/ParseException.php

@@ -4,6 +4,8 @@
 
 namespace TypeLang\Parser\Exception;
 
+use Phplrt\Contracts\Source\SourceExceptionInterface;
+
 class ParseException extends \LogicException implements ParserExceptionInterface
 {
     final public const ERROR_CODE_UNEXPECTED_TOKEN = 0x01;
@@ -28,6 +30,7 @@ final public function __construct(string $message, int $code = 0, ?\Throwable $p
      * unexpected source location.
      *
      * @param int<0, max> $offset
+     * @throws SourceExceptionInterface
      */
     public static function fromUnexpectedToken(string $char, string $statement, int $offset): static
     {
@@ -44,6 +47,7 @@ public static function fromUnexpectedToken(string $char, string $statement, int
      * This error occurs when unable to recognize tokens in source code.
      *
      * @param int<0, max> $offset
+     * @throws SourceExceptionInterface
      */
     public static function fromUnrecognizedToken(string $token, string $statement, int $offset): static
     {
@@ -58,6 +62,7 @@ public static function fromUnrecognizedToken(string $token, string $statement, i
 
     /**
      * @param int<0, max> $offset
+     * @throws SourceExceptionInterface
      */
     public static function fromUnrecognizedSyntaxError(string $statement, int $offset): static
     {
@@ -71,6 +76,7 @@ public static function fromUnrecognizedSyntaxError(string $statement, int $offse
 
     /**
      * @param int<0, max> $offset
+     * @throws SourceExceptionInterface
      */
     public static function fromSemanticError(string $message, string $statement, int $offset, int $code = 0): static
     {

src/Node/Identifier.php

@@ -128,4 +128,20 @@ public function jsonSerialize(): string
     {
         return $this->toString();
     }
+
+    public function __serialize(): array
+    {
+        return [$this->offset, $this->value];
+    }
+
+    public function __unserialize(array $data): void
+    {
+        $this->offset = $data[0] ?? throw new \UnexpectedValueException(
+            message: 'Unable to unserialize Identifier offset',
+        );
+
+        $this->value = $data[1] ?? throw new \UnexpectedValueException(
+            message: 'Unable to unserialize Identifier value',
+        );
+    }
 }

src/Node/Name.php

@@ -300,4 +300,20 @@ public function jsonSerialize(): string
     {
         return $this->toString();
     }
+
+    public function __serialize(): array
+    {
+        return [$this->offset, $this->parts];
+    }
+
+    public function __unserialize(array $data): void
+    {
+        $this->offset = $data[0] ?? throw new \UnexpectedValueException(
+            message: 'Unable to unserialize Name offset',
+        );
+
+        $this->parts = $data[1] ?? throw new \UnexpectedValueException(
+            message: 'Unable to unserialize Name identifier parts',
+        );
+    }
 }

src/Node/Stmt/ClassConstMaskNode.php

@@ -9,10 +9,17 @@
 
 class ClassConstMaskNode extends TypeStatement
 {
+    public ?Identifier $constant;
+
+    /**
+     * @param Identifier|non-empty-string|null $constant
+     */
     public function __construct(
         public Name $class,
-        public ?Identifier $constant = null,
-    ) {}
+        Identifier|string|null $constant = null,
+    ) {
+        $this->constant = \is_string($constant) ? new Identifier($constant) : $constant;
+    }
 
     public function toArray(): array
     {

src/Node/Stmt/ClassConstNode.php

@@ -9,7 +9,7 @@
 
 class ClassConstNode extends ClassConstMaskNode
 {
-    public function __construct(Name $class, Identifier $constant)
+    public function __construct(Name $class, Identifier|string $constant)
     {
         parent::__construct($class, $constant);
     }

src/Node/Stmt/GenericTypeStmt.php

@@ -23,4 +23,22 @@ public function toArray(): array
             'type' => $this->type->toArray(),
         ];
     }
+
+    public function __serialize(): array
+    {
+        return [$this->offset, $this->type];
+    }
+
+    public function __unserialize(array $data): void
+    {
+        $this->offset = $data[0] ?? throw new \UnexpectedValueException(\sprintf(
+            'Unable to unserialize %s offset',
+            static::class,
+        ));
+
+        $this->type = $data[1] ?? throw new \UnexpectedValueException(\sprintf(
+            'Unable to unserialize %s type',
+            static::class,
+        ));
+    }
 }

src/Node/Stmt/LogicalTypeNode.php

@@ -70,4 +70,22 @@ public function toArray(): array
             'items' => $items,
         ];
     }
+
+    public function __serialize(): array
+    {
+        return [$this->offset, $this->statements];
+    }
+
+    public function __unserialize(array $data): void
+    {
+        $this->offset = $data[0] ?? throw new \UnexpectedValueException(\sprintf(
+            'Unable to unserialize %s offset',
+            static::class,
+        ));
+
+        $this->statements = $data[1] ?? throw new \UnexpectedValueException(\sprintf(
+            'Unable to unserialize %s statements',
+            static::class,
+        ));
+    }
 }

src/Node/Stmt/NamedTypeNode.php

@@ -4,17 +4,25 @@
 
 namespace TypeLang\Parser\Node\Stmt;
 
+use TypeLang\Parser\Node\Identifier;
 use TypeLang\Parser\Node\Name;
 use TypeLang\Parser\Node\Stmt\Shape\FieldsListNode;
 use TypeLang\Parser\Node\Stmt\Template\ArgumentsListNode;
 
 class NamedTypeNode extends TypeStatement
 {
+    public Name $name;
+
+    /**
+     * @param Name|Identifier|non-empty-string $name
+     */
     public function __construct(
-        public Name $name,
+        Name|Identifier|string $name,
         public ?ArgumentsListNode $arguments = null,
         public ?FieldsListNode $fields = null,
-    ) {}
+    ) {
+        $this->name = $name instanceof Name ? $name : new Name($name);
+    }
 
     public function toArray(): array
     {

src/Node/Stmt/Shape/NamedFieldNode.php

@@ -9,11 +9,18 @@
 
 final class NamedFieldNode extends ExplicitFieldNode
 {
+    public Identifier $key;
+
+    /**
+     * @param Identifier|non-empty-string $key
+     */
     public function __construct(
-        public Identifier $key,
+        Identifier|string $key,
         TypeStatement $of,
         bool $optional = false,
     ) {
+        $this->key = \is_string($key) ? new Identifier($key) : $key;
+
         parent::__construct($of, $optional);
     }
 

src/Node/Stmt/Template/ArgumentNode.php

@@ -10,10 +10,17 @@
 
 class ArgumentNode extends Node
 {
+    public ?Identifier $hint;
+
+    /**
+     * @param Identifier|non-empty-string|null $hint
+     */
     public function __construct(
         public TypeStatement $value,
-        public ?Identifier $hint = null,
-    ) {}
+        Identifier|string|null $hint = null,
+    ) {
+        $this->hint = \is_string($hint) ? new Identifier($hint) : $hint;
+    }
 
     public function toArray(): array
     {