Nwidart\Modules\Generators\Command

Complexity

Total Complexity

19

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	appendable()	0	4	1
A	stubFile()	0	4	1
A	replaces()	0	6	1
A	getTemplateContents()	0	4	1
A	getDestinationFilePath()	0	6	2
A	resolveFilename()	0	6	1
A	before()	0	4	1
A	after()	0	4	1
A	handle()	0	9	2
A	getFileName()	0	10	3
A	getDefaultNamespace()	0	9	3
A	getGeneratorConfigKey()	0	5	2

<?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;


    /**
     * Specifies default path.
     *
     * @var null|string
     */
    protected $defaultPath;

    /**
     * Destination file extension
     *
     * @var string
     */
    protected $outputExtension = 'php';

    /**
     * Generator paths key
     *
     * @see config/modules.php
     * @var string
     */
    protected $generatorPathsKey = 'generator.paths';

    /**
     * Generator config key
     *
     * @see config/modules.php
     * @var string
     */
    protected $generatorConfigKey = '';

    /**
     * Generator config prefix for the $generatorConfigKey
     *
     * @var string
     */
    protected $generatorConfigPrefix;

    /**
     * @var string $configKeySeparator
     */
    protected $configKeySeparator = '-';


    /**
     * 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() . "/" .

The method getModulePath does not exist on object<Nwidart\Modules\Generators\Command>? Since you implemented __call, maybe consider adding a @method annotation.

            GenerateConfigReader::read($this->getGeneratorConfigKey())->getPath() . "/" .
            $this->resolveFilename() . '.' . $this->outputExtension ?: 'php';
    }

    /**
     * Resolves the filename so that it always starts with capital letter
     *
     * @return string
     */
    private function resolveFilename()
    {
        $filename = str_replace('/', ' ', $this->getFileName());
        $filename = ucwords(str_replace('\\', ' ', $filename));
        return trim(str_replace(' ', '/', $filename));
    }

    /**
     * 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));

It seems like $this->argument($this->argumentName) targeting Illuminate\Console\Concerns\InteractsWithIO::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?

        if ($this->appendable() && !Str::contains(strtolower($name), strtolower($this->appendable()))) {

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.

            $name .= Str::studly($this->appendable());
        }

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

    /**
     * Get default namespace.
     *
     * @return string
     */
    public function getDefaultNamespace(): string
    {
        return $this->getModules()->config(
            $this->generatorPathsKey . '.' . $this->getGeneratorConfigKey() . '.namespace'
        ) ?: $this->getModules()->config(
            $this->generatorPathsKey . '.' . $this->getGeneratorConfigKey() . '.path',
            $this->defaultPath ?: ''
        );
    }

    /**
     * Get configurator config key
     *
     * @return string
     */
    private function getGeneratorConfigKey()
    {
        return ($this->generatorConfigPrefix ? $this->generatorConfigPrefix . $this->configKeySeparator : '') .
            $this->generatorConfigKey;
    }
}