Fix #419: Add meta links to the RSS feed

Author: caendesilva

src/Concerns/HasPageMetadata.php

@@ -5,6 +5,7 @@
 use Hyde\Framework\Helpers\Meta;
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Services\RssFeedService;
 
 /**
  * @see \Tests\Feature\Concerns\HasPageMetadataTest
@@ -24,8 +25,16 @@ public function getDynamicMetadata(): array
             $array[] = '<link rel="canonical" href="'.$this->getCanonicalUrl().'" />';
         }
 
+        if ($this->canUseRssFeedlink()) {
+            $array[] = '<link rel="alternate" type="application/rss+xml" title="'
+            .RssFeedService::getTitle()
+            .' RSS Feed" href="'
+            .Hyde::uriPath(RssFeedService::getDefaultOutputFilename())
+            .'" />';
+        }
+
         if ($this instanceof MarkdownPost) {
-            // Temporarly merge data with GeneratesPageMetadata trait for compatibility
+            // Temporarily merge data with GeneratesPageMetadata trait for compatibility
             $array[] = "\n<!-- Blog Post Meta Tags -->";
             foreach ($this->getMetadata() as $name => $content) {
                 $array[] = Meta::name($name, $content);
@@ -51,4 +60,24 @@ public function canUseCanonicalUrl(): bool
     {
         return Hyde::uriPath() && isset($this->slug);
     }
+
+    public function canUseRssFeedLink(): bool
+    {
+        if (RssFeedService::canGenerateFeed() && isset($this->slug)) {
+
+            if ($this instanceof MarkdownPost) {
+                return true;
+            }
+
+            if (str_starts_with($this->getCurrentPagePath(), 'post')) {
+                return true;
+            }
+
+            if ($this->getCurrentPagePath() === 'index') {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

tests/Unit/HasPageMetadataRssFeedLinkTest.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Tests\Unit;
+
+use Hyde\Framework\Models\BladePage;
+use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\MarkdownPage;
+use Hyde\Framework\Models\MarkdownPost;
+use Tests\TestCase;
+
+/**
+ * @covers \Hyde\Framework\Concerns\HasPageMetadata::canUseRssFeedLink
+ */
+class HasPageMetadataRssFeedLinkTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        config(['hyde.site_url' => 'foo']);
+    }
+
+
+    public function test_can_use_rss_feed_link_adds_meta_link_for_markdown_posts()
+    {
+        $page = new MarkdownPost([], '');
+
+        $this->assertStringContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="foo/feed.xml" />',
+            $page->renderPageMetadata()
+        );
+    }
+
+    public function test_can_use_rss_feed_link_adds_meta_link_for_post_related_pages()
+    {
+        $page = new MarkdownPage([], '', slug: 'posts');
+
+        $this->assertStringContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="foo/feed.xml" />',
+            $page->renderPageMetadata()
+        );
+    }
+
+    public function test_can_use_rss_feed_link_adds_meta_link_for_markdown_index_page()
+    {
+        $page = new MarkdownPage([], '', slug: 'index');
+
+        $this->assertStringContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="foo/feed.xml" />',
+            $page->renderPageMetadata()
+        );
+    }
+    
+    public function test_can_use_rss_feed_link_adds_meta_link_for_blade_index_page()
+    {
+        $page = new BladePage('index');
+
+        $this->assertStringContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="foo/feed.xml" />',
+            $page->renderPageMetadata()
+        );
+    }
+    
+    public function test_can_use_rss_feed_link_does_not_add_meta_link_for_documentation_index_page()
+    {
+        $page = new DocumentationPage([], '', slug: 'index');
+
+        $this->assertStringNotContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="foo/feed.xml" />',
+            $page->renderPageMetadata()
+        );
+    }
+
+    public function test_can_use_rss_feed_uses_configured_site_url()
+    {
+        config(['hyde.site_url' => 'https://example.org']);
+        $page = new MarkdownPost([], '');
+
+        $this->assertStringContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="https://example.org/feed.xml" />',
+            $page->renderPageMetadata()
+        );
+    }   
+
+    public function test_can_use_rss_feed_uses_configured_rss_file_name()
+    {
+        config(['hyde.rssFilename' => 'posts.rss']);
+        $page = new MarkdownPost([], '');
+
+        $this->assertStringContainsString(
+            '<link rel="alternate" type="application/rss+xml" title="HydePHP RSS Feed" href="foo/posts.rss" />',
+            $page->renderPageMetadata()
+        );
+    }
+
+    // Test link is not added if site url is not set
+    public function test_link_is_not_added_if_site_url_is_not_set()
+    {
+        config(['hyde.site_url' => '']);
+        $page = new MarkdownPost([], '');
+
+        $this->assertStringNotContainsString(
+            '<link rel="alternate" type="application/rss+xml"',
+            $page->renderPageMetadata()
+        );
+    }
+}