Implement flexible slot type transpilation

grebaldi · grebaldi · commit 9532b2add7c8 · 2022-11-18T18:57:52.000+01:00
diff --git a/src/Target/Php/Transpiler/ComponentDeclaration/ComponentDeclarationStrategyInterface.php b/src/Target/Php/Transpiler/ComponentDeclaration/ComponentDeclarationStrategyInterface.php
@@ -24,9 +24,11 @@
 
 use PackageFactory\ComponentEngine\Parser\Ast\ComponentDeclarationNode;
 use PackageFactory\ComponentEngine\Target\Php\TargetSpecific\ClassName;
+use PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference\TypeReferenceStrategyInterface;
 
 interface ComponentDeclarationStrategyInterface
 {
     public function getClassNameFor(ComponentDeclarationNode $componentDeclarationNode): ClassName;
     public function getBaseClassNameFor(ComponentDeclarationNode $componentDeclarationNode): ?ClassName;
+    public function getTypeReferenceStrategyFor(ComponentDeclarationNode $componentDeclarationNode): TypeReferenceStrategyInterface;
 }
diff --git a/src/Target/Php/Transpiler/ComponentDeclaration/ComponentDeclarationTranspiler.php b/src/Target/Php/Transpiler/ComponentDeclaration/ComponentDeclarationTranspiler.php
@@ -72,7 +72,7 @@ public function transpile(ComponentDeclarationNode $componentDeclarationNode): s
 
         if (!$componentDeclarationNode->propertyDeclarations->isEmpty()) {
             $lines[] = '    public function __construct(';
-            $lines[] = $this->writeConstructorPropertyDeclarations($componentDeclarationNode->propertyDeclarations);
+            $lines[] = $this->writeConstructorPropertyDeclarations($componentDeclarationNode);
             $lines[] = '    ) {';
             $lines[] = '    }';
             $lines[] = '';
@@ -88,9 +88,13 @@ public function transpile(ComponentDeclarationNode $componentDeclarationNode): s
         return join("\n", $lines);
     }
 
-    public function writeConstructorPropertyDeclarations(PropertyDeclarationNodes $propertyDeclarations): string
+    public function writeConstructorPropertyDeclarations(ComponentDeclarationNode $componentDeclarationNode): string
     {
-        $typeReferenceTranspiler = new TypeReferenceTranspiler();
+        $typeReferenceTranspiler = new TypeReferenceTranspiler(
+            scope: $this->scope,
+            strategy: $this->strategy->getTypeReferenceStrategyFor($componentDeclarationNode)
+        );
+        $propertyDeclarations = $componentDeclarationNode->propertyDeclarations;
         $lines = [];
 
         foreach ($propertyDeclarations->items as $propertyDeclaration) {
diff --git a/src/Target/Php/Transpiler/Module/ModuleTranspiler.php b/src/Target/Php/Transpiler/Module/ModuleTranspiler.php
@@ -59,6 +59,11 @@ public function transpile(ModuleNode $moduleNode): string
                     strategy: $this->strategy->getEnumDeclarationStrategyFor($moduleNode)
                 ))->transpile($exportNode->declaration),
                 StructDeclarationNode::class => (new StructDeclarationTranspiler(
+                    scope: new ModuleScope(
+                        loader: $this->loader,
+                        moduleNode: $moduleNode,
+                        parentScope: $this->globalScope
+                    ),
                     strategy: $this->strategy->getStructDeclarationStrategyFor($moduleNode)
                 ))->transpile($exportNode->declaration)
             };
diff --git a/src/Target/Php/Transpiler/StructDeclaration/StructDeclarationStrategyInterface.php b/src/Target/Php/Transpiler/StructDeclaration/StructDeclarationStrategyInterface.php
@@ -24,9 +24,11 @@
 
 use PackageFactory\ComponentEngine\Parser\Ast\StructDeclarationNode;
 use PackageFactory\ComponentEngine\Target\Php\TargetSpecific\ClassName;
+use PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference\TypeReferenceStrategyInterface;
 
 interface StructDeclarationStrategyInterface
 {
     public function getClassNameFor(StructDeclarationNode $structDeclarationNode): ClassName;
     public function getBaseClassNameFor(StructDeclarationNode $structDeclarationNode): ?ClassName;
+    public function getTypeReferenceStrategyFor(StructDeclarationNode $structDeclarationNode): TypeReferenceStrategyInterface;
 }
