Merge pull request #1662 from hydephp/strip-markdown-from-automatic-blog-post-descriptions

emmadesilva · web-flow · commit f669a1ada4b9 · 2024-04-14T15:04:48.000+02:00
Strip Markdown from automatic blog post descriptions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -29,6 +29,7 @@ This serves two purposes:
 ### Fixed
 - Fixed a bug where the sitemap and RSS feed generator commands did not work when the `_site/` directory was not present in https://github.com/hydephp/develop/pull/1654
 - Fixed extra newlines being written to console for failing build tasks in https://github.com/hydephp/develop/pull/1661
+- Markdown formatting will now be stripped when generating an automatic blog post description when none is set in https://github.com/hydephp/develop/pull/1662 (fixes https://github.com/hydephp/develop/issues/1634)
 - Realtime Compiler: Fixed responsive dashboard table issue in https://github.com/hydephp/develop/pull/1595
 
 ### Security
diff --git a/packages/framework/src/Framework/Factories/BlogPostDataFactory.php b/packages/framework/src/Framework/Factories/BlogPostDataFactory.php
@@ -5,6 +5,7 @@
 namespace Hyde\Framework\Factories;
 
 use Hyde\Framework\Factories\Concerns\CoreDataObject;
+use Hyde\Framework\Actions\ConvertsMarkdownToPlainText;
 use Hyde\Framework\Features\Blogging\Models\FeaturedImage;
 use Hyde\Framework\Features\Blogging\Models\PostAuthor;
 use Hyde\Markdown\Contracts\FrontMatter\BlogPostSchema;
@@ -72,7 +73,7 @@ public function toArray(): array
 
     protected function makeDescription(): string
     {
-        return $this->getMatter('description') ?? $this->getTruncatedMarkdown($this->markdown->body());
+        return $this->getMatter('description') ?? $this->makeDescriptionFromMarkdownBody();
     }
 
     protected function makeCategory(): ?string
@@ -107,6 +108,11 @@ protected function makeImage(): ?FeaturedImage
         return null;
     }
 
+    private function makeDescriptionFromMarkdownBody(): string
+    {
+        return $this->getTruncatedMarkdown($this->stripMarkdownFromBody($this->markdown->body()));
+    }
+
     private function getTruncatedMarkdown(string $markdown): string
     {
         if (strlen($markdown) >= 128) {
@@ -116,6 +122,11 @@ private function getTruncatedMarkdown(string $markdown): string
         return $markdown;
     }
 
+    private function stripMarkdownFromBody(string $body): string
+    {
+        return (new ConvertsMarkdownToPlainText($body))->execute();
+    }
+
     protected function getMatter(string $key): string|null|array
     {
         return $this->matter->get($key);
diff --git a/packages/framework/tests/Unit/Pages/MarkdownPostHelpersTest.php b/packages/framework/tests/Unit/Pages/MarkdownPostHelpersTest.php
@@ -49,4 +49,10 @@ public function testDynamicDescriptionIsTruncatedWhenLongerThan128Characters()
         $post = MarkdownPost::make('foo-bar', [], str_repeat('a', 128));
         $this->assertEquals(str_repeat('a', 125).'...', $post->description);
     }
+
+    public function testDynamicDescriptionStripsMarkdown()
+    {
+        $post = MarkdownPost::make('foo-bar', [], '## This is a **bold** description with [a link](https://example.com) and <code>more</code>');
+        $this->assertEquals('This is a bold description with a link and more', $post->description);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`namespace Hyde\Framework\Factories;`
`6`	`6`
`7`	`7`	`use Hyde\Framework\Factories\Concerns\CoreDataObject;`
	`8`	`+use Hyde\Framework\Actions\ConvertsMarkdownToPlainText;`
`8`	`9`	`use Hyde\Framework\Features\Blogging\Models\FeaturedImage;`
`9`	`10`	`use Hyde\Framework\Features\Blogging\Models\PostAuthor;`
`10`	`11`	`use Hyde\Markdown\Contracts\FrontMatter\BlogPostSchema;`
`@@ -72,7 +73,7 @@ public function toArray(): array`
`72`	`73`
`73`	`74`	`protected function makeDescription(): string`
`74`	`75`	`{`
`75`		`- return $this->getMatter('description') ?? $this->getTruncatedMarkdown($this->markdown->body());`
	`76`	`+ return $this->getMatter('description') ?? $this->makeDescriptionFromMarkdownBody();`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`protected function makeCategory(): ?string`
`@@ -107,6 +108,11 @@ protected function makeImage(): ?FeaturedImage`
`107`	`108`	`return null;`
`108`	`109`	`}`
`109`	`110`
	`111`	`+ private function makeDescriptionFromMarkdownBody(): string`
	`112`	`+ {`
	`113`	`+ return $this->getTruncatedMarkdown($this->stripMarkdownFromBody($this->markdown->body()));`
	`114`	`+ }`
	`115`	`+`
`110`	`116`	`private function getTruncatedMarkdown(string $markdown): string`
`111`	`117`	`{`
`112`	`118`	`if (strlen($markdown) >= 128) {`
`@@ -116,6 +122,11 @@ private function getTruncatedMarkdown(string $markdown): string`
`116`	`122`	`return $markdown;`
`117`	`123`	`}`
`118`	`124`
	`125`	`+ private function stripMarkdownFromBody(string $body): string`
	`126`	`+ {`
	`127`	`+ return (new ConvertsMarkdownToPlainText($body))->execute();`
	`128`	`+ }`
	`129`	`+`
`119`	`130`	`protected function getMatter(string $key): string\|null\|array`
`120`	`131`	`{`
`121`	`132`	`return $this->matter->get($key);`
Original file line number	Diff line number	Diff line change
`@@ -49,4 +49,10 @@ public function testDynamicDescriptionIsTruncatedWhenLongerThan128Characters()`
`49`	`49`	`$post = MarkdownPost::make('foo-bar', [], str_repeat('a', 128));`
`50`	`50`	`$this->assertEquals(str_repeat('a', 125).'...', $post->description);`
`51`	`51`	`}`
	`52`	`+`
	`53`	`+ public function testDynamicDescriptionStripsMarkdown()`
	`54`	`+ {`
	`55`	`+ $post = MarkdownPost::make('foo-bar', [], '## This is a bold description with [a link](https://example.com) and <code>more</code>');`
	`56`	`+ $this->assertEquals('This is a bold description with a link and more', $post->description);`
	`57`	`+ }`
`52`	`58`	`}`