GenerateListenerCommand::getArguments() - Code Metrics - Inspection of "Addded Event and Listener Generation Commands" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Lanre

created 2016-07-21 17:58 UTC

GenerateListenerCommand::getArguments() A

↳ Parent: GenerateListenerCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	0
crap	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'));

    }

    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');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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


1		<?php
2
3		namespace Nwidart\Modules\Commands;
4
5		use Nwidart\Modules\Commands\GeneratorCommand;
6		use Nwidart\Modules\Module;
7		use Nwidart\Modules\Traits\ModuleCommandTrait;
8		use Pingpong\Support\Stub;
9		use Symfony\Component\Console\Input\InputOption;
10		use Symfony\Component\Console\Input\InputArgument;
11
12		class GenerateListenerCommand extends GeneratorCommand
13		{
14		use ModuleCommandTrait;
15
16		protected $argumentName = 'name';
17
18		/**
19		* The console command name.
20		*
21		* @var string
22		*/
23		protected $name = 'module:make-listener';
24
25		/**
26		* The console command description.
27		*
28		* @var string
29		*/
30		protected $description = 'Generate a new Listener Class for the specified module';
31
32		/**
33		* Get the console command arguments.
34		*
35		* @return array
36		*/
37	25	protected function getArguments()
38		{
39	2	return [
40	25	['name', InputArgument::REQUIRED, 'The name of the command.'],
41	25	['module', InputArgument::OPTIONAL, 'The name of module will be used.'],
42	25	];
43		}
44
45		/**
46		* Get the console command options.
47		*
48		* @return array
49		*/
50	25	protected function getOptions()
51		{
52		return [
53	25	['event', null, InputOption::VALUE_REQUIRED, 'An example option.', null],
54	25	];
55		}
56
57	2	protected function getTemplateContents()
58		{
59	2	$module = $this->laravel['modules']->findOrFail($this->getModuleName());
60
61	2	return (new Stub('/listener.stub', [
62	2	'NAMESPACE' => $this->getClassNamespace($module) . "\\" . config("modules.paths.generator.listener"),
63	2	"EVENTNAME" => $this->getEventName($module),
64	2	"EVENTSHORTENEDNAME" => $this->option('event'),
65	2	"CLASS" => $this->getClass(),
66	2	'DUMMYNAMESPACE' => $this->laravel->getNamespace() . "Events"
67	2	]))->render();
68
69		}
70
71	2	protected function getDestinationFilePath()
72		{
73	2	$path = $this->laravel['modules']->getModulePath($this->getModuleName());
74
75	2	$seederPath = $this->laravel['modules']->config('paths.generator.listener');
76
77	2	return $path . $seederPath . '/' . $this->getFileName() . '.php';
78
79		}
80
81		/**
82		* @return string
83		*/
84	2	protected function getFileName()
85		{
86	2	return studly_case($this->argument('name'));
		0 ignored issues – show Bug introduced 2016-07-17 02:12 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, `studly_case()` 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...
87	2	}
88
89	2	public function fire()
90		{
91	2	if (!$this->option('event')) {
92		return $this->error("The --event option is neccessary");
93		}
94
95	2	parent::fire();
96	2	}
97
98	2	protected function getEventName(Module $module)
99		{
100	2	return $this->getClassNamespace($module) . "\\" . config("modules.paths.generator.event") . "\\" . $this->option('event');
		0 ignored issues – show Documentation introduced 2016-07-17 02:12 UTC by Report Bug Copy Issue Report `$module` is of type `object<Nwidart\Modules\Module>`, but the function expects a `object<Nwidart\Module\Module>`. 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...
101		}
102		}
103

nWidart / laravel-modules

Pull Request — master (#2)

GenerateListenerCommand::getArguments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like