HasStatuses::scopeWithoutStatus() - Code Metrics - Inspection of "Created a withoutStatus scope" - spatie/laravel-model-status - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#23)

by Matt

created 2018-02-28 23:44 UTC

HasStatuses::scopeWithoutStatus() A

↳ Parent: HasStatuses

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Spatie\ModelStatus;

use DB;
use Illuminate\Database\Eloquent\Builder;
use Spatie\ModelStatus\Exceptions\InvalidStatus;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Database\Query\Builder as QueryBuilder;

trait HasStatuses
{
    public function statuses(): MorphMany
    {
        return $this->morphMany($this->getStatusModelClassName(), 'model')->latest();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function status(): ?Status
    {
        return $this->latestStatus();
    }

    public function setStatus(string $name, string $reason = ''): self
    {
        if (! $this->isValidStatus($name, $reason)) {
            throw InvalidStatus::create($name, $reason);

        }

        $this->statuses()->create([
            'name' => $name,
            'reason' => $reason,
        ]);

        return $this;
    }

    public function isValidStatus(string $name, string $reason = ''): bool

    {
        return true;
    }

    /**
     * @param string|array $names
     *
     * @return null|Status
     */
    public function latestStatus(...$names): ?Status
    {
        $names = is_array($names) ? array_flatten($names) : func_get_args();

        if (count($names) < 1) {
            return $this->statuses()->orderByDesc('id')->first();
        }

        return $this->statuses()->whereIn('name', $names)->orderByDesc('id')->first();
    }

    public function scopeCurrentStatus(Builder $builder, string $name)
    {
        $builder
            ->whereHas('statuses', function (Builder $query) use ($name) {
                $query
                    ->where('name', $name)
                    ->whereIn('id', function (QueryBuilder $query) use ($name) {
                        $query
                            ->select(DB::raw('max(id)'))
                            ->from($this->getStatusTableName())
                            ->where('model_type', static::class)
                            ->groupBy('model_id');
                    });
            });
    }

    public function scopeWithoutStatus(Builder $builder)
    {
        $builder->whereDoesntHave('statuses');
    }

    public function getStatusAttribute(): string
    {
        return (string) $this->latestStatus();
    }

    protected function getStatusTableName(): string
    {
        $modelClass = $this->getStatusModelClassName();

        return (new $modelClass)->getTable();
    }

    protected function getStatusModelClassName(): string
    {
        return config('model-status.status_model');
    }
}


1			<?php
2
3			namespace Spatie\ModelStatus;
4
5			use DB;
6			use Illuminate\Database\Eloquent\Builder;
7			use Spatie\ModelStatus\Exceptions\InvalidStatus;
8			use Illuminate\Database\Eloquent\Relations\MorphMany;
9			use Illuminate\Database\Query\Builder as QueryBuilder;
10
11			trait HasStatuses
12			{
13			public function statuses(): MorphMany
14			{
15			return $this->morphMany($this->getStatusModelClassName(), 'model')->latest();
			0 ignored issues – show Bug introduced 2018-02-09 19:41 UTC by Report Bug Copy Issue Report It seems like `morphMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
16			}
17
18			public function status(): ?Status
19			{
20			return $this->latestStatus();
21			}
22
23			public function setStatus(string $name, string $reason = ''): self
24			{
25			if (! $this->isValidStatus($name, $reason)) {
26			throw InvalidStatus::create($name, $reason);
			0 ignored issues – show Unused Code introduced 2018-02-06 16:42 UTC by Report Bug Copy Issue Report The call to `InvalidStatus::create()` has too many arguments starting with `$reason`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
27			}
28
29			$this->statuses()->create([
30			'name' => $name,
31			'reason' => $reason,
32			]);
33
34			return $this;
35			}
36
37			public function isValidStatus(string $name, string $reason = ''): bool
			0 ignored issues – show Unused Code introduced 2018-02-06 16:42 UTC by Report Bug Copy Issue Report The parameter `$name` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-02-06 16:42 UTC by Report Bug Copy Issue Report The parameter `$reason` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
38			{
39			return true;
40			}
41
42			/**
43			* @param string\|array $names
44			*
45			* @return null\|Status
46			*/
47			public function latestStatus(...$names): ?Status
48			{
49			$names = is_array($names) ? array_flatten($names) : func_get_args();
50
51			if (count($names) < 1) {
52			return $this->statuses()->orderByDesc('id')->first();
53			}
54
55			return $this->statuses()->whereIn('name', $names)->orderByDesc('id')->first();
56			}
57
58			public function scopeCurrentStatus(Builder $builder, string $name)
59			{
60			$builder
61			->whereHas('statuses', function (Builder $query) use ($name) {
62			$query
63			->where('name', $name)
64			->whereIn('id', function (QueryBuilder $query) use ($name) {
65			$query
66			->select(DB::raw('max(id)'))
67			->from($this->getStatusTableName())
68			->where('model_type', static::class)
69			->groupBy('model_id');
70			});
71			});
72			}
73
74			public function scopeWithoutStatus(Builder $builder)
75			{
76			$builder->whereDoesntHave('statuses');
77			}
78
79			public function getStatusAttribute(): string
80			{
81			return (string) $this->latestStatus();
82			}
83
84			protected function getStatusTableName(): string
85			{
86			$modelClass = $this->getStatusModelClassName();
87
88			return (new $modelClass)->getTable();
89			}
90
91			protected function getStatusModelClassName(): string
92			{
93			return config('model-status.status_model');
94			}
95			}
96

spatie / laravel-model-status

Pull Request — master (#23)

HasStatuses::scopeWithoutStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like