SeedCommand - Code Metrics - Inspection of "Preparing dependencies for laravel 6.0" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4fafa1...e65f27 )

by Nicolas

created 2019-09-03 15:54 UTC

SeedCommand A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	224
Duplicated Lines	3.57 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

5.26%

Importance

Changes

Metric	Value
wmc	27
lcom	1
cbo	7
dl	8
loc	224
ccs	4
cts	76
cp	0.0526
rs	10
c	0
b	0
f	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	19	3
A	getModuleRepository()	0	9	2
A	getModuleByName()	0	9	2
B	moduleSeed()	0	31	9
A	dbSeed()	0	18	4
A	getSeederName()	0	10	1
A	getSeederNames()	0	15	2
A	renderException()	0	4	1
A	reportException()	0	4	1
A	getArguments()	0	6	1
A	getOptions()	8	8	1

How to fix Duplicated Code

<?php

namespace Nwidart\Modules\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Debug\ExceptionHandler;
use Illuminate\Support\Str;
use Nwidart\Modules\Contracts\RepositoryInterface;
use Nwidart\Modules\Module;
use Nwidart\Modules\Support\Config\GenerateConfigReader;
use Nwidart\Modules\Traits\ModuleCommandTrait;
use RuntimeException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;

class SeedCommand extends Command
{
    use ModuleCommandTrait;

    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'module:seed';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Run database seeder from the specified module or from all modules.';

    /**
     * Execute the console command.
     * @throws FatalThrowableError
     */
    public function handle()
    {
        try {
            if ($name = $this->argument('module')) {
                $name = Str::studly($name);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $this->moduleSeed($this->getModuleByName($name));
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            } else {
                $modules = $this->getModuleRepository()->getOrdered();
                array_walk($modules, [$this, 'moduleSeed']);
                $this->info('All modules seeded.');
            }
        } catch (\Throwable $e) {
            $this->reportException($e);

            $this->renderException($this->getOutput(), $e);

            return 1;
        }
    }

    /**
     * @throws RuntimeException
     * @return RepositoryInterface
     */
    public function getModuleRepository(): RepositoryInterface
    {
        $modules = $this->laravel['modules'];
        if (!$modules instanceof RepositoryInterface) {
            throw new RuntimeException('Module repository not found!');
        }

        return $modules;
    }

    /**
     * @param $name
     *
     * @throws RuntimeException
     *
     * @return Module
     */
    public function getModuleByName($name)
    {
        $modules = $this->getModuleRepository();
        if ($modules->has($name) === false) {
            throw new RuntimeException("Module [$name] does not exists.");
        }

        return $modules->find($name);
    }

    /**
     * @param Module $module
     *
     * @return void
     */
    public function moduleSeed(Module $module)
    {
        $seeders = [];
        $name = $module->getName();
        $config = $module->get('migration');
        if (is_array($config) && array_key_exists('seeds', $config)) {
            foreach ((array)$config['seeds'] as $class) {
                if (class_exists($class)) {
                    $seeders[] = $class;
                }
            }
        } else {
            $class = $this->getSeederName($name); //legacy support
            if (class_exists($class)) {
                $seeders[] = $class;
            } else {
                //look at other namespaces
                $classes = $this->getSeederNames($name);
                foreach ($classes as $class) {
                    if (class_exists($class)) {
                        $seeders[] = $class;
                    }
                }
            }
        }

        if (count($seeders) > 0) {
            array_walk($seeders, [$this, 'dbSeed']);
            $this->info("Module [$name] seeded.");
        }
    }

    /**
     * Seed the specified module.
     *
     * @param string $className
     */
    protected function dbSeed($className)
    {
        if ($option = $this->option('class')) {
            $params['--class'] = Str::finish(substr($className, 0, strrpos($className, '\\')), '\\') . $option;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        } else {
            $params = ['--class' => $className];
        }

        if ($option = $this->option('database')) {
            $params['--database'] = $option;
        }

        if ($option = $this->option('force')) {
            $params['--force'] = $option;
        }

        $this->call('db:seed', $params);
    }

    /**
     * Get master database seeder name for the specified module.
     *
     * @param string $name
     *
     * @return string
     */
    public function getSeederName($name)
    {
        $name = Str::studly($name);

        $namespace = $this->laravel['modules']->config('namespace');
        $config = GenerateConfigReader::read('seeder');
        $seederPath = str_replace('/', '\\', $config->getPath());
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        return $namespace . '\\' . $name . '\\' . $config->getNamespace() . '\\' . $name . 'DatabaseSeeder';
    }

