Hyde\Framework\Factories\NavigationDataFactory

Complexity

Total Complexity

50

Size/Duplication

Total Lines	276
Duplicated Lines	0 %

Importance

Changes

0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	7	1
A	makeLabel()	0	6	1
A	searchForGroupInFrontMatter()	0	4	1
A	searchForLabelInFrontMatter()	0	4	1
A	searchForHiddenInFrontMatter()	0	4	1
A	__construct()	0	12	1
A	isInstanceOf()	0	3	1
A	searchForPriorityInFrontMatter()	0	4	1
A	checkFilePrefixForOrder()	0	11	3
A	isPageHiddenInNavigationConfiguration()	0	3	1
A	parseNavigationPriorityConfig()	0	18	2
A	searchForHiddenInConfigs()	0	5	2
A	searchForPriorityInNavigationConfig()	0	10	1
A	getMatter()	0	6	1
A	searchForPriorityInSidebarConfig()	0	11	1
A	getSubdirectoryName()	0	3	1
A	pageIsInSubdirectory()	0	3	1
A	makeGroup()	0	9	4
A	canUseSubdirectoryForGroups()	0	4	2
A	searchForLabelInConfigs()	0	5	2
A	invert()	0	3	2
A	makeHidden()	0	6	4
A	makePriority()	0	6	1
A	searchForLabelInSidebarConfig()	0	8	1
A	searchForPriorityInConfigs()	0	5	2
A	isPageHiddenInSidebarConfiguration()	0	9	3
A	getSubdirectoryConfiguration()	0	3	1
A	isNonDocumentationPageInHiddenSubdirectory()	0	6	4
A	searchForLabelInNavigationConfig()	0	9	1
A	offset()	0	3	2

<?php

declare(strict_types=1);

namespace Hyde\Framework\Factories;

use Hyde\Facades\Config;
use Illuminate\Support\Str;
use Hyde\Pages\MarkdownPost;
use Hyde\Pages\DocumentationPage;
use Hyde\Markdown\Models\FrontMatter;
use Hyde\Framework\Factories\Concerns\CoreDataObject;
use Hyde\Framework\Features\Navigation\NavigationMenu;
use Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema;
use Hyde\Framework\Features\Navigation\NumericalPageOrderingHelper;

use function basename;
use function array_flip;
use function in_array;
use function is_a;
use function array_key_exists;

/**
 * Discover data used for navigation menus and the documentation sidebar.
 */
class NavigationDataFactory extends Concerns\PageDataFactory implements NavigationSchema
{
    /**
     * The front matter properties supported by this factory.
     *
     * Note that this represents a sub-schema, and is used as part of the page schema.
     */
    final public const SCHEMA = NavigationSchema::NAVIGATION_SCHEMA;

    protected readonly ?string $label;
    protected readonly ?string $group;
    protected readonly ?bool $hidden;
    protected readonly ?int $priority;
    private readonly string $title;
    private readonly string $routeKey;
    private readonly string $pageClass;
    private readonly string $identifier;
    private readonly FrontMatter $matter;

    public function __construct(CoreDataObject $pageData, string $title)
    {
        $this->matter = $pageData->matter;

The property matter is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->identifier = $pageData->identifier;

The property identifier is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->pageClass = $pageData->pageClass;

The property pageClass is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->routeKey = $pageData->routeKey;

The property routeKey is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->title = $title;

The property title is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->label = $this->makeLabel();

The property label is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->group = $this->makeGroup();

The property group is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->hidden = $this->makeHidden();

The property hidden is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

        $this->priority = $this->makePriority();

The property priority is declared read-only in Hyde\Framework\Factories\NavigationDataFactory.

    }

    /**
     * @return array{label: string|null, group: string|null, hidden: bool|null, priority: int|null}
     */
    public function toArray(): array
    {
        return [

The expression return array('label' => $this->label, 'group' => $this->group, 'hidden' => $this->hidden, 'priority' => $this->priority) returns an array which contains values of type boolean|integer|string which are incompatible with the return type Illuminate\Contracts\Support\TValue mandated by Illuminate\Contracts\Support\Arrayable::toArray().

            'label' => $this->label,
            'group' => $this->group,
            'hidden' => $this->hidden,
            'priority' => $this->priority,
        ];
    }

