Add tests

Author: olaru

src/App/src/Factory/MarkdownExtensionFactory.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Factory;
+
+use Psr\Container\ContainerInterface;
+use Twig\Extra\Markdown\MarkdownExtension;
+
+class MarkdownExtensionFactory
+{
+    public function __invoke(ContainerInterface $container): MarkdownExtension
+    {
+        return new MarkdownExtension();
+    }
+}

src/App/src/Factory/MarkdownRuntimeLoaderFactory.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Factory;
+
+use League\CommonMark\GithubFlavoredMarkdownConverter;
+use Psr\Container\ContainerInterface;
+use Twig\Extra\Markdown\LeagueMarkdown;
+use Twig\Extra\Markdown\MarkdownRuntime;
+use Twig\RuntimeLoader\FactoryRuntimeLoader;
+use Twig\RuntimeLoader\RuntimeLoaderInterface;
+
+class MarkdownRuntimeLoaderFactory
+{
+    public function __invoke(ContainerInterface $container): RuntimeLoaderInterface
+    {
+        return new FactoryRuntimeLoader([
+            MarkdownRuntime::class => static fn (): MarkdownRuntime => new MarkdownRuntime(
+                new LeagueMarkdown(new GithubFlavoredMarkdownConverter())
+            ),
+        ]);
+    }
+}

src/App/src/Service/ArticleBodyCleaner.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Service;
+
+use function preg_replace;
+use function trim;
+
+/**
+ * Strips the leading `# Title` heading (already rendered separately from the article's DB
+ * title) and the `## TL;DR` section (an LLM-summary artifact, not meant for human display) from
+ * a Markdown article body.
+ */
+final class ArticleBodyCleaner
+{
+    public static function clean(string $body): string
+    {
+        $body = (string) preg_replace('/\A#[ \t][^\n]*\n/', '', $body, 1);
+        $body = (string) preg_replace('/^## TL;DR\s*$.*?(?=^## |\z)/ms', '', $body, 1);
+
+        return trim($body);
+    }
+}

src/App/src/Service/FaqExtractor.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Service;
+
+use function preg_match;
+use function preg_match_all;
+use function preg_replace;
+use function trim;
+
+use const PREG_SET_ORDER;
+
+/**
+ * Pulls the trailing `## FAQ` section (a `**Q: ...**` / `A: ...` pair per question) out of a
+ * Markdown article body, so it can be rendered as an accordion and fed into JSON-LD separately
+ * from the rest of the body.
+ */
+final class FaqExtractor
+{
+    /**
+     * @return array{faq: list<array{question: string, answer: string}>, body: string}
+     */
+    public static function extract(string $body): array
+    {
+        if (preg_match('/^## FAQ\s*$(.*)\z/ms', $body, $section, offset: 0) !== 1) {
+            return ['faq' => [], 'body' => $body];
+        }
+
+        $faq = [];
+        preg_match_all(
+            '/\*\*Q:\s*(.+?)\*\*\s*\n\s*A:\s*(.+?)(?=\n\s*\n|\z)/s',
+            $section[1],
+            $matches,
+            PREG_SET_ORDER
+        );
+        foreach ($matches as $match) {
+            $faq[] = [
+                'question' => trim($match[1]),
+                'answer'   => trim(preg_replace('/\s+/', ' ', $match[2]) ?? ''),
+            ];
+        }
+
+        $body = trim((string) preg_replace('/^## FAQ\s*$.*\z/ms', '', $body));
+
+        return ['faq' => $faq, 'body' => $body];
+    }
+}

src/App/src/Service/FrontMatter.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Service;
+
+use Symfony\Component\Yaml\Yaml;
+
+use function preg_match;
+use function trim;
+
+/**
+ * Splits a Markdown file's leading `---` YAML front matter block from its body.
+ */
+final class FrontMatter
+{
+    /**
+     * @return array{meta: array<string, mixed>, body: string}
+     */
+    public static function parse(string $raw): array
+    {
+        if (preg_match('/\A---\r?\n(.*?)\r?\n---\r?\n?(.*)\z/s', $raw, $matches) !== 1) {
+            return ['meta' => [], 'body' => trim($raw)];
+        }
+
+        /** @var array<string, mixed> $meta */
+        $meta = Yaml::parse($matches[1]) ?? [];
+
+        return ['meta' => $meta, 'body' => trim($matches[2])];
+    }
+}

src/Blog/templates/page/markdown-article.html.twig

