InstallCommand::getOptions() - Code Metrics - Inspection of "Testing model generation" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 15e02a...758c52 )

by Nicolas

created 2016-06-29 13:02 UTC

InstallCommand::getOptions() A

↳ Parent: InstallCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	7
cts	7
cp	1
rs	9.4285
cc	1
eloc	7
nc	1
nop	0
crap	1

<?php

namespace Nwidart\Modules\Commands;

use Illuminate\Console\Command;
use Nwidart\Modules\Process\Installer;
use Pingpong\Support\Json;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;

class InstallCommand extends Command
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'module:install';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Install the specified module by given package name (vendor/name).';

    /**
     * Create a new command instance.
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function fire()
    {
        if (is_null($this->argument('name'))) {
            $this->installFromFile();

            return;
        }

        $this->install(
            $this->argument('name'),

            $this->argument('version'),

            $this->option('type'),

            $this->option('tree')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    /**
     * Install modules from modules.json file.
     */
    protected function installFromFile()
    {
        if (!file_exists($path = base_path('modules.json'))) {
            $this->error("File 'modules.json' does not exist in your project root.");

            return;
        }

        $modules = Json::make($path);

        $dependencies = $modules->get('require', []);

        foreach ($dependencies as $module) {
            $module = collect($module);

            $this->install(
                $module->get('name'),
                $module->get('version'),
                $module->get('type')
            );
        }
    }

    /**
     * Install the specified module.
     *
     * @param string $name
     * @param string $version
     * @param string $type
     * @param bool   $tree
     */
    protected function install($name, $version = 'dev-master', $type = 'composer', $tree = false)
    {
        $installer = new Installer(
            $name,
            $version,
            $type ?: $this->option('type'),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $tree ?: $this->option('tree')
        );

        $installer->setRepository($this->laravel['modules']);

        $installer->setConsole($this);

        if ($timeout = $this->option('timeout')) {
            $installer->setTimeout($timeout);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        if ($path = $this->option('path')) {
            $installer->setPath($path);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        $installer->run();

        if (!$this->option('no-update')) {
            $this->call('module:update', [
                'module' => $installer->getModuleName(),
            ]);
        }
    }

    /**
     * Get the console command arguments.
     *
     * @return array
     */
    protected function getArguments()
    {
        return array(
            array('name', InputArgument::OPTIONAL, 'The name of module will be installed.'),
            array('version', InputArgument::OPTIONAL, 'The version of module will be installed.'),
        );
    }

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return array(
            array('timeout', null, InputOption::VALUE_OPTIONAL, 'The process timeout.', null),
            array('path', null, InputOption::VALUE_OPTIONAL, 'The installation path.', null),
            array('type', null, InputOption::VALUE_OPTIONAL, 'The type of installation.', null),
            array('tree', null, InputOption::VALUE_NONE, 'Install the module as a git subtree', null),
            array('no-update', null, InputOption::VALUE_NONE, 'Disables the automatic update of the dependencies.', null),
        );
    }
}


1		<?php
2
3		namespace Nwidart\Modules\Commands;
4
5		use Illuminate\Console\Command;
6		use Nwidart\Modules\Process\Installer;
7		use Pingpong\Support\Json;
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	16	public function __construct()
31		{
32	16	parent::__construct();
33	16	}
34
35		/**
36		* Execute the console command.
37		*
38		* @return mixed
39		*/
40		public function fire()
41		{
42		if (is_null($this->argument('name'))) {
43		$this->installFromFile();
44
45		return;
46		}
47
48		$this->install(
49		$this->argument('name'),
		0 ignored issues – show Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$this->argument('name')` targeting `Illuminate\Console\Command::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...
50		$this->argument('version'),
		0 ignored issues – show Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$this->argument('version')` targeting `Illuminate\Console\Command::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...
51		$this->option('type'),
		0 ignored issues – show Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$this->option('type')` targeting `Illuminate\Console\Command::option()` 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...
52		$this->option('tree')
		0 ignored issues – show Documentation introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report `$this->option('tree')` is of type `string\|array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
53		);
54		}
55
56		/**
57		* Install modules from modules.json file.
58		*/
59		protected function installFromFile()
60		{
61		if (!file_exists($path = base_path('modules.json'))) {
62		$this->error("File 'modules.json' does not exist in your project root.");
63
64		return;
65		}
66
67		$modules = Json::make($path);
68
69		$dependencies = $modules->get('require', []);
70
71		foreach ($dependencies as $module) {
72		$module = collect($module);
73
74		$this->install(
75		$module->get('name'),
76		$module->get('version'),
77		$module->get('type')
78		);
79		}
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'),
		0 ignored issues – show Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$type ?: $this->option('type')` can also be of type `array`; however, `Nwidart\Modules\Process\Installer::__construct()` does only seem to accept `string\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
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);
		0 ignored issues – show Documentation introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report `$timeout` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
105		}
106
107		if ($path = $this->option('path')) {
108		$installer->setPath($path);
		0 ignored issues – show Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->option('path')` on line `107` can also be of type `array`; however, `Nwidart\Modules\Process\Installer::setPath()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
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	16	protected function getArguments()
126		{
127		return array(
128	16	array('name', InputArgument::OPTIONAL, 'The name of module will be installed.'),
129	16	array('version', InputArgument::OPTIONAL, 'The version of module will be installed.'),
130	16	);
131		}
132
133		/**
134		* Get the console command options.
135		*
136		* @return array
137		*/
138	16	protected function getOptions()
139		{
140		return array(
141	16	array('timeout', null, InputOption::VALUE_OPTIONAL, 'The process timeout.', null),
142	16	array('path', null, InputOption::VALUE_OPTIONAL, 'The installation path.', null),
143	16	array('type', null, InputOption::VALUE_OPTIONAL, 'The type of installation.', null),
144	16	array('tree', null, InputOption::VALUE_NONE, 'Install the module as a git subtree', null),
145	16	array('no-update', null, InputOption::VALUE_NONE, 'Disables the automatic update of the dependencies.', null),
146	16	);
147		}
148		}
149

nWidart / laravel-modules

Push — master ( 15e02a...758c52 )

InstallCommand::getOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like