reliqarts / laravel-scavenger

src/Console/Command/Seek.php

<?php

/**
 * @noinspection PhpMissingFieldTypeInspection
 */

declare(strict_types=1);

namespace ReliqArts\Scavenger\Console\Command;

use Carbon\Carbon;
use Exception;
use Illuminate\Console\Command;
use ReliqArts\Scavenger\Contract\ConfigProvider;
use ReliqArts\Scavenger\Contract\Seeker;
use ReliqArts\Scavenger\Exception\BadDaemonConfig;
use ReliqArts\Scavenger\OptionSet;
use ReliqArts\Scavenger\Result;

class Seek extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'scavenger:seek 
                            {target? : Optionally specify a single target from list of available targets}
                            {--w|keywords= : Comma separated keywords}
                            {--k|keep : Whether to save found scraps}
                            {--c|convert : Whether to convert found scraps to target objects}
                            {--y|y : Whether to skip confirmation}
                            {--b|backoff=0 : Wait time after each scrape}
                            {--p|pages=2 : Max. number of pages to scrape}
                            ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Finds entities and updates database';

    /**
     * Execute the console command.
     *
     * @throws Exception
     */
    public function handle(ConfigProvider $configProvider, Seeker $seeker): void
    {
        $saveScraps = $this->option('keep');
        $target = $this->argument('target');
        $keywords = $this->option('keywords');
        $skipConfirmation = $this->option('y');
        $backOff = (int)$this->option('backoff');
        $pages = (int)$this->option('pages');
        $convertScraps = $this->option('convert');
        $optionSet = new OptionSet($saveScraps, $convertScraps, $backOff, $pages, $keywords);

$convertScraps of type string is incompatible with the type boolean expected by parameter $convertScraps of ReliqArts\Scavenger\OptionSet::__construct().

$saveScraps of type string is incompatible with the type boolean expected by parameter $saveScraps of ReliqArts\Scavenger\OptionSet::__construct().

        $confirmationQuestion = 'Scavenger will scour a resource for scraps and make model records,'
            . "performing HTTP, DB and I/O operations.\n Ensure your internet connection is stable. Ready?";

        $this->comment(
            PHP_EOL
            . "<info>♣♣♣</info> Scavenger Seek \nHelp is here, try: php artisan scavenger:seek --help"
        );

        if (!($skipConfirmation || $this->confirm($confirmationQuestion))) {
            return;
        }

        if (!$this->logDaemonIn($configProvider)) {
            return;
        }

        $this->info(
            "Scavenger is seeking. Output is shown below.\nT: "
            . Carbon::now()->toCookieString() . "\n----------"
        );

        $result = $seeker->seek($optionSet, $target);

It seems like $target can also be of type string[]; however, parameter $targetName of ReliqArts\Scavenger\Contract\Seeker::seek() does only seem to accept null|string, maybe add an additional type check?

        $this->showResult($result);
    }

    private function logDaemonIn(ConfigProvider $configProvider): bool
    {
        try {
            $daemon = $configProvider->getDaemon();

            auth()->login($daemon);

            return true;
        } catch (BadDaemonConfig $exception) {
            $this->line(
                PHP_EOL
                . "<error>✘ Woe there! Scavenger daemon doesn't live in your database and couldn't be created. "
                . "You sure you know what yer doin'?</error>\n► "
                . $exception->getMessage()
            );

            return false;
        }
    }

    private function showResult(Result $result): void
    {
        if (!$result->isSuccess()) {
            foreach ($result->getErrors() as $errorMessage) {
                $this->line(PHP_EOL . "<error>✘</error> {$errorMessage}");
            }

            return;
        }

        try {
            $this->info(PHP_EOL . '----------');
            $this->comment('<info>✔</info> Done. Scavenger daemon now goes to sleep...');
            $this->line('');

            $extra = $result->getExtra();
            $headers = ['Time', 'Scraps Found', 'New', 'Saved?', 'Converted?'];
            $data = [
                [
                    $extra->executionTime,
                    $extra->total,
                    $extra->new,
                    $extra->scrapsSaved ? 'true' : 'false',
                    $extra->scrapsConverted ? 'true' : 'false',
                ],
            ];

            $this->table($headers, $data);
            $this->line(PHP_EOL);
        } catch (Exception $exception) {
            $this->line(
                PHP_EOL
                . "<error>✘</error> Something strange happened at the end there... {$exception->getMessage()}"
            );
        }
    }
}