Cycle\Schema\Provider\PhpFileSchemaProvider

Complexity

Total Complexity

22

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Test Coverage

Coverage

87.76%

Importance

Changes	2
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	clear()	0	6	2
A	write()	0	10	2
A	config()	0	7	1
A	isReadable()	0	3	1
A	withConfig()	0	13	3
A	removeFile()	0	13	4
A	__construct()	0	6	2
B	read()	0	21	7

<?php

declare(strict_types=1);

namespace Cycle\Schema\Provider;

use Cycle\Schema\Provider\Exception\ConfigurationException;
use Cycle\Schema\Provider\Exception\SchemaProviderException;
use Cycle\Schema\Renderer\PhpSchemaRenderer;
use Spiral\Files\Files;
use Spiral\Files\FilesInterface;

final class PhpFileSchemaProvider implements SchemaProviderInterface
{
    public const MODE_READ_AND_WRITE = 0;
    public const MODE_WRITE_ONLY = 1;

    private string $file = '';
    private int $mode = self::MODE_READ_AND_WRITE;

    /**
     * @var \Closure(non-empty-string): non-empty-string
     */
    private \Closure $pathResolver;
    private FilesInterface $files;

    /**
     * @param null|callable(non-empty-string): non-empty-string $pathResolver A function that resolves
     *        framework-specific file paths.
     */
    public function __construct(?callable $pathResolver = null, ?FilesInterface $files = null)
    {
        $this->files = $files ?? new Files();
        $this->pathResolver = $pathResolver === null
            ? static fn (string $path): string => $path
            : \Closure::fromCallable($pathResolver);
    }

    /**
     * Create a configuration array for the {@see self::withConfig()} method.
     */
    public static function config(
        string $file,
        int $mode = self::MODE_READ_AND_WRITE,
    ): array {
        return [
            'file' => $file,
            'mode' => $mode,
        ];
    }

    /**
     * @param array{
     *     file: non-empty-string,
     *     mode?: self::MODE_READ_AND_WRITE|self::MODE_WRITE_ONLY,
     * } $config
     */
    public function withConfig(array $config): self
    {
        $new = clone $this;

        // required option
        if ($this->file === '' && !array_key_exists('file', $config)) {
            throw new ConfigurationException('The `file` parameter is required.');
        }
        $new->file = ($this->pathResolver)($config['file']);

        $new->mode = $config['mode'] ?? $this->mode;

        return $new;
    }

    public function read(?SchemaProviderInterface $nextProvider = null): ?array
    {
        if (!$this->isReadable()) {
            if ($nextProvider === null) {
                throw new SchemaProviderException(__CLASS__ . ' can not read schema.');
            }
            $schema = null;
        } else {
            /** @psalm-suppress UnresolvableInclude */
            $schema = !$this->files->isFile($this->file) ? null : (include $this->file);
        }

        if ($schema !== null || $nextProvider === null) {
            return $schema;
        }

        $schema = $nextProvider->read();
        if ($schema !== null) {
            $this->write($schema);
        }
        return $schema;
    }

    public function clear(): bool
    {
        try {
            return $this->removeFile();
        } catch (\Throwable $e) {
            return false;
        }
    }

    private function write(array $schema): bool
    {
        if (\basename($this->file) === '') {
            throw new SchemaProviderException('The `file` parameter must not be empty.');
        }

        $content = (new PhpSchemaRenderer())->render($schema);
        $this->files->write($this->file, $content, 0777, true);

        return true;
    }

    private function removeFile(): bool
    {
        if (!$this->files->exists($this->file)) {
            return true;
        }
        if (!$this->files->isFile($this->file)) {
            throw new SchemaProviderException(\sprintf('`%s` is not a file.', $this->file));
        }
        if (!\is_writable($this->file)) {
            throw new SchemaProviderException(\sprintf('File `%s` is not writeable.', $this->file));
        }

        return $this->files->delete($this->file);
    }

    private function isReadable(): bool
    {
        return $this->mode !== self::MODE_WRITE_ONLY;
    }
}