UnicornFail\Emoji\Dataset

Complexity

Total Complexity

14

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetGet()	0	11	2
A	filter()	0	3	1
A	indexBy()	0	7	2
A	unarchive()	0	25	6
A	__construct()	0	4	1
A	archive()	0	9	2

<?php

declare(strict_types=1);

namespace UnicornFail\Emoji;

use UnicornFail\Emoji\Exception\FileNotFoundException;
use UnicornFail\Emoji\Exception\MalformedArchiveException;
use UnicornFail\Emoji\Exception\UnarchiveException;
use UnicornFail\Emoji\Util\ImmutableArrayIterator;
use UnicornFail\Emoji\Util\Normalize;

/**
 * @method Emoji[] getArrayCopy()
 */
final class Dataset extends ImmutableArrayIterator
{
    public const DIRECTORY = __DIR__ . '/../datasets';

    /** @var string */
    private $index;

    /** @var Dataset[] */
    private $indices = [];

    /**
     * @param mixed $emojis
     */
    public function __construct($emojis = [], string $index = 'hexcode')
    {
        $this->index = $index;
        parent::__construct(Normalize::dataset($emojis, $index), \ArrayIterator::ARRAY_AS_PROPS | \ArrayIterator::STD_PROP_LIST);
    }

    public static function unarchive(string $filename): self
    {
        if (! \file_exists($filename)) {
            throw new FileNotFoundException($filename);
        }

        if (
            ! ($contents = \file_get_contents($filename)) ||
            ! ($decoded = \gzdecode($contents))
        ) {
            throw new UnarchiveException($filename);
        }

        try {
            /** @var ?Dataset $dataset */
            $dataset = \unserialize((string) $decoded);
        } catch (\Throwable $throwable) {
            throw new MalformedArchiveException($filename, $throwable);
        }

        if (! $dataset instanceof Dataset) {
            throw new MalformedArchiveException($filename);
        }

        return $dataset;
    }

    /**
     * @param string[] $indices
     *
     * @return false|string
     */
    public function archive(array $indices = Parser::INDICES)
    {
        foreach ($indices as $index) {
            $this->indexBy($index);
        }

        $serialize = \serialize($this);

        return \gzencode($serialize, 9);
    }

    /**
     * @param callable(Emoji):bool $callback
     */
    public function filter(callable $callback): Dataset
    {
        return new self(new \CallbackFilterIterator($this, $callback));
    }

    public function indexBy(string $index = 'hexcode'): Dataset
    {
        if (! isset($this->indices[$index])) {
            $this->indices[$index] = new self($this, $index);
        }

        return $this->indices[$index];
    }

    /**
     * @param string $key
     */
    public function offsetGet($key): ?Emoji // phpcs:ignore
    {
        // Normalize shortcodes to match index.
        if (\strpos($this->index, 'shortcode') !== false) {
            $key = \current(Normalize::shortcodes($key));
        }

        /** @var ?Emoji $emoji */
        $emoji = parent::offsetGet($key);

        return $emoji;
    }
}