feat: add getLatestReceivedReviews

Author: fajarwz

src/Traits/CanBeReviewed.php

@@ -4,6 +4,7 @@
 
 use Fajarwz\LaravelReview\Models\Review;
 use Fajarwz\LaravelReview\Models\ReviewSummary;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\MorphOne;
@@ -61,6 +62,23 @@ public function getReceivedReview(Model $model, bool $includeUnapproved = false)
         return $query->first();
     }
 
+    /**
+     * Get the current model latest received reviews of the specified model.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model|null  $model
+     * @param  bool                                      $includeUnapproved
+     */
+    public function getLatestReceivedReviews(?Model $model = null, bool $includeUnapproved = false): Collection
+    {
+        $query = $this->receivedReviews($model);
+
+        if ($includeUnapproved) {
+            $query->withUnapproved();
+        }
+
+        return $query->orderByDesc('created_at')->get();
+    }
+
     /**
      * Returns the review summary for this model.
      */

tests/CanBeReviewedTest.php

@@ -148,6 +148,42 @@ public function test_getReceivedReview_can_retrieve_unapproved_review_when_inclu
         $this->assertEquals(3, $review->rating);
     }
 
+    public function test_getLatestReceivedReviews_retrieves_latest_approved_reviews_by_default()
+    {
+        $newMentee = Mentor::factory()->create();
+
+        $newReview = $newMentee->review($this->mentor, 4, 'nice!!!');
+
+        $reviews = $this->mentor->getLatestReceivedReviews();
+
+        $this->assertCount(3, $reviews);
+        $this->assertEquals($reviews->first()->id, $newReview->id);
+    }
+
+    public function test_getLatestReceivedReviews_not_returning_unapproved_reviews_by_default()
+    {
+        $newMentee = Mentor::factory()->create();
+
+        $newReview = $newMentee->review($this->mentor, 4, 'nice!!!', isApproved: false);
+
+        $reviews = $this->mentor->getLatestReceivedReviews();
+
+        $this->assertCount(2, $reviews);
+        $this->assertNotEquals($reviews->first()->id, $newReview->id);
+    }
+
+    public function test_getLatestReceivedReviews_can_retrieves_unapproved_reviews_when_includeUnapproved_is_true()
+    {
+        $newMentee = Mentor::factory()->create();
+
+        $newReview = $newMentee->review($this->mentor, 4, 'nice!!!', isApproved: false);
+
+        $reviews = $this->mentor->getLatestReceivedReviews(includeUnapproved: true);
+
+        $this->assertCount(3, $reviews);
+        $this->assertEquals($reviews->first()->id, $newReview->id);
+    }
+
     public function test_a_reviewable_can_display_its_review_summary()
     {
         $this->assertTrue($this->mentor->reviewSummary->exists());