    /**
     * Get master database seeder name for the specified module under a different namespace than Modules.
     *
     * @param string $name
     *
     * @return array $foundModules array containing namespace paths
     */
    public function getSeederNames($name)
    {
        $name = Str::studly($name);

        $seederPath = GenerateConfigReader::read('seeder');
        $seederPath = str_replace('/', '\\', $seederPath->getPath());

        $foundModules = [];
        foreach ($this->laravel['modules']->config('scan.paths') as $path) {
            $namespace = array_slice(explode('/', $path), -1)[0];
            $foundModules[] = $namespace . '\\' . $name . '\\' . $seederPath . '\\' . $name . 'DatabaseSeeder';
        }

        return $foundModules;
    }

    /**
     * Report the exception to the exception handler.
     *
     * @param  \Symfony\Component\Console\Output\OutputInterface  $output
     * @param  \Throwable  $e
     * @return void
     */
    protected function renderException($output, \Throwable $e)
    {
        $this->laravel[ExceptionHandler::class]->renderForConsole($output, $e);
    }

    /**
     * Report the exception to the exception handler.
     *
     * @param  \Throwable  $e
     * @return void
     */
    protected function reportException(\Throwable $e)
    {
        $this->laravel[ExceptionHandler::class]->report($e);
    }

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

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['class', null, InputOption::VALUE_OPTIONAL, 'The class name of the root seeder.'],
            ['database', null, InputOption::VALUE_OPTIONAL, 'The database connection to seed.'],
            ['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
        ];
    }
}


