Add support for passing meta into view data for custom routes (#255)

Co-authored-by: Jesse Leite <jesseleite@gmail.com>
Closes #254

Author: edalzell

DOCUMENTATION.md

@@ -44,6 +44,19 @@ If you wish to use assets in your meta, you can [publish the SEO Pro config](#pu
 
 > You may disable the glide preset altogether by setting `'open_graph_preset' => false,` in your config.
 
+### Custom Statamic Routes
+
+In the case that you're loading a custom [Statamic Route](https://statamic.dev/routing#statamic-routes), you can pass SEO meta directly into the route data param. This allows you to define custom meta on a route-by-route basis in situations without a proper collection entry.
+
+```php
+Route::statamic('search', 'search/index', [
+    'title' => 'Search',
+    'description' => 'Comprehensive Site Search.',
+    // ...
+]);
+```
+
+
 ## File Usage
 
 For advanced devs, you may bypass the CP and configure your SEO settings through files. There are 3 sorts of values you may save.

src/Cascade.php

@@ -17,6 +17,7 @@ class Cascade
 {
     protected $data;
     protected $current;
+    protected $explicitUrl;
     protected $model;
     protected $forSitemap = false;
 
@@ -54,10 +55,18 @@ public function withCurrent($data)
         return $this;
     }
 
+    public function withExplicitUrl($url)
+    {
+        $this->explicitUrl = $url;
+
+        return $this;
+    }
+
     public function get()
     {
         if (! $this->current) {
             $this->withCurrent(Entry::findByUri('/'));
+            $this->withExplicitUrl(request()->url());
         }
 
         if ($this->forSitemap) {
@@ -113,7 +122,7 @@ public function value($key)
 
     public function canonicalUrl()
     {
-        $url = Str::trim($this->data->get('canonical_url'));
+        $url = Str::trim($this->explicitUrl ?? $this->data->get('canonical_url'));
 
         if (! app('request')->has('page')) {
             return $url;

src/Directives/SeoProDirective.php

@@ -10,7 +10,10 @@ class SeoProDirective extends SeoProTags
     public function renderTag($tag, $context)
     {
         if ($this->isMissingContext($context)) {
-            $context = $this->getContextFromCascade();
+            $context = array_merge(
+                $this->getContextFromCurrentRouteData(),
+                $this->getContextFromCascade()
+            );
         }
 
         return $this->setContext($context)->$tag();
@@ -25,4 +28,9 @@ protected function getContextFromCascade()
     {
         return Cascade::instance()->toArray();
     }
+
+    protected function getContextFromCurrentRouteData()
+    {
+        return app('router')->current()->parameter('data') ?? [];
+    }
 }

src/Tags/SeoProTags.php

@@ -40,6 +40,7 @@ public function metaData()
             ->with(SiteDefaults::load()->augmented())
             ->with($this->getAugmentedSectionDefaults($current))
             ->with($this->context->value('seo'))
+            ->with($current ? [] : $this->context->except('template_content'))
             ->withCurrent($current)
             ->get();
 

tests/CascadeTest.php

@@ -145,7 +145,7 @@ public function it_generates_seo_cascade_without_exception_when_no_home_entry_ex
             'change_frequency' => 'monthly',
             'compiled_title' => 'Site Name',
             'og_title' => 'Site Name',
-            'canonical_url' => '',
+            'canonical_url' => 'http://cool-runnings.com',
             'prev_url' => null,
             'next_url' => null,
             'home_url' => 'http://cool-runnings.com/',

tests/MetaTagTest.php

@@ -4,10 +4,12 @@
 
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Route;
 use Statamic\Facades\Blink;
 use Statamic\Facades\Collection;
 use Statamic\Facades\Config;
 use Statamic\Facades\Entry;
+use Statamic\Statamic;
 
 class MetaTagTest extends TestCase
 {
@@ -18,6 +20,13 @@ protected function getEnvironmentSetUp($app)
         parent::getEnvironmentSetUp($app);
 
         $app['config']->set('view.paths', [$this->viewsPath()]);
+
+        Statamic::booted(function () {
+            Route::statamic('the-view', 'page', [
+                'title' => 'The View',
+                'description' => 'A wonderful view!',
+            ]);
+        });
     }
 
     public function tearDown(): void
@@ -58,6 +67,36 @@ public function it_generates_normalized_meta($viewType)
         $this->assertStringContainsString($this->normalizeMultilineString($expected), $content);
     }
 
+    /**
+     * @test
+     * @dataProvider viewScenarioProvider
+     */
+    public function it_generates_normalized_meta_when_visiting_statamic_route_with_raw_view_data($viewType)
+    {
+        $this->prepareViews($viewType);
+
+        $expected = <<<'EOT'
+<title>The View | Site Name</title>
+<meta name="description" content="A wonderful view!" />
+<meta property="og:type" content="website" />
+<meta property="og:title" content="The View" />
+<meta property="og:description" content="A wonderful view!" />
+<meta property="og:url" content="http://cool-runnings.com/the-view" />
+<meta property="og:site_name" content="Site Name" />
+<meta property="og:locale" content="en_US" />
+<meta name="twitter:card" content="summary_large_image" />
+<meta name="twitter:title" content="The View" />
+<meta name="twitter:description" content="A wonderful view!" />
+<link href="http://cool-runnings.com/" rel="home" />
+<link href="http://cool-runnings.com/the-view" rel="canonical" />
+<link type="text/plain" rel="author" href="http://cool-runnings.com/humans.txt" />
+EOT;
+
+        $content = $this->get('/the-view')->content();
+        $this->assertStringContainsString("<h1>{$viewType}</h1>", $content);
+        $this->assertStringContainsString($this->normalizeMultilineString($expected), $content);
+    }
+
     /**
      * @test
      * @dataProvider viewScenarioProvider