Spiral\Scaffolder\Config\ScaffolderConfig

Complexity

Total Complexity

26

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Test Coverage

Coverage

86.36%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	headerLines()	0	3	1
A	declarationDirectory()	0	5	2
A	classNamespace()	0	14	3
A	getDeclaration()	0	6	1
A	declarationClass()	0	11	2
A	elementPostfix()	0	3	1
A	declarationOptions()	0	3	1
A	classFilename()	0	10	1
A	baseNamespace()	0	9	2
A	parseName()	0	13	2
A	baseDirectory()	0	3	1
A	joinPathChunks()	0	14	3
A	getOption()	0	13	3
A	classify()	0	5	1
A	className()	0	8	2

<?php

declare(strict_types=1);

namespace Spiral\Scaffolder\Config;

use Doctrine\Inflector\Rules\English\InflectorFactory;
use Spiral\Core\InjectableConfig;
use Spiral\Scaffolder\Exception\ScaffolderException;

/**
 * Configuration for default scaffolder namespaces and other rendering options.
 */
class ScaffolderConfig extends InjectableConfig
{
    public const CONFIG = 'scaffolder';

    protected array $config = [
        'header'       => [],
        'directory'    => '',
        'namespace'    => '',
        'declarations' => [],
        'defaults'     => [
            'declarations' => [],
        ],
    ];

    public function headerLines(): array
    {
        return $this->config['header'];
    }

    /**
     * @deprecated since v3.8.0.
     */
    public function baseDirectory(): string
    {
        return $this->config['directory'];
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function declarationDirectory(string $element): string
    {
        $declaration = $this->getDeclaration($element);

        return !empty($declaration['directory']) ? $declaration['directory'] : $this->config['directory'];
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function className(string $element, string $name): string
    {
        ['name' => $name] = $this->parseName($name);

        $class = $this->classify($name);
        $postfix = $this->elementPostfix($element);

        return \str_ends_with($class, $postfix) ? $class : $class . $postfix;
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function classNamespace(string $element, string $name = ''): string
    {
        $localNamespace = \trim($this->getOption($element, 'namespace', ''), '\\');
        ['namespace' => $namespace] = $this->parseName($name);

        if (!empty($namespace)) {
            $localNamespace .= '\\' . $this->classify($namespace);
        }

        if (empty($this->baseNamespace($element))) {
            return $localNamespace;
        }

        return \trim($this->baseNamespace($element) . '\\' . $localNamespace, '\\');
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param non-empty-string $name
     *
     * @return non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function classFilename(string $element, string $name, ?string $namespace = null): string
    {
        $elementNamespace = $namespace ?? $this->classNamespace($element, $name);
        $elementNamespace = \substr($elementNamespace, \strlen($this->baseNamespace($element)));

        return $this->joinPathChunks([
            $this->declarationDirectory($element),
            \str_replace('\\', '/', $elementNamespace),
            $this->className($element, $name) . '.php',
        ], '/');
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     *
     * @throws ScaffolderException
     */
    public function declarationClass(string $element): string
    {
        $class = $this->getOption($element, 'class');

        if (empty($class)) {
            throw new ScaffolderException(
                \sprintf("Unable to scaffold '%s', no declaration class found", $element)
            );
        }

        return $class;
    }

    /**
     * Declaration options.
     *
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function declarationOptions(string $element): array
    {
        return $this->getOption($element, 'options', []);
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    private function elementPostfix(string $element): string
    {
        return $this->getOption($element, 'postfix', '');
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param non-empty-string $section
     */
    private function getOption(string $element, string $section, mixed $default = null): mixed
    {
        $declaration = $this->getDeclaration($element);

        if ($declaration === []) {
            throw new ScaffolderException(\sprintf("Undefined declaration '%s'.", $element));
        }

        if (\array_key_exists($section, $declaration)) {
            return $declaration[$section];
        }

        return $default;
    }

    /**
     * Split user name into namespace and class name.
     *
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     *
     * @return array{namespace: string, name: non-empty-string}

The doc comment array{namespace: string, name: non-empty-string} at position 8 could not be parsed: Unknown type name 'non-empty-string' at position 8 in array{namespace: string, name: non-empty-string}.

     */
    private function parseName(string $name): array
    {
        $name = \str_replace('/', '\\', $name);

        if (str_contains($name, '\\')) {
            $names = \explode('\\', $name);
            $class = \array_pop($names);

            return ['namespace' => \implode('\\', $names), 'name' => $class];
        }

        //No user namespace
        return ['namespace' => '', 'name' => $name];
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    private function baseNamespace(string $element): string
    {
        $declaration = $this->getDeclaration($element);

        if (\array_key_exists('baseNamespace', $declaration)) {
            return \trim((string) $this->getOption($element, 'baseNamespace', ''), '\\');
        }

        return \trim($this->config['namespace'], '\\');
    }

    private function joinPathChunks(array $chunks, string $joint): string
    {
        $firstChunkIterated = false;
        $joinedPath = '';
        foreach ($chunks as $chunk) {
            if (!$firstChunkIterated) {
                $firstChunkIterated = true;
                $joinedPath = $chunk;
            } else {
                $joinedPath = \rtrim($joinedPath, $joint) . $joint . \ltrim($chunk, $joint);
            }
        }

        return $joinedPath;
    }

    private function classify(string $name): string
    {
        return ( new InflectorFactory() )
            ->build()
            ->classify($name);
    }

    /**
     * @param non-empty-string $element

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    private function getDeclaration(string $element): array
    {
        $default = $this->config['defaults']['declarations'][$element] ?? [];
        $declaration = $this->config['declarations'][$element] ?? [];

        return $declaration + $default;
    }
}