Completed
Pull Request — master (#1026)
by
unknown
02:34
created

InstallCommand::getArguments()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 7
ccs 2
cts 2
cp 1
crap 1
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace Nwidart\Modules\Commands;
4
5
use Illuminate\Console\Command;
6
use Nwidart\Modules\Json;
7
use Nwidart\Modules\Process\Installer;
8
use Symfony\Component\Console\Input\InputArgument;
9
use Symfony\Component\Console\Input\InputOption;
10
11
class InstallCommand extends Command
12
{
13
    /**
14
     * The console command name.
15
     *
16
     * @var string
17
     */
18
    protected $name = 'module:install';
19
20
    /**
21
     * The console command description.
22
     *
23
     * @var string
24
     */
25
    protected $description = 'Install the specified module by given package name (vendor/name).';
26
27
    /**
28
     * Create a new command instance.
29
     */
30 128
    public function __construct()
31
    {
32 128
        parent::__construct();
33 128
    }
34
35
    /**
36
     * Execute the console command.
37
     */
38
    public function handle() : int
39
    {
40
        if (is_null($this->argument('name'))) {
41
            return $this->installFromFile();
42
        }
43
44
        $this->install(
45
            $this->argument('name'),
0 ignored issues
show
Bug introduced by
It seems like $this->argument('name') targeting Illuminate\Console\Conce...ractsWithIO::argument() can also be of type array; however, Nwidart\Modules\Commands\InstallCommand::install() does only seem to accept string, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
46
            $this->argument('version'),
0 ignored issues
show
Bug introduced by
It seems like $this->argument('version') targeting Illuminate\Console\Conce...ractsWithIO::argument() can also be of type array; however, Nwidart\Modules\Commands\InstallCommand::install() does only seem to accept string, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
47
            $this->option('type'),
48
            $this->option('tree')
49
        );
50
51
        return 0;
52
    }
53
54
    /**
55
     * Install modules from modules.json file.
56
     */
57
    protected function installFromFile() : int
58
    {
59
        if (!file_exists($path = base_path('modules.json'))) {
60
            $this->error("File 'modules.json' does not exist in your project root.");
61
62
            return E_ERROR;
63
        }
64
65
        $modules = Json::make($path);
66
67
        $dependencies = $modules->get('require', []);
68
69
        foreach ($dependencies as $module) {
70
            $module = collect($module);
71
72
            $this->install(
73
                $module->get('name'),
74
                $module->get('version'),
75
                $module->get('type')
76
            );
77
        }
78
79
        return 0;
80
    }
81
82
    /**
83
     * Install the specified module.
84
     *
85
     * @param string $name
86
     * @param string $version
87
     * @param string $type
88
     * @param bool   $tree
89
     */
90
    protected function install($name, $version = 'dev-master', $type = 'composer', $tree = false)
91
    {
92
        $installer = new Installer(
93
            $name,
94
            $version,
95
            $type ?: $this->option('type'),
96
            $tree ?: $this->option('tree')
97
        );
98
99
        $installer->setRepository($this->laravel['modules']);
100
101
        $installer->setConsole($this);
102
103
        if ($timeout = $this->option('timeout')) {
104
            $installer->setTimeout($timeout);
105
        }
106
107
        if ($path = $this->option('path')) {
108
            $installer->setPath($path);
109
        }
110
111
        $installer->run();
112
113
        if (!$this->option('no-update')) {
114
            $this->call('module:update', [
115
                'module' => $installer->getModuleName(),
116
            ]);
117
        }
118
    }
119
120
    /**
121
     * Get the console command arguments.
122
     *
123
     * @return array
124
     */
125 128
    protected function getArguments()
126
    {
127
        return [
128 128
            ['name', InputArgument::OPTIONAL, 'The name of module will be installed.'],
129
            ['version', InputArgument::OPTIONAL, 'The version of module will be installed.'],
130
        ];
131
    }
132
133
    /**
134
     * Get the console command options.
135
     *
136
     * @return array
137
     */
138 128
    protected function getOptions()
139
    {
140
        return [
141 128
            ['timeout', null, InputOption::VALUE_OPTIONAL, 'The process timeout.', null],
142
            ['path', null, InputOption::VALUE_OPTIONAL, 'The installation path.', null],
143
            ['type', null, InputOption::VALUE_OPTIONAL, 'The type of installation.', null],
144
            ['tree', null, InputOption::VALUE_NONE, 'Install the module as a git subtree', null],
145
            ['no-update', null, InputOption::VALUE_NONE, 'Disables the automatic update of the dependencies.', null],
146
        ];
147
    }
148
}
149