Cortex\Foundation\Console\Commands\DataTableMakeCommand

Complexity

Total Complexity

9

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	buildClass()	0	10	1
B	replaceClasses()	0	44	4
A	getStub()	0	4	1
A	getDefaultNamespace()	0	4	1
A	getArguments()	0	6	1
A	getOptions()	0	8	1

<?php

declare(strict_types=1);

namespace Cortex\Foundation\Console\Commands;

use Illuminate\Support\Str;
use Illuminate\Console\GeneratorCommand;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Cortex\Foundation\Traits\ConsoleMakeModuleCommand;

class DataTableMakeCommand extends GeneratorCommand
{
    use ConsoleMakeModuleCommand;

    /**
     * The model name.
     *
     * @var string
     */
    protected $modelName;

    /**
     * The transformer name.
     *
     * @var string
     */
    protected $transformerName;

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

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Create a new datatable class';

    /**
     * The type of class being generated.
     *
     * @var string
     */
    protected $type = 'Datatable';

    /**
     * Build the class with the given name.
     *
     * @param string $name
     *
     * @return string
     */
    protected function buildClass($name)
    {
        $stub = parent::buildClass($name);

        $model = $this->option('model') ?? $this->modelName = $this->ask('What is your model?');

        $transformer = $this->option('transformer') ?? $this->transformerName = $this->ask('What is your transformer?');

        return $this->replaceClasses($stub, $model, $transformer);

It seems like $model defined by $this->option('model') ?? ($this->modelName = $this->ask('What is your model?')) on line 63 can also be of type array; however, Cortex\Foundation\Console\Commands\DataTableMakeCommand::replaceClasses() does only seem to accept string, maybe add an additional type check?

It seems like $transformer defined by $this->option('transformer') ?? ($this->transformerName = $this->ask('What is your transformer?')) on line 65 can also be of type array; however, Cortex\Foundation\Console\Commands\DataTableMakeCommand::replaceClasses() does only seem to accept string|null, maybe add an additional type check?

    }

    /**
     * Replace the model and transformer for the given stub.
     *
     * @param string $stub
     * @param string $model
     * @param string $transformer

Should the type for parameter $transformer not be string|null?

     *
     * @return string
     */
    protected function replaceClasses($stub, $model, $transformer = null)
    {
        if ($transformer) {

The expression $transformer of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $transformer = str_replace('/', '\\', $transformer);

            $namespaceTransformer = $this->rootNamespace().'\Transformers\\'.$transformer;

            if (Str::startsWith($transformer, '\\')) {
                $stub = str_replace('NamespacedDummyTransformer', trim($transformer, '\\'), $stub);
            } else {
                $stub = str_replace('NamespacedDummyTransformer', $namespaceTransformer, $stub);
            }

            $stub = str_replace(
                "use {$namespaceTransformer};\nuse {$namespaceTransformer};", "use {$namespaceTransformer};", $stub
            );

            $transformer = class_basename(trim($transformer, '\\'));

            $stub = str_replace('DummyTransformer', $transformer, $stub);

            $stub = str_replace('dummyTransformer', Str::camel($transformer), $stub);
        }

        $model = str_replace('/', '\\', $model);

        $namespaceModel = $this->rootNamespace().'\Models\\'.$model;

        if (Str::startsWith($model, '\\')) {
            $stub = str_replace('NamespacedDummyModel', trim($model, '\\'), $stub);
        } else {
            $stub = str_replace('NamespacedDummyModel', $namespaceModel, $stub);
        }

        $stub = str_replace(
            "use {$namespaceModel};\nuse {$namespaceModel};", "use {$namespaceModel};", $stub
        );

        $model = class_basename(trim($model, '\\'));

        $stub = str_replace('DummyModel', $model, $stub);

        return str_replace('dummyModel', Str::camel($model), $stub);
    }

    /**
     * Get the stub file for the generator.
     *
     * @return string
     */
    protected function getStub()
    {
        return __DIR__.'/../../../resources/stubs/datatable.stub';
    }

    /**
     * Get the default namespace for the class.
     *
     * @param string $rootNamespace
     *
     * @return string
     */
    protected function getDefaultNamespace($rootNamespace)
    {
        return $rootNamespace.'\Datatables';
    }

    /**
     * Get the console command arguments.
     *
     * @return array

Consider making the return type a bit more specific; maybe use string[][].

     */
    protected function getArguments()
    {
        return [
            ['name', InputArgument::REQUIRED, 'The name of the datatable.'],
        ];
    }

    /**
     * Get the console command arguments.
     *
     * @return array

Consider making the return type a bit more specific; maybe use string[][].

     */
    protected function getOptions()
    {
        return [
            ['model', 'm', InputOption::VALUE_REQUIRED, 'The model that the datatable applies to.'],
            ['module', 'd', InputOption::VALUE_REQUIRED, 'The module name to generate the file within.'],
            ['transformer', 't', InputOption::VALUE_REQUIRED, 'The transformer that the datatable applies to.'],
        ];
    }
}