Modelarium\GeneratorNameTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	188
Duplicated Lines	0 %

Test Coverage

Coverage

90.74%

Importance

Changes	2
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	templateStub()	0	4	1
A	toTableName()	0	3	1
A	splitClassName()	0	7	1
A	getStudlyName()	0	3	1
A	getLowerName()	0	3	1
A	getInflector()	0	7	2
A	templateFile()	0	9	1
A	setBaseName()	0	7	1
A	getBasePath()	0	7	2
A	compileMustacheFromFile()	0	16	2
A	getBaseName()	0	3	1
A	getTableName()	0	3	1
A	getLowerNamePlural()	0	3	1

<?php declare(strict_types=1);

namespace Modelarium;

use Doctrine\Inflector\InflectorFactory;
use Illuminate\Support\Str;
use LightnCandy\LightnCandy;
use Modelarium\Exception\Exception;
use function Safe\date;

trait GeneratorNameTrait
{
    /**
     * @var string
     */
    protected $baseName = '';

    /**
     * @var string
     */
    protected $studlyName = '';

    /**
     * @var string
     */
    protected $lowerName = '';

    /**
     * @var string
     */
    protected $lowerNamePlural = '';

    /**
     * @var string
     */
    protected $tableName = '';

    public function getInflector(): \Doctrine\Inflector\Inflector
    {
        static $inflector = null;
        if (!$inflector) {
            $inflector = InflectorFactory::create()->build();
        }
        return $inflector;
    }

    protected function setBaseName(string $name): void
    {
        $this->baseName = $name;
        $this->studlyName = Str::studly($this->baseName);
        $this->lowerName = mb_strtolower($this->baseName);
        $this->lowerNamePlural = $this->getInflector()->pluralize($this->lowerName);
        $this->tableName = self::toTableName($this->baseName);
    }

    /**
     * Generates the expected laravel table name
     *
     * @param string $name
     * @return string
     */
    public static function toTableName(string $name): string
    {
        return Str::snake(Str::pluralStudly($name));
    }

    /**
     * Splits a fully qualified class name into its namespace, class name and relative path
     *
     * @param string $fullclass
     * @return array
     */
    public static function splitClassName(string $fullclass): array
    {
        $classTokens = explode('\\', $fullclass);
        $className = array_pop($classTokens);
        $classNamespace = implode('\\', $classTokens);
        $relativePath = implode('/', $classTokens);
        return [$classNamespace, $className, $relativePath];
    }

    /**
     * Returns the base path (where composer.json is located)
     *
     * @param string $file The filename
     * @return string
     */
    public static function getBasePath(string $file = null): string
    {
        $basepath = dirname(\Composer\Factory::getComposerFile());
        if ($file) {
            $basepath .= '/' . $file;
        }
        return $basepath;
    }

    /**
     * Get the value of name
     *
     * @return  string
     */
    public function getBaseName()
    {
        return $this->baseName;
    }

    /**
     * Get the value of studlyName
     *
     * @return  string
     */
    public function getStudlyName()
    {
        return $this->studlyName;
    }

    /**
     *
     * @param string $path
     * @return callable
     */
    protected function compileMustacheFromFile(string $path)
    {
        $template = \Safe\file_get_contents($path);
        $phpStr = LightnCandy::compile(
            $template,
            [

array('flags' => LightnCandy\LightnCandy::FLAG_ERROR_EXCEPTION, 'delimiters' => array('{|', '|}')) of type array<string,array<integer,string>|integer> is incompatible with the type array<string,array|integer|string> expected by parameter $options of LightnCandy\LightnCandy::compile().

                'flags' => LightnCandy::FLAG_ERROR_EXCEPTION,
                'delimiters' => array('{|', '|}')
            ]
        );
        if (!$phpStr) {
            throw new Exception('Invalid template');
        }
        /** @var callable $renderer */
        $renderer = LightnCandy::prepare($phpStr);

The function LightnCandy\LightnCandy::prepare() has been deprecated.

        return $renderer;
    }

    /**
     * Replaces common strings from the stubs
     *
     * @param string $path The string data to apply replaces
     * @param array $context
     * @return string
     */
    public function templateFile(string $path, array $context = [])
    {
        $renderer = $this->compileMustacheFromFile($path);
        $context['StudlyName'] = $context['studlyName'] = $this->studlyName;
        $context['lowerName'] = $this->lowerName;
        $context['lowerNamePlural'] = $this->lowerNamePlural;
        $context['date'] = date("c");

        return $renderer($context);
    }

    /**
     * Stubs from a mustache file. Convenience wrapper for templateFile().
     *
     * @param string $stubName
     * @param array $context
     * @return string
     */
    public function templateStub(string $stubName, array $context = []): string
    {
        $stub = $this->stubDir . "/$stubName.mustache.php";
        return $this->templateFile($stub, $context);
    }

    /**
     * Get the value of lowerName
     *
     * @return  string
     */
    public function getLowerName(): string
    {
        return $this->lowerName;
    }

    /**
     * Get the value of lowerName
     *
     * @return  string
     */
    public function getTableName(): string
    {
        return $this->tableName;
    }

    /**
     * Get the value of lowerNamePlural
     *
     * @return  string
     */
    public function getLowerNamePlural(): string
    {
        return $this->lowerNamePlural;
    }
}