Merge pull request #365 from hydephp/front-matter-schemas

Refactor page metadata to use front matter schemas

RELEASE_NOTES.md

@@ -6,10 +6,13 @@ This update contains **breaking changes** to the internal API regarding page mod
 
 The update makes large changes to how dynamic data is constructed. Instead of generating page data at runtime, now the data is generated when constructing a page object. This gives the major benefit of being able to see all dynamic data right away, without having to render the page.
 
+The way metadata tags are handled internally is also refactored. The rendered result should not be affected.
+
 ### Added
 - Added `compile()` method to `Facades\Markdown`, replacing the `parse()` method of the same class
 - Adds new actions to handle complex dynamic constructors
 - Adds new front matter schema traits to define the public API for front matter and hold their data
+- Adds new Meta::link() helper to create `<link>` tags
 
 ### Changed
 - Breaking: Rename AbstractMarkdownPage constructor parameter `slug` to `identifier`

packages/framework/src/Concerns/FrontMatter/Schemas/PageSchema.php

@@ -4,6 +4,7 @@
 
 use Hyde\Framework\Actions\Constructors\FindsNavigationDataForPage;
 use Hyde\Framework\Actions\Constructors\FindsTitleForPage;
+use Hyde\Framework\Hyde;
 use JetBrains\PhpStorm\ArrayShape;
 
 trait PageSchema
@@ -15,12 +16,36 @@ trait PageSchema
      */
     public string $title;
 
+    /**
+     * The settings for how the page should be presented in the navigation menu.
+     */
     #[ArrayShape(['title' => 'string', 'hidden' => 'bool', 'priority' => 'int'])]
     public ?array $navigation = null;
 
+    /**
+     * The canonical URL of the page.
+     *
+     * @var string|null
+     */
+    public ?string $canonicalUrl = null;
+
     protected function constructPageSchema(): void
     {
         $this->title = FindsTitleForPage::run($this);
         $this->navigation = FindsNavigationDataForPage::run($this);
+        $this->canonicalUrl = $this->makeCanonicalUrl();
+    }
+
+    protected function makeCanonicalUrl(): ?string
+    {
+        if (! empty($this->matter('canonicalUrl'))) {
+            return $this->matter('canonicalUrl');
+        }
+
+        if (Hyde::hasSiteUrl() && ! empty($this->identifier)) {
+            return $this->getRoute()->getQualifiedUrl();
+        }
+
+        return null;
     }
 }

packages/framework/src/Contracts/AbstractPage.php

@@ -4,14 +4,12 @@
 
 use Hyde\Framework\Actions\SourceFileParser;
 use Hyde\Framework\Concerns\FrontMatter\Schemas\PageSchema;
-use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Helpers\Meta;
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Models\FrontMatter;
 use Hyde\Framework\Models\Pages\MarkdownPost;
 use Hyde\Framework\Models\Route;
 use Hyde\Framework\Services\DiscoveryService;
-use Hyde\Framework\Services\RssFeedService;
 use Illuminate\Support\Collection;
 
 /**
@@ -163,12 +161,9 @@ public function getBladeView(): string
     /** @inheritDoc */
     abstract public function compile(): string;
 
-    public function getCanonicalUrl(): string
-    {
-        return $this->getRoute()->getQualifiedUrl();
-    }
-
     /**
+     * @internal
+     *
      * @return string[]
      *
      * @psalm-return list<string>
@@ -177,25 +172,13 @@ public function getDynamicMetadata(): array
     {
         $array = [];
 
-        if ($this->canUseCanonicalUrl()) {
-            $array[] = '<link rel="canonical" href="'.$this->getCanonicalUrl().'" />';
-        }
-
-        if (Features::sitemap()) {
-            $array[] = '<link rel="sitemap" type="application/xml" title="Sitemap" href="'.Hyde::url('sitemap.xml').'" />';
+        if (! empty($this->canonicalUrl)) {
+            $array[] = Meta::link('canonical', $this->canonicalUrl);
         }
 
-        if (Features::rss()) {
-            $array[] = $this->makeRssFeedLink();
-        }
-
-        if (isset($this->title)) {
-            if ($this->hasTwitterTitleInConfig()) {
-                $array[] = '<meta name="twitter:title" content="'.$this->htmlTitle().'" />';
-            }
-            if ($this->hasOpenGraphTitleInConfig()) {
-                $array[] = '<meta property="og:title" content="'.$this->htmlTitle().'" />';
-            }
+        if (! empty($this->title)) {
+            $array[] = Meta::name('twitter:title', $this->htmlTitle());
+            $array[] = Meta::property('title', $this->htmlTitle());
         }
 
         if ($this instanceof MarkdownPost) {
@@ -218,27 +201,6 @@ public function renderPageMetadata(): string
         );
     }
 
-    public function canUseCanonicalUrl(): bool
-    {
-        return Hyde::hasSiteUrl() && isset($this->identifier);
-    }
-
-    public function hasTwitterTitleInConfig(): bool
-    {
-        return str_contains(json_encode(config('hyde.meta', [])), 'twitter:title');
-    }
-
-    public function hasOpenGraphTitleInConfig(): bool
-    {
-        return str_contains(json_encode(config('hyde.meta', [])), 'og:title');
-    }
-
-    protected function makeRssFeedLink(): string
-    {
-        return '<link rel="alternate" type="application/rss+xml" title="'.RssFeedService::getDescription().
-            '" href="'.Hyde::url(RssFeedService::getDefaultOutputFilename()).'" />';
-    }
-
     public function showInNavigation(): bool
     {
         return ! $this->navigation['hidden'];

packages/framework/src/Helpers/Meta.php

@@ -2,6 +2,9 @@
 
 namespace Hyde\Framework\Helpers;
 
+use Hyde\Framework\Hyde;
+use Hyde\Framework\Services\RssFeedService;
+
 /**
  * Helpers to fluently declare HTML meta tags.
  *
@@ -21,6 +24,19 @@ public static function property(string $property, string $content): string
         return '<meta property="'.e($property).'" content="'.e($content).'">';
     }
 
+    public static function link(string $rel, string $href, array $attr = []): string
+    {
+        if (! $attr) {
+            return '<link rel="'.e($rel).'" href="'.e($href).'">';
+        }
+
+        $attributes = collect($attr)->map(function ($value, $key) {
+            return e($key).'="'.e($value).'"';
+        })->implode(' ');
+
+        return '<link rel="'.e($rel).'" href="'.e($href).'" '.$attributes.'>';
+    }
+
     public static function render(array $withMergedData = []): string
     {
         return implode(
@@ -52,6 +68,33 @@ protected static function filterUnique(array $meta): array
     }
 
     public static function getGlobalMeta(): array
+    {
+        return array_merge(
+            static::getDynamicMeta(),
+            static::getConfiguredMeta()
+        );
+    }
+
+    protected static function getDynamicMeta(): array
+    {
+        $array = [];
+
+        if (Features::sitemap()) {
+            $array[] = Meta::link('sitemap', Hyde::url('sitemap.xml'), [
+                'type' => 'application/xml', 'title' => 'Sitemap',
+            ]);
+        }
+
+        if (Features::rss()) {
+            $array[] = Meta::link('alternate', Hyde::url(RssFeedService::getDefaultOutputFilename()), [
+                'type' => 'application/rss+xml', 'title' => RssFeedService::getDescription(),
+            ]);
+        }
+
+        return $array;
+    }
+
+    protected static function getConfiguredMeta(): array
     {
         return config('hyde.meta', []);
     }