Hyde\Framework\Factories\NavigationDataFactory

Complexity

Total Complexity

27

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	7	1
A	__construct()	0	12	1
A	makeLabel()	0	6	1
A	searchForLabelInConfig()	0	12	2
A	findPriorityInSidebarConfig()	0	11	2
A	isInstanceOf()	0	3	1
A	findPriorityInNavigationConfig()	0	3	2
A	makeGroup()	0	13	4
A	makePriority()	0	9	3
A	makeHidden()	0	19	6
A	getDocumentationPageGroup()	0	8	2
A	getSubdirectoryConfiguration()	0	3	1
A	findGroupFromMatter()	0	5	1

<?php

declare(strict_types=1);

namespace Hyde\Framework\Factories;

use function array_flip;
use function array_key_exists;
use function array_merge;
use function config;
use Hyde\Framework\Concerns\InteractsWithFrontMatter;
use Hyde\Framework\Factories\Concerns\CoreDataObject;
use Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema;
use Hyde\Markdown\Models\FrontMatter;
use Hyde\Pages\DocumentationPage;
use Hyde\Pages\MarkdownPost;
use Illuminate\Support\Str;
use function in_array;
use function is_a;

/**
 * Discover data used for navigation menus and the documentation sidebar.
 */
class NavigationDataFactory extends Concerns\PageDataFactory implements NavigationSchema
{
    use InteractsWithFrontMatter;

    /**
     * The front matter properties supported by this factory.
     *
     * Note that this represents a sub-schema, and is used as part of the page schema.
     */
    public const SCHEMA = NavigationSchema::NAVIGATION_SCHEMA;

    protected const FALLBACK_PRIORITY = 999;
    protected const CONFIG_OFFSET = 500;

    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.

    }

    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->matter('navigation.label')
            ?? $this->searchForLabelInConfig()
            ?? $this->matter('title')
            ?? $this->title;
    }

    protected function makeGroup(): ?string
    {
        if ($this->isInstanceOf(DocumentationPage::class)) {
            return $this->getDocumentationPageGroup();
        }

        if (Str::contains($this->identifier, '/') && $this->getSubdirectoryConfiguration() === 'dropdown') {
            return Str::before($this->identifier, '/');
        }

        // TODO Check in front matter for group?

        return null;
    }

    protected function makeHidden(): ?bool
    {
        if ($this->isInstanceOf(MarkdownPost::class)) {
            return true;
        }

        if ($this->matter('navigation.hidden', false)) {
            return true;
        }

        if (in_array($this->routeKey, config('hyde.navigation.exclude', ['404']))) {
            return true;
        }

        if (Str::contains($this->identifier, '/') && $this->getSubdirectoryConfiguration() === 'hidden') {
            return true;
        }

        return false;
    }

    protected function makePriority(): ?int
    {
        if ($this->matter('navigation.priority') !== null) {
            return $this->matter('navigation.priority');
        }

        return $this->isInstanceOf(DocumentationPage::class)
            ? $this->findPriorityInSidebarConfig(array_flip(config('docs.sidebar_order', []))) ?? self::FALLBACK_PRIORITY
            : $this->findPriorityInNavigationConfig(config('hyde.navigation.order', [])) ?? self::FALLBACK_PRIORITY;
    }

    private function findPriorityInNavigationConfig(array $config): ?int
    {
        return array_key_exists($this->routeKey, $config) ? (int) $config[$this->routeKey] : null;
    }

    private function findPriorityInSidebarConfig(array $config): ?int
    {
        // Sidebars uses a special syntax where the keys are just the page identifiers in a flat array

        // Adding 250 makes so that pages with a front matter priority that is lower can be shown first.
        // It's lower than the fallback of 500 so that the config ones still come first.
        // This is all to make it easier to mix ways of adding priorities.

        return isset($config[$this->identifier])
            ? $config[$this->identifier] + (self::CONFIG_OFFSET)
            : null;
    }

    private function getDocumentationPageGroup(): ?string
    {
        // If the documentation page is in a subdirectory,
        return str_contains($this->identifier, '/')
            // then we can use that as the category name.
            ? Str::before($this->identifier, '/')
            // Otherwise, we look in the front matter.
            : $this->findGroupFromMatter();
    }

    protected function searchForLabelInConfig(): ?string
    {
        $labelConfig = array_merge([
            'index' => 'Home',
            'docs/index' => 'Docs',
        ], config('hyde.navigation.labels', []));

        if (isset($labelConfig[$this->routeKey])) {
            return $labelConfig[$this->routeKey];
        }

        return null;
    }

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

    protected function findGroupFromMatter(): mixed
    {
        return $this->matter('navigation.group')
            ?? $this->matter('navigation.category')
            ?? 'other';
    }

    protected static function getSubdirectoryConfiguration(): string
    {
        return config('hyde.navigation.subdirectories', 'hidden');
    }
}