Ikechukwukalu\Makeservice\Console\Commands\MakeRepositoryCommand

Complexity

Total Complexity

27

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getDefaultNamespace()	0	3	1
A	resolveStubPath()	0	5	2
A	areOptionsPresent()	0	18	6
A	buildClass()	0	46	5
A	getOptions()	0	8	1
A	alreadyExists()	0	4	2
B	handle()	0	36	8
A	getStub()	0	7	2

<?php

namespace Ikechukwukalu\Makeservice\Console\Commands;

use Illuminate\Console\GeneratorCommand;
use Illuminate\Console\Concerns\CreatesMatchingTest;
use Illuminate\Support\Str;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputOption;

#[AsCommand(name: 'make:repository')]
class MakeRepositoryCommand extends GeneratorCommand
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'make:repository';

    /**
     * The name of the console command.
     *
     * This name is used to identify the command during lazy loading.
     *
     * @var string|null
     *
     * @deprecated
     */
    protected static $defaultName = 'make:repository';

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

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

    /**
     * Build the class with the given name.
     *
     * @param  string  $name
     * @return string
     */
    protected function buildClass($name)
    {
        $model = $this->option('model');

        if ($this->option('contract')) {
            $interface = $model . "RepositoryInterface";

            if ($this->option('user')) {
                $this->call('make:interfaceclass', ['name' => $interface, '--model' => $model, '--user' => null]);
            } else {
                $this->call('make:interfaceclass', ['name' => $interface, '--model' => $model]);
            }
        } else {
            $interface = $this->option('interface');
        }

        if (! Str::startsWith($model, [

It seems like $model can also be of type array; however, parameter $haystack of Illuminate\Support\Str::startsWith() does only seem to accept string, maybe add an additional type check?

            $this->laravel->getNamespace(),
            'Illuminate',
            '\\',
        ])) {
            $model = $this->laravel->getNamespace().'Models\\'.str_replace('/', '\\', $model);
        }

        if (! Str::startsWith($interface, [
            $this->laravel->getNamespace(),
            'Illuminate',
            '\\',
        ])) {
            $interface = $this->laravel->getNamespace().'Contracts\\'.str_replace('/', '\\', $interface);
        }

        $stub = str_replace(
            ['DummyModel', '{{ model }}'], class_basename($model), parent::buildClass($name)

It seems like $model can also be of type array; however, parameter $class of class_basename() does only seem to accept object|string, maybe add an additional type check?

        );

        $stub = str_replace(
            ['DummyFullModel', '{{ modelNamespace }}'], trim($model, '\\'), $stub
        );

        $stub = str_replace(
            ['DummyInterface', '{{ interface }}'], class_basename($interface), $stub
        );

        return str_replace(
            ['DummyFullInterface', '{{ interfaceNamespace }}'], trim($interface, '\\'), $stub
        );
    }

    /**
     * Determine if the class already exists.
     *
     * @param  string  $rawName
     * @return bool
     */
    protected function alreadyExists($rawName)
    {
        return class_exists($rawName) ||
               $this->files->exists($this->getPath($this->qualifyClass($rawName)));
    }

    /**
     * Get the stub file for the generator.
     *
     * @return string
     */
    protected function getStub()
    {
        if ($this->option('user')) {
            return __DIR__.'/stubs/repository-user.stub';
        }

        return __DIR__.'/stubs/repository.stub';
    }

    /**
     * Resolve the fully-qualified path to the stub.
     *
     * @param  string  $stub
     * @return string
     */
    protected function resolveStubPath($stub)
    {
        return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
                        ? $customPath
                        : __DIR__.$stub;
    }

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

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['contract', 'c', InputOption::VALUE_NONE, 'Create an interface class for this repository'],
            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the repository already exists'],
            ['interface', 'i', InputOption::VALUE_OPTIONAL, 'Create an interface namespace for this repository'],
            ['model', 'm', InputOption::VALUE_REQUIRED, 'Create a model namespace for this repository'],
            ['user', 'u', InputOption::VALUE_NONE, 'Create extra fetch by user id functions for this repository'],
        ];
    }

    /**
     * Execute the console command.
     *
     * @return bool|null
     *
     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
     */
    public function handle()
    {
        if ($this->isReservedName($this->getNameInput())) {
            $this->components->error('The name "'.$this->getNameInput().'" is reserved by PHP.');

The property components does not exist on Ikechukwukalu\Makeservice\Console\Commands\MakeRepositoryCommand. Did you maybe forget to declare it?

            return false;
        }

        if (!$this->areOptionsPresent()) {
            return false;
        }

        $name = $this->qualifyClass($this->getNameInput());

        $path = $this->getPath($name);

        if ((! $this->hasOption('force') ||
             ! $this->option('force')) &&
             $this->alreadyExists($this->getNameInput())) {
            $this->components->error($this->type.' already exists.');

            return false;
        }

        $this->makeDirectory($path);

        $this->files->put($path, $this->sortImports($this->buildClass($name)));

        $info = $this->type;

        if (in_array(CreatesMatchingTest::class, class_uses_recursive($this))) {
            if ($this->handleTestCreation($path)) {

The method handleTestCreation() does not exist on Ikechukwukalu\Makeservice\Console\Commands\MakeRepositoryCommand. Since you implemented __call, consider adding a @method annotation.

                $info .= ' and test';
            }
        }

        $this->components->info(sprintf('%s [%s] created successfully.', $info, $path));
    }

    private function areOptionsPresent():bool
    {
        if (!$this->option('model')) {
            if (!($this->option('contract') || $this->option('interface'))) {
                $this->components->error('Expected options "model" and "contract or interface"!');

The property components does not exist on Ikechukwukalu\Makeservice\Console\Commands\MakeRepositoryCommand. Did you maybe forget to declare it?

                return false;
            }

            $this->components->error('Expected option "model"!');
            return false;
        }

        if (!($this->option('contract') || $this->option('interface'))) {
            $this->components->error('Expected option "interface or contract"!');
            return false;
        }

        return true;
    }
}