Merge pull request #57 from BinaryStudioAcademy/feature/likes-entity

Feature/likes entity

Author: nemoipaha

backend/app/Entity/Comment.php

@@ -5,9 +5,9 @@
 namespace App\Entity;
 
 use Carbon\Carbon;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use InvalidArgumentException;
 
 /**
  * Class Comment
@@ -29,18 +29,8 @@ final class Comment extends Model
         'tweet_id'
     ];
 
-    protected static function boot()
-    {
-        parent::boot();
-
-        // append author relation in entity by default
-        self::addGlobalScope(
-            'with-author',
-            function(Builder $builder) {
-                $builder->with('author');
-            }
-        );
-    }
+    // append author relation in entity by default
+    protected $with = ['author'];
 
     public function author(): BelongsTo
     {
@@ -80,7 +70,7 @@ public function getAuthorId(): int
     public function edit(string $text): void
     {
         if (empty($text)) {
-            throw new \InvalidArgumentException('Comment body cannot be empty.');
+            throw new InvalidArgumentException('Comment body cannot be empty.');
         }
 
         $this->body = $text;

backend/app/Entity/Like.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+/**
+ * Class Like
+ *
+ * Polymorphic entity
+ *
+ * @package App\Entity
+ *
+ * @property int $id
+ * @property int $user_id
+ * @property User $user
+ * @property int $likeable_id
+ * @property string $likeable_type
+ * @property Carbon $created_at
+ */
+final class Like extends Model
+{
+    protected $table = 'likes';
+
+    protected $fillable = [
+        'user_id',
+        'likeable_id',
+        'likeable_type'
+    ];
+
+    protected $with = ['user'];
+
+    public function likeable(): MorphTo
+    {
+        return $this->morphTo();
+    }
+
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class);
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getCreatedAt(): Carbon
+    {
+        return $this->created_at;
+    }
+
+    public function getUserId(): int
+    {
+        return $this->user_id;
+    }
+
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+}

backend/app/Entity/Tweet.php

@@ -8,6 +8,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
 use InvalidArgumentException;
 
 /**
@@ -20,6 +21,7 @@
  * @property Carbon $created_at
  * @property Carbon $updated_at
  * @property int $comments_count
+ * @property int $likes_count
  * @property User $author
  */
 final class Tweet extends Model
@@ -30,7 +32,7 @@ final class Tweet extends Model
     protected $with = ['author'];
 
     // Eager load related comments count each time.
-    protected $withCount = ['comments'];
+    protected $withCount = ['comments', 'likes'];
 
     protected $fillable = [
         'text',
@@ -48,6 +50,11 @@ public function comments(): HasMany
         return $this->hasMany(Comment::class);
     }
 
+    public function likes(): MorphMany
+    {
+        return $this->morphMany(Like::class, 'likeable');
+    }
+
     public function getId(): int
     {
         return $this->id;
@@ -84,6 +91,11 @@ public function getCommentsCount(): int
         return (int)$this->comments_count;
     }
 
+    public function getLikesCount(): int
+    {
+        return (int)$this->likes_count;
+    }
+
     public function changeContent(string $text): void
     {
         if (empty($text)) {

backend/app/Http/Presenter/Tweet/TweetArrayPresenter.php

@@ -26,7 +26,8 @@ public function present(Tweet $tweet): array
             'image_url' => $tweet->getImageUrl(),
             'created_at' => $tweet->getCreatedAt()->toDateTimeString(),
             'author' => $this->userPresenter->present($tweet->getAuthor()),
-            'comments_count' => $tweet->getCommentsCount()
+            'comments_count' => $tweet->getCommentsCount(),
+            'likes_count' => $tweet->getLikesCount()
         ];
     }
 

backend/database/migrations/2019_05_12_161356_likes_table_migration.php

@@ -0,0 +1,40 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class LikesTableMigration extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('likes', function(Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->unsignedBigInteger('user_id');
+            $table->unsignedBigInteger('likeable_id');
+            $table->string('likeable_type');
+            $table->dateTime('created_at');
+
+            $table
+                ->foreign('user_id')
+                ->references('id')
+                ->on('users')
+                ->onDelete('cascade');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('likes');
+    }
+}

