Code Coverage for /home/runner/work/develop/develop/packages/framework/src/Framework/Actions/MarkdownFileParser.php

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Hyde\Framework\Actions;
6
7	use Hyde\Facades\Filesystem;
8	use Hyde\Markdown\Models\MarkdownDocument;
9	use Spatie\YamlFrontMatter\YamlFrontMatter;
10
11	use function str_starts_with;
12
13	/**
14	* Prepares a Markdown file for further usage by extracting the Front Matter
15	* and Markdown body, and creating MarkdownDocument object from them.
16	*/
17	class MarkdownFileParser
18	{
19	/**
20	* @param string $path The path to the Markdown file tp parse.
21	* @return MarkdownDocument The processed Markdown file as a MarkdownDocument.
22	*/
23	public static function parse(string $path): MarkdownDocument
24	{
25	return (new static($path))->get();
26	}
27
28	/**
29	* The extracted Front Matter.
30	*/
31	protected array $matter = [];
32
33	/**
34	* The extracted Markdown body.
35	*/
36	protected string $markdown = '';
37
38	protected function __construct(string $path)
39	{
40	$stream = Filesystem::getContents($path);
41
42	// Check if the file has Front Matter.
43	if (str_starts_with($stream, '---')) {
44	$document = YamlFrontMatter::markdownCompatibleParse($stream);
45
46	if ($document->matter()) {
47	$this->matter = (array) $document->matter();
48	}
49
50	if ($document->body()) {
51	$this->markdown = $document->body();
52	}
53	} else {
54	$this->markdown = $stream;
55	}
56	}
57
58	protected function get(): MarkdownDocument
59	{
60	return new MarkdownDocument($this->matter, $this->markdown);
61	}
62	}