Nwidart\Modules\Commands\GenerateListenerCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

96.77%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getArguments()	0	7	1
A	getOptions()	0	6	1
A	getTemplateContents()	0	13	1
A	getDestinationFilePath()	0	9	1
A	getFileName()	0	4	1
A	fire()	0	8	2
A	getEventName()	0	4	1

<?php

namespace Nwidart\Modules\Commands;

use Nwidart\Modules\Commands\GeneratorCommand;
use Nwidart\Modules\Module;
use Nwidart\Modules\Traits\ModuleCommandTrait;
use Pingpong\Support\Stub;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;

class GenerateListenerCommand extends GeneratorCommand
{
    use ModuleCommandTrait;

    protected $argumentName = 'name';

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

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Generate a new Listener Class for the specified module';

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

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['event', null, InputOption::VALUE_REQUIRED, 'An example option.', null],
        ];
    }

    protected function getTemplateContents()
    {
        $module = $this->laravel['modules']->findOrFail($this->getModuleName());

        return (new Stub('/listener.stub', [
            'NAMESPACE' => $this->getClassNamespace($module) . "\\" . config("modules.paths.generator.listener"),
            "EVENTNAME" => $this->getEventName($module),
            "EVENTSHORTENEDNAME" => $this->option('event'),
            "CLASS" => $this->getClass(),
            'DUMMYNAMESPACE' => $this->laravel->getNamespace() . "Events"
        ]))->render();

    }

    protected function getDestinationFilePath()
    {
        $path = $this->laravel['modules']->getModulePath($this->getModuleName());

        $seederPath = $this->laravel['modules']->config('paths.generator.listener');

        return $path . $seederPath . '/' . $this->getFileName() . '.php';

    }

    /**
     * @return string
     */
    protected function getFileName()
    {
        return studly_case($this->argument('name'));

It seems like $this->argument('name') targeting Illuminate\Console\Command::argument() can also be of type array; however, studly_case() does only seem to accept string, maybe add an additional type check?

    }

    public function fire()
    {
        if (!$this->option('event')) {
            return $this->error("The --event option is neccessary");
        }

        parent::fire();
    }

    protected function getEventName(Module $module)
    {
        return $this->getClassNamespace($module) . "\\" . config("modules.paths.generator.event") . "\\" . $this->option('event');

$module is of type object<Nwidart\Modules\Module>, but the function expects a object<Nwidart\Module\Module>.

    }
}