Cerbero\CommandValidator\ValidatesInput

Complexity

Total Complexity

8

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Test Coverage

Coverage

82.61%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getDataToValidate()	0	6	1
A	execute()	0	7	2
A	messages()	0	3	1
A	validator()	0	11	2
A	formatErrors()	0	3	1
A	attributes()	0	3	1

<?php

namespace Cerbero\CommandValidator;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Illuminate\Contracts\Validation\Validator;
use Symfony\Component\Console\Exception\InvalidArgumentException;

/**
 * The trait to validate console commands input.
 *
 */
trait ValidatesInput
{
    /**
     * The command input validator.
     *
     * @var \Illuminate\Contracts\Validation\Validator
     */
    protected $validator;

    /**
     * Retrieve the rules to validate data against
     *
     * @return array
     */
    abstract protected function rules(): array;

    /**
     * Execute the console command.
     *
     * @param  \Symfony\Component\Console\Input\InputInterface  $input
     * @param  \Symfony\Component\Console\Output\OutputInterface  $output
     * @return mixed
     * @throws \Symfony\Component\Console\Exception\InvalidArgumentException
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if ($this->validator()->fails()) {
            throw new InvalidArgumentException($this->formatErrors());
        }

        return parent::execute($input, $output);
    }

    /**
     * Retrieve the command input validator
     *
     * @return \Illuminate\Contracts\Validation\Validator
     */
    protected function validator(): Validator
    {
        if (isset($this->validator)) {
            return $this->validator;
        }

        return $this->validator = $this->laravel['validator']->make(
            $this->getDataToValidate(),
            $this->rules(),
            $this->messages(),
            $this->attributes()
        );
    }

    /**
     * Retrieve the data to validate
     *
     * @return array
     */
    protected function getDataToValidate(): array
    {
        $data = array_merge($this->argument(), $this->option());

It seems like argument() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like option() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return array_filter($data, function ($value) {
            return $value !== null;
        });
    }

    /**
     * Format the validation errors
     *
     * @return string
     */
    protected function formatErrors(): string
    {
        return implode(PHP_EOL, $this->validator()->errors()->all());
    }

    /**
     * Retrieve the custom error messages
     *
     * @return array
     */
    protected function messages(): array
    {
        return [];
    }

    /**
     * Retrieve the custom attribute names for error messages
     *
     * @return array
     */
    protected function attributes(): array
    {
        return [];
    }
}