HasStatuses::latestStatus() - Code Metrics - Inspection of "Add clearStatuses method" - spatie/laravel-model-status - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Jeroen

created 2018-02-07 17:21 UTC

HasStatuses::latestStatus() A

↳ Parent: HasStatuses

Complexity

Conditions	3
Paths	4

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\ModelStatus;

use Spatie\ModelStatus\Exceptions\InvalidStatus;
use Illuminate\Database\Eloquent\Relations\MorphMany;

trait HasStatuses
{
    public function statuses(): MorphMany
    {
        return $this->morphMany(ModelStatusServiceProvider::getStatusModel(), 'model');
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);

        }

        $attributes = compact('name', 'reason');

        $this->statuses()->create($attributes);

        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()->latest()->orderByDesc('id')->first();
        }

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

    public function clearStatuses(): ?bool
    {
        return $this->statuses()->delete();
    }
}


1			<?php
2
3			namespace Spatie\ModelStatus;
4
5			use Spatie\ModelStatus\Exceptions\InvalidStatus;
6			use Illuminate\Database\Eloquent\Relations\MorphMany;
7
8			trait HasStatuses
9			{
10			public function statuses(): MorphMany
11			{
12			return $this->morphMany(ModelStatusServiceProvider::getStatusModel(), 'model');
			0 ignored issues – show Bug introduced 2018-02-07 10:25 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...
13			}
14
15			public function status(): ?Status
16			{
17			return $this->latestStatus();
18			}
19
20			public function setStatus(string $name, string $reason = ''): self
21			{
22			if (! $this->isValidStatus($name, $reason)) {
23			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...
24			}
25
26			$attributes = compact('name', 'reason');
27
28			$this->statuses()->create($attributes);
29
30			return $this;
31			}
32
33			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...
34			{
35			return true;
36			}
37
38			/**
39			* @param string\|array $names
40			* @return null\|Status
41			*/
42			public function latestStatus(...$names): ?Status
43			{
44			$names = is_array($names) ? array_flatten($names) : func_get_args();
45
46			if (count($names) < 1) {
47			return $this->statuses()->latest()->orderByDesc('id')->first();
48			}
49
50			return $this->statuses()->whereIn('name', $names)->latest()->orderByDesc('id')->first();
51			}
52
53			public function clearStatuses(): ?bool
54			{
55			return $this->statuses()->delete();
56			}
57			}
58

spatie / laravel-model-status

Pull Request — master (#15)

HasStatuses::latestStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like