Spiral\Scaffolder\Declaration\CommandDeclaration

Complexity

Total Complexity

6

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	declare()	0	26	2
A	addOption()	0	8	1
A	__construct()	0	9	1
A	addArgument()	0	11	1
A	getInstructions()	0	5	1

<?php

declare(strict_types=1);

namespace Spiral\Scaffolder\Declaration;

use Spiral\Console\Attribute\Argument;
use Spiral\Console\Attribute\AsCommand;
use Spiral\Console\Attribute\Option;
use Spiral\Console\Attribute\Question;
use Spiral\Console\Command;
use Spiral\Scaffolder\Config\ScaffolderConfig;

final class CommandDeclaration extends AbstractDeclaration implements HasInstructions
{
    public const TYPE = 'command';

    public function __construct(
        ScaffolderConfig $config,
        string $name,
        ?string $comment = null,
        ?string $namespace = null,
        private readonly ?string $alias = null,
        private readonly ?string $description = null,
    ) {
        parent::__construct($config, $name, $comment, $namespace);
    }

    public function addArgument(string $name): void
    {
        $this->class
            ->addProperty($name)
            ->setPrivate()
            ->setType('string')
            ->addAttribute(Argument::class, [
                'description' => 'Argument description',
            ])
            ->addAttribute(Question::class, [
                'question' => \sprintf('What would you like to name the %s argument?', $name),
            ]);
    }

    public function addOption(string $name): void
    {
        $this->class
            ->addProperty($name)
            ->setPrivate()
            ->setType('bool')
            ->addAttribute(Option::class, [
                'description' => 'Argument description',
            ]);
    }

    /**
     * Declare default command body.
     */
    public function declare(): void
    {
        $this->namespace->addUse(Command::class);
        $this->namespace->addUse(AsCommand::class);
        $this->namespace->addUse(Argument::class);
        $this->namespace->addUse(Option::class);
        $this->namespace->addUse(Question::class);

        $this->class->setExtends(Command::class);
        $this->class->setFinal();

        $commandDefinition = [
            'name' => $this->alias,
        ];

        if ($this->description) {
            $commandDefinition['description'] = $this->description;
        }

        $this->class->addAttribute(AsCommand::class, $commandDefinition);

        $this->class
            ->addMethod('__invoke')
            ->setReturnType('int')
            ->setBody(
                <<<'PHP'
                // Put your command logic here
                $this->info('Command logic is not implemented yet');

                return self::SUCCESS;
                PHP,
            );
    }

    public function getInstructions(): array
    {
        return [
            \sprintf('Use the following command to run your command: \'<comment>php app.php %s</comment>\'', $this->alias),
            'Read more about user Commands in the documentation: https://spiral.dev/docs/console-commands',
        ];
    }
}