Completed
Pull Request — master (#23)
by Travis
01:10
created

UnknownState   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 38
Duplicated Lines 100 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
wmc 4
lcom 1
cbo 2
dl 38
loc 38
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A make() 6 6 1
A setField() 6 6 1
A setModelClass() 6 6 1
A getSolution() 8 8 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace Spatie\ModelStates\Exceptions;
4
5
use Facade\IgnitionContracts\Solution;
6
use Facade\IgnitionContracts\BaseSolution;
7
use Facade\IgnitionContracts\ProvidesSolution;
8
9 View Code Duplication
class UnknownState extends InvalidConfig implements ProvidesSolution
0 ignored issues
show
Duplication introduced by
This class seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
10
{
11
    /** @var string */
12
    protected $field;
13
14
    /** @var string */
15
    protected $modelClass;
16
17
    public static function make(string $field, string $modelClass): self
18
    {
19
        return (new static("No state field found for {$modelClass}::{$field}, did you forget to provide a mapping in {$modelClass}::registerStates()?"))
20
            ->setField($field)
21
            ->setModelClass($modelClass);
22
    }
23
24
    public function setField(string $field): self
25
    {
26
        $this->field = $field;
27
28
        return $this;
29
    }
30
31
    public function setModelClass(string $modelClass): self
32
    {
33
        $this->modelClass = $modelClass;
34
35
        return $this;
36
    }
37
38
    public function getSolution(): Solution
39
    {
40
        return BaseSolution::create('The state field is unknown')
41
            ->setSolutionDescription("Add the `{$this->field}` field to the `registerStates` method inside `{$this->modelClass}`")
42
            ->setDocumentationLinks([
43
                'Configuring states' => 'https://docs.spatie.be/laravel-model-states/v1/working-with-states/01-configuring-states/',
44
            ]);
45
    }
46
}
47