Features::hasThemeToggleButtons() - Code Metrics - Inspection of "Merge pull request #1697 from hydephp/add-automati..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 7d3c20...ef46df )

by Caen
created 2024-04-29 11:08 UTC
Features::hasThemeToggleButtons() A

↳ Parent: Features
Complexity

Conditions	2
Paths	2
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	1
nc	2
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace Hyde\Facades;

use Hyde\Hyde;
use Hyde\Enums\Feature;
use Hyde\Pages\MarkdownPost;
use Hyde\Pages\DocumentationPage;
use JetBrains\PhpStorm\Deprecated;
use Hyde\Support\Concerns\Serializable;
use Hyde\Support\Contracts\SerializableContract;
use Hyde\Framework\Concerns\Internal\MockableFeatures;
use Illuminate\Support\Str;

use function get_class_methods;
use function extension_loaded;
use function str_starts_with;
use function in_array;
use function collect;
use function substr;
use function count;
use function app;

/**
 * Allows features to be enabled and disabled in a simple object-oriented manner.
 *
 * @internal Until this class is split into a service/manager class, it should not be used outside of Hyde as the API is subject to change.
 *
 * @todo Split facade logic to service/manager class. (Initial and mock data could be set with boot/set methods)
 * Based entirely on Laravel Jetstream (License MIT)
 *
 * @see https://jetstream.laravel.com/
 */
class Features implements SerializableContract
{
    use Serializable;
    use MockableFeatures;

    /**
     * Determine if the given specified is enabled.
     */
    public static function enabled(Feature $feature): bool
    {
        return static::resolveMockedInstance($feature->name) ?? in_array(

            $feature, Config::getArray('hyde.features', static::getDefaultOptions())
        );
    }

    // ================================================
    // Determine if a given feature is enabled.
    // ================================================

    public static function hasHtmlPages(): bool
    {
        return static::enabled(Feature::HtmlPages);
    }

    public static function hasBladePages(): bool
    {
        return static::enabled(Feature::BladePages);
    }

    public static function hasMarkdownPages(): bool
    {
        return static::enabled(Feature::MarkdownPages);
    }

    public static function hasMarkdownPosts(): bool
    {
        return static::enabled(Feature::MarkdownPosts);
    }

    public static function hasDocumentationPages(): bool
    {
        return static::enabled(Feature::DocumentationPages);
    }

    public static function hasDocumentationSearch(): bool
    {
        return static::enabled(Feature::DocumentationSearch)
            && static::hasDocumentationPages()
            && count(DocumentationPage::files()) > 0;
    }

    public static function hasDarkmode(): bool
    {
        return static::enabled(Feature::Darkmode);
    }

    public static function hasThemeToggleButtons(): bool
    {
        return static::hasDarkmode() && Config::getBool('hyde.theme_toggle_buttons', true);
    }

    /**
     * Torchlight is by default enabled automatically when an API token
     * is set in the .env file but is disabled when running tests.
     */
    public static function hasTorchlight(): bool
    {
        return static::enabled(Feature::Torchlight)
            && (Config::getNullableString('torchlight.token') !== null)
            && (app('env') !== 'testing');
    }

    // =================================================
    // Configure features to be used in the config file.
    // =================================================

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::HtmlPages` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::HtmlPages Enum case', replacement: 'Feature::HtmlPages', since: '1.6.0')]
    public static function htmlPages(): Feature
    {
        return Feature::HtmlPages;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::BladePages` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::BladePages Enum case', replacement: 'Feature::BladePages', since: '1.6.0')]
    public static function bladePages(): Feature
    {
        return Feature::BladePages;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::MarkdownPages` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::MarkdownPages Enum case', replacement: 'Feature::MarkdownPages', since: '1.6.0')]
    public static function markdownPages(): Feature
    {
        return Feature::MarkdownPages;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::MarkdownPosts` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::MarkdownPosts Enum case', replacement: 'Feature::MarkdownPosts', since: '1.6.0')]
    public static function markdownPosts(): Feature
    {
        return Feature::MarkdownPosts;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::DocumentationPages` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::DocumentationPages Enum case', replacement: 'Feature::DocumentationPages', since: '1.6.0')]
    public static function documentationPages(): Feature
    {
        return Feature::DocumentationPages;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::DocumentationSearch` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::DocumentationSearch Enum case', replacement: 'Feature::DocumentationSearch', since: '1.6.0')]
    public static function documentationSearch(): Feature
    {
        return Feature::DocumentationSearch;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::Darkmode` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::Darkmode Enum case', replacement: 'Feature::Darkmode', since: '1.6.0')]
    public static function darkmode(): Feature
    {
        return Feature::Darkmode;
    }

    /**
     * @codeCoverageIgnore Deprecated method.
     *
     * @deprecated This method will be removed in v2.0. Please use `Feature::Torchlight` instead.
     */
    #[Deprecated(reason: 'Replaced by the \Hyde\Enums\Feature::Torchlight Enum case', replacement: 'Feature::Torchlight', since: '1.6.0')]
    public static function torchlight(): Feature
    {
        return Feature::Torchlight;
    }

    // ====================================================
    // Dynamic features that in addition to being enabled
    // in the config file, require preconditions to be met.
    // ====================================================

    /** Can a sitemap be generated? */
    public static function sitemap(): bool
    {
        return static::resolveMockedInstance('sitemap') ?? Hyde::hasSiteUrl()
            && Config::getBool('hyde.generate_sitemap', true)
            && extension_loaded('simplexml');
    }

    /** Can an RSS feed be generated? */
    public static function rss(): bool
    {
        return static::resolveMockedInstance('rss') ?? Hyde::hasSiteUrl()
            && static::hasMarkdownPosts()
            && Config::getBool('hyde.rss.enabled', true)
            && extension_loaded('simplexml')
            && count(MarkdownPost::files()) > 0;
    }

    /**
     * Get an array representation of the features and their status.
     *
     * @return array<string, bool>
     *
     * @example ['html-pages' => true, 'markdown-pages' => false, ...]
     */
    public function toArray(): array
    {
        return collect(get_class_methods(static::class))
        return collect(/** @scrutinizer ignore-type */ get_class_methods(static::class))
            ->filter(fn (string $method): bool => str_starts_with($method, 'has'))
            ->mapWithKeys(fn (string $method): array => [
                Str::kebab(substr($method, 3)) => static::{$method}(),
            ])->toArray();
    }

    protected static function getDefaultOptions(): array
    {
        return [
            // Page Modules
            Feature::HtmlPages,
            Feature::MarkdownPosts,
            Feature::BladePages,
            Feature::MarkdownPages,
            Feature::DocumentationPages,

            // Frontend Features
            Feature::Darkmode,
            Feature::DocumentationSearch,

            // Integrations
            Feature::Torchlight,
        ];
    }
}

hydephp / develop

Push — master ( 7d3c20...ef46df )

Features::hasThemeToggleButtons() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
