HydeBuildSiteCommand::canGenerateSearch() - Code Metrics - Inspection of "Merge pull request #475 from hydephp/breaking-name..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f2f8c0...5c7f99 )

by Caen

created 2022-09-08 17:25 UTC

HydeBuildSiteCommand::canGenerateSearch() A

↳ Parent: HydeBuildSiteCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Hyde\Framework\Commands;

use Exception;
use Hyde\Framework\Actions\PostBuildTasks\GenerateRssFeed;
use Hyde\Framework\Actions\PostBuildTasks\GenerateSearch;
use Hyde\Framework\Actions\PostBuildTasks\GenerateSitemap;
use Hyde\Framework\Helpers\Features;
use Hyde\Framework\Hyde;
use Hyde\Framework\Services\BuildService;
use Hyde\Framework\Services\BuildTaskService;
use Hyde\Framework\Services\DiscoveryService;
use Illuminate\Support\Facades\Config;
use LaravelZero\Framework\Commands\Command;

/**
 * Hyde Command to run the Build Process.
 *
 * @see \Hyde\Framework\Testing\Feature\StaticSiteServiceTest
 */
class HydeBuildSiteCommand extends Command
{
    /**
     * The signature of the command.
     *
     * @var string
     */
    protected $signature = 'build 
        {--run-dev : Run the NPM dev script after build}
        {--run-prod : Run the NPM prod script after build}
        {--run-prettier : Format the output using NPM Prettier}
        {--pretty-urls : Should links in output use pretty URLs?}
        {--no-api : Disable API calls, for example, Torchlight}';

    /**
     * The description of the command.
     *
     * @var string
     */
    protected $description = 'Build the static site';

    protected BuildService $service;

    /**
     * Execute the console command.
     *
     * @return int
     *
     * @throws Exception
     */
    public function handle(): int
    {
        $time_start = microtime(true);

        $this->title('Building your static site!');

        $this->service = new BuildService($this->output);

        $this->runPreBuildActions();

        $this->service->cleanOutputDirectory();

        $this->service->transferMediaAssets();

        $this->service->compileStaticPages();

        $this->runPostBuildActions();

        $this->printFinishMessage($time_start);
        $this->printFinishMessage(/** @scrutinizer ignore-type */ $time_start);

        return 0;
    }

    /** @internal */
    protected function runPreBuildActions(): void
    {
        if ($this->option('no-api')) {
            $this->info('Disabling external API calls');
            $this->newLine();
            $config = config('hyde.features');
            unset($config[array_search('torchlight', $config)]);
            Config::set(['hyde.features' => $config]);
        }

        if ($this->option('pretty-urls')) {
            $this->info('Generating site with pretty URLs');
            $this->newLine();
            Config::set(['site.pretty_urls' => true]);
        }
    }

    /**
     * Run any post-build actions.
     *
     * @return void
     */
    public function runPostBuildActions(): void
    {
        $service = new BuildTaskService($this->output);

        if ($this->option('run-prettier')) {
            $this->runNodeCommand(
                'npx prettier '.Hyde::pathToRelative(Hyde::getSiteOutputPath()).'/**/*.html --write --bracket-same-line',
                'Prettifying code!',
                'prettify code'
            );
        }

        if ($this->option('run-dev')) {
            $this->runNodeCommand('npm run dev', 'Building frontend assets for development!');
        }

        if ($this->option('run-prod')) {
            $this->runNodeCommand('npm run prod', 'Building frontend assets for production!');
        }

        $service->runIf(GenerateSitemap::class, $this->canGenerateSitemap());
        $service->runIf(GenerateRssFeed::class, $this->canGenerateFeed());
        $service->runIf(GenerateSearch::class, $this->canGenerateSearch());

        $service->runPostBuildTasks();
    }

    /** @internal */
    protected function printFinishMessage(float $time_start): void
    {
        $execution_time = (microtime(true) - $time_start);
        $this->info(sprintf(
            'All done! Finished in %s seconds. (%sms)',
            number_format($execution_time, 2),
            number_format($execution_time * 1000, 2)
        ));

        $this->info('Congratulations! 🎉 Your static site has been built!');
        $this->line(
            'Your new homepage is stored here -> '.
            DiscoveryService::createClickableFilepath(Hyde::getSiteOutputPath('index.html'))
        );
    }

    /* @internal */
    protected function runNodeCommand(string $command, string $message, ?string $actionMessage = null): void
    {
        $this->info($message.' This may take a second.');

        $output = shell_exec(sprintf(
            '%s%s',
            app()->environment() === 'testing' ? 'echo ' : '',
            app()->/** @scrutinizer ignore-call */ environment() === 'testing' ? 'echo ' : '',
            $command
        ));

        $this->line($output ?? sprintf(
            '<fg=red>Could not %s! Is NPM installed?</>',
            $actionMessage ?? 'run script'
        ));
    }

    protected function canGenerateSitemap(): bool
    {
        return Features::sitemap();
    }

    protected function canGenerateFeed(): bool
    {
        return Features::rss();
    }

    protected function canGenerateSearch(): bool
    {
        return Features::hasDocumentationSearch();
    }
}


hydephp / develop

Push — master ( f2f8c0...5c7f99 )

HydeBuildSiteCommand::canGenerateSearch() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like