Completed
Push — master ( 023ae7...9901a6 )
by Fumio
03:37
created

GeneratorCommandTrait::onAddon()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 2
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 4
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
3
namespace LaravelPlus\Extension\Generators;
4
5
use Jumilla\Addomnipot\Laravel\Environment as AddonEnvironment;
6
use Jumilla\Addomnipot\Laravel\Addon;
7
use UnexpectedValueException;
8
9
trait GeneratorCommandTrait
10
{
11
    /**
12
     * addon.
13
     *
14
     * @var \LaravelPlus\Extension\Addons\Addon
15
     */
16
    protected $addon;
17
18
    /**
19
     * Execute the console command.
20
     *
21
     * @return bool
22
     */
23 44
    public function handle()
24
    {
25 44
        if (!$this->processArguments()) {
26 1
            return false;
27
        }
28
29 42
        $this->addon = $this->getAddon();
0 ignored issues
show
Documentation Bug introduced by Fumio Furukawa
It seems like $this->getAddon() of type string is incompatible with the declared type object<LaravelPlus\Extension\Addons\Addon> of property $addon.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
30
31 28
        return parent::handle();
32
    }
33
34
    /**
35
     * Process command line arguments
36
     *
37
     * @return bool
38
     */
39 39
    protected function processArguments()
40
    {
41 39
        return true;
42
    }
43
44
    /**
45
     * Option --addon specified.
46
     *
47
     * @return bool
48
     */
49 8
    protected function onAddon()
50
    {
51 8
        return $this->option('addon') !== null;
0 ignored issues
show
Bug introduced by Fumio Furukawa
It seems like option() 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...
52
    }
53
54
    /**
55
     * Get addon.
56
     *
57
     * @return string
58
     */
59 46
    protected function getAddon()
60
    {
61 46
        if ($addon = $this->option('addon')) {
62 31
            $env = app(AddonEnvironment::class);
63
64 31
            if (!$env->exists($addon)) {
65 15
                throw new UnexpectedValueException("Addon '$addon' is not found.");
66
            }
67
68 16
            return $env->addon($addon);
69
        } else {
70 15
            return;
71
        }
72
    }
73
74
    /**
75
     * Get the application namespace.
76
     *
77
     * @return $string
78
     */
79 20
    protected function getAppNamespace()
80
    {
81 20
        return trim($this->laravel->getNamespace(), '\\');
82
    }
83
84
    /**
85
    * Get the addon namespace.
86
     *
87
     * @return $string
88
     */
89 15
    protected function getAddonNamespace()
90
    {
91 15
        return $this->addon->phpNamespace();
92
    }
93
94
    /**
95
     * Get the default namespace for the class.
96
     *
97
     * @return $string
98
     */
99 29
    protected function getRootNamespace()
100
    {
101 29
        return $this->addon ? $this->getAddonNamespace() : $this->getAppNamespace();
102
    }
103
104
    /**
105
     * Get the directory path for root namespace.
106
     *
107
     * @return string
108
     */
109 29
    protected function getRootDirectory()
110
    {
111 29
        if ($this->addon) {
112 15
            $directories = $this->addon->config('addon.directories');
113
114 15
            if (! $directories) {
115 15
                $directories = ['classes'];
116
            }
117
118 15
            return $this->addon->path($directories[0]);
119
        }
120
        else {
121 14
            return parent::getRootDirectory();
122
        }
123
    }
124
}
125