refactor: add new method for better accessibility

- replace code with new method in test - update docs
cjmellor · Nov 10, 2024 · 23240b4 · 23240b4
1 parent f1772a0
commit 23240b4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -436,11 +436,7 @@ $user->achievementsWithProgress()->get();
 Check Achievements that have a certain amount of progression:
 
 ```php
-$user->achievements
-    ->first()
-    ->pivot()
-    ->withProgress(25)
-    ->get();
+$user->achievementsWithSpecificProgress(25)->get();
 ```
 
 ### Increase Achievement Progression

diff --git a/src/Concerns/HasAchievements.php b/src/Concerns/HasAchievements.php
@@ -71,6 +71,12 @@ public function achievementsWithProgress(): BelongsToMany
             ->wherePivotNotNull(column: 'progress');
     }
 
+    public function achievementsWithSpecificProgress(int $progress): BelongsToMany
+    {
+        return $this->achievements()
+            ->wherePivot(column: 'progress', operator: '>=', value: $progress);
+    }
+
     public function secretAchievements(): BelongsToMany
     {
         return $this->belongsToMany(related: config(key: 'level-up.models.achievement'))

diff --git a/tests/Concerns/HasAchievementsTest.php b/tests/Concerns/HasAchievementsTest.php
@@ -80,7 +80,7 @@
     $this->user->grantAchievement($this->achievement, 50);
     $this->user->grantAchievement(Achievement::factory()->create(), 50);
 
-    expect($this->user)->getUserAchievements()->first()->pivot->withProgress(50)->toHaveCount(2);
+    expect($this->user->achievementsWithSpecificProgress(50)->get())->toHaveCount(count: 2);
 });
 
 it(description: 'can increment the progress of an Achievement', closure: function (): void {