Cerbero\JsonParser\Sources\Source

Complexity

Total Complexity

5

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

77.78%

Importance

Changes	6
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	size()	0	8	2
A	__construct()	0	3	2
A	config()	0	3	1

<?php

namespace Cerbero\JsonParser\Sources;

use Cerbero\JsonParser\ValueObjects\Config;
use IteratorAggregate;
use Traversable;

/**
 * The JSON source.
 *
 * @implements IteratorAggregate<int, string>
 */
abstract class Source implements IteratorAggregate
{
    /**
     * The configuration.
     *
     * @var Config
     */
    protected Config $config;

    /**
     * The cached size of the JSON source.
     *
     * @var int|null
     */
    protected ?int $size;

    /**
     * Whether the JSON size has already been calculated.
     * Avoid re-calculations when the size is NULL (not computable).
     *
     * @var bool
     */
    protected bool $sizeWasSet = false;

    /**
     * Retrieve the JSON fragments
     *
     * @return Traversable<int, string>
     */
    abstract public function getIterator(): Traversable;

    /**
     * Determine whether the JSON source can be handled
     *
     * @return bool
     */
    abstract public function matches(): bool;

    /**
     * Retrieve the calculated size of the JSON source
     *
     * @return int|null
     */
    abstract protected function calculateSize(): ?int;

    /**
     * Enforce the factory method to instantiate the class.
     *
     * @param mixed $source
     * @param Config|null $config
     */
    final public function __construct(protected mixed $source, Config $config = null)
    {
        $this->config = $config ?: new Config();
    }

    /**
     * Retrieve the underlying configuration
     *
     * @return Config
     */
    public function config(): Config
    {
        return $this->config;
    }

    /**
     * Retrieve the size of the JSON source and cache it
     *
     * @return int|null
     */
    public function size(): ?int
    {
        if (!$this->sizeWasSet) {
            $this->size = $this->calculateSize();
            $this->sizeWasSet = true;
        }

        return $this->size;
    }
}