diff --git a/src/Target/Php/Transpiler/StructDeclaration/StructDeclarationTranspiler.php b/src/Target/Php/Transpiler/StructDeclaration/StructDeclarationTranspiler.php
@@ -23,12 +23,13 @@
 namespace PackageFactory\ComponentEngine\Target\Php\Transpiler\StructDeclaration;
 
 use PackageFactory\ComponentEngine\Parser\Ast\StructDeclarationNode;
-use PackageFactory\ComponentEngine\Parser\Ast\PropertyDeclarationNodes;
 use PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference\TypeReferenceTranspiler;
+use PackageFactory\ComponentEngine\TypeSystem\ScopeInterface;
 
 final class StructDeclarationTranspiler
 {
     public function __construct(
+        private readonly ScopeInterface $scope,
         private readonly StructDeclarationStrategyInterface $strategy
     ) {
     }
@@ -59,7 +60,7 @@ public function transpile(StructDeclarationNode $structDeclarationNode): string
 
         if (!$structDeclarationNode->propertyDeclarations->isEmpty()) {
             $lines[] = '    public function __construct(';
-            $lines[] = $this->writeConstructorPropertyDeclarations($structDeclarationNode->propertyDeclarations);
+            $lines[] = $this->writeConstructorPropertyDeclarations($structDeclarationNode);
             $lines[] = '    ) {';
             $lines[] = '    }';
         }
@@ -70,9 +71,13 @@ public function transpile(StructDeclarationNode $structDeclarationNode): string
         return join("\n", $lines);
     }
 