    protected function makeLabel(): ?string
    {
        return $this->searchForLabelInFrontMatter()

The expression return $this->searchForLabelInFrontMatter() ?? $this->searchForLabelInConfigs() ?? $this->getMatter('title') ?? $this->title could return the type boolean which is incompatible with the type-hinted return null|string. Consider adding an additional type-check to rule them out.

            ?? $this->searchForLabelInConfigs()
            ?? $this->getMatter('title')
            ?? $this->title;
    }

    protected function makeGroup(): ?string
    {
        if ($this->pageIsInSubdirectory() && $this->canUseSubdirectoryForGroups()) {
            return NumericalPageOrderingHelper::hasNumericalPrefix($this->getSubdirectoryName())
                ? NumericalPageOrderingHelper::splitNumericPrefix($this->getSubdirectoryName())[1]
                : $this->getSubdirectoryName();
        }

        return $this->searchForGroupInFrontMatter();
    }

    protected function makeHidden(): bool
    {
        return $this->isInstanceOf(MarkdownPost::class)
            || $this->searchForHiddenInFrontMatter()
            || $this->searchForHiddenInConfigs()
            || $this->isNonDocumentationPageInHiddenSubdirectory();
    }

    protected function makePriority(): int
    {
        return $this->searchForPriorityInFrontMatter()
            ?? $this->searchForPriorityInConfigs()
            ?? $this->checkFilePrefixForOrder()
            ?? NavigationMenu::LAST;
    }

    private function searchForLabelInFrontMatter(): ?string
    {
        return $this->getMatter('navigation.label')

The expression return $this->getMatter('navigation.label') ?? $this->getMatter('navigation.title') could return the type boolean which is incompatible with the type-hinted return null|string. Consider adding an additional type-check to rule them out.

            ?? $this->getMatter('navigation.title');
    }

    private function searchForGroupInFrontMatter(): ?string
    {
        return $this->getMatter('navigation.group')

The expression return $this->getMatter('navigation.group') ?? $this->getMatter('navigation.category') could return the type boolean which is incompatible with the type-hinted return null|string. Consider adding an additional type-check to rule them out.

            ?? $this->getMatter('navigation.category');
    }

    private function searchForHiddenInFrontMatter(): ?bool
    {
        return $this->getMatter('navigation.hidden')

The expression return $this->getMatter('navigation.hidden') ?? $this->invert($this->getMatter('navigation.visible')) could return the type integer|string which is incompatible with the type-hinted return boolean|null. Consider adding an additional type-check to rule them out.

            ?? $this->invert($this->getMatter('navigation.visible'));

It seems like $this->getMatter('navigation.visible') can also be of type integer and string; however, parameter $value of Hyde\Framework\Factories\NavigationDataFactory::invert() does only seem to accept boolean|null, maybe add an additional type check?

    }

    private function searchForHiddenInConfigs(): ?bool
    {
        return $this->isInstanceOf(DocumentationPage::class)
            ? $this->isPageHiddenInSidebarConfiguration()
            : $this->isPageHiddenInNavigationConfiguration();
    }

    private function isPageHiddenInNavigationConfiguration(): bool
    {
        return in_array($this->routeKey, Config::getArray('hyde.navigation.exclude', ['404']));
    }

    private function isPageHiddenInSidebarConfiguration(): ?bool
    {
        $config = Config::getArray('docs.sidebar.exclude', ['404']);

        return
            // Check if the page is hidden from the sidebar by route key or identifier.
            (in_array($this->routeKey, $config) || in_array($this->identifier, $config))
            // Check if the page is hidden from the main navigation by its route key.
            || $this->isPageHiddenInNavigationConfiguration();
    }

    private function isNonDocumentationPageInHiddenSubdirectory(): bool
    {
        return ! $this->isInstanceOf(DocumentationPage::class)
            && $this->pageIsInSubdirectory()
            && $this->getSubdirectoryConfiguration() === 'hidden'
            && basename($this->identifier) !== 'index';
    }

    private function searchForPriorityInFrontMatter(): ?int
    {
        return $this->getMatter('navigation.priority')

The expression return $this->getMatter('navigation.priority') ?? $this->getMatter('navigation.order') could return the type boolean|string which is incompatible with the type-hinted return integer|null. Consider adding an additional type-check to rule them out.

            ?? $this->getMatter('navigation.order');
    }

    private function searchForLabelInConfigs(): ?string
    {
        return $this->isInstanceOf(DocumentationPage::class)
            ? $this->searchForLabelInSidebarConfig()
            : $this->searchForLabelInNavigationConfig();
    }

