Merge pull request #155 from context-hub/maintenance/feature-tests

tests: added feature tests for document compiler

Author: butschster

src/Application/Kernel.php

@@ -33,7 +33,7 @@
 use Spiral\Boot\AbstractKernel;
 use Spiral\Boot\Exception\BootException;
 
-final class Kernel extends AbstractKernel
+class Kernel extends AbstractKernel
 {
     #[\Override]
     protected function defineSystemBootloaders(): array

src/Document/Compiler/DocumentCompiler.php

@@ -4,6 +4,7 @@
 
 namespace Butschster\ContextGenerator\Document\Compiler;
 
+use Butschster\ContextGenerator\Application\FSPath;
 use Butschster\ContextGenerator\Application\Logger\LoggerPrefix;
 use Butschster\ContextGenerator\Document\Compiler\Error\ErrorCollection;
 use Butschster\ContextGenerator\Document\Compiler\Error\SourceError;
@@ -50,7 +51,7 @@ public function compile(Document $document): CompiledDocument
         ]);
 
         $errors = new ErrorCollection();
-        $resultPath = \rtrim($this->basePath, '/') . '/' . \ltrim($outputPath, '/');
+        $resultPath = (string) FSPath::create($this->basePath)->join($outputPath);
 
         if (!$document->overwrite && $this->files->exists($resultPath)) {
             $this->logger?->notice('Document already exists and overwrite is disabled', [

src/Lib/Content/ContentBuilder.php

@@ -168,6 +168,6 @@ public function build(): string
 
     public function __toString(): string
     {
-        return $this->build();
+        return (string) \preg_replace("/(\r\n|\n)+$/", '', $this->build());
     }
 }

src/Lib/Content/Renderer/AbstractRenderer.php

@@ -20,7 +20,7 @@ public function renderContent(array $blocks): string
                 continue;
             }
 
-            $content .= $block->render($this);
+            $content .= \preg_replace("/(\r\n|\n)+$/", "\n", $block->render($this));
         }
 
         return $content;

tests/fixtures/Compiler/context.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json",
+  "documents": [
+    {
+      "description": "Project structure",
+      "outputPath": "structure.md",
+      "sources": [
+        {
+          "type": "tree",
+          "sourcePaths": [
+            "src"
+          ],
+          "showCharCount": true,
+          "showSize": true
+        }
+      ]
+    },
+    {
+      "description": "This is a test document",
+      "outputPath": "test-document.md",
+      "sources": [
+        {
+          "type": "file",
+          "sourcePaths": [
+            "src/dir1"
+          ],
+          "filePattern": "*.php"
+        },
+        {
+          "type": "text",
+          "content": "Foo Bar"
+        }
+      ]
+    },
+    {
+      "description": "This is a test document 1",
+      "outputPath": "test-document1.md",
+      "sources": [
+        {
+          "type": "file",
+          "sourcePaths": [
+            "src/dir2"
+          ],
+          "filePattern": "*.php"
+        },
+        {
+          "type": "text",
+          "content": "Foo Bar"
+        }
+      ]
+    },
+    {
+      "description": "This is a test document 2",
+      "outputPath": "test-document2.md",
+      "sources": [
+        {
+          "type": "file",
+          "sourcePaths": [
+            "src"
+          ],
+          "filePattern": "*.txt"
+        },
+        {
+          "type": "text",
+          "content": "Foo Bar"
+        }
+      ]
+    }
+  ]
+}

tests/fixtures/Compiler/context.yaml

@@ -0,0 +1,41 @@
+"$schema": https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json
+
+documents:
+  - description: Project structure
+    outputPath: structure.md
+    sources:
+      - type: tree
+        sourcePaths:
+          - src
+        showCharCount: true
+        showSize: true
+
+  - description: This is a test document
+    outputPath: test-document.md
+    sources:
+      - type: file
+        sourcePaths:
+          - src/dir1
+        filePattern: "*.php"
+      - type: text
+        content: Foo Bar
+
+  - description: This is a test document 1
+    outputPath: test-document1.md
+    sources:
+      - type: file
+        sourcePaths:
+          - src/dir2
+        filePattern: "*.php"
+      - type: text
+        content: Foo Bar
+
+  - description: This is a test document 2
+    outputPath: test-document2.md
+    sources:
+      - type: file
+        sourcePaths:
+          - src
+        filePattern: "*.txt"
+      - type: text
+        content: Foo Bar

tests/fixtures/Compiler/src/dir1/Test1Class.php

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+final readonly class Test1Class {}

tests/fixtures/Compiler/src/dir1/TestClass.php

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+final readonly class TestClass {}

tests/fixtures/Compiler/src/dir1/file.txt

@@ -0,0 +1 @@
+foo baf

tests/fixtures/Compiler/src/dir1/subdir1/Test3Class.php

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+final readonly class Test3Class {}