@@ -0,0 +1,20 @@
+{% extends '@layout/blog-post.html.twig' %}
+
+{% block body %}
+{{ content|markdown_to_html }}
+
+{% if faq is not empty %}
+<h2 id="user-content-faq">Frequently Asked Questions</h2>
+
+<div class="faq-list">
+    {% for item in faq %}
+    <details class="acc"{% if loop.first %} open{% endif %}>
+        <summary>{{ item.question }} <span class="chev">+</span></summary>
+        <div class="acc-body">
+            <p class="mb-0">{{ item.answer }}</p>
+        </div>
+    </details>
+    {% endfor %}
+</div>
+{% endif %}
+{% endblock %}

test/Unit/App/Factory/MarkdownExtensionFactoryTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LightTest\Unit\App\Factory;
+
+use Light\App\Factory\MarkdownExtensionFactory;
+use LightTest\Unit\UnitTest;
+use PHPUnit\Framework\MockObject\Exception;
+use Psr\Container\ContainerInterface;
+use Twig\TwigFilter;
+
+use function array_map;
+
+class MarkdownExtensionFactoryTest extends UnitTest
+{
+    /**
+     * @throws Exception
+     */
+    public function testInvokeReturnsAMarkdownExtensionRegisteringTheMarkdownFilter(): void
+    {
+        $extension = (new MarkdownExtensionFactory())($this->createStub(ContainerInterface::class));
+
+        $filterNames = array_map(
+            static fn (TwigFilter $filter): string => $filter->getName(),
+            $extension->getFilters()
+        );
+
+        $this->assertContains('markdown_to_html', $filterNames);
+    }
+}

test/Unit/App/Factory/MarkdownRuntimeLoaderFactoryTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LightTest\Unit\App\Factory;
+
+use Light\App\Factory\MarkdownRuntimeLoaderFactory;
+use LightTest\Unit\UnitTest;
+use PHPUnit\Framework\MockObject\Exception;
+use Psr\Container\ContainerInterface;
+use Twig\Extra\Markdown\MarkdownRuntime;
+
+class MarkdownRuntimeLoaderFactoryTest extends UnitTest
+{
+    /**
+     * @throws Exception
+     */
+    public function testInvokeReturnsALoaderThatResolvesTheMarkdownRuntime(): void
+    {
+        $loader = (new MarkdownRuntimeLoaderFactory())($this->createStub(ContainerInterface::class));
+
+        $this->assertInstanceOf(MarkdownRuntime::class, $loader->load(MarkdownRuntime::class));
+        $this->assertNull($loader->load('SomeUnknownRuntime'));
+    }
+}

test/Unit/App/Service/ArticleBodyCleanerTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LightTest\Unit\App\Service;
+
+use Light\App\Service\ArticleBodyCleaner;
+use LightTest\Unit\UnitTest;
+
+class ArticleBodyCleanerTest extends UnitTest
+{
+    public function testCleanStripsTheLeadingTitleAndTlDrSection(): void
+    {
+        $body = "# A Title\n\n## TL;DR\n\nA short summary.\n\n## First Section\n\nThe real content.";
+
+        $this->assertSame("## First Section\n\nThe real content.", ArticleBodyCleaner::clean($body));
+    }
+
+    public function testCleanOnlyStripsTheTitleWhenThereIsNoTlDrSection(): void
+    {
+        $body = "# A Title\n\n## First Section\n\nThe real content.";
+
+        $this->assertSame("## First Section\n\nThe real content.", ArticleBodyCleaner::clean($body));
+    }
+}

test/Unit/App/Service/FaqExtractorTest.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LightTest\Unit\App\Service;
+
+use Light\App\Service\FaqExtractor;
+use LightTest\Unit\UnitTest;
+
+class FaqExtractorTest extends UnitTest
+{
+    public function testExtractPullsTheQuestionAnswerPairsOutOfTheFaqSection(): void
+    {
+        $body = "Some intro text.\n\n## FAQ\n\n"
+            . "**Q: What is it?**\nA: It's an example.\n\n"
+            . "**Q: Why does it matter?**\nA: Because tests need coverage.";
+
+        $result = FaqExtractor::extract($body);
+
+        $this->assertSame('Some intro text.', $result['body']);
+        $this->assertSame(
+            [
+                ['question' => 'What is it?', 'answer' => "It's an example."],
+                ['question' => 'Why does it matter?', 'answer' => 'Because tests need coverage.'],
+            ],
+            $result['faq']
+        );
+    }
+
+    public function testExtractReturnsAnEmptyFaqWhenThereIsNoFaqSection(): void
+    {
+        $body = "Some intro text.\n\nMore content.";
+
+        $result = FaqExtractor::extract($body);
+
+        $this->assertSame([], $result['faq']);
+        $this->assertSame($body, $result['body']);
+    }
+}