Automatically subscribe users when replying

Also refactor the internals of subscriptions to an interface and move some of the logic.

Author: driesvints

app/Helpers/ProvidesSubscriptions.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Helpers;
+
+use App\User;
+use App\Models\Subscription;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
+trait ProvidesSubscriptions
+{
+    /**
+     * @return \App\Models\Subscription[]
+     */
+    public function subscriptions()
+    {
+        return $this->subscriptionsRelation;
+    }
+
+    public function subscriptionsRelation(): MorphMany
+    {
+        return $this->morphMany(Subscription::class, 'subscriptionable');
+    }
+
+    public function hasSubscriber(User $user): bool
+    {
+        return $this->subscriptionsRelation()
+            ->where('user_id', $user->id())
+            ->exists();
+    }
+}

app/Helpers/ReceivesReplies.php

@@ -3,7 +3,6 @@
 namespace App\Helpers;
 
 use App\Models\Reply;
-use App\Models\Subscription;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 
 trait ReceivesReplies
@@ -33,17 +32,4 @@ public function repliesRelation(): MorphMany
     {
         return $this->morphMany(Reply::class, 'replyable');
     }
-
-    /**
-     * @return \App\Models\Subscription[]
-     */
-    public function subscriptions()
-    {
-        return $this->subscriptionsRelation;
-    }
-
-    public function subscriptionsRelation(): MorphMany
-    {
-        return $this->morphMany(Subscription::class, 'subscriptionable');
-    }
 }

app/Jobs/CreateReply.php

@@ -2,6 +2,8 @@
 
 namespace App\Jobs;
 
+use App\Models\Subscription;
+use App\Models\SubscriptionAble;
 use App\User;
 use App\Models\Reply;
 use App\Models\ReplyAble;
@@ -52,6 +54,14 @@ public function handle(): Reply
 
         event(new ReplyWasCreated($reply));
 
+        if ($this->replyAble instanceof SubscriptionAble && ! $this->replyAble->hasSubscriber($this->author)) {
+            $subscription = new Subscription();
+            $subscription->userRelation()->associate($this->author);
+            $subscription->subscriptionAbleRelation()->associate($this->replyAble);
+
+            $this->replyAble->subscriptionsRelation()->save($subscription);
+        }
+
         return $reply;
     }
 }

app/Jobs/CreateThread.php

@@ -2,6 +2,7 @@
 
 namespace App\Jobs;
 
+use App\Models\Subscription;
 use App\User;
 use App\Models\Thread;
 use App\Http\Requests\ThreadRequest;
@@ -66,10 +67,11 @@ public function handle(): Thread
         $thread->save();
 
         // Subscribe author to the thread.
-        $this->author->subscriptionAble()->create([
-            'subscriptionable_id' => $thread->id(),
-            'subscriptionable_type' => Thread::TABLE,
-        ]);
+        $subscription = new Subscription();
+        $subscription->userRelation()->associate($this->author);
+        $subscription->subscriptionAbleRelation()->associate($thread);
+
+        $thread->subscriptionsRelation()->save($subscription);
 
         return $thread;
     }

app/Models/ReplyAble.php

@@ -22,11 +22,4 @@ public function latestReplies(int $amount = 5);
     public function deleteReplies();
 
     public function repliesRelation(): MorphMany;
-
-    /**
-     * @return \App\Models\Subscription[]
-     */
-    public function subscriptions();
-
-    public function subscriptionsRelation(): MorphMany;
 }

app/Models/Subscription.php

@@ -5,6 +5,7 @@
 use App\User;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 class Subscription extends Model
 {
@@ -13,14 +14,6 @@ class Subscription extends Model
      */
     protected $table = 'subscriptions';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $fillable = [
-        'subscriptionable_id',
-        'subscriptionable_type',
-    ];
-
     public function user(): User
     {
         return $this->userRelation;
@@ -30,4 +23,14 @@ public function userRelation(): BelongsTo
     {
         return $this->belongsTo(User::class, 'user_id');
     }
+
+    public function subscriptionAble(): SubscriptionAble
+    {
+        return $this->subscriptionAbleRelation;
+    }
+
+    public function subscriptionAbleRelation(): MorphTo
+    {
+        return $this->morphTo('subscriptionable');
+    }
 }

app/Models/SubscriptionAble.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Models;
+
+use App\User;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
+interface SubscriptionAble
+{
+    /**
+     * @return \App\Models\Subscription[]
+     */
+    public function subscriptions();
+
+    public function subscriptionsRelation(): MorphMany;
+
+    public function hasSubscriber(User $user): bool;
+}

app/Models/Thread.php

@@ -9,16 +9,17 @@
 use App\Helpers\ModelHelpers;
 use App\Helpers\HasTimestamps;
 use App\Helpers\ReceivesReplies;
+use App\Helpers\ProvidesSubscriptions;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Contracts\Pagination\Paginator;
 use App\Exceptions\CouldNotMarkReplyAsSolution;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-class Thread extends Model implements ReplyAble
+class Thread extends Model implements ReplyAble, SubscriptionAble
 {
-    use HasAuthor, HasSlug, HasTimestamps, ModelHelpers, ReceivesReplies, HasTags;
+    use HasAuthor, HasSlug, HasTimestamps, ModelHelpers, ProvidesSubscriptions, ReceivesReplies, HasTags;
 
     const TABLE = 'threads';
 

app/User.php

@@ -4,7 +4,6 @@
 
 use App\Models\Reply;
 use App\Models\Thread;
-use App\Models\Subscription;
 use App\Helpers\ModelHelpers;
 use App\Helpers\HasTimestamps;
 use Illuminate\Notifications\Notifiable;
@@ -239,17 +238,4 @@ public function delete()
 
         parent::delete();
     }
-
-    public function isSubscribedTo($subscriptionAble): bool
-    {
-        return $this->subscriptionAble()
-            ->where('subscriptionable_id', $subscriptionAble->id())
-            ->where('subscriptionable_type', $subscriptionAble::TABLE)
-            ->exists();
-    }
-
-    public function subscriptionAble(): HasMany
-    {
-        return $this->hasMany(Subscription::class, 'user_id');
-    }
 }

tests/Components/Models/UserTest.php

@@ -2,7 +2,6 @@
 
 namespace Tests\Components\Models;
 
-use App\Models\Subscription;
 use App\User;
 use Tests\TestCase;
 use App\Models\Reply;
@@ -48,14 +47,4 @@ private function createTwoSolutionReplies(User $user)
         $reply = factory(Reply::class)->create(['replyable_id' => $thread->id(), 'author_id' => $user->id()]);
         $thread->markSolution($reply);
     }
-
-    /** @test */
-    public function it_can_check_if_its_subscribed_to_a_thread()
-    {
-        $user = $this->createUser();
-        $thread = factory(Thread::class)->create();
-        factory(Subscription::class)->create(['user_id' => $user->id(), 'subscriptionable_id' => $thread->id()]);
-
-        $this->assertTrue($user->isSubscribedTo($thread));
-    }
 }