Extract Eloquent models scopes

[antonkomarev]

This discussion created after the #224

Right now Eloquent model local scopes are located in Reactable & Reacterable traits and you cannot exclude them. To not add magical optional methods to models but let people easily use them we move them to the specific traits.

There are 2 options:

1. Right in the Model magical local scope methods
2. New custom eloquent builder methods

[antonkomarev]

Solution 1: Magical local scope methods in models traits

Pros

• Easy to add traits right in the model
• Breaking change, but very easy to fix (we can include new traits in old ones to keep backward compatibility)

Cons

• Magical, not obvious usage of scope methods
• IDE don't know when method is used, because of magical scope prefix

Usage

$usersReactedByMe = User::query()->whereReactedBy($myUser)->get();

Implementation

<?php

declare(strict_types=1);

namespace App\Models;

use Cog\Laravel\Love\Reactable\Models\Traits\Reactable;
use Cog\Laravel\Love\Reactable\ReactableScopesTrait;
use Cog\Laravel\Love\Reacterable\Models\Traits\Reacterable;
use Cog\Laravel\Love\Reacterable\ReacterableScopesTrait;
use Illuminate\Database\Eloquent\Model;

final class User extends Model
{
    use Reactable;
    use ReactableScopesTrait;
    use Reacterable;
    use ReacterableScopesTrait;
}

<?php

declare(strict_types=1);

namespace Cog\Laravel\Love\Reactable;

use Cog\Contracts\Love\Reacterable\Models\Reacterable as ReacterableInterface;
use Cog\Laravel\Love\ReactionType\Models\ReactionType;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

/**
 * @mixin Model
 */