backend/database/migrations/2019_05_12_171919_like_is_unique_for_user.php

@@ -0,0 +1,40 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class LikeIsUniqueForUser extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        // user can like smth only once
+        Schema::table('likes', function(Blueprint $blueprint) {
+            $blueprint->unique(['user_id', 'likeable_id', 'likeable_type']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('likes', function(Blueprint $blueprint) {
+            // need to drop foreign key before we can drop unique index
+            $blueprint->dropForeign('likes_user_id_foreign');
+            $blueprint->dropUnique(['user_id', 'likeable_id', 'likeable_type']);
+            $blueprint
+                ->foreign('user_id')
+                ->references('id')
+                ->on('users')
+                ->onDelete('cascade');
+        });
+    }
+}

backend/database/seeds/DatabaseSeeder.php

@@ -14,5 +14,6 @@ public function run()
         $this->call(UserTableSeeder::class);
         $this->call(TweetTableSeeder::class);
         $this->call(CommentTableSeeder::class);
+        $this->call(LikeTableSeeder::class);
     }
 }

backend/database/seeds/LikeTableSeeder.php

@@ -0,0 +1,68 @@
+<?php
+
+use App\Entity\Comment;
+use App\Entity\Like;
+use App\Entity\Tweet;
+use App\Entity\User;
+use Carbon\Carbon;
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\DB;
+
+class LikeTableSeeder extends Seeder
+{
+    private const LIKES_COUNT = 10;
+
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        $tweets = Tweet::all();
+        $users = User::all();
+        $comments = Comment::all();
+        $now = Carbon::now();
+
+        $tweetLikes = $tweets->map(
+            function(Tweet $tweet) use ($users, $now) {
+                $userIds = $users->shuffle()->shuffle()->take(self::LIKES_COUNT)->pluck('id');
+
+                return $userIds->map(
+                    function(int $userId) use ($tweet, $now) {
+                        return [
+                            'user_id' => $userId,
+                            'likeable_id' => $tweet->id,
+                            'likeable_type' => Tweet::class,
+                            'created_at' => $now->toDateTimeString()
+                        ];
+                    }
+                );
+            }
+        );
+
+        $commentLikes = $comments->map(
+            function(Comment $comment) use ($users, $now) {
+                $userIds = $users->shuffle()->shuffle()->take(self::LIKES_COUNT)->pluck('id');
+
+                return $userIds->map(
+                    function(int $userId) use ($comment, $now) {
+                        return [
+                            'user_id' => $userId,
+                            'likeable_id' => $comment->id,
+                            'likeable_type' => Comment::class,
+                            'created_at' => $now->toDateTimeString()
+                        ];
+                    }
+                );
+            }
+        );
+
+        DB::table('likes')->insert(
+            $tweetLikes
+                ->flatten(1)
+                ->merge($commentLikes->flatten(1))
+                ->toArray()
+        );
+    }
+}

backend/tests/Feature/Api/ApiTestCase.php

@@ -46,7 +46,8 @@ abstract class ApiTestCase extends BaseTestCase
         'text',
         'image_url',
         'author' => self::USER_RESOURCE_STRUCTURE,
-        'comments_count'
+        'comments_count',
+        'likes_count'
     ];
 
     /**

frontend/src/components/common/NoContent.vue

@@ -0,0 +1,33 @@
+<template>
+    <section class="hero is-info" v-show="show">
+        <div class="hero-body">
+            <div class="has-text-centered">
+                <p class="title">
+                    {{ title }}
+                </p>
+            </div>
+        </div>
+    </section>
+</template>
+
+<script>
+export default {
+    name: 'NoContent',
+
+    props: {
+        title: {
+            default: 'No content :)',
+            type: String
+        },
+
+        show: {
+            type: Boolean,
+            required: true
+        }
+    }
+};
+</script>
+
+<style scoped>
+
+</style>