SeedCommand::getSeederName() - Code Metrics - Inspection of "The Seeder path is now also used in the seed:make..." - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc87d5...f777a6 )

by Nicolas

created 2017-10-09 07:51 UTC

SeedCommand::getSeederName() A

↳ Parent: SeedCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Nwidart\Modules\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Debug\ExceptionHandler;
use Illuminate\Support\Str;
use Nwidart\Modules\Module;
use Nwidart\Modules\Repository;
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;
use Symfony\Component\Debug\Exception\FatalThrowableError;

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));
            } else {
                $modules = $this->getModuleRepository()->getOrdered();
                array_walk($modules, [$this, 'moduleSeed']);
                $this->info('All modules seeded.');
            }
        } catch (\Exception $e) {
            $e = new FatalThrowableError($e);

            $this->reportException($e);

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

            return 1;
        }
    }

    /**
     * @throws RuntimeException
     *
     * @return Repository
     */
    public function getModuleRepository()
    {
        $modules = $this->laravel['modules'];
        if (!$modules instanceof Repository) {
            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->get($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;
            }
        }

        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)
    {
        $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');
        $seederPath = GenerateConfigReader::read('seeder');
        $seederPath = str_replace('/', '\\', $seederPath->getPath());

        return $namespace . '\\' . $name . '\\' . $seederPath . '\\' . $name . 'DatabaseSeeder';
    }

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

    /**
     * Report the exception to the exception handler.
     *
     * @param  \Exception  $e
     * @return void
     */
    protected function reportException(\Exception $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 [
            ['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\Module;
9		use Nwidart\Modules\Repository;
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		use Symfony\Component\Debug\Exception\FatalThrowableError;
16
17		class SeedCommand extends Command
18		{
19		use ModuleCommandTrait;
20
21		/**
22		* The console command name.
23		*
24		* @var string
25		*/
26		protected $name = 'module:seed';
27
28		/**
29		* The console command description.
30		*
31		* @var string
32		*/
33		protected $description = 'Run database seeder from the specified module or from all modules.';
34
35		/**
36		* Execute the console command.
37		* @throws FatalThrowableError
38		*/
39		public function handle()
40		{
41		try {
42		if ($name = $this->argument('module')) {
43		$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...
44		$this->moduleSeed($this->getModuleByName($name));
45		} else {
46		$modules = $this->getModuleRepository()->getOrdered();
47		array_walk($modules, [$this, 'moduleSeed']);
48		$this->info('All modules seeded.');
49		}
50		} catch (\Exception $e) {
51		$e = new FatalThrowableError($e);
52
53		$this->reportException($e);
54
55		$this->renderException($this->getOutput(), $e);
56
57		return 1;
58		}
59		}
60
61		/**
62		* @throws RuntimeException
63		*
64		* @return Repository
65		*/
66		public function getModuleRepository()
67		{
68		$modules = $this->laravel['modules'];
69		if (!$modules instanceof Repository) {
70		throw new RuntimeException("Module repository not found!");
71		}
72
73		return $modules;
74		}
75
76		/**
77		* @param $name
78		*
79		* @throws RuntimeException
80		*
81		* @return Module
82		*/
83		public function getModuleByName($name)
84		{
85		$modules = $this->getModuleRepository();
86		if ($modules->has($name) === false) {
87		throw new RuntimeException("Module [$name] does not exists.");
88		}
89
90		return $modules->get($name);
		0 ignored issues – show Deprecated Code introduced 2017-09-27 08:51 UTC by Report Bug Copy Issue Report The method `Nwidart\Modules\Repository::get()` has been deprecated. This method has been deprecated. Loading history...
91		}
92
93		/**
94		* @param Module $module
95		*
96		* @return void
97		*/
98		public function moduleSeed(Module $module)
99		{
100		$seeders = [];
101		$name = $module->getName();
102		$config = $module->get('migration');
103		if (is_array($config) && array_key_exists('seeds', $config)) {
104		foreach ((array)$config['seeds'] as $class) {
105		if (class_exists($class)) {
106		$seeders[] = $class;
107		}
108		}
109		} else {
110		$class = $this->getSeederName($name); //legacy support
111		if (class_exists($class)) {
112		$seeders[] = $class;
113		}
114		}
115
116		if (count($seeders) > 0) {
117		array_walk($seeders, [$this, 'dbSeed']);
118		$this->info("Module [$name] seeded.");
119		}
120		}
121
122		/**
123		* Seed the specified module.
124		*
125		* @param string $className
126		*/
127		protected function dbSeed($className)
128		{
129		$params = [
130		'--class' => $className,
131		];
132
133		if ($option = $this->option('database')) {
134		$params['--database'] = $option;
135		}
136
137		if ($option = $this->option('force')) {
138		$params['--force'] = $option;
139		}
140
141		$this->call('db:seed', $params);
142		}
143
144		/**
145		* Get master database seeder name for the specified module.
146		*
147		* @param string $name
148		*
149		* @return string
150		*/
151		public function getSeederName($name)
152		{
153		$name = Str::studly($name);
154
155		$namespace = $this->laravel['modules']->config('namespace');
156		$seederPath = GenerateConfigReader::read('seeder');
157		$seederPath = str_replace('/', '\\', $seederPath->getPath());
158
159		return $namespace . '\\' . $name . '\\' . $seederPath . '\\' . $name . 'DatabaseSeeder';
160		}
161
162		/**
163		* Report the exception to the exception handler.
164		*
165		* @param \Symfony\Component\Console\Output\OutputInterface $output
166		* @param \Exception $e
167		* @return void
168		*/
169		protected function renderException($output, \Exception $e)
170		{
171		$this->laravel[ExceptionHandler::class]->renderForConsole($output, $e);
172		}
173
174		/**
175		* Report the exception to the exception handler.
176		*
177		* @param \Exception $e
178		* @return void
179		*/
180		protected function reportException(\Exception $e)
181		{
182		$this->laravel[ExceptionHandler::class]->report($e);
183		}
184
185		/**
186		* Get the console command arguments.
187		*
188		* @return array
189		*/
190	91	protected function getArguments()
191		{
192		return [
193	91	['module', InputArgument::OPTIONAL, 'The name of module will be used.'],
194		];
195		}
196
197		/**
198		* Get the console command options.
199		*
200		* @return array
201		*/
202	91	protected function getOptions()
203		{
204		return [
205	91	['database', null, InputOption::VALUE_OPTIONAL, 'The database connection to seed.'],
206		['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
207		];
208		}
209		}
210

nWidart / laravel-modules

Push — master ( bc87d5...f777a6 )

SeedCommand::getSeederName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like