Cog\Laravel\Love\Reactable\Models\Traits\Reactable

Complexity

Total Complexity

16

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	viaLoveReactant()	0	3	1
A	registerAsLoveReactant()	0	13	2
A	isRegisteredAsLoveReactant()	0	3	1
A	getLoveReactant()	0	3	1
A	loveReactant()	0	3	1
A	isNotRegisteredAsLoveReactant()	0	3	1
A	bootReactable()	0	3	1
A	scopeWhereReactedBy()	0	9	2
A	scopeJoinReactionTotal()	0	12	2
A	scopeWhereNotReactedBy()	0	9	2
A	scopeJoinReactionCounterOfType()	0	18	2

<?php

/*
 * This file is part of Laravel Love.
 *
 * (c) Anton Komarev <anton@komarev.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cog\Laravel\Love\Reactable\Models\Traits;

use Cog\Contracts\Love\Reactable\Exceptions\AlreadyRegisteredAsLoveReactant;
use Cog\Contracts\Love\Reactant\Facades\Reactant as ReactantFacadeContract;
use Cog\Contracts\Love\Reactant\Models\Reactant as ReactantContract;
use Cog\Contracts\Love\Reacterable\Models\Reacterable as ReacterableContract;
use Cog\Laravel\Love\Reactable\Observers\ReactableObserver;
use Cog\Laravel\Love\Reactant\Facades\Reactant as ReactantFacade;
use Cog\Laravel\Love\Reactant\Models\NullReactant;
use Cog\Laravel\Love\Reactant\Models\Reactant;
use Cog\Laravel\Love\Reactant\ReactionCounter\Models\ReactionCounter;
use Cog\Laravel\Love\Reactant\ReactionTotal\Models\ReactionTotal;
use Cog\Laravel\Love\ReactionType\Models\ReactionType;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Query\JoinClause;
use Illuminate\Support\Facades\DB;

/**
 * @mixin \Cog\Contracts\Love\Reactable\Models\Reactable
 */
trait Reactable
{
    protected static function bootReactable(): void
    {
        static::observe(ReactableObserver::class);
    }

    public function loveReactant(): BelongsTo
    {
        return $this->belongsTo(Reactant::class, 'love_reactant_id');

It seems like belongsTo() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function getLoveReactant(): ReactantContract
    {
        return $this->getAttribute('loveReactant') ?? new NullReactant($this);

It seems like getAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

$this of type Cog\Laravel\Love\Reactable\Models\Traits\Reactable is incompatible with the type Cog\Contracts\Love\Reactable\Models\Reactable expected by parameter $reactable of Cog\Laravel\Love\Reactant\Models\NullReactant::__construct().

    }

    public function viaLoveReactant(): ReactantFacadeContract
    {
        return new ReactantFacade($this->getLoveReactant());
    }

    public function isRegisteredAsLoveReactant(): bool
    {
        return !$this->isNotRegisteredAsLoveReactant();
    }

    public function isNotRegisteredAsLoveReactant(): bool
    {
        return is_null($this->getAttributeValue('love_reactant_id'));

It seems like getAttributeValue() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function registerAsLoveReactant(): void
    {
        if ($this->isRegisteredAsLoveReactant()) {
            throw new AlreadyRegisteredAsLoveReactant();
        }

        /** @var \Cog\Contracts\Love\Reactant\Models\Reactant $reactant */
        $reactant = $this->loveReactant()->create([
            'type' => $this->getMorphClass(),

It seems like getMorphClass() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        ]);

        $this->setAttribute('love_reactant_id', $reactant->getId());

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

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

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

    public function scopeJoinReactionCounterOfType(
        Builder $query,
        string $reactionTypeName,
        ?string $alias = null
    ): Builder {
        $reactionType = ReactionType::fromName($reactionTypeName);
        $alias = is_null($alias) ? strtolower($reactionType->getName()) . '_reactions' : $alias;

        $select = $query->getQuery()->columns ?? ["{$this->getTable()}.*"];

It seems like getTable() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $select[] = DB::raw("COALESCE({$alias}.count, 0) as {$alias}_count");
        $select[] = DB::raw("COALESCE({$alias}.weight, 0) as {$alias}_weight");

        return $query

The expression return $query->leftJoin(new Cog\Laravel\Love\Reactant\ReactionCounter\Models\ReactionCounter()->getTable() . ' as ' . $alias, function(...) { /* ... */ })->select($select) could return the type Illuminate\Database\Query\Builder which is incompatible with the type-hinted return Illuminate\Database\Eloquent\Builder. Consider adding an additional type-check to rule them out.

            ->leftJoin((new ReactionCounter())->getTable() . ' as '. $alias, function (JoinClause $join) use ($reactionType, $alias) {
                $join->on("{$alias}.reactant_id", '=', "{$this->getTable()}.love_reactant_id");
                $join->where("{$alias}.reaction_type_id", $reactionType->getId());
            })
            ->select($select);
    }

    public function scopeJoinReactionTotal(
        Builder $query,
        ?string $alias = null
    ): Builder {
        $alias = is_null($alias) ? 'total_reactions' : $alias;
        $select = $query->getQuery()->columns ?? ["{$this->getTable()}.*"];
        $select[] = DB::raw("COALESCE({$alias}.count, 0) as {$alias}_count");
        $select[] = DB::raw("COALESCE({$alias}.weight, 0) as {$alias}_weight");

        return $query

The expression return $query->leftJoin(new Cog\Laravel\Love\Reactant\ReactionTotal\Models\ReactionTotal()->getTable() . ' as ' . $alias, $alias.'.reactant_id', '=', $this->getTable().'.love_reactant_id')->select($select) could return the type Illuminate\Database\Query\Builder which is incompatible with the type-hinted return Illuminate\Database\Eloquent\Builder. Consider adding an additional type-check to rule them out.

            ->leftJoin((new ReactionTotal())->getTable() . ' as ' . $alias, "{$alias}.reactant_id", '=', "{$this->getTable()}.love_reactant_id")
            ->select($select);
    }
}