Merge pull request #127 from hydephp/refine-markdown-document-classes

Refine markdown document classes

Author: caendesilva

CHANGELOG.md

@@ -23,6 +23,7 @@ This serves two purposes:
 
 ### Added
 - Added Hyde::makeTitle() helper, an improved version of Hyde::titleFromSlug()
+- Added new helper method render() to MarkdownDocuments to compile the Markdown to HTML, fixes https://github.com/hydephp/develop/issues/109
 
 ### Changed
 - Update default HydeFront version to v1.12.x

packages/framework/src/Contracts/AbstractMarkdownPage.php

@@ -19,7 +19,7 @@
  *
  * @test \Hyde\Framework\Testing\Feature\AbstractPageTest
  */
-abstract class AbstractMarkdownPage extends AbstractPage
+abstract class AbstractMarkdownPage extends AbstractPage implements MarkdownPageContract
 {
     use HasDynamicTitle;
 

packages/framework/src/Contracts/MarkdownDocumentContract.php

@@ -8,7 +8,51 @@ interface MarkdownDocumentContract
      * Construct the class.
      *
      * @param  array  $matter  The parsed front matter.
-     * @param  string  $body  The parsed markdown body.
+     * @param  string  $body  The parsed Markdown body.
      */
     public function __construct(array $matter = [], string $body = '');
+
+    /**
+     * Get the front matter property for the specified key, or null if it does not exist.
+     *
+     * @param  string  $key
+     */
+    public function __get(string $key);
+
+    /**
+     * Get the Markdown body.
+     *
+     * @return string
+     */
+    public function __toString(): string;
+
+    /**
+     * Get all the front matter as an array, or the property if a key is specified,
+     * falling back to the supplied default return value if the key is not found.
+     *
+     * @param  string|null  $key
+     * @param  mixed|null  $default
+     * @return mixed|null
+     */
+    public function matter(string $key = null, mixed $default = null): mixed;
+
+    /**
+     * Get the Markdown body.
+     *
+     * @return string
+     */
+    public function body(): string;
+
+    /**
+     * Render the Markdown body into HTML.
+     */
+    public function render(): string;
+
+    /**
+     * Parse a Markdown file and return a new MarkdownDocument instance.
+     *
+     * @param  string  $localFilepath
+     * @return static<MarkdownDocumentContract>
+     */
+    public static function parseFile(string $localFilepath): static;
 }

packages/framework/src/Contracts/MarkdownPageContract.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Hyde\Framework\Contracts;
+
+use Hyde\Framework\Models\MarkdownDocument;
+
+interface MarkdownPageContract
+{
+    /**
+     * Get the page's Markdown Document object.
+     *
+     * @return \Hyde\Framework\Models\MarkdownDocument
+     */
+    public function markdown(): MarkdownDocument;
+}

packages/framework/src/Models/MarkdownDocument.php

@@ -2,6 +2,7 @@
 
 namespace Hyde\Framework\Models;
 
+use Hyde\Framework\Actions\MarkdownConverter;
 use Hyde\Framework\Contracts\MarkdownDocumentContract;
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Services\MarkdownFileService;
@@ -21,12 +22,17 @@ public function __construct(array $matter = [], string $body = '')
         $this->body = $body;
     }
 
-    public function __get(string $key)
+    public function __toString(): string
+    {
+        return $this->body;
+    }
+
+    public function __get(string $key): mixed
     {
         return $this->matter($key);
     }
 
-    public function matter(string $key = null, $default = null)
+    public function matter(string $key = null, mixed $default = null): mixed
     {
         if ($key) {
             return Arr::get($this->matter, $key, $default);
@@ -40,6 +46,11 @@ public function body(): string
         return $this->body;
     }
 
+    public function render(): string
+    {
+        return MarkdownConverter::parse($this->body);
+    }
+
     public static function parseFile(string $localFilepath): static
     {
         return (new MarkdownFileService(Hyde::path($localFilepath)))->get();

packages/framework/tests/Unit/MarkdownDocumentTest.php

@@ -42,6 +42,12 @@ public function test_magic_get_method_returns_null_if_property_does_not_exist()
         $this->assertNull($document->bar);
     }
 
+    public function test_magic_to_string_method_returns_body()
+    {
+        $document = new MarkdownDocument(['foo' => 'bar'], 'Hello, world!');
+        $this->assertEquals('Hello, world!', (string) $document);
+    }
+
     public function test_matter_method_returns_empty_array_if_document_has_no_matter()
     {
         $document = new MarkdownDocument();
@@ -84,6 +90,12 @@ public function test_body_method_returns_document_body()
         $this->assertEquals('Hello, world!', $document->body());
     }
 
+    public function test_render_method_returns_rendered_html()
+    {
+        $document = new MarkdownDocument([], 'Hello, world!');
+        $this->assertEquals("<p>Hello, world!</p>\n", $document->render());
+    }
+
     public function test_parse_file_method_parses_a_file_using_the_markdown_file_service()
     {
         file_put_contents('_pages/foo.md', 'Hello, world!');