Railt\Compiler\Reader\BaseRules

Complexity

Total Complexity

12

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	11	4
A	addDelegate()	0	14	3
A	addFile()	0	4	1
A	all()	0	4	1
A	hasDelegate()	0	4	1
A	getDelegate()	0	4	1
A	getFile()	0	4	1

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\Compiler\Reader;

use Railt\Compiler\Exception\GrammarException;
use Railt\Io\Readable;
use Railt\Parser\Ast\Delegate;
use Railt\Parser\Ast\Rule;
use Railt\Parser\Rule\Production;
use Railt\Parser\Rule\Symbol;
use Railt\Parser\Rule\Terminal;

/**
 * Class BaseRules
 */
abstract class BaseRules implements ProvideRules
{
    /**
     * @var array|Symbol[]
     */
    private $rules = [];

    /**
     * @var array
     */
    private $mappings = [];

    /**
     * @var array
     */
    private $delegates = [];

    /**
     * @var array|Readable[]
     */
    private $files = [];

    /**
     * @param Symbol $symbol
     */
    protected function add(Symbol $symbol): void
    {
        $this->rules[$symbol->getId()] = $symbol;

        $providesName = $symbol instanceof Terminal ||
            ($symbol instanceof Production && $symbol->getName());

The expression $symbol->getName() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

        if ($providesName) {
            $this->mappings[$symbol->getName()] = $symbol->getId();

It seems like you code against a concrete implementation and not the interface Railt\Parser\Rule\Symbol as the method getName() does only exist in the following implementations of said interface: Railt\Parser\Rule\Alternation, Railt\Parser\Rule\BaseProduction, Railt\Parser\Rule\Concatenation, Railt\Parser\Rule\Repetition, Railt\Parser\Rule\Token.

        }
    }

    /**
     * @param string $rule
     * @param string $delegate
     * @throws GrammarException
     */
    protected function addDelegate(string $rule, string $delegate): void
    {
        if (! \class_exists($delegate)) {
            $error = 'Could not found delegate class "%s"';
            throw new GrammarException(\sprintf($error, $delegate));
        }

        if (! \is_subclass_of($delegate, Delegate::class)) {

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if \Railt\Parser\Ast\Delegate::class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

            $error = 'Delegate should be an instance of %s, but %s given';
            throw new GrammarException(\sprintf($error, Delegate::class, $delegate));
        }

        $this->delegates[$rule] = $delegate;
    }

    /**
     * @param string $rule
     * @param Readable $grammar
     */
    protected function addFile(string $rule, Readable $grammar): void
    {
        $this->files[$rule] = $grammar;
    }

    /**
     * @return array
     */
    public function all(): array
    {
        return $this->rules;
    }

    /**
     * @param string $rule
     * @return bool
     */
    public function hasDelegate(string $rule): bool
    {
        return \array_key_exists($rule, $this->delegates);
    }

    /**
     * @param string $rule
     * @return string
     */
    public function getDelegate(string $rule): string
    {
        return $this->delegates[$rule] ?? Rule::class;
    }

    /**
     * @param string $rule
     * @return Readable
     */
    public function getFile(string $rule): Readable
    {
        return $this->files[$rule];
    }
}