SeedCommand::moduleSeed() - Code Metrics - Inspection of "Renaming "Repository" classes to show their intend..." - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6e27f1...d5fec2 )

by Nicolas

created 2018-06-24 20:44 UTC

SeedCommand::moduleSeed() B

↳ Parent: SeedCommand

Complexity

Conditions	7
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
cc	7
nc	8
nop	1
dl	0
loc	23
ccs	0
cts	15
cp	0
crap	56
rs	8.6186
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\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);
                $this->moduleSeed($this->getModuleByName($name));
            } 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;
            }
        }

        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  \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);
43			$this->moduleSeed($this->getModuleByName($name));
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();
			0 ignored issues – show Bug introduced 2018-02-28 02:53 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
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			}
110			}
111
112			if (count($seeders) > 0) {
113			array_walk($seeders, [$this, 'dbSeed']);
114			$this->info("Module [$name] seeded.");
115			}
116			}
117
118			/**
119			* Seed the specified module.
120			*
121			* @param string $className
122			*/
123			protected function dbSeed($className)
124			{
125			$params = [
126			'--class' => $className,
127			];
128
129			if ($option = $this->option('database')) {
130			$params['--database'] = $option;
131			}
132
133			if ($option = $this->option('force')) {
134			$params['--force'] = $option;
135			}
136
137			$this->call('db:seed', $params);
138			}
139
140			/**
141			* Get master database seeder name for the specified module.
142			*
143			* @param string $name
144			*
145			* @return string
146			*/
147			public function getSeederName($name)
148			{
149			$name = Str::studly($name);
150
151			$namespace = $this->laravel['modules']->config('namespace');
152			$seederPath = GenerateConfigReader::read('seeder');
153			$seederPath = str_replace('/', '\\', $seederPath->getPath());
154
155			return $namespace . '\\' . $name . '\\' . $seederPath . '\\' . $name . 'DatabaseSeeder';
156			}
157
158			/**
159			* Report the exception to the exception handler.
160			*
161			* @param \Symfony\Component\Console\Output\OutputInterface $output
162			* @param \Throwable $e
163			* @return void
164			*/
165			protected function renderException($output, \Throwable $e)
166			{
167			$this->laravel[ExceptionHandler::class]->renderForConsole($output, $e);
168			}
169
170			/**
171			* Report the exception to the exception handler.
172			*
173			* @param \Throwable $e
174			* @return void
175			*/
176			protected function reportException(\Throwable $e)
177			{
178			$this->laravel[ExceptionHandler::class]->report($e);
179			}
180
181			/**
182			* Get the console command arguments.
183			*
184			* @return array
185			*/
186	92		protected function getArguments()
187			{
188			return [
189	92		['module', InputArgument::OPTIONAL, 'The name of module will be used.'],
190			];
191			}
192
193			/**
194			* Get the console command options.
195			*
196			* @return array
197			*/
198	92	View Code Duplication	protected function getOptions()
199			{
200			return [
201	92		['class', null, InputOption::VALUE_OPTIONAL, 'The class name of the root seeder.'],
202			['database', null, InputOption::VALUE_OPTIONAL, 'The database connection to seed.'],
203			['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
204			];
205			}
206			}
207

nWidart / laravel-modules

Push — master ( 6e27f1...d5fec2 )

SeedCommand::moduleSeed() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like