Merge pull request #54 from BinaryStudioAcademy/feature/comment-count

Feature/comment count

Author: nemoipaha

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 InvalidArgumentException;
 
 /**
  * Class Tweet
@@ -18,13 +19,18 @@
  * @property int $author_id
  * @property Carbon $created_at
  * @property Carbon $updated_at
+ * @property int $comments_count
+ * @property User $author
  */
 final class Tweet extends Model
 {
     protected $table = 'tweets';
-    
-    // The relations to eager load on every query.
-    protected $with = ['author', 'comments'];
+
+    // Relations to eager load on every query.
+    protected $with = ['author'];
+
+    // Eager load related comments count each time.
+    protected $withCount = ['comments'];
 
     protected $fillable = [
         'text',
@@ -67,10 +73,21 @@ public function getAuthorId(): int
         return $this->author_id;
     }
 
+    public function getAuthor(): User
+    {
+        return $this->author;
+    }
+
+    public function getCommentsCount(): int
+    {
+        // cast to int, because if tweet doesn't have comments null will be returned
+        return (int)$this->comments_count;
+    }
+
     public function changeContent(string $text): void
     {
         if (empty($text)) {
-            throw new \InvalidArgumentException('Tweet content cannot be empty.');
+            throw new InvalidArgumentException('Tweet content cannot be empty.');
         }
 
         $this->text = $text;
@@ -79,7 +96,7 @@ public function changeContent(string $text): void
     public function changePreviewImage(string $imageUrl): void
     {
         if (empty($imageUrl)) {
-            throw new \InvalidArgumentException('Empty image url.');
+            throw new InvalidArgumentException('Empty image url.');
         }
 
         $this->image_url = $imageUrl;

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

@@ -8,19 +8,14 @@
 use App\Http\Presenter\CollectionAsArrayPresenter;
 use Illuminate\Support\Collection;
 use App\Http\Presenter\User\UserArrayPresenter;
-use App\Http\Presenter\Comment\CommentAsArrayPresenter;
 
 final class TweetArrayPresenter implements CollectionAsArrayPresenter
 {
     private $userPresenter;
-    private $commentPresenter;
 
-    public function __construct(
-        UserArrayPresenter $userPresenter,
-        CommentAsArrayPresenter $commentPresenter
-    ) {
+    public function __construct(UserArrayPresenter $userPresenter)
+    {
         $this->userPresenter = $userPresenter;
-        $this->commentPresenter = $commentPresenter;
     }
 
     public function present(Tweet $tweet): array
@@ -30,8 +25,8 @@ public function present(Tweet $tweet): array
             'text' => $tweet->getText(),
             'image_url' => $tweet->getImageUrl(),
             'created_at' => $tweet->getCreatedAt()->toDateTimeString(),
-            'author' => $this->userPresenter->present($tweet->author),
-            'comments' => $this->commentPresenter->presentCollection($tweet->comments)
+            'author' => $this->userPresenter->present($tweet->getAuthor()),
+            'comments_count' => $tweet->getCommentsCount()
         ];
     }
 

backend/tests/Feature/Api/ApiTestCase.php

@@ -9,7 +9,9 @@
 use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Foundation\Testing\TestResponse;
 use Illuminate\Support\Facades\Auth;
+use InvalidArgumentException;
 use Tests\CreatesApplication;
 
 abstract class ApiTestCase extends BaseTestCase
@@ -43,7 +45,8 @@ abstract class ApiTestCase extends BaseTestCase
         'id',
         'text',
         'image_url',
-        'author' => self::USER_RESOURCE_STRUCTURE
+        'author' => self::USER_RESOURCE_STRUCTURE,
+        'comments_count'
     ];
 
     /**
@@ -91,7 +94,7 @@ protected function seedFakeData(int $itemsAmount = 5): void
      * @param array $files
      * @param array $server
      * @param null $content
-     * @return \Illuminate\Foundation\Testing\TestResponse
+     * @return TestResponse
      */
     public function call($method, $uri, $parameters = [], $cookies = [], $files = [], $server = [], $content = null)
     {
@@ -121,7 +124,7 @@ protected function actingWithToken(Authenticatable $user = null): self
     private function assertUriIsValid(string $uri): void
     {
         if (empty($uri)) {
-            throw new \InvalidArgumentException('Request URI cannot be empty.');
+            throw new InvalidArgumentException('Request URI cannot be empty.');
         }
     }
 
@@ -240,7 +243,7 @@ protected function createResourceItemUri(string $uri, int $id): string
     private function assertAttributesIsValid(array $attributes): void
     {
         if (empty($attributes)) {
-            throw new \InvalidArgumentException('Request attributes are empty.');
+            throw new InvalidArgumentException('Request attributes are empty.');
         }
     }
 }