Add canonical URL support

Author: joedixon

app/Http/Requests/ArticleRequest.php

@@ -14,6 +14,8 @@ public function rules()
             'body' => ['required', new HttpImageRule],
             'tags' => 'array',
             'tags.*' => 'exists:tags,id',
+            'series' => 'exists:series,id',
+            'canonical_url' => 'url',
         ];
     }
 
@@ -41,4 +43,9 @@ public function series(): ?string
     {
         return $this->get('series');
     }
+
+    public function canonicalUrl(): ?string
+    {
+        return $this->get('canonical_url');
+    }
 }

app/Jobs/CreateArticle.php

@@ -15,15 +15,18 @@ final class CreateArticle
 
     private $author;
 
+    private $canonicalUrl;
+
     private $tags;
 
     private $series;
 
-    public function __construct(string $title, string $body, User $author, array $tags = [], string $series = null)
+    public function __construct(string $title, string $body, User $author, string $canonicalUrl = null, array $tags = [], string $series = null)
     {
         $this->title = $title;
         $this->body = $body;
         $this->author = $author;
+        $this->canonicalUrl = $canonicalUrl;
         $this->tags = $tags;
         $this->series = $series;
     }
@@ -34,6 +37,7 @@ public static function fromRequest(ArticleRequest $request): self
             $request->title(),
             $request->body(),
             $request->author(),
+            $request->canonicalUrl(),
             $request->tags(),
             $request->series()
         );
@@ -44,6 +48,7 @@ public function handle(): Article
         $article = new Article([
             'title' => $this->title,
             'body' => $this->body,
+            'canonical_url' => $this->canonicalUrl,
             'slug' => $this->title,
         ]);
         $article->authoredBy($this->author);

app/Jobs/UpdateArticle.php

@@ -14,15 +14,18 @@ final class UpdateArticle
 
     private $body;
 
+    private $canonicalUrl;
+
     private $tags;
 
     private $series;
 
-    public function __construct(Article $article, string $title, string $body, array $tags = [], string $series = null)
+    public function __construct(Article $article, string $title, string $body, string $canonicalUrl = null, array $tags = [], string $series = null)
     {
         $this->article = $article;
         $this->title = $title;
         $this->body = $body;
+        $this->canonicalUrl = $canonicalUrl;
         $this->tags = $tags;
         $this->series = $series;
     }
@@ -33,6 +36,7 @@ public static function fromRequest(Article $article, ArticleRequest $request): s
             $article,
             $request->title(),
             $request->body(),
+            $request->canonicalUrl(),
             $request->tags(),
             $request->series()
         );
@@ -43,6 +47,7 @@ public function handle(): Article
         $this->article->update([
             'title' => $this->title,
             'body' => $this->body,
+            'canonical_url' => $this->canonicalUrl,
             'slug' => $this->title,
         ]);
         $this->article->syncTags($this->tags);

app/Models/Article.php

@@ -19,6 +19,7 @@ final class Article extends Model
     protected $fillable = [
         'title',
         'body',
+        'canonical_url',
         'slug',
     ];
 
@@ -37,6 +38,11 @@ public function body(): string
         return $this->body;
     }
 
+    public function canonicalUrl(): string
+    {
+        return $this->canonical_url ?: route('articles.show', $this->slug);
+    }
+
     public function series()
     {
         return $this->belongsTo(Series::class);

database/migrations/2020_04_07_185543_create_community_articles_table.php

@@ -19,6 +19,7 @@ public function up()
             $table->unsignedInteger('author_id');
             $table->string('title');
             $table->text('body');
+            $table->string('canonical_url')->nullable();
             $table->string('slug')->unique();
             $table->timestamps();
 

resources/views/articles/_form.blade.php

@@ -26,6 +26,20 @@ class="form-control"
         @error('body')
     @endFormGroup
 
+    @formGroup('canonical_url')
+        <label for="canonical_url">Canonical URL</label>
+        <input 
+            type="text" 
+            name="canonical_url" 
+            id="canonical_url" 
+            value="{{ isset($article) ? $article->canonicalUrl() : null }}" 
+            class="form-control" 
+            required maxlength="60" 
+        />
+        <span class="text-gray-600 text-sm">If you have already posted this article on your own site, enter the URL here and the content will be attributed to you.</span>
+        @error('canonical_url')
+    @endFormGroup
+
     @formGroup('tags')
         <label for="tags">Tags</label>
 

resources/views/articles/show.blade.php

@@ -1,5 +1,9 @@
 @extends('layouts.default')
 
+@push('meta')
+<link rel="canonical" href="{{ $article->canonicalUrl() }}" />
+@endpush
+
 @section('content')
     <div class="max-w-screen-md mx-auto p-4 pt-8">
         <h1 class="text-4xl tracking-tight leading-10 font-extrabold text-gray-900 sm:leading-none mb-4">{{ $article->title() }}</h1>

resources/views/layouts/base.blade.php

@@ -17,6 +17,7 @@
     <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
     <link href="{{ mix('css/app.css') }}" rel="stylesheet">
+    @stack('meta')
 
     <script>
         window.Laravel = {!! json_encode(['csrfToken' => csrf_token()]) !!};

tests/Feature/ArticleTest.php

@@ -145,11 +145,29 @@ public function users_can_delete_their_own_articles()
     /** @test */
     public function users_cannot_delete_an_article_they_do_not_own()
     {
-        factory(Article::class)->create(['slug' => 'my-first-thread']);
+        factory(Article::class)->create(['slug' => 'my-first-article']);
 
         $this->login();
 
-        $this->delete('/articles/my-first-thread')
+        $this->delete('/articles/my-first-article')
             ->assertForbidden();
     }
+
+    /** @test */
+    public function canonical_urls_are_rendered()
+    {
+        factory(Article::class)->create(['slug' => 'my-first-article']);
+
+        $this->get('/articles/my-first-article')
+            ->see('<link rel="canonical" href="http://localhost/articles/my-first-article" />');
+    }
+
+    /** @test */
+    public function custom_canonical_urls_are_rendered()
+    {
+        factory(Article::class)->create(['slug' => 'my-first-article', 'canonical_url' => 'https://joedixon.co.uk/my-first-article']);
+
+        $this->get('/articles/my-first-article')
+            ->see('<link rel="canonical" href="https://joedixon.co.uk/my-first-article" />');
+    }
 }

tests/Integration/Jobs/CreateArticleTest.php

@@ -16,10 +16,11 @@ public function we_can_create_an_article()
     {
         $user = $this->createUser();
 
-        $article = $this->dispatch(new CreateArticle('Title', 'Body', $user));
+        $article = $this->dispatch(new CreateArticle('Title', 'Body', $user, 'https://laravel.io'));
 
         $this->assertEquals('Title', $article->title());
         $this->assertEquals('Body', $article->body());
+        $this->assertEquals('https://laravel.io', $article->canonicalUrl());
     }
 
     /** @test */
@@ -28,10 +29,11 @@ public function we_can_create_an_article_with_a_series()
         $user = $this->createUser();
         $series = factory(Series::class)->create(['author_id' => $user->id()]);
 
-        $article = $this->dispatch(new CreateArticle('Title', 'Body', $user, [], $series->id));
+        $article = $this->dispatch(new CreateArticle('Title', 'Body', $user, 'https://laravel.io', [], $series->id));
 
         $this->assertEquals('Title', $article->title());
         $this->assertEquals('Body', $article->body());
+        $this->assertEquals('https://laravel.io', $article->canonicalUrl());
         $this->assertEquals($series->id, $article->id());
     }
 }