App\Commands\BaseValidatorCommand

Complexity

Total Complexity

12

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	compileRowsFromSource()	0	8	1
A	setSource()	0	7	3
A	getSourceFromFile()	0	11	1
A	buildRowFromValidator()	0	10	2
A	validateOutputPath()	0	10	2
A	handle()	0	11	1
A	buildCsvFromRows()	0	5	1

<?php

namespace App\Commands;

use Carbon\Carbon;
use App\PhoneNumberValidator;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\File;
use LaravelZero\Framework\Commands\Command;
use Symfony\Component\Console\Exception\RuntimeException;

abstract class BaseValidatorCommand extends Command
{
    /**
     * @var mixed
     */
    protected $source;

    /**
     * Make a validator for a given number.
     *
     * @param  mixed $number
     * @return App\PhoneNumberValidator

The type App\Commands\App\PhoneNumberValidator was not found. Did you mean App\PhoneNumberValidator? If so, make sure to prefix the type with \.

     */
    abstract public function makeValidatorForNumer($number): PhoneNumberValidator;

    /**
     * Is the number valid?
     *
     * @param  App\PhoneNumberValidator $validator
     * @return bool
     */
    abstract public function isNumberValid(PhoneNumberValidator $validator): bool;

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();

        $date = Carbon::now()->format('Ymd_his');
        $rand = mb_strtolower(str_random(6));

        $this->fileName = $date.'-'.$rand.'.csv';

The property fileName does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->outputPath = base_path('output');

The property outputPath does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle(): void
    {
        $this->setSource();
        $this->validateOutputPath();

        $this->buildCsvFromRows(
            $this->compileRowsFromSource($this->source)
        );

        $this->info('Total: '.count($this->source));
        $this->info('Filename: '.$this->fileName);
    }

    /**
     * Build a CSV from the rows.
     *
     * @param  Collection $rows
     * @return void
     */
    protected function buildCsvFromRows(Collection $rows)
    {
        File::put(
            $this->outputPath.'/'.$this->fileName,
            implode("\n", $rows->toArray())
        );
    }

    /**
     * Process a list of numbers.
     *
     * @param array $source
     * @return Illuminate\Support\Collection

The type App\Commands\Illuminate\Support\Collection was not found. Did you mean Illuminate\Support\Collection? If so, make sure to prefix the type with \.

     */
    protected function compileRowsFromSource(array $source): Collection
    {
        return collect($source)
            ->map([$this, 'makeValidatorForNumer'])
            ->map([$this, 'buildRowFromValidator'])
            ->prepend(['phone number', 'carrier', 'status'])
            ->map(function ($row) {
                return implode(',', $row);
            });
    }

    /**
     * Build a row.
     *
     * @param  App\PhoneNumberValidator $validator
     * @return array
     */
    public function buildRowFromValidator(PhoneNumberValidator $validator): array
    {
        $row = [$validator->getNumber(), '', 'not valid'];

        if ($this->isNumberValid($validator)) {
            $row[1] = $validator->getCarrierName();
            $row[2] = 'valid';
        }

        return $row;
    }

    /**
     * Set the source.
     */
    protected function setSource(): void
    {
        $this->source = $this->option('file')
            ? $this->getSourceFromFile($this->argument('source'))
            : array_wrap($this->argument('source'));

        $this->info('Source valid: '.($this->option('file') ? 'File' : 'List'));
    }

    /**
     * Return the contents of the source file.
     *
     * @return array
     */
    protected function getSourceFromFile($file): array
    {
        $file = head(array_wrap($file));

        throw_unless(
            File::exists($file),
            RuntimeException::class,
            "Source does not exist [{$file}]"

EncapsedNode of type string is incompatible with the type array expected by parameter $parameters of throw_unless().

        );

        return array_wrap(explode("\n", File::get($file)));
    }

    /**
     * Set the output path.
     */
    protected function validateOutputPath(): void
    {
        if ($this->option('output')) {
            $this->outputPath = $this->option('output');

The property outputPath does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        throw_unless(
            is_dir($this->outputPath),

It seems like $this->outputPath can also be of type array; however, parameter $filename of is_dir() does only seem to accept string, maybe add an additional type check?

            RuntimeException::class,
            "The output path does not exist [{$this->outputPath}]"

EncapsedNode of type string is incompatible with the type array expected by parameter $parameters of throw_unless().

        );
    }
}