trait ReactableScopesTrait
{
    public function scopeWhereReactedBy(
        Builder $query,
        ReacterableInterface $reacterable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $query->whereHas(
            'loveReactant.reactions',
            function (Builder $reactionsQuery) use ($reacterable, $reactionTypeName) {
                $reactionsQuery->where('reacter_id', $reacterable->getLoveReacter()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }

    public function scopeWhereNotReactedBy(
        Builder $query,
        ReacterableInterface $reacterable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $query->whereDoesntHave(
            'loveReactant.reactions',
            function (Builder $reactionsQuery) use ($reacterable, $reactionTypeName) {
                $reactionsQuery->where('reacter_id', $reacterable->getLoveReacter()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }
}

<?php

declare(strict_types=1);

namespace Cog\Laravel\Love\Reacterable;

use Cog\Contracts\Love\Reactable\Models\Reactable as ReactableInterface;
use Cog\Laravel\Love\ReactionType\Models\ReactionType;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

/**
 * @mixin Model
 */
trait ReacterableScopesTrait
{
    public function scopeWhereReactedTo(
        Builder $query,
        ReactableInterface $reactable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $query->whereHas(
            'loveReacter.reactions',
            function (Builder $reactionsQuery) use ($reactable, $reactionTypeName) {
                $reactionsQuery->where('reactant_id', $reactable->getLoveReactant()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }

    public function scopeWhereNotReactedTo(
        Builder $query,
        ReactableInterface $reactable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $query->whereDoesntHave(
            'loveReacter.reactions',
            function (Builder $reactionsQuery) use ($reactable, $reactionTypeName) {
                $reactionsQuery->where('reactant_id', $reactable->getLoveReactant()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }
}

[vesper8]

@antonkomarev Hey hey! Long time.. so.. I'm just now upgrading to Laravel 10 and as a result am having to migrate from v8 to v9.

Am I to understand that you've done away with this "Solution 1" entirely and not left it up to the user to decide if they want to use a simple trait?

This really throws a curveball at me because.. I already have a newEloquentBuilder in my User model.. and now I'm stuck trying to figure out how I can make it work with two!!

[antonkomarev]

@vesper8 Nope, I've picked solution 2.

[antonkomarev]

Implementation #227

[antonkomarev]

You can add reusable traits to your builder.

[vesper8]

Yea thank you, I was able to combine them both into one. Cheers!

[antonkomarev]

Solution 2: Custom Eloquent Builder methods traits

Pros

• Scopes are encapsulated in specialized Eloquent Builder classes
• IDE friendly, can find scope method usages
• Methods named exactly like they are used

Cons

• Increased entry threshold to start using package, not all developers familiar with custom Eloquent Builders feature
• Breaking change, will require to add custom Eloquent Builders and use traits in them

Usage

$usersReactedByMe = User::query()->whereReactedBy($myUser)->get();

Implementation

<?php

declare(strict_types=1);

namespace App\Models;

use Cog\Laravel\Love\Reactable\Models\Traits\Reactable;
use Cog\Laravel\Love\Reacterable\Models\Traits\Reacterable;
use Illuminate\Database\Eloquent\Model;

/**
 * @method static UserEloquentBuilder query()
 */
final class User extends Model
{
    use Reactable;
    use Reacterable;

    public function newEloquentBuilder($query)
    {
        return new UserEloquentBuilder($query);
    }
}

<?php

declare(strict_types=1);

namespace App\Models;

use Cog\Laravel\Love\Reactable\ReactableScopesTrait;
use Cog\Laravel\Love\Reacterable\ReacterableScopesTrait;
use Illuminate\Database\Eloquent\Builder;

final class UserEloquentBuilder extends Builder
{
    use ReactableScopesTrait;
    use ReacterableScopesTrait;

    // Your other custom scopes
}

<?php

declare(strict_types=1);

namespace Cog\Laravel\Love\Reactable;

use Cog\Contracts\Love\Reacterable\Models\Reacterable as ReacterableInterface;
use Cog\Laravel\Love\ReactionType\Models\ReactionType;
use Illuminate\Database\Eloquent\Builder;

/**
 * @mixin Builder
 */
trait ReactableEloquentBuilderTrait
{
    public function whereReactedBy(
        ReacterableInterface $reacterable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $this->whereHas(
            'loveReactant.reactions',
            function (Builder $reactionsQuery) use ($reacterable, $reactionTypeName) {
                $reactionsQuery->where('reacter_id', $reacterable->getLoveReacter()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }

    public function whereNotReactedBy(
        ReacterableInterface $reacterable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $this->whereDoesntHave(
            'loveReactant.reactions',
            function (Builder $reactionsQuery) use ($reacterable, $reactionTypeName) {
                $reactionsQuery->where('reacter_id', $reacterable->getLoveReacter()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }
}

<?php

declare(strict_types=1);

namespace Cog\Laravel\Love\Reacterable;

use Cog\Contracts\Love\Reactable\Models\Reactable as ReactableInterface;
use Cog\Laravel\Love\ReactionType\Models\ReactionType;
use Illuminate\Database\Eloquent\Builder;

/**
 * @mixin Builder
 */
trait ReacterableEloquentBuilderTrait
{
    public function whereReactedTo(
        ReactableInterface $reactable,
        ?string $reactionTypeName = null,
    ): Builder {
        return $this->whereHas(
            'loveReacter.reactions',
            function (Builder $reactionsQuery) use ($reactable, $reactionTypeName) {
                $reactionsQuery->where('reactant_id', $reactable->getLoveReactant()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }

    public function whereNotReactedTo(
        ReactableInterface $reactable,
        ?string $reactionTypeName = null,
    ): self {
        return $this->whereDoesntHave(
            'loveReacter.reactions',
            function (Builder $reactionsQuery) use ($reactable, $reactionTypeName) {
                $reactionsQuery->where('reactant_id', $reactable->getLoveReactant()->getId());
                if ($reactionTypeName !== null) {
                    $reactionsQuery->where('reaction_type_id', ReactionType::fromName($reactionTypeName)->getId());
                }
            }
        );
    }
}

[antonkomarev]

• Implementation of this option Extract local Model scopes to Eloquent Builder traits #227