Merge pull request #17 from 8fold/partials

joshbruce · web-flow · commit 82311022c8b3 · 2023-05-15T15:51:46.000-04:00
add: CommonMark partials
diff --git a/composer.json b/composer.json
@@ -14,7 +14,8 @@
     "league/commonmark": "^2.0",
     "symfony/yaml": "^2.3 || ^3.0 || ^4.0 || ^5.0 || ^6.0",
     "8fold/commonmark-abbreviations": "^1.2 || ^2.1",
-    "8fold/commonmark-accessible-heading-permalinks": "^1.0"
+    "8fold/commonmark-accessible-heading-permalinks": "^1.0",
+    "8fold/commonmark-partials": "^1.0"
   },
   "require-dev": {
     "phpstan/phpstan": "^1.2.0",
diff --git a/composer.lock b/composer.lock
diff --git a/src/Markdown.php b/src/Markdown.php
@@ -10,6 +10,7 @@
 use Eightfold\CommonMarkAbbreviations\AbbreviationExtension as Abbreviations;
 use Eightfold\CommonMarkAccessibleHeadingPermalink\HeadingPermalinkExtension
     as HeadingPermalink;
+use Eightfold\CommonMarkPartials\PartialsExtension as Partials;
 
 class Markdown extends FluentCommonMark
 {
@@ -74,7 +75,7 @@ public function abbreviations(): Markdown
     }
 
     /**
-     * @param  array<string, mixed> $config [description]
+     * @param  array<string, mixed> $config
      */
     public function accessibleHeadingPermalinks(array $config = []): Markdown
     {
@@ -86,4 +87,18 @@ public function accessibleHeadingPermalinks(array $config = []): Markdown
             $config
         )->addExtension(new HeadingPermalink());
     }
+
+    /**
+     * @param  array<string, mixed> $config
+     */
+    public function partials(array $config = []): Markdown
+    {
+        if (count($config) === 0) {
+            return $this;
+        }
+        return $this->addExtensionWithConfig(
+            'partials',
+            $config
+        )->addExtension(new Partials());
+    }
 }
diff --git a/tests/MarkdownBaselineTest.php b/tests/MarkdownBaselineTest.php
@@ -149,4 +149,43 @@ public function can_use_accessible_heading_permalinks(): void // phpcs:ignore
 
         $this->assertSame($expected, $result);
     }
+
+    /**
+     * @test
+     */
+    public function can_use_partials(): void // phpcs: ignore
+    {
+        $expected = <<<html
+        <p>This was created by a partial</p>
+
+        html;
+
+        $result = Markdown::create()->partials([
+            'partials' => [
+                'inject' => 'Eightfold\Markdown\Tests\Mocks\PartialMarkdown'
+            ]
+        ])->convert(<<<md
+            {!! inject !!}
+            md
+        );
+
+        $this->assertSame($expected, $result);
+
+        $expected = <<<html
+        <h1>This was created by a partial</h1>
+
+        html;
+
+        $result = Markdown::create()->withConfig(['html_input' => 'allow'])
+            ->partials([
+                'partials' => [
+                    'inject' => 'Eightfold\Markdown\Tests\Mocks\PartialHtml'
+                ]
+            ])->convert(<<<md
+                {!! inject !!}
+                md
+            );
+
+        $this->assertSame($expected, $result);
+    }
 }
diff --git a/tests/Mocks/PartialHtml.php b/tests/Mocks/PartialHtml.php
@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace Eightfold\Markdown\Tests\Mocks;
+
+use Eightfold\CommonMarkPartials\PartialInterface;
+
+use Eightfold\CommonMarkPartials\PartialInput;
+
+class PartialHtml implements PartialInterface
+{
+    public function __invoke(PartialInput $input, array $extras = []): string
+    {
+        return '<h1>This was created by a partial</h1>';
+    }
+}
diff --git a/tests/Mocks/PartialMarkdown.php b/tests/Mocks/PartialMarkdown.php
@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace Eightfold\Markdown\Tests\Mocks;
+
+use Eightfold\CommonMarkPartials\PartialInterface;
+
+use Eightfold\CommonMarkPartials\PartialInput;
+
+class PartialMarkdown implements PartialInterface
+{
+    public function __invoke(PartialInput $input, array $extras = []): string
+    {
+        return 'This was created by a partial';
+    }
+}
