feat: add custom markdown renderers

Author: mariosimao

src/Blocks/Renderer/MarkdownRenderer.php

@@ -12,14 +12,51 @@ public static function render(BlockInterface ...$blocks): string
     {
         $markdown = "";
         foreach ($blocks as $block) {
-            $markdown = $markdown . self::renderBlock($block) . "\n";
+            $markdown = $markdown . self::renderBlock($block, 0) . "\n";
         }
 
         return $markdown;
     }
 
-    public static function renderBlock(BlockInterface $block, int $depth = 0): string
+    /**
+     * Render blocks with custom renderers.
+     *
+     * @param array<value-of<BlockType>, BlockRendererInterface> $overrides
+     * @param BlockInterface ...$blocks
+     *
+     * @return string
+     */
+    public static function renderWithOverrides(
+        array $overrides,
+        BlockInterface ...$blocks,
+    ): string {
+        $markdown = "";
+        foreach ($blocks as $block) {
+            $markdown = $markdown . self::renderBlock($block, 0, $overrides) . "\n";
+        }
+
+        return $markdown;
+    }
+
+    /**
+     * Undocumented function
+     *
+     * @param BlockInterface $block
+     * @param int $depth
+     * @param array<value-of<BlockType>, BlockRendererInterface> $overrides
+     *
+     * @return string
+     */
+    public static function renderBlock(
+        BlockInterface $block,
+        int $depth = 0,
+        array $overrides = []): string
     {
+        if (array_key_exists($block->metadata()->type->value, $overrides)) {
+            $renderer = $overrides[$block->metadata()->type->value];
+            return $renderer::render($block, $depth);
+        }
+
         return match ($block->metadata()->type) {
             BlockType::Bookmark         => Markdown\BookmarkRenderer::render($block, $depth),
             BlockType::Breadcrumb       => Markdown\BreadcrumbRenderer::render($block, $depth),

tests/Unit/Blocks/Renderer/MarkdownRendererTest.php

@@ -2,10 +2,12 @@
 
 namespace Notion\Test\Unit\Blocks\Renderer;
 
+use Notion\Blocks\BlockType;
 use Notion\Blocks\BulletedListItem;
 use Notion\Blocks\Heading1;
 use Notion\Blocks\Heading2;
 use Notion\Blocks\Paragraph;
+use Notion\Blocks\Renderer\Markdown\Heading1Renderer;
 use Notion\Blocks\Renderer\MarkdownRenderer;
 use PHPUnit\Framework\TestCase;
 
@@ -37,6 +39,35 @@ public function test_render(): void
 ## Mall
 - Black T-Shirt
 
+MARKDOWN;
+
+        $this->assertSame($expected, $markdown);
+    }
+
+    public function test_render_with_overrides(): void
+    {
+        $blocks = [
+            Heading1::fromString("Post title"),
+            Paragraph::fromString("My dummy post content."),
+        ];
+
+        $overrides = [
+            BlockType::Heading1->value => new class implements \Notion\Blocks\Renderer\BlockRendererInterface {
+                public static function render(\Notion\Blocks\BlockInterface $block, int $depth = 0): string
+                {
+                    $original = Heading1Renderer::render($block, $depth);
+                    return "{$original} (OVERRIDE)";
+                }
+            },
+        ];
+
+        $markdown = MarkdownRenderer::renderWithOverrides($overrides, ...$blocks);
+
+        $expected = <<<MARKDOWN
+# Post title (OVERRIDE)
+My dummy post content.
+
+
 MARKDOWN;
 
         $this->assertSame($expected, $markdown);