Webfactor\Laravel\OpeningHours\Traits\OpeningHoursScopes

Complexity

Total Complexity

17

Size/Duplication

Total Lines	145
Duplicated Lines	13.79 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

87.5%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	scopeWithOpeningHours()	0	4	1
A	scopeOpenOn()	10	10	2
A	scopeClosedOn()	10	10	2
A	scopeOpenAt()	0	4	1
A	scopeClosedAt()	0	4	1
B	scopeOpen()	0	24	5
B	scopeClosed()	0	24	5

<?php

namespace Webfactor\Laravel\OpeningHours\Traits;

use Carbon\Carbon;
use DateTimeInterface;
use Illuminate\Database\Eloquent\Builder;
use Webfactor\Laravel\OpeningHours\Entities\Day;
use Webfactor\Laravel\OpeningHours\Entities\Time;
use Webfactor\Laravel\OpeningHours\Exceptions\InvalidDayName;
use Webfactor\Laravel\OpeningHours\Exceptions\InvalidTimeString;

trait OpeningHoursScopes
{
    protected $openingHoursRelationName = 'dayOpenTimeRanges';

    public function scopeWithOpeningHours(Builder $query)
    {
        return $query->with($this->openingHoursRelationName);
    }

    /**
     * Get only open models.
     * If no time and day are provided current time and day are used.
     * If only time is provided current day is used.
     *
     * @param Builder $query
     * @param Time|string|null $time defaults to current time
     * @param string|null $day defaults to current day
     * @return Builder|static

Should the return type not be Builder|\Illuminate\Database\Eloquent\Concerns\QueriesRelationships?

     * @throws InvalidDayName
     * @throws InvalidTimeString
     */
    public function scopeOpen(Builder $query, $time = null, string $day = null)
    {
        $now = Carbon::now();
        if ($time == null) {

It seems like you are loosely comparing $time of type Webfactor\Laravel\OpeningHours\Entities\Time|string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $time = Time::fromDateTime($now);
        } elseif (is_string($time)) {
            $time = Time::fromString($time);
        }

        if ($day == null) {

It seems like you are loosely comparing $day of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $day = Day::onDateTime($now);
        } else {
            if (! Day::isValid($day)) {
                throw new InvalidDayName();
            }
        }

        return $query->whereHas($this->openingHoursRelationName, function (Builder $subquery) use ($day, $time) {
            $subquery
                ->where('day', $day)
                ->where('start', '<=', $time)
                ->where('end', '>=', $time);
        });
    }

    /**
     * Get only closed models.
     * If no time and day are provided current time and day are used.
     * If only time is provided current day is used.
     *
     * @param Builder $query
     * @param Time|string|null $time defaults to current time
     * @param string|null $day defaults to current day
     * @return Builder|static

Should the return type not be Builder|\Illuminate\Database\Eloquent\Concerns\QueriesRelationships?

     * @throws InvalidDayName
     * @throws InvalidTimeString
     */
    public function scopeClosed(Builder $query, $time = null, string $day = null)
    {
        $now = Carbon::now();
        if ($time == null) {

It seems like you are loosely comparing $time of type Webfactor\Laravel\OpeningHours\Entities\Time|string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $time = Time::fromDateTime($now);
        } elseif (is_string($time)) {
            $time = Time::fromString($time);
        }

        if ($day == null) {

It seems like you are loosely comparing $day of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $day = Day::onDateTime($now);
        } else {
            if (! Day::isValid($day)) {
                throw new InvalidDayName();
            }
        }

        return $query->whereDoesntHave($this->openingHoursRelationName, function (Builder $subquery) use ($day, $time) {
            $subquery
                ->where('day', $day)
                ->where('start', '<=', $time)
                ->where('end', '>=', $time);
        });
    }

    /**
     * Get all models open at the specified day at random time
     *
     * @param Builder $query
     * @param string $day
     * @return Builder|static

Should the return type not be Builder|\Illuminate\Database\Eloquent\Concerns\QueriesRelationships?

     * @throws InvalidDayName
     */
    public function scopeOpenOn(Builder $query, string $day)

This method seems to be duplicated in your project.

    {
        if (! Day::isValid($day)) {
            throw new InvalidDayName();
        }

        return $query->whereHas($this->openingHoursRelationName, function (Builder $subquery) use ($day) {
            $subquery->where('day', $day);
        });
    }

    /**
     * Get all models closed at the specified day
     *
     * @param Builder $query
     * @param string $day
     * @return Builder|static

Should the return type not be Builder|\Illuminate\Database\Eloquent\Concerns\QueriesRelationships?

     * @throws InvalidDayName
     */
    public function scopeClosedOn(Builder $query, string $day)

This method seems to be duplicated in your project.

    {
        if (! Day::isValid($day)) {
            throw new InvalidDayName();
        }

        return $query->whereDoesntHave($this->openingHoursRelationName, function (Builder $subquery) use ($day) {
            $subquery->where('day', $day);
        });
    }

    /**
     * Get all models open at the specified DateTime
     *
     * @param Builder $query
     * @param DateTimeInterface $date
     * @return mixed
     */
    public function scopeOpenAt(Builder $query, DateTimeInterface $date)
    {
        return $query->open(Time::fromDateTime($date), Day::onDateTime($date));
    }

    /**
     * Get all models closed at the specified DateTime
     *
     * @param Builder $query
     * @param DateTimeInterface $date
     * @return mixed
     */
    public function scopeClosedAt(Builder $query, DateTimeInterface $date)
    {
        return $query->closed(Time::fromDateTime($date), Day::onDateTime($date));
    }
}