-    public function writeConstructorPropertyDeclarations(PropertyDeclarationNodes $propertyDeclarations): string
+    public function writeConstructorPropertyDeclarations(StructDeclarationNode $structDeclarationNode): string
     {
-        $typeReferenceTranspiler = new TypeReferenceTranspiler();
+        $typeReferenceTranspiler = new TypeReferenceTranspiler(
+            scope: $this->scope,
+            strategy: $this->strategy->getTypeReferenceStrategyFor($structDeclarationNode)
+        );
+        $propertyDeclarations = $structDeclarationNode->propertyDeclarations;
         $lines = [];
 
         foreach ($propertyDeclarations->items as $propertyDeclaration) {
diff --git a/src/Target/Php/Transpiler/TypeReference/TypeReferenceStrategyInterface.php b/src/Target/Php/Transpiler/TypeReference/TypeReferenceStrategyInterface.php
@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * PackageFactory.ComponentEngine - Universal View Components for PHP
+ *   Copyright (C) 2022 Contributors of PackageFactory.ComponentEngine
+ *
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference;
+
+use PackageFactory\ComponentEngine\Parser\Ast\TypeReferenceNode;
+use PackageFactory\ComponentEngine\TypeSystem\Type\ComponentType\ComponentType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\EnumType\EnumType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\SlotType\SlotType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\StructType\StructType;
+use PackageFactory\ComponentEngine\TypeSystem\TypeInterface;
+
+interface TypeReferenceStrategyInterface
+{
+    public function getPhpTypeReferenceForSlotType(SlotType $slotType, TypeReferenceNode $typeReferenceNode): string;
+    public function getPhpTypeReferenceForComponentType(ComponentType $componentType, TypeReferenceNode $typeReferenceNode): string;
+    public function getPhpTypeReferenceForEnumType(EnumType $enumType, TypeReferenceNode $typeReferenceNode): string;
+    public function getPhpTypeReferenceForStructType(StructType $structType, TypeReferenceNode $typeReferenceNode): string;
+    public function getPhpTypeReferenceForCustomType(TypeInterface $customType, TypeReferenceNode $typeReferenceNode): string;
+}
diff --git a/src/Target/Php/Transpiler/TypeReference/TypeReferenceTranspiler.php b/src/Target/Php/Transpiler/TypeReference/TypeReferenceTranspiler.php
@@ -23,16 +23,36 @@
 namespace PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference;
 
 use PackageFactory\ComponentEngine\Parser\Ast\TypeReferenceNode;
+use PackageFactory\ComponentEngine\TypeSystem\ScopeInterface;
+use PackageFactory\ComponentEngine\TypeSystem\Type\BooleanType\BooleanType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\ComponentType\ComponentType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\EnumType\EnumType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\NumberType\NumberType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\SlotType\SlotType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\StringType\StringType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\StructType\StructType;
 
 final class TypeReferenceTranspiler
 {
+    public function __construct(
+        private readonly ScopeInterface $scope,
+        private readonly TypeReferenceStrategyInterface $strategy
+    ) {
+    }
+
     public function transpile(TypeReferenceNode $typeReferenceNode): string
     {
-        return match ($typeReferenceNode->name) {
-            'number' => 'int|float',
-            'string' => 'string',
-            'boolean' => 'bool',
-            default => $typeReferenceNode->name
+        $type = $this->scope->resolveTypeReference($typeReferenceNode);
+
+        return match ($type::class) {
+            NumberType::class => 'int|float',
+            StringType::class => 'string',
+            BooleanType::class => 'bool',
+            SlotType::class => $this->strategy->getPhpTypeReferenceForSlotType($type, $typeReferenceNode),
+            ComponentType::class => $this->strategy->getPhpTypeReferenceForComponentType($type, $typeReferenceNode),
+            EnumType::class => $this->strategy->getPhpTypeReferenceForEnumType($type, $typeReferenceNode),
+            StructType::class => $this->strategy->getPhpTypeReferenceForStructType($type, $typeReferenceNode),
+            default => $this->strategy->getPhpTypeReferenceForCustomType($type, $typeReferenceNode)
         };
     }
 }
diff --git a/src/TypeSystem/Scope/GlobalScope/GlobalScope.php b/src/TypeSystem/Scope/GlobalScope/GlobalScope.php
@@ -27,6 +27,7 @@
 use PackageFactory\ComponentEngine\TypeSystem\ScopeInterface;
 use PackageFactory\ComponentEngine\TypeSystem\Type\BooleanType\BooleanType;
 use PackageFactory\ComponentEngine\TypeSystem\Type\NumberType\NumberType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\SlotType\SlotType;
 use PackageFactory\ComponentEngine\TypeSystem\Type\StringType\StringType;
 use PackageFactory\ComponentEngine\TypeSystem\TypeInterface;
 
@@ -54,6 +55,7 @@ public function resolveTypeReference(TypeReferenceNode $typeReferenceNode): Type
             'string' => StringType::get(),
             'number' => NumberType::get(),
             'boolean' => BooleanType::get(),
+            'slot' => SlotType::get(),
             default => throw new \Exception('@TODO: Unknown Type ' . $typeReferenceNode->name)
         };
     }
diff --git a/src/TypeSystem/Type/ComponentType/ComponentType.php b/src/TypeSystem/Type/ComponentType/ComponentType.php
@@ -27,9 +27,15 @@
 
 final class ComponentType implements TypeInterface
 {
+    private function __construct(public readonly string $componentName)
+    {
+    }
+
     public static function fromComponentDeclarationNode(ComponentDeclarationNode $componentDeclarationNode): self
     {
-        return new self();
+        return new self(
+            componentName: $componentDeclarationNode->componentName
+        );
     }
 
     public function is(TypeInterface $other): bool
diff --git a/src/TypeSystem/Type/EnumType/EnumStaticType.php b/src/TypeSystem/Type/EnumType/EnumStaticType.php
@@ -27,9 +27,15 @@
 
 final class EnumStaticType implements TypeInterface
 {
+    private function __construct(public readonly string $enumName)
+    {
+    }
+
     public static function fromEnumDeclarationNode(EnumDeclarationNode $enumDeclarationNode): self
     {
-        return new self();
+        return new self(
+            enumName: $enumDeclarationNode->enumName
+        );
     }
 
     public function is(TypeInterface $other): bool
diff --git a/src/TypeSystem/Type/EnumType/EnumType.php b/src/TypeSystem/Type/EnumType/EnumType.php
@@ -27,9 +27,15 @@
 
 final class EnumType implements TypeInterface
 {
+    private function __construct(public readonly string $enumName)
+    {
+    }
+
     public static function fromEnumDeclarationNode(EnumDeclarationNode $enumDeclarationNode): self
     {
-        return new self();
+        return new self(
+            enumName: $enumDeclarationNode->enumName
+        );
     }
 
     public function is(TypeInterface $other): bool
diff --git a/src/TypeSystem/Type/SlotType/SlotType.php b/src/TypeSystem/Type/SlotType/SlotType.php
@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * PackageFactory.ComponentEngine - Universal View Components for PHP
+ *   Copyright (C) 2022 Contributors of PackageFactory.ComponentEngine
+ *
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\ComponentEngine\TypeSystem\Type\SlotType;
+
+use PackageFactory\ComponentEngine\TypeSystem\TypeInterface;
+
+final class SlotType implements TypeInterface
+{
+    private static null|self $instance = null;
+
+    private function __construct()
+    {
+    }
+
+    public static function get(): self
+    {
+        return self::$instance ??= new self();
+    }
+
+    public function is(TypeInterface $other): bool
+    {
+        return $other === self::$instance;
+    }
+}
diff --git a/src/TypeSystem/Type/StructType/StructType.php b/src/TypeSystem/Type/StructType/StructType.php
@@ -27,9 +27,15 @@
 
 final class StructType implements TypeInterface
 {
+    private function __construct(public readonly string $structName)
+    {
+    }
+
     public static function fromStructDeclarationNode(StructDeclarationNode $structDeclarationNode): self
     {
-        return new self();
+        return new self(
+            structName: $structDeclarationNode->structName
+        );
     }
 
     public function is(TypeInterface $other): bool
diff --git a/test/Integration/Examples/ImportExport/ImportExport.php b/test/Integration/Examples/ImportExport/ImportExport.php
@@ -12,8 +12,8 @@ final class Card extends BaseClass
 {
     public function __construct(
         public readonly string $title,
-        public readonly Link $link,
-        public readonly Button $button
+        public readonly LinkStruct $link,
+        public readonly ButtonComponent $button
     ) {
     }
 
diff --git a/test/Integration/Examples/Match/Match.php b/test/Integration/Examples/Match/Match.php
@@ -9,8 +9,8 @@
 final class Button extends BaseClass
 {
     public function __construct(
-        public readonly ButtonType $type,
-        public readonly slot $content
+        public readonly ButtonTypeEnum $type,
+        public readonly SlotInterface $content
     ) {
     }
 
diff --git a/test/Integration/PhpTranspilerIntegrationTest.php b/test/Integration/PhpTranspilerIntegrationTest.php
@@ -34,6 +34,7 @@
 use PackageFactory\ComponentEngine\TypeSystem\Type\EnumType\EnumStaticType;
 use PackageFactory\ComponentEngine\TypeSystem\Type\EnumType\EnumType;
 use PackageFactory\ComponentEngine\TypeSystem\Type\NumberType\NumberType;
+use PackageFactory\ComponentEngine\TypeSystem\Type\SlotType\SlotType;
 use PackageFactory\ComponentEngine\TypeSystem\Type\StringType\StringType;
 use PHPUnit\Framework\TestCase;
 
@@ -84,7 +85,7 @@ public function testTranspiler(string $example): void
                 )
             ], [
                 'string' => StringType::get(),
-                'slot' => StringType::get(),
+                'slot' => SlotType::get(),
                 'number' => NumberType::get(),
                 'boolean' => BooleanType::get(),
                 'ButtonType' => EnumType::fromEnumDeclarationNode(
diff --git a/test/Unit/Target/Php/Transpiler/ComponentDeclaration/ComponentDeclarationTestStrategy.php b/test/Unit/Target/Php/Transpiler/ComponentDeclaration/ComponentDeclarationTestStrategy.php
@@ -25,6 +25,8 @@
 use PackageFactory\ComponentEngine\Parser\Ast\ComponentDeclarationNode;
 use PackageFactory\ComponentEngine\Target\Php\TargetSpecific\ClassName;
 use PackageFactory\ComponentEngine\Target\Php\Transpiler\ComponentDeclaration\ComponentDeclarationStrategyInterface;
+use PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference\TypeReferenceStrategyInterface;
+use PackageFactory\ComponentEngine\Test\Unit\Target\Php\Transpiler\TypeReference\TypeReferenceTestStrategy;
 
 final class ComponentDeclarationTestStrategy implements ComponentDeclarationStrategyInterface
 {
@@ -37,4 +39,9 @@ public function getBaseClassNameFor(ComponentDeclarationNode $componentDeclarati
     {
         return ClassName::fromString('Vendor\\Project\\BaseClass');
     }
-}
+
+    public function getTypeReferenceStrategyFor(ComponentDeclarationNode $componentDeclarationNode): TypeReferenceStrategyInterface
+    {
+        return new TypeReferenceTestStrategy();
+    }
+}
diff --git a/test/Unit/Target/Php/Transpiler/StructDeclaration/StructDeclarationTestStrategy.php b/test/Unit/Target/Php/Transpiler/StructDeclaration/StructDeclarationTestStrategy.php
@@ -25,6 +25,8 @@
 use PackageFactory\ComponentEngine\Parser\Ast\StructDeclarationNode;
 use PackageFactory\ComponentEngine\Target\Php\TargetSpecific\ClassName;
 use PackageFactory\ComponentEngine\Target\Php\Transpiler\StructDeclaration\StructDeclarationStrategyInterface;
+use PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference\TypeReferenceStrategyInterface;
+use PackageFactory\ComponentEngine\Test\Unit\Target\Php\Transpiler\TypeReference\TypeReferenceTestStrategy;
 
 final class StructDeclarationTestStrategy implements StructDeclarationStrategyInterface
 {
@@ -37,4 +39,9 @@ public function getBaseClassNameFor(StructDeclarationNode $structDeclarationNode
     {
         return ClassName::fromString('Vendor\\Project\\BaseClass');
     }
+
+    public function getTypeReferenceStrategyFor(StructDeclarationNode $structDeclarationNode): TypeReferenceStrategyInterface
+    {
+        return new TypeReferenceTestStrategy();
+    }
 }
diff --git a/test/Unit/Target/Php/Transpiler/StructDeclaration/StructDeclarationTranspilerTest.php b/test/Unit/Target/Php/Transpiler/StructDeclaration/StructDeclarationTranspilerTest.php
diff --git a/test/Unit/Target/Php/Transpiler/TypeReference/TypeReferenceTestStrategy.php b/test/Unit/Target/Php/Transpiler/TypeReference/TypeReferenceTestStrategy.php
diff --git a/test/Unit/Target/Php/Transpiler/TypeReference/TypeReferenceTranspilerTest.php b/test/Unit/Target/Php/Transpiler/TypeReference/TypeReferenceTranspilerTest.php
diff --git a/test/Unit/TypeSystem/Type/ComponentType/ComponentTypeTest.php b/test/Unit/TypeSystem/Type/ComponentType/ComponentTypeTest.php
diff --git a/test/Unit/TypeSystem/Type/EnumType/EnumStaticTypeTest.php b/test/Unit/TypeSystem/Type/EnumType/EnumStaticTypeTest.php
diff --git a/test/Unit/TypeSystem/Type/EnumType/EnumTypeTest.php b/test/Unit/TypeSystem/Type/EnumType/EnumTypeTest.php
diff --git a/test/Unit/TypeSystem/Type/SlotType/SlotTypeTest.php b/test/Unit/TypeSystem/Type/SlotType/SlotTypeTest.php
diff --git a/test/Unit/TypeSystem/Type/StructType/StructTypeTest.php b/test/Unit/TypeSystem/Type/StructType/StructTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,11 @@`
`24`	`24`
`25`	`25`	`use PackageFactory\ComponentEngine\Parser\Ast\ComponentDeclarationNode;`
`26`	`26`	`use PackageFactory\ComponentEngine\Target\Php\TargetSpecific\ClassName;`
	`27`	`+use PackageFactory\ComponentEngine\Target\Php\Transpiler\TypeReference\TypeReferenceStrategyInterface;`
`27`	`28`
`28`	`29`	`interface ComponentDeclarationStrategyInterface`
`29`	`30`	`{`
`30`	`31`	`public function getClassNameFor(ComponentDeclarationNode $componentDeclarationNode): ClassName;`
`31`	`32`	`public function getBaseClassNameFor(ComponentDeclarationNode $componentDeclarationNode): ?ClassName;`
	`33`	`+ public function getTypeReferenceStrategyFor(ComponentDeclarationNode $componentDeclarationNode): TypeReferenceStrategyInterface;`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,15 @@`
`27`	`27`
`28`	`28`	`final class ComponentType implements TypeInterface`
`29`	`29`	`{`
	`30`	`+ private function __construct(public readonly string $componentName)`
	`31`	`+ {`
	`32`	`+ }`
	`33`	`+`
`30`	`34`	`public static function fromComponentDeclarationNode(ComponentDeclarationNode $componentDeclarationNode): self`
`31`	`35`	`{`
`32`		`- return new self();`
	`36`	`+ return new self(`
	`37`	`+ componentName: $componentDeclarationNode->componentName`
	`38`	`+ );`
`33`	`39`	`}`
`34`	`40`
`35`	`41`	`public function is(TypeInterface $other): bool`