Hyde\Framework\Services\DocumentationSearchService

Complexity

Total Complexity

14

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Importance

Changes	15
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	generate()	0	3	1
A	generateSearchPage()	0	11	1
A	__construct()	0	4	1
A	getFilePath()	0	4	1
A	run()	0	12	3
A	getDestinationForSlug()	0	7	3
A	execute()	0	3	1
A	save()	0	7	1
A	generatePageEntry()	0	7	1
A	getSearchContentForDocument()	0	3	1

<?php

declare(strict_types=1);

namespace Hyde\Framework\Services;

use Hyde\Framework\Actions\ConvertsMarkdownToPlainText;
use Hyde\Framework\Concerns\InteractsWithDirectories;
use Hyde\Hyde;
use Hyde\Pages\DocumentationPage;
use Illuminate\Support\Collection;

/**
 * @internal Generate a JSON file that can be used as a search index for documentation pages.
 *
 * @see \Hyde\Framework\Testing\Feature\Services\DocumentationSearchServiceTest
 */
final class DocumentationSearchService
{
    use InteractsWithDirectories;

    public Collection $searchIndex;
    protected string $filePath;

    public static function generate(): self
    {
        return (new self())->execute();
    }

    public static function generateSearchPage(): string
    {
        $outputDirectory = Hyde::sitePath(DocumentationPage::outputDirectory());
        self::needsDirectory($outputDirectory);

        file_put_contents(
            "$outputDirectory/search.html",
            view('hyde::pages.documentation-search')->render()
        );

        return $outputDirectory;
    }

    public function __construct()
    {
        $this->searchIndex = new Collection();
        $this->filePath = $this->getFilePath();
    }

    public function execute(): self
    {
        return $this->run()->save();
    }

    public function run(): self
    {
        /** @var \Hyde\Pages\DocumentationPage $page */
        foreach (DocumentationPage::all() as $page) {
            if (! in_array($page->identifier, config('docs.exclude_from_search', []))) {
                $this->searchIndex->push(
                    $this->generatePageEntry($page)

$this->generatePageEntry($page) of type array<string,string> is incompatible with the type Illuminate\Support\TValue expected by parameter $values of Illuminate\Support\Collection::push().

                );
            }
        }

        return $this;
    }

    /**
     * @return array{slug: string, title: string, content: string, destination: string}
     */
    public function generatePageEntry(DocumentationPage $page): array
    {
        return [
            'slug' => basename($page->identifier),
            'title' => $page->title,
            'content' => trim($this->getSearchContentForDocument($page)),
            'destination' => $this->getDestinationForSlug(basename($page->identifier)),
        ];
    }

    protected function save(): self
    {
        $this->needsParentDirectory(Hyde::path($this->filePath));

        file_put_contents(Hyde::path($this->filePath), $this->searchIndex->toJson());

        return $this;
    }

    protected function getSearchContentForDocument(DocumentationPage $page): string
    {
        return (new ConvertsMarkdownToPlainText($page->markdown->body()))->execute();
    }

    public function getDestinationForSlug(string $slug): string
    {
        if (config('site.pretty_urls', false) === true) {
            return $slug !== 'index' ? $slug : '';
        }

        return $slug.'.html';
    }

    public static function getFilePath(): string
    {
        return Hyde::pathToRelative(Hyde::sitePath(
            DocumentationPage::outputDirectory().'/search.json'
        ));
    }
}