Command - Code Metrics - Inspection of "Extended Commands" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1088)

unknown

created 2020-10-07 20:01 UTC

Command A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	125
ccs	0
cts	45
cp	0
rs	10
c	0
b	0
f	0
wmc	12
lcom	2
cbo	6

9 Methods

Rating	Name	Size	Complexity
A	appendable()	4	1
A	stubFile()	4	1
A	replaces()	6	1
A	getTemplateContents()	4	1
A	getDestinationFilePath()	6	1
A	before()	4	1
A	after()	4	1
A	handle()	9	2
A	getFileName()	10	3

<?php

namespace Nwidart\Modules\Generators;

use Illuminate\Support\Str;
use Nwidart\Modules\Support\Stub;
use Nwidart\Modules\Commands\GeneratorCommand;
use Nwidart\Modules\Console\Traits\Definitions;
use Nwidart\Modules\Support\Config\GenerateConfigReader;

abstract class Command extends GeneratorCommand
{
    use Definitions;

    /**
     * The name to be appended to the generated resources.
     *
     * @var null|string
     */
    protected $appendable;

    /**
     * Stub file of the resource
     *
     * @var null|string
     */
    protected $stubFile;

    /**
     * Getter for appendable
     *
     * @return void
     */
    public function appendable()
    {
        return $this->appendable;
    }

    /**
     * Getter for the stub file
     *
     * @return void
     */
    public function stubFile()
    {
        return $this->stubFile;
    }

    /**
     * Replacements for the stub file
     *
     * @return array
     */
    public function replaces()
    {
        return [
            //...
        ];
    }

    /**
     * Get stub file contents
     *
     * @return mixed
     */
    protected function getTemplateContents()
    {
        return (new Stub($this->stubFile(), $this->replaces()))->render();
    }

    /**
     * Get destination file path.
     *
     * @return mixed
     */
    public function getDestinationFilePath()
    {
        return  $this->getModulePath() . "/" .
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            GenerateConfigReader::read($this->getGeneratorConfigKey())->getPath() . "/" .
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $this->resolveFilename() . '.' . $this->outputExtension;
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Method to apply necessary functionality
     * before console command gets executed
     *
     * @return void
     */
    public function before()
    {
        // ...
    }

    /**
     * Method to apply necessary functionality
     * after console command has executed.
     *
     * @return void
     */
    public function after()
    {
        // ...
    }

    /**
     * Execute the console command
     *
     * @return int
     */
    public function handle(): int
    {
        $this->before();

        if (parent::handle() != E_ERROR) {
            $this->after();
        }
        return 0;
    }

    /**
     * Get and resolve the filename.
     *
     * @return string
     */
    protected function getFileName(): string
    {

        $name = Str::studly($this->argument($this->argumentName));

        if ($this->appendable() && !Str::contains(strtolower($name), strtolower($this->appendable()))) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $name .= Str::studly($this->appendable());
        }

        return Str::singular(Str::studly($name));
    }
}


1			<?php
2
3			namespace Nwidart\Modules\Generators;
4
5			use Illuminate\Support\Str;
6			use Nwidart\Modules\Support\Stub;
7			use Nwidart\Modules\Commands\GeneratorCommand;
8			use Nwidart\Modules\Console\Traits\Definitions;
9			use Nwidart\Modules\Support\Config\GenerateConfigReader;
10
11			abstract class Command extends GeneratorCommand
12			{
13			use Definitions;
14
15			/**
16			* The name to be appended to the generated resources.
17			*
18			* @var null\|string
19			*/
20			protected $appendable;
21
22			/**
23			* Stub file of the resource
24			*
25			* @var null\|string
26			*/
27			protected $stubFile;
28
29			/**
30			* Getter for appendable
31			*
32			* @return void
33			*/
34			public function appendable()
35			{
36			return $this->appendable;
37			}
38
39			/**
40			* Getter for the stub file
41			*
42			* @return void
43			*/
44			public function stubFile()
45			{
46			return $this->stubFile;
47			}
48
49			/**
50			* Replacements for the stub file
51			*
52			* @return array
53			*/
54			public function replaces()
55			{
56			return [
57			//...
58			];
59			}
60
61			/**
62			* Get stub file contents
63			*
64			* @return mixed
65			*/
66			protected function getTemplateContents()
67			{
68			return (new Stub($this->stubFile(), $this->replaces()))->render();
69			}
70
71			/**
72			* Get destination file path.
73			*
74			* @return mixed
75			*/
76			public function getDestinationFilePath()
77			{
78			return $this->getModulePath() . "/" .
			0 ignored issues – show Documentation Bug introduced 2020-10-07 20:04 UTC by Report Bug Copy Issue Report The method `getModulePath` does not exist on `object<Nwidart\Modules\Generators\Command>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
79			GenerateConfigReader::read($this->getGeneratorConfigKey())->getPath() . "/" .
			0 ignored issues – show Documentation Bug introduced 2020-10-07 20:04 UTC by Report Bug Copy Issue Report The method `getGeneratorConfigKey` does not exist on `object<Nwidart\Modules\Generators\Command>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
80			$this->resolveFilename() . '.' . $this->outputExtension;
			0 ignored issues – show Bug introduced 2020-10-07 20:04 UTC by Report Bug Copy Issue Report The property `outputExtension` does not seem to exist. Did you mean `output`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Documentation Bug introduced 2020-10-07 20:04 UTC by Report Bug Copy Issue Report The method `resolveFilename` does not exist on `object<Nwidart\Modules\Generators\Command>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
81			}
82
83			/**
84			* Method to apply necessary functionality
85			* before console command gets executed
86			*
87			* @return void
88			*/
89			public function before()
90			{
91			// ...
92			}
93
94			/**
95			* Method to apply necessary functionality
96			* after console command has executed.
97			*
98			* @return void
99			*/
100			public function after()
101			{
102			// ...
103			}
104
105			/**
106			* Execute the console command
107			*
108			* @return int
109			*/
110			public function handle(): int
111			{
112			$this->before();
113
114			if (parent::handle() != E_ERROR) {
115			$this->after();
116			}
117			return 0;
118			}
119
120			/**
121			* Get and resolve the filename.
122			*
123			* @return string
124			*/
125			protected function getFileName(): string
126			{
127
128			$name = Str::studly($this->argument($this->argumentName));
			0 ignored issues – show Bug introduced 2020-10-07 19:39 UTC by Report Bug Copy Issue Report It seems like `$this->argument($this->argumentName)` targeting `Illuminate\Console\Conce...ractsWithIO::argument()` can also be of type `array` or `null`; however, `Illuminate\Support\Str::studly()` 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...
129			if ($this->appendable() && !Str::contains(strtolower($name), strtolower($this->appendable()))) {
			0 ignored issues – show Bug Best Practice introduced 2020-10-07 19:39 UTC by Report Bug Copy Issue Report The expression `$this->appendable()` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
130			$name .= Str::studly($this->appendable());
131			}
132
133			return Str::singular(Str::studly($name));
134			}
135			}
136

nWidart / laravel-modules

Pull Request — master (#1088)

Command A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like