Merge pull request #35 from lara-zeus/feat/add-local-scopes

feat(scopes): add local scopes

Author: atmonshi

.github/workflows/run-tests.yml

@@ -2,9 +2,9 @@ name: run-tests
 
 on:
   push:
-    branches: [main]
+    branches: [1.x]
   pull_request:
-    branches: [main]
+    branches: [1.x]
   workflow_dispatch:
 
 jobs:
@@ -14,7 +14,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        php: [8.2,8.3]
+        php: [8.2,8.3,8.4]
         laravel: [11.*,12.*]
         stability: [prefer-lowest, prefer-stable]
         include:

.github/workflows/update-changelog.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: main
+          ref: 1.x
 
       - name: Update Changelog
         uses: stefanzweifel/changelog-updater-action@v1
@@ -26,6 +26,6 @@ jobs:
       - name: Commit updated CHANGELOG
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
-          branch: main
+          branch: 1.x
           commit_message: Update CHANGELOG
           file_pattern: CHANGELOG.md

composer.json

@@ -22,14 +22,15 @@
     "require": {
         "php": "^8.2",
         "filament/filament": "^3.2",
+        "illuminate/database": "^11.40|^12.0",
         "spatie/laravel-package-tools": "^1.18"
     },
     "require-dev": {
         "laravel/pint": "^1.0",
         "nunomaduro/collision": "^8.0",
         "larastan/larastan": "^3.0",
         "orchestra/testbench": "^10.0",
-        "pestphp/pest": "^3.0",
+        "pestphp/pest": "^3.5",
         "pestphp/pest-plugin-arch": "^3.0",
         "pestphp/pest-plugin-laravel": "^3.0",
         "phpstan/extension-installer": "^1.0",
@@ -49,7 +50,7 @@
     "scripts": {
         "post-autoload-dump": "@php ./vendor/bin/testbench package:discover --ansi",
         "analyse": "vendor/bin/phpstan analyse",
-        "test": "vendor/bin/pest",
+        "test": "vendor/bin/pest --parallel",
         "test-coverage": "vendor/bin/pest --coverage",
         "format": "vendor/bin/pint",
         "lint": [

src/Traits/Bookmark/Bookmarkable.php

@@ -12,4 +12,5 @@ trait Bookmarkable
     use Markable\Actions;
     use Markable\Indicators;
     use Markable\Relations;
+    use Markable\Scopes;
 }

src/Traits/Bookmark/HasBookmarks.php

@@ -12,4 +12,5 @@ trait HasBookmarks
     use Marker\Actions;
     use Marker\Indicators;
     use Marker\Relations;
+    use Marker\Scopes;
 }

src/Traits/Bookmark/Markable/Scopes.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaraZeus\Mark\Traits\Bookmark\Markable;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+trait Scopes
+{
+    public function scopeWhereBookmarkedBy(Builder $query, Model | Collection $marker): Builder
+    {
+        return $query->whereRelation(
+            'bookmarks',
+            fn (Builder $q) => $q->whereBelongsTo($marker, 'marker')
+        );
+    }
+}

src/Traits/Bookmark/Marker/Scopes.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaraZeus\Mark\Traits\Bookmark\Marker;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+trait Scopes
+{
+    public function scopeWhereBookmarked(Builder $query, Model | Collection $markable): Builder
+    {
+        return $query->whereRelation(
+            'bookmarks',
+            fn (Builder $q) => $q->whereMorphedTo('markable', $markable)
+        );
+    }
+}

src/Traits/Like/HasLikes.php

@@ -12,4 +12,5 @@ trait HasLikes
     use Marker\Actions;
     use Marker\Indicators;
     use Marker\Relations;
+    use Marker\Scopes;
 }

src/Traits/Like/Likeable.php

@@ -12,4 +12,5 @@ trait Likeable
     use Markable\Actions;
     use Markable\Indicators;
     use Markable\Relations;
+    use Markable\Scopes;
 }

src/Traits/Like/Markable/Scopes.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LaraZeus\Mark\Traits\Like\Markable;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+trait Scopes
+{
+    public function scopeWhereLikedOrDislikedBy(Builder $query, Model | Collection $marker): Builder
+    {
+        return $query->whereRelation(
+            'likes',
+            fn (Builder $q) => $q->whereBelongsTo($marker, 'marker')
+        );
+    }
+
+    public function scopeWhereLikedBy(Builder $query, Model | Collection $marker): Builder
+    {
+        return $query->whereRelation(
+            'likes',
+            fn (Builder $q) => $q
+                ->whereBelongsTo($marker, 'marker')
+                ->where('value', true)
+        );
+    }
+
+    public function scopeWhereDislikedBy(Builder $query, Model | Collection $marker): Builder
+    {
+        return $query->whereRelation(
+            'likes',
+            fn (Builder $q) => $q
+                ->whereBelongsTo($marker, 'marker')
+                ->where('value', false)
+        );
+    }
+}

src/Traits/Like/Marker/Scopes.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LaraZeus\Mark\Traits\Like\Marker;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+trait Scopes
+{
+    public function scopeWhereLikedOrDisliked(Builder $query, Model | Collection $markable): Builder
+    {
+        return $query->whereRelation(
+            'likes',
+            fn (Builder $q) => $q->whereMorphedTo('markable', $markable)
+        );
+    }
+
+    public function scopeWhereLiked(Builder $query, Model | Collection $markable): Builder
+    {
+        return $query->whereRelation(
+            'likes',
+            fn (Builder $q) => $q
+                ->whereMorphedTo('markable', $markable)
+                ->where('value', true)
+        );
+    }
+
+    public function scopeWhereDisliked(Builder $query, Model | Collection $markable): Builder
+    {
+        return $query->whereRelation(
+            'likes',
+            fn (Builder $q) => $q
+                ->whereMorphedTo('markable', $markable)
+                ->where('value', false)
+        );
+    }
+}

src/Traits/Rating/HasRatings.php

@@ -12,4 +12,5 @@ trait HasRatings
     use Marker\Actions;
     use Marker\Indicators;
     use Marker\Relations;
+    use Marker\Scopes;
 }

src/Traits/Rating/Markable/Scopes.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaraZeus\Mark\Traits\Rating\Markable;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+trait Scopes
+{
+    public function scopeWhereRatedBy(Builder $query, Model | Collection $marker): Builder
+    {
+        return $query->whereRelation(
+            'ratings',
+            fn (Builder $q) => $q->whereBelongsTo($marker, 'marker')
+        );
+    }
+}

src/Traits/Rating/Marker/Scopes.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaraZeus\Mark\Traits\Rating\Marker;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+trait Scopes
+{
+    public function scopeWhereRated(Builder $query, Model | Collection $markable): Builder
+    {
+        return $query->whereRelation(
+            'ratings',
+            fn (Builder $q) => $q->whereMorphedTo('markable', $markable)
+        );
+    }
+}

src/Traits/Rating/Rateable.php

@@ -12,4 +12,5 @@ trait Rateable
     use Markable\Actions;
     use Markable\Indicators;
     use Markable\Relations;
+    use Markable\Scopes;
 }

tests/ExampleTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaraZeus\Mark\Tests\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use LaraZeus\Mark\Tests\Models\Markable;
+
+class MarkableFactory extends Factory
+{
+    protected $model = Markable::class;
+
+    public function definition(): array
+    {
+        return [
+
+        ];
+    }
+}

tests/Factories/MarkableFactory.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaraZeus\Mark\Tests\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use LaraZeus\Mark\Tests\Models\Marker;
+
+class MarkerFactory extends Factory
+{
+    protected $model = Marker::class;
+
+    public function definition(): array
+    {
+        return [
+
+        ];
+    }
+}

tests/Factories/MarkerFactory.php

@@ -0,0 +1,69 @@
+<?php
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use LaraZeus\Mark\Tests\Models\Markable;
+use LaraZeus\Mark\Tests\Models\Marker;
+
+describe('scope', function () {
+    beforeEach(function () {
+        $this->marker1 = Marker::factory()->create();
+        $this->markables1 = Markable::factory()
+            ->count(3)
+            ->create()
+            ->each(
+                fn (Markable $markable) => $markable
+                    ->bookmarkedBy()
+                    ->attach($this->marker1, ['value' => true])
+            );
+
+        $this->marker2 = Marker::factory()->create();
+        $this->markables2 = Markable::factory()
+            ->count(3)
+            ->create()
+            ->each(
+                fn (Markable $markable) => $markable
+                    ->bookmarkedBy()
+                    ->attach($this->marker2, ['value' => true])
+            );
+    });
+
+    describe('whereBookmarkedBy', function () {
+
+        test('has correct signature', function () {
+            $method = (new ReflectionClass(Markable::class))
+                ->getMethod('scopeWhereBookmarkedBy');
+
+            expect($method->isPublic())->toBeTrue();
+
+            $parameters = $method->getParameters();
+            expect($parameters)->toHaveCount(2);
+
+            [$queryParam, $markableParam] = $parameters;
+
+            expect($queryParam->getName())->toBe('query')
+                ->and($queryParam->getType()->getName())->toBe(Builder::class)
+                ->and($queryParam->getType()->allowsNull())->toBeFalse();
+
+            expect($markableParam->getName())->toBe('marker')
+                ->and($markableParam->getType())->toBeInstanceOf(ReflectionUnionType::class)
+                ->and(collect($markableParam->getType()->getTypes())->map(fn ($t) => $t->getName())->all())
+                ->toMatchArray([Model::class, Collection::class]);
+        });
+
+        test('filter the relations currectly', function () {
+            expect(Markable::whereBookmarkedBy($this->marker1)->get())
+                ->toHaveCount(3)
+                ->toContainModel($this->markables1);
+
+            expect(Markable::whereBookmarkedBy($this->marker2)->get())
+                ->toHaveCount(3)
+                ->toContainModel($this->markables2);
+
+            expect(Markable::whereBookmarkedBy($this->marker1)->get())
+                ->toHaveCount(3)
+                ->not->toContainModel($this->markables2);
+        });
+    });
+});