OuvrageCompleteWorker::run() - Code Metrics - Inspection of "refac OuvrageOptimizer (handlers)" - Dispositif/Wikibot - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 9e3ea7...ee24dc )

by Dispositif
created 2023-04-28 17:05 UTC
OuvrageCompleteWorker::run() B

↳ Parent: OuvrageCompleteWorker
Complexity

Conditions	7
Paths	6
Size

Total Lines	53
Code Lines	29
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	29
c	0
b	0
f	0
dl	0
loc	53
rs	8.5226
cc	7
nc	6
nop	1
How to fix Long Method

<?php
/*
 * This file is part of dispositif/wikibot application (@github)
 * 2019-2023 © Philippe M./Irønie  <[email protected]>
 * For the full copyright and MIT license information, view the license file.
 */

declare(strict_types=1);

namespace App\Application\OuvrageComplete;

use App\Application\InfrastructurePorts\DbAdapterInterface;
use App\Application\InfrastructurePorts\MemoryInterface;
use App\Application\OuvrageComplete\Handlers\BnfFromIsbnHandler;
use App\Application\OuvrageComplete\Handlers\GoogleBooksHandler;
use App\Application\OuvrageComplete\Handlers\OpenLibraryHandler;
use App\Application\OuvrageComplete\Handlers\ParseTemplateHandler;
use App\Application\OuvrageComplete\Handlers\WikidataSearchHandler;
use App\Application\OuvrageComplete\Validators\GoogleRequestValidator;
use App\Application\OuvrageComplete\Validators\IsbnBanValidator;
use App\Application\OuvrageComplete\Validators\NewPageOuvrageToCompleteValidator;
use App\Application\WikiBotConfig;
use App\Domain\InfrastructurePorts\WikidataAdapterInterface;
use App\Domain\Models\PageOuvrageDTO;
use App\Domain\Models\Wiki\OuvrageTemplate;
use App\Domain\OptimizerFactory;
use App\Domain\OuvrageComplete;
use App\Domain\SummaryLogTrait;
use App\Domain\WikiOptimizer\OuvrageOptimize;
use DateTime;
use Exception;
use Normalizer;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

/**
 * TODO Legacy class, to be refactored. To big, too many responsibilities.
 * TODO use DTO from DbAdapter.
 */
class OuvrageCompleteWorker
{
    use SummaryLogTrait;


    /**
     * @var MemoryInterface
     */
    protected $memory;
    /**
     * @var PageOuvrageDTO
     */
    protected $pageOuvrage;
    /**
     * @var DbAdapterInterface
     */
    protected $queueAdapter;

    protected $page; // article title
    /**
     * @var OuvrageTemplate
     */
    protected $ouvrage;
    /**
     * @var LoggerInterface
     */
    protected $logger;
    /**
     * @var WikidataAdapterInterface
     */
    protected $wikidataAdapter;
    /**
     * @var CitationWorkStatus
     */
    protected $citationWorkStatus;

    public function __construct(
        DbAdapterInterface       $queueAdapter,
        WikidataAdapterInterface $wikidataAdapter,
        MemoryInterface          $memory,
        ?LoggerInterface         $logger = null
    )
    {
        $this->queueAdapter = $queueAdapter;
        $this->logger = $logger ?? new NullLogger();
        $this->wikidataAdapter = $wikidataAdapter;
        $this->memory = $memory;
    }

    public function run(?int $limit = 10000): bool
    {
        while ($limit > 0) {
            $limit--;
            sleep(1);
            $this->pageOuvrage = $this->getNewRow2CompleteOrException();
            if ($this->pageOuvrage === null) {
                throw new Exception('no more queue to process');
            }
            $this->page = $this->pageOuvrage->getPage();

            $this->printTitle($this->pageOuvrage);

            // initialise variables
            $this->citationWorkStatus = new CitationWorkStatus($this->page);

            $this->resetSummaryLog();
            $this->ouvrage = null;


            // TODO WIP
            $handler = new ParseTemplateHandler($this->pageOuvrage, $this->queueAdapter, $this->logger);
            $origin = $handler->handle();


            // Final optimizing (with online predictions)
            $optimizer = OptimizerFactory::fromTemplate($origin, $this->page, $this->logger);
            $optimizer = OptimizerFactory::fromTemplate(/** @scrutinizer ignore-type */ $origin, $this->page, $this->logger);
            /** @var OuvrageOptimize $optimizer */
            $optimizer->doTasks();
            $this->ouvrage = $optimizer->getOptiTemplate();
            $this->summaryLog = array_merge($this->getSummaryLog(), $optimizer->getSummaryLog());
            $this->citationWorkStatus->notCosmetic = ($optimizer->isNotCosmetic() || $this->citationWorkStatus->notCosmetic);


            /**
             * RECHERCHE ONLINE
             */
            $isbn = $origin->getParam('isbn') ?? null; // avant mise en forme EAN>ISBN
            $isbn10 = $origin->getParam('isbn2') ?? $origin->getParam('isbn10') ?? null;
            if (!empty($isbn)
                && !$origin->hasParamValue('isbn invalide')
                && !$origin->hasParamValue('isbn erroné')
            ) {
                $this->completeByIsbnSearch($isbn, $isbn10);
            }

            $this->sendCompleted();
            unset($optimizer);
            unset($parse);

            unset($origin);
        } // END WHILE

        return true;
    }

    /**
     * Get array (title+raw strings) to complete from AMQP queue, SQL Select or file reading.
     */
    protected function getNewRow2CompleteOrException(): ?PageOuvrageDTO
    {
        $pageOuvrageDTO = $this->queueAdapter->getNewRaw();
        if ((new NewPageOuvrageToCompleteValidator($pageOuvrageDTO))->validate()) {
            return $pageOuvrageDTO;
        }
        $this->logger->debug('no more raw');

        return null;
    }

    // todo extract class

    protected function printTitle(PageOuvrageDTO $pageOuvrage): void
    {
        echo sprintf(
            "-------------------------------\n%s [%s]\n%s\n%s\n",
            date("Y-m-d H:i:s"),
            WikiBotConfig::VERSION ?? '',
            $pageOuvrage->getPage(),
            $pageOuvrage->getRaw()
        );

        $this->logger->debug($this->memory->getMemory(true));
    }

    //    protected function onlineQuerySearch(string $query)
    //    {
    //        echo "sleep 40...";
    //        sleep(20);
    //        onlineQuerySearch:
    //
    //        try {
    //            dump('GOOGLE SEARCH...');
    //            //            $googleOuvrage = OuvrageFactory::GoogleFromIsbn($isbn);
    //            $adapter = new GoogleBooksAdapter();
    //            $data = $adapter->search('blabla');
    //            dump($data);
    //            //die;
    //            //            return $import->getOuvrage();
    //            //            $this->completeOuvrage($googleOuvrage);
    //        } catch (Throwable $e) {
    //            echo "*** ERREUR GOOGLE QuerySearch *** ".$e->getMessage()."\n";
    //            echo "sleep 30min";
    //            sleep(60 * 30);
    //            echo "Wake up\n";
    //            goto onlineQuerySearch;
    //        }
    //    }

    protected function completeByIsbnSearch(string $isbn, ?string $isbn10 = null)
    {
        if ((new IsbnBanValidator($isbn, $isbn10))->validate() === false) {
            echo "*** SKIP THAT ISBN ***\n";
            return;
        }

        $this->logger->info("sleep 10...\n"); // API throttle
        sleep(10);

        $bnfOuvrage = (new BnfFromIsbnHandler($isbn, $isbn10, $this->logger))->handle();
        $this->completeOuvrage($bnfOuvrage); // todo move to BnfFromIsbnHandler ?

        if ($bnfOuvrage instanceof OuvrageTemplate) {
            $wdOuvrage = (new WikidataSearchHandler($bnfOuvrage, $this->wikidataAdapter, $this->page))->handle();
            $this->completeOuvrage($wdOuvrage);
        }

        if ((new GoogleRequestValidator($this->ouvrage, $bnfOuvrage))->validate()) {
            $googleOuvrage = (new GoogleBooksHandler($isbn, $this->logger))->handle();
            $this->completeOuvrage($googleOuvrage);
        }

        if (!isset($bnfOuvrage) && !isset($googleOuvrage)) {
            $openLibraryOuvrage = (new OpenLibraryHandler($isbn, $this->logger))->handle();
            $this->completeOuvrage($openLibraryOuvrage);
        }
    }

    protected function completeOuvrage(?OuvrageTemplate $onlineOuvrage): void
    {
        if (!$onlineOuvrage instanceof OuvrageTemplate) {
            return;
        }
        $this->logger->info($onlineOuvrage->serialize(true));
        $optimizer = OptimizerFactory::fromTemplate($onlineOuvrage, $this->page, $this->logger);
        $onlineOptimized = ($optimizer)->doTasks()->getOptiTemplate();

        $completer = new OuvrageComplete($this->ouvrage, $onlineOptimized, $this->logger);
        $this->ouvrage = $completer->getResult();

        // todo move that optimizing in OuvrageComplete ?
        $optimizer = OptimizerFactory::fromTemplate($this->ouvrage, $this->page, $this->logger);
        $this->ouvrage = $optimizer->doTasks()->getOptiTemplate();

        $this->logger->info('Summary', $completer->getSummaryLog());

        if ($completer->major) {
            $this->citationWorkStatus->minorFlag = false;
        }
        $this->citationWorkStatus->notCosmetic = ($completer->notCosmetic || $this->citationWorkStatus->notCosmetic);
        $this->summaryLog = array_merge($this->getSummaryLog(), $completer->getSummaryLog());
        unset($optimizer);
        unset($completer);
    }

    protected function sendCompleted()
    {
        $this->pageOuvrage
            ->setOpti($this->serializeFinalOpti())
            ->setOptidate(new DateTime())
            ->setModifs(mb_substr(implode(',', $this->getSummaryLog()), 0, 250))
            ->setNotcosmetic(($this->citationWorkStatus->notCosmetic) ? 1 : 0)
            ->setMajor(($this->citationWorkStatus->minorFlag) ? 0 : 1)
            ->setIsbn(substr($this->ouvrage->getParam('isbn'), 0, 19))
            ->setIsbn(substr(/** @scrutinizer ignore-type */ $this->ouvrage->getParam('isbn'), 0, 19))
            ->setVersion(WikiBotConfig::VERSION ?? null);

        $result = $this->queueAdapter->sendCompletedData($this->pageOuvrage);
        $this->logger->debug($result ? 'OK DB' : 'erreur sendCompletedData()');
    }

    /**
     * Final serialization of the completed OuvrageTemplate.
     */
    protected function serializeFinalOpti(): string
    {
        //        // Améliore style compact : plus espacé
        //        if ('|' === $this->ouvrage->userSeparator) {
        //            $this->ouvrage->userSeparator = ' |';
        //        }
        $finalOpti = $this->ouvrage->serialize(true);
        $finalOpti = Normalizer::normalize($finalOpti);
        if (empty($finalOpti) || !is_string($finalOpti)) {
            throw new Exception('normalized $finalOpti serialize in OuvrageComplete is not a string');
        }

        return $finalOpti;
    }
}

Dispositif / Wikibot

Push — master ( 9e3ea7...ee24dc )

OuvrageCompleteWorker::run() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
