Merge pull request #325 from hydephp/improve-file-parsing

Handle complex parsing logic in new parser action hydephp/develop@c7f34a0

src/Actions/GeneratesDocumentationSearchIndexFile.php

@@ -63,7 +63,7 @@ public function generatePageObject(DocumentationPage $page): object
     {
         return (object) [
             'slug' => $page->slug,
-            'title' => trim($page->findTitleForDocument()),
+            'title' => $page->title,
             'content' => trim($this->getSearchContentForDocument($page)),
             'destination' => $this->getDestinationForSlug($page->slug),
         ];

src/Actions/SourceFileParser.php

@@ -5,8 +5,11 @@
 use Hyde\Framework\Concerns\ValidatesExistence;
 use Hyde\Framework\Contracts\AbstractMarkdownPage;
 use Hyde\Framework\Contracts\PageContract;
+use Hyde\Framework\Hyde;
 use Hyde\Framework\Models\Pages\BladePage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 use Hyde\Framework\Modules\Markdown\MarkdownFileParser;
+use Illuminate\Support\Str;
 
 /**
  * Parses a source file and returns a new page model instance for it.
@@ -28,10 +31,15 @@ class SourceFileParser
     public function __construct(string $pageClass, string $slug)
     {
         $this->validateExistence($pageClass, $slug);
-
         $this->slug = $slug;
 
-        $this->page = $pageClass === BladePage::class
+        $this->page = $this->constructBaseModel($pageClass);
+        $this->constructDynamicData();
+    }
+
+    protected function constructBaseModel(string $pageClass): BladePage|AbstractMarkdownPage
+    {
+        return $pageClass === BladePage::class
             ? $this->parseBladePage()
             : $this->parseMarkdownPage($pageClass);
     }
@@ -54,11 +62,54 @@ protected function parseMarkdownPage(string $pageClass): AbstractMarkdownPage
         return new $pageClass(
             matter: $matter,
             body: $body,
-            title: FindsTitleForDocument::get($this->slug, $matter, $body),
             slug: $this->slug
         );
     }
 
+    protected function constructDynamicData(): void
+    {
+        $this->page->title = $this->findTitleForPage();
+
+        if ($this->page instanceof DocumentationPage) {
+            $this->page->category = $this->getDocumentationPageCategory();
+        }
+    }
+
+    protected function findTitleForPage(): string
+    {
+        if ($this->page instanceof BladePage) {
+            return Hyde::makeTitle($this->slug);
+        }
+
+        if ($this->page->matter('title')) {
+            return $this->page->matter('title');
+        }
+
+        return $this->findTitleFromMarkdownHeadings() ?? Hyde::makeTitle($this->slug);
+    }
+
+    protected function findTitleFromMarkdownHeadings(): ?string
+    {
+        foreach ($this->page->markdown()->toArray() as $line) {
+            if (str_starts_with($line, '# ')) {
+                return trim(substr($line, 2), ' ');
+            }
+        }
+
+        return null;
+    }
+
+    protected function getDocumentationPageCategory(): ?string
+    {
+        // If the documentation page is in a subdirectory,
+        // then we can use that as the category name.
+        // Otherwise, we look in the front matter.
+
+        return str_contains($this->slug, '/')
+            ? Str::before($this->slug, '/')
+            : $this->page->matter('category');
+    }
+
     public function get(): PageContract
     {
         return $this->page;

src/Concerns/HasDynamicTitle.php

@@ -1,50 +1,3 @@
 <?php
 
 namespace Hyde\Framework\Concerns;
-
-use Hyde\Framework\Hyde;
-
-/**
- * Find and get the title to use for a Markdown Document.
- *
- * First check the front matter for a title. If one is not found,
- * it searches the Markdown for a level one heading. Falls back to
- * generating a title from the slug if no other title could be found.
- *
- * @deprecated Move to action to generate when constructing a page.
- */
-trait HasDynamicTitle
-{
-    public function constructDynamicTitle(): void
-    {
-        if (! isset($this->title) || $this->title === '') {
-            $this->title = $this->findTitleForDocument();
-        }
-    }
-
-    public function findTitleForDocument(): string
-    {
-        if (isset($this->matter['title'])) {
-            return $this->matter['title'];
-        }
-
-        return $this->findTitleTagInMarkdown($this->body)
-            ?: Hyde::makeTitle($this->slug);
-    }
-
-    /**
-     * Attempt to find the title based on the first H1 tag.
-     */
-    protected function findTitleTagInMarkdown(string $stream): string|false
-    {
-        $lines = explode("\n", $stream);
-
-        foreach ($lines as $line) {
-            if (str_starts_with($line, '# ')) {
-                return trim(substr($line, 2), ' ');
-            }
-        }
-
-        return false;
-    }
-}

src/Contracts/AbstractMarkdownPage.php

@@ -2,7 +2,6 @@
 
 namespace Hyde\Framework\Contracts;
 
-use Hyde\Framework\Concerns\HasDynamicTitle;
 use Hyde\Framework\Facades\Markdown;
 use Hyde\Framework\Models\MarkdownDocument;
 
@@ -22,8 +21,6 @@
  */
 abstract class AbstractMarkdownPage extends AbstractPage
 {
-    use HasDynamicTitle;
-
     public MarkdownDocument $markdown;
 
     public array $matter;
@@ -33,16 +30,14 @@ abstract class AbstractMarkdownPage extends AbstractPage
 
     public static string $fileExtension = '.md';
 
-    public function __construct(array $matter = [], string $body = '', string $title = '', string $slug = '', ?MarkdownDocument $markdownDocument = null)
+    public function __construct(array $matter = [], string $body = '', ?string $title = null, string $slug = '', ?MarkdownDocument $markdownDocument = null)
     {
         $this->matter = $matter;
         $this->body = $body;
-        $this->title = $title;
+        $this->title = $title ?? $matter['title'] ?? '';
         $this->slug = $slug;
 
         $this->markdown = $markdownDocument ?? new MarkdownDocument($matter, $body);
-
-        $this->constructDynamicTitle();
     }
 
     public function markdown(): MarkdownDocument

src/Models/Pages/DocumentationPage.php

@@ -6,7 +6,6 @@
 use Hyde\Framework\Contracts\AbstractMarkdownPage;
 use Hyde\Framework\Contracts\RouteContract;
 use Hyde\Framework\Models\Route;
-use Illuminate\Support\Str;
 
 class DocumentationPage extends AbstractMarkdownPage
 {
@@ -24,16 +23,6 @@ class DocumentationPage extends AbstractMarkdownPage
     public function __construct(array $matter = [], string $body = '', string $title = '', string $slug = '')
     {
         parent::__construct($matter, $body, $title, $slug);
-        $this->category = $this->getDocumentationPageCategory();
-    }
-
-    protected function getDocumentationPageCategory(): ?string
-    {
-        if (str_contains($this->slug, '/')) {
-            return Str::before($this->slug, '/');
-        }
-
-        return $this->matter['category'] ?? null;
     }
 
     /** @inheritDoc */

src/Services/RssFeedService.php

@@ -51,7 +51,7 @@ public function getXML(): string|false
     protected function addItem(MarkdownPost $post): void
     {
         $item = $this->feed->channel->addChild('item');
-        $item->addChild('title', $post->findTitleForDocument());
+        $item->addChild('title', $post->title);
         $item->addChild('link', $post->getCanonicalLink());
         $item->addChild('guid', $post->getCanonicalLink());
         $item->addChild('description', $post->getPostDescription());

tests/Feature/AbstractPageTest.php

@@ -2,7 +2,6 @@
 
 namespace Hyde\Framework\Testing\Feature;
 
-use Hyde\Framework\Concerns\HasDynamicTitle;
 use Hyde\Framework\Contracts\AbstractMarkdownPage;
 use Hyde\Framework\Contracts\AbstractPage;
 use Hyde\Framework\Contracts\PageContract;
@@ -86,7 +85,7 @@ public function test_all_returns_collection_of_all_source_files_parsed_into_the_
     {
         Hyde::touch(('_pages/foo.md'));
         $this->assertEquals(
-            collect([new MarkdownPage([], '', '', 'foo')]),
+            collect([new MarkdownPage([], '', 'Foo', 'foo')]),
             MarkdownPage::all()
         );
         unlink(Hyde::path('_pages/foo.md'));
@@ -237,11 +236,6 @@ public function test_abstract_markdown_page_implements_page_contract()
         $this->assertInstanceOf(PageContract::class, new class extends AbstractMarkdownPage {});
     }
 
-    public function test_abstract_markdown_page_uses_has_dynamic_title_trait()
-    {
-        $this->assertContains(HasDynamicTitle::class, class_uses_recursive(AbstractMarkdownPage::class));
-    }
-
     public function test_abstract_markdown_page_has_markdown_document_property()
     {
         $this->assertClassHasAttribute('markdown', AbstractMarkdownPage::class);

tests/Feature/SourceFileParserTest.php

@@ -3,6 +3,7 @@
 namespace Hyde\Framework\Testing\Feature;
 
 use Hyde\Framework\Actions\SourceFileParser;
+use Hyde\Framework\Hyde;
 use Hyde\Framework\Models\Pages\BladePage;
 use Hyde\Framework\Models\Pages\DocumentationPage;
 use Hyde\Framework\Models\Pages\MarkdownPage;
@@ -59,4 +60,48 @@ public function test_documentation_page_parser()
         $this->assertEquals('# Foo Bar', $page->body);
         $this->assertEquals('Foo Bar Baz', $page->title);
     }
+
+    public function test_dynamic_data_constructor_can_find_title_from_front_matter()
+    {
+        $this->markdown('_pages/foo.md', '# Foo Bar', ['title' => 'My Title']);
+        $page = MarkdownPage::parse('foo');
+        $this->assertEquals('My Title', $page->title);
+    }
+
+    public function test_dynamic_data_constructor_can_find_title_from_h1_tag()
+    {
+        $this->markdown('_pages/foo.md', '# Foo Bar');
+        $page = MarkdownPage::parse('foo');
+
+        $this->assertEquals('Foo Bar', $page->title);
+    }
+
+    public function test_dynamic_data_constructor_can_find_title_from_slug()
+    {
+        $this->markdown('_pages/foo-bar.md');
+        $page = MarkdownPage::parse('foo-bar');
+
+        $this->assertEquals('Foo Bar', $page->title);
+    }
+
+    public function test_documentation_page_parser_can_get_category_from_front_matter()
+    {
+        $this->markdown('_docs/foo.md', '# Foo Bar', ['category' => 'foo']);
+
+        $page = DocumentationPage::parse('foo');
+        $this->assertEquals('foo', $page->category);
+    }
+
+    public function test_documentation_page_parser_can_get_category_automatically_from_nested_page()
+    {
+        mkdir(Hyde::path('_docs/foo'));
+        touch(Hyde::path('_docs/foo/bar.md'));
+
+        /** @var DocumentationPage $page */
+        $page = DocumentationPage::parse('foo/bar');
+        $this->assertEquals('foo', $page->category);
+
+        unlink(Hyde::path('_docs/foo/bar.md'));
+        rmdir(Hyde::path('_docs/foo'));
+    }
 }

tests/Unit/DocumentationPageTest.php

@@ -2,7 +2,6 @@
 
 namespace Hyde\Framework\Testing\Unit;
 
-use Hyde\Framework\Actions\SourceFileParser;
 use Hyde\Framework\Hyde;
 use Hyde\Framework\HydeServiceProvider;
 use Hyde\Framework\Models\Pages\DocumentationPage;
@@ -129,30 +128,4 @@ public function test_compiled_pages_originating_in_subdirectories_get_output_to_
         $page = (new DocumentationPage([], '', '', 'foo/bar'));
         $this->assertEquals('docs/bar.html', $page->getOutputPath());
     }
-
-    public function test_documentation_page_parser_can_get_category_from_front_matter()
-    {
-        $this->markdown('_docs/foo.md', '# Foo Bar', ['category' => 'foo']);
-
-        $parser = new SourceFileParser(DocumentationPage::class, 'foo');
-
-        /** @var DocumentationPage $page */
-        $page = $parser->get();
-        $this->assertEquals('foo', $page->category);
-    }
-
-    public function test_documentation_page_parser_can_get_category_automatically_from_nested_page()
-    {
-        mkdir(Hyde::path('_docs/foo'));
-        touch(Hyde::path('_docs/foo/bar.md'));
-
-        $parser = new SourceFileParser(DocumentationPage::class, 'foo/bar');
-
-        /** @var DocumentationPage $page */
-        $page = $parser->get();
-        $this->assertEquals('foo', $page->category);
-
-        unlink(Hyde::path('_docs/foo/bar.md'));
-        rmdir(Hyde::path('_docs/foo'));
-    }
 }