Hyde\Framework\Factories\FeaturedImageFactory

Complexity

Total Complexity

22

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	makeAltText()	0	3	1
A	normalizeLocalImagePath()	0	8	1
A	isRemote()	0	7	3
A	makeLicenseName()	0	3	1
A	makeSource()	0	21	5
A	makeAuthorName()	0	3	1
A	makeTitleText()	0	3	1
A	getStringMatter()	0	3	2
A	__construct()	0	11	1
A	makeAuthorUrl()	0	3	1
A	make()	0	9	2
A	makeLicenseUrl()	0	3	1
A	makeCopyrightText()	0	3	1
A	toArray()	0	11	1

<?php

declare(strict_types=1);

namespace Hyde\Framework\Factories;

use Hyde\Framework\Features\Blogging\Models\FeaturedImage;
use Hyde\Framework\Features\Blogging\Models\LocalFeaturedImage;
use Hyde\Framework\Features\Blogging\Models\RemoteFeaturedImage;
use Hyde\Hyde;
use Hyde\Markdown\Contracts\FrontMatter\SubSchemas\FeaturedImageSchema;
use Hyde\Markdown\Models\FrontMatter;
use Illuminate\Support\Str;
use function is_string;
use RuntimeException;
use function str_starts_with;

class FeaturedImageFactory extends Concerns\PageDataFactory implements FeaturedImageSchema
{
    final public const SCHEMA = FeaturedImageSchema::FEATURED_IMAGE_SCHEMA;

    protected readonly string $source;
    protected readonly ?string $altText;
    protected readonly ?string $titleText;
    protected readonly ?string $authorName;
    protected readonly ?string $authorUrl;
    protected readonly ?string $copyrightText;
    protected readonly ?string $licenseName;
    protected readonly ?string $licenseUrl;

    public function __construct(
        private readonly FrontMatter $matter,
    ) {
        $this->source = $this->makeSource();

The property source is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->altText = $this->makeAltText();

The property altText is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->titleText = $this->makeTitleText();

The property titleText is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->authorName = $this->makeAuthorName();

The property authorName is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->authorUrl = $this->makeAuthorUrl();

The property authorUrl is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->copyrightText = $this->makeCopyrightText();

The property copyrightText is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->licenseName = $this->makeLicenseName();

The property licenseName is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

        $this->licenseUrl = $this->makeLicenseUrl();

The property licenseUrl is declared read-only in Hyde\Framework\Factories\FeaturedImageFactory.

    }

    /**
     * @return array{source: string, altText: string|null, titleText: string|null, authorName: string|null, authorUrl: string|null, copyrightText: string|null, licenseName: string|null, licenseUrl: string|null}
     */
    public function toArray(): array
    {
        return [

The expression return array('source' => $this->source, 'altText' => $this->altText, 'titleText' => $this->titleText, 'authorName' => $this->authorName, 'authorUrl' => $this->authorUrl, 'copyrightText' => $this->copyrightText, 'licenseName' => $this->licenseName, 'licenseUrl' => $this->licenseUrl) returns an array which contains values of type string which are incompatible with the return type Illuminate\Contracts\Support\TValue mandated by Illuminate\Contracts\Support\Arrayable::toArray().

            'source' => $this->source,
            'altText' => $this->altText,
            'titleText' => $this->titleText,
            'authorName' => $this->authorName,
            'authorUrl' => $this->authorUrl,
            'copyrightText' => $this->copyrightText,
            'licenseName' => $this->licenseName,
            'licenseUrl' => $this->licenseUrl,
        ];
    }

    public static function make(FrontMatter $matter): FeaturedImage
    {
        $data = (new static($matter))->toArray();

        if (self::isRemote($matter)) {
            return new RemoteFeaturedImage(...$data);
        }

        return new LocalFeaturedImage(...$data);
    }

    protected function makeSource(): string
    {
        if (is_string($this->getStringMatter('image'))) {
            if (str_starts_with($this->getStringMatter('image'), 'http')) {

It seems like $this->getStringMatter('image') can also be of type null; however, parameter $haystack of str_starts_with() does only seem to accept string, maybe add an additional type check?

                return $this->getStringMatter('image');

The expression return $this->getStringMatter('image') could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

            }

            return self::normalizeLocalImagePath($this->getStringMatter('image'));

It seems like $this->getStringMatter('image') can also be of type null; however, parameter $path of Hyde\Framework\Factories\FeaturedImageFactory::normalizeLocalImagePath() does only seem to accept string, maybe add an additional type check?

        }

        if ($this->getStringMatter('image.url') !== null) {
            return $this->getStringMatter('image.url');

The expression return $this->getStringMatter('image.url') could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        }

        if ($this->getStringMatter('image.path') !== null) {
            return $this->normalizeLocalImagePath($this->getStringMatter('image.path'));
        }

        // Todo, we might want to add a note about which file caused the error.
        // We could also check for these before calling the factory, and just ignore the image if it's not valid.
        throw new RuntimeException('No featured image source was found');
    }

    protected function makeAltText(): ?string
    {
        return $this->getStringMatter('image.description');
    }

    protected function makeTitleText(): ?string
    {
        return $this->getStringMatter('image.title');
    }

    protected function makeAuthorName(): ?string
    {
        return $this->getStringMatter('image.author');
    }

    protected function makeAuthorUrl(): ?string
    {
        return $this->getStringMatter('image.attributionUrl');
    }

    protected function makeCopyrightText(): ?string
    {
        return $this->getStringMatter('image.copyright');
    }

    protected function makeLicenseName(): ?string
    {
        return $this->getStringMatter('image.license');
    }

    protected function makeLicenseUrl(): ?string
    {
        return $this->getStringMatter('image.licenseUrl');
    }

    protected static function normalizeLocalImagePath(string $path): string
    {
        $path = Hyde::pathToRelative($path);

        $path = Str::after($path, Hyde::getMediaDirectory());
        $path = Str::after($path, Hyde::getMediaOutputDirectory());

        return unslash($path);
    }

    protected static function isRemote(FrontMatter $matter): bool
    {
        if (is_string($matter->get('image')) && str_starts_with($matter->get('image'), 'http')) {
            return true;
        }

        return $matter->get('image.url') !== null;
    }

    protected function getStringMatter(string $key): ?string
    {
        return is_string($this->matter->get($key)) ? $this->matter->get($key) : null;
    }
}