1			<?php
2
3			namespace Nwidart\Modules\Commands;
4
5			use Illuminate\Console\Command;
6			use Illuminate\Contracts\Debug\ExceptionHandler;
7			use Illuminate\Support\Str;
8			use Nwidart\Modules\Contracts\RepositoryInterface;
9			use Nwidart\Modules\Module;
10			use Nwidart\Modules\Support\Config\GenerateConfigReader;
11			use Nwidart\Modules\Traits\ModuleCommandTrait;
12			use RuntimeException;
13			use Symfony\Component\Console\Input\InputArgument;
14			use Symfony\Component\Console\Input\InputOption;
15
16			class SeedCommand extends Command
17			{
18			use ModuleCommandTrait;
19
20			/**
21			* The console command name.
22			*
23			* @var string
24			*/
25			protected $name = 'module:seed';
26
27			/**
28			* The console command description.
29			*
30			* @var string
31			*/
32			protected $description = 'Run database seeder from the specified module or from all modules.';
33
34			/**
35			* Execute the console command.
36			* @throws FatalThrowableError
37			*/
38			public function handle()
39			{
40			try {
41			if ($name = $this->argument('module')) {
42			$name = Str::studly($name);
			0 ignored issues – show Bug introduced 2016-09-14 00:22 UTC by Report Bug Copy Issue Report It seems like `$name` can also be of type `array`; however, `Illuminate\Support\Str::studly()` 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...
43			$this->moduleSeed($this->getModuleByName($name));
			0 ignored issues – show Bug introduced 2019-09-03 16:06 UTC by Report Bug Copy Issue Report It seems like `$this->getModuleByName($name)` can be `null`; however, `moduleSeed()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
44			} else {
45			$modules = $this->getModuleRepository()->getOrdered();
46			array_walk($modules, [$this, 'moduleSeed']);
47			$this->info('All modules seeded.');
48			}
49			} catch (\Throwable $e) {
50			$this->reportException($e);
51
52			$this->renderException($this->getOutput(), $e);
53
54			return 1;
55			}
56			}
57
58			/**
59			* @throws RuntimeException
60			* @return RepositoryInterface
61			*/
62			public function getModuleRepository(): RepositoryInterface
63			{
64			$modules = $this->laravel['modules'];
65			if (!$modules instanceof RepositoryInterface) {
66			throw new RuntimeException('Module repository not found!');
67			}
68
69			return $modules;
70			}
71
72			/**
73			* @param $name
74			*
75			* @throws RuntimeException
76			*
77			* @return Module
78			*/
79			public function getModuleByName($name)
80			{
81			$modules = $this->getModuleRepository();
82			if ($modules->has($name) === false) {
83			throw new RuntimeException("Module [$name] does not exists.");
84			}
85
86			return $modules->find($name);
87			}
88
89			/**
90			* @param Module $module
91			*
92			* @return void
93			*/
94			public function moduleSeed(Module $module)
95			{
96			$seeders = [];
97			$name = $module->getName();
98			$config = $module->get('migration');
99			if (is_array($config) && array_key_exists('seeds', $config)) {
100			foreach ((array)$config['seeds'] as $class) {
101			if (class_exists($class)) {
102			$seeders[] = $class;
103			}
104			}
105			} else {
106			$class = $this->getSeederName($name); //legacy support
107			if (class_exists($class)) {
108			$seeders[] = $class;
109			} else {
110			//look at other namespaces
111			$classes = $this->getSeederNames($name);
112			foreach ($classes as $class) {
113			if (class_exists($class)) {
114			$seeders[] = $class;
115			}
116			}
117			}
118			}
119
120			if (count($seeders) > 0) {
121			array_walk($seeders, [$this, 'dbSeed']);
122			$this->info("Module [$name] seeded.");
123			}
124			}
125
126			/**
127			* Seed the specified module.
128			*
129			* @param string $className
130			*/
131			protected function dbSeed($className)
132			{
133			if ($option = $this->option('class')) {
134			$params['--class'] = Str::finish(substr($className, 0, strrpos($className, '\\')), '\\') . $option;
			0 ignored issues – show Coding Style Comprehensibility introduced 2018-07-24 19:12 UTC by Report Bug Copy Issue Report `$params` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$params = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
135			} else {
136			$params = ['--class' => $className];
137			}
138
139			if ($option = $this->option('database')) {
140			$params['--database'] = $option;
141			}
142
143			if ($option = $this->option('force')) {
144			$params['--force'] = $option;
145			}
146
147			$this->call('db:seed', $params);
148			}
149
150			/**
151			* Get master database seeder name for the specified module.
152			*
153			* @param string $name
154			*
155			* @return string
156			*/
157			public function getSeederName($name)
158			{
159			$name = Str::studly($name);
160
161			$namespace = $this->laravel['modules']->config('namespace');
162			$config = GenerateConfigReader::read('seeder');
163			$seederPath = str_replace('/', '\\', $config->getPath());
			0 ignored issues – show Unused Code introduced 2019-07-05 05:44 UTC by Report Bug Copy Issue Report `$seederPath` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
164
165			return $namespace . '\\' . $name . '\\' . $config->getNamespace() . '\\' . $name . 'DatabaseSeeder';
166			}
167
168			/**
169			* Get master database seeder name for the specified module under a different namespace than Modules.
170			*
171			* @param string $name
172			*
173			* @return array $foundModules array containing namespace paths
174			*/
175			public function getSeederNames($name)
176			{
177			$name = Str::studly($name);
178
179			$seederPath = GenerateConfigReader::read('seeder');
180			$seederPath = str_replace('/', '\\', $seederPath->getPath());
181
182			$foundModules = [];
183			foreach ($this->laravel['modules']->config('scan.paths') as $path) {
184			$namespace = array_slice(explode('/', $path), -1)[0];
185			$foundModules[] = $namespace . '\\' . $name . '\\' . $seederPath . '\\' . $name . 'DatabaseSeeder';
186			}
187
188			return $foundModules;
189			}
190
191			/**
192			* Report the exception to the exception handler.
193			*
194			* @param \Symfony\Component\Console\Output\OutputInterface $output
195			* @param \Throwable $e
196			* @return void
197			*/
198			protected function renderException($output, \Throwable $e)
199			{
200			$this->laravel[ExceptionHandler::class]->renderForConsole($output, $e);
201			}
202
203			/**
204			* Report the exception to the exception handler.
205			*
206			* @param \Throwable $e
207			* @return void
208			*/
209			protected function reportException(\Throwable $e)
210			{
211			$this->laravel[ExceptionHandler::class]->report($e);
212			}
213
214			/**
215			* Get the console command arguments.
216			*
217			* @return array
218			*/
219	120		protected function getArguments()
220			{
221			return [
222	120		['module', InputArgument::OPTIONAL, 'The name of module will be used.'],
223			];
224			}
225
226			/**
227			* Get the console command options.
228			*
229			* @return array
230			*/
231	120	View Code Duplication	protected function getOptions()
232			{
233			return [
234	120		['class', null, InputOption::VALUE_OPTIONAL, 'The class name of the root seeder.'],
235			['database', null, InputOption::VALUE_OPTIONAL, 'The database connection to seed.'],
236			['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
237			];
238			}
239			}
240

nWidart / laravel-modules

Push — master ( 4fafa1...e65f27 )

SeedCommand A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like