    private function searchForLabelInNavigationConfig(): ?string
    {
        /** @var array<string, string> $config */
        $config = Config::getArray('hyde.navigation.labels', [
            'index' => 'Home',
            DocumentationPage::homeRouteName() => 'Docs',
        ]);

        return $config[$this->routeKey] ?? null;
    }

    private function searchForLabelInSidebarConfig(): ?string
    {
        /** @var array<string>|array<string, string> $config */
        $config = Config::getArray('docs.sidebar.labels', [
            DocumentationPage::homeRouteName() => 'Docs',
        ]);

        return $config[$this->routeKey] ?? $config[$this->identifier] ?? null;
    }

    private function searchForPriorityInConfigs(): ?int
    {
        return $this->isInstanceOf(DocumentationPage::class)
            ? $this->searchForPriorityInSidebarConfig()
            : $this->searchForPriorityInNavigationConfig();
    }

    private function searchForPriorityInSidebarConfig(): ?int
    {
        /** @var array<string>|array<string, int> $config */
        $config = Config::getArray('docs.sidebar.order', []);

        return
            // For consistency with the navigation config.
            $this->parseNavigationPriorityConfig($config, 'routeKey')
            // For backwards compatibility, and ease of use, as the route key prefix
            // is redundant due to it being the same for all documentation pages
            ?? $this->parseNavigationPriorityConfig($config, 'identifier');
    }

    private function searchForPriorityInNavigationConfig(): ?int
    {
        /** @var array<string, int>|array<string> $config */
        $config = Config::getArray('hyde.navigation.order', [
            'index' => 0,
            'posts' => 10,
            'docs/index' => 100,
        ]);

        return $this->parseNavigationPriorityConfig($config, 'routeKey');
    }

    /**
     * @param  array<string, int>|array<string>  $config
     * @param  'routeKey'|'identifier'  $pageKeyName

The doc comment 'routeKey'|'identifier' at position 0 could not be parsed: Unknown type name ''routeKey'' at position 0 in 'routeKey'|'identifier'.

     */
    private function parseNavigationPriorityConfig(array $config, string $pageKeyName): ?int
    {
        /** @var string $pageKey */
        $pageKey = $this->{$pageKeyName};

        // Check if the config entry is a flat array or a keyed array.
        if (! array_key_exists($pageKey, $config)) {
            // Adding an offset makes so that pages with a front matter priority, or
            // explicit keyed priority selection that is lower can be shown first.
            // This is all to make it easier to mix ways of adding priorities.

            return $this->offset(
                array_flip($config)[$pageKey] ?? null,
                NavigationMenu::DEFAULT
            );
        }

        return $config[$pageKey] ?? null;
    }

    private function checkFilePrefixForOrder(): ?int
    {
        if (! $this->isInstanceOf(DocumentationPage::class)) {
            return null;
        }

        if (! NumericalPageOrderingHelper::hasNumericalPrefix($this->identifier)) {
            return null;
        }

        return NumericalPageOrderingHelper::splitNumericPrefix($this->identifier)[0];
    }

    private function canUseSubdirectoryForGroups(): bool
    {
        return $this->getSubdirectoryConfiguration() === 'dropdown'
            || $this->isInstanceOf(DocumentationPage::class);
    }

    private function pageIsInSubdirectory(): bool
    {
        return Str::contains($this->identifier, '/');
    }

    private function getSubdirectoryName(): string
    {
        return Str::before($this->identifier, '/');
    }

    protected function getSubdirectoryConfiguration(): string
    {
        return Config::getString('hyde.navigation.subdirectory_display', 'hidden');
    }

    /** @param class-string<\Hyde\Pages\Concerns\HydePage> $class */

The doc comment class-string<\Hyde\Pages\Concerns\HydePage> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<\Hyde\Pages\Concerns\HydePage>.

    protected function isInstanceOf(string $class): bool
    {
        return is_a($this->pageClass, $class, true);
    }

    protected function invert(?bool $value): ?bool
    {
        return $value === null ? null : ! $value;
    }

    protected function offset(?int $value, int $offset): ?int
    {
        return $value === null ? null : $value + $offset;
    }

    protected function getMatter(string $key): string|null|int|bool
    {
        /** @var string|null|int|bool $value */
        $value = $this->matter->get($key);

        return $value;
    }
}