ORM\Namer

Complexity

Total Complexity

45

Size/Duplication

Total Lines	326
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
B	setOption()	0	26	6
A	getTableName()	0	32	5
A	getColumnName()	0	18	5
A	getMethodName()	0	8	2
A	getAttributeName()	0	12	3
A	substitute()	0	15	2
B	forceNamingScheme()	0	49	10
A	getValue()	0	23	5
A	arrayToString()	0	16	5

<?php

namespace ORM;

use ORM\Exception\InvalidConfiguration;
use ORM\Exception\InvalidName;
use ReflectionClass;

/**
 * Namer is for naming errors, columns, tables and methods
 *
 * Namer is an artificial word and is more a name giver. We just don't wanted to write so much.
 *
 * @package ORM
 * @author  Thomas Flori <thflori@gmail.com>
 */
class Namer
{
    /** The template to use to calculate the table name.
     * @var string */
    protected $tableNameTemplate = '%short%';

    /** The naming scheme to use for table names.
     * @var string */
    protected $tableNameScheme = 'snake_lower';

    /** @var string[] */
    protected $tableNames = [];

    /** @var string[][] */
    protected $columnNames = [];

    /** The naming scheme to use for column names.
     * @var string */
    protected $columnNameScheme = 'snake_lower';

    /** The naming scheme used for method names.
     * @var string */
    protected $methodNameScheme = 'camelCase';

    /** The naming scheme used for attributes.
     * @var string */
    protected $attributeNameScheme = 'camelCase';

    /**
     * Namer constructor.
     *
     * @param array $options
     */
    public function __construct($options = [])
    {
        foreach ($options as $option => $value) {
            $this->setOption($option, $value);
        }
    }

    /**
     * Set $option to $value
     *
     * @param string $option
     * @param mixed  $value
     * @return static
     */
    public function setOption($option, $value)
    {
        switch ($option) {
            case EntityManager::OPT_TABLE_NAME_TEMPLATE:
                $this->tableNameTemplate = $value;
                break;

            case EntityManager::OPT_NAMING_SCHEME_TABLE:
                $this->tableNameScheme = $value;
                break;

            case EntityManager::OPT_NAMING_SCHEME_COLUMN:
                $this->columnNameScheme = $value;
                break;

            case EntityManager::OPT_NAMING_SCHEME_METHODS:
                $this->methodNameScheme = $value;
                break;

            case EntityManager::OPT_NAMING_SCHEME_ATTRIBUTE:
                $this->attributeNameScheme = $value;
                break;
        }

        return $this;
    }

    /**
     * Get the table name for $reflection
     *
     * @param string $class
     * @param string $template
     * @param string $namingScheme
     * @return string
     * @throws InvalidName
     */
    public function getTableName($class, $template = null, $namingScheme = null)
    {
        if (!isset($this->tableNames[$class])) {
            if ($template === null) {
                $template = $this->tableNameTemplate;
            }

            if ($namingScheme === null) {
                $namingScheme = $this->tableNameScheme;
            }

            $reflection = new ReflectionClass($class);

            $name = $this->substitute(
                $template,
                [
                    'short'     => $reflection->getShortName(),
                    'namespace' => explode('\\', $reflection->getNamespaceName()),
                    'name'      => preg_split('/[\\\\_]+/', $reflection->name),
                ],
                '_'
            );

            if (empty($name)) {
                throw new InvalidName('Table name can not be empty');
            }

            $this->tableNames[$class] = $this->forceNamingScheme($name, $namingScheme);
        }

        return $this->tableNames[$class];
    }

    /**
     * Get the column name with $namingScheme or default naming scheme
     *
     * @param string $class
     * @param string $attribute
     * @param string $prefix
     * @param string $namingScheme
     * @return string
     */
    public function getColumnName($class, $attribute, $prefix = null, $namingScheme = null)
    {
        if (!isset($this->columnNames[$class][$attribute])) {
            if ($namingScheme === null) {
                $namingScheme = $this->columnNameScheme;
            }

            $name = $this->forceNamingScheme($attribute, $namingScheme);

            if ($prefix !== null && strpos($name, $prefix) !== 0) {
                $name = $prefix . $name;
            }

            $this->columnNames[$class][$attribute] = $name;
        }

        return $this->columnNames[$class][$attribute];
    }

    /**
     * Get the method name with $namingScheme or default naming scheme
     *
     * @param string $name
     * @param string $namingScheme
     * @return string
     */
    public function getMethodName($name, $namingScheme = null)
    {
        if ($namingScheme === null) {
            $namingScheme = $this->methodNameScheme;
        }

        return $this->forceNamingScheme($name, $namingScheme);
    }


    /**
     * Get the attribute name with $namingScheme or default naming scheme
     *
     * @param string $name
     * @param string $namingScheme
     * @return string
     */
    public function getAttributeName($name, $prefix = null, $namingScheme = null)
    {
        if ($namingScheme === null) {
            $namingScheme = $this->attributeNameScheme;
        }

        if ($prefix !== null) {
            $name = preg_replace('~^' . preg_quote($prefix) . '~', '', $name);
        }

        return $this->forceNamingScheme($name, $namingScheme);
    }

    /**
     * Substitute a $template with $values
     *
     * $values is a key value pair array. The value should be a string or an array o
     *
     * @param string $template
     * @param array  $values
     * @param string $arrayGlue
     * @return string
     */
    public function substitute($template, $values = [], $arrayGlue = ', ')
    {
        return preg_replace_callback(
            '/%(.*?)%/',
            function ($match) use ($values, $arrayGlue) {
                // escape % with another % ( %% => % )
                if ($match[0] === '%%') {
                    return '%';
                }

                return $this->getValue(trim($match[1]), $values, $arrayGlue);
            },
            $template
        );
    }

    /**
     * Enforce $namingScheme to $name
     *
     * Supported naming schemes: snake_case, snake_lower, SNAKE_UPPER, Snake_Ucfirst, camelCase, StudlyCaps, lower
     * and UPPER.
     *
     * @param string $name The name of the var / column
     * @param string $namingScheme The naming scheme to use
     * @return string
     * @throws InvalidConfiguration
     */
    public function forceNamingScheme($name, $namingScheme)
    {
        $words = explode('_', preg_replace(
            '/([a-z0-9])([A-Z])/',
            '$1_$2',
            preg_replace_callback('/([a-z0-9])?([A-Z]+)([A-Z][a-z])/', function ($match) {
                return ($match[1] ? $match[1] . '_' : '') . $match[2] . '_' . $match[3];
            }, $name)
        ));

        switch ($namingScheme) {
            case 'snake_case':
                $newName = implode('_', $words);
                break;

            case 'snake_lower':
                $newName = implode('_', array_map('strtolower', $words));
                break;

            case 'SNAKE_UPPER':
                $newName = implode('_', array_map('strtoupper', $words));
                break;

            case 'Snake_Ucfirst':
                $newName = implode('_', array_map('ucfirst', $words));
                break;

            case 'camelCase':
                $newName = lcfirst(implode('', array_map('ucfirst', array_map('strtolower', $words))));
                break;

            case 'StudlyCaps':
                $newName = implode('', array_map('ucfirst', array_map('strtolower', $words)));
                break;

            case 'lower':
                $newName = implode('', array_map('strtolower', $words));
                break;

            case 'UPPER':
                $newName = implode('', array_map('strtoupper', $words));
                break;

            default:
                throw new InvalidConfiguration('Naming scheme ' . $namingScheme . ' unknown');
        }

        return $newName;
    }

    /**
     * Get the value for $attribute from $values using $arrayGlue
     *
     * @param string $attribute The key for $values
     * @param array $values
     * @param string $arrayGlue
     * @return string
     * @throws InvalidConfiguration
     */
    protected function getValue($attribute, $values, $arrayGlue)
    {
        $placeholder = '%' . $attribute . '%';
        if (preg_match('/\[(-?\d+\*?)\]$/', $attribute, $arrayAccessor)) {
            $attribute     = substr($attribute, 0, strpos($attribute, '['));
            $arrayAccessor = $arrayAccessor[1];
        } else {
            $arrayAccessor = '';
        }

        // throw when the variable is unknown
        if (!array_key_exists($attribute, $values)) {
            throw new InvalidConfiguration(
                'Template invalid: Placeholder ' . $placeholder . ' is not allowed'
            );
        }

        if (is_scalar($values[$attribute]) || is_null($values[$attribute])) {
            return (string) $values[$attribute];
        }

        return $this->arrayToString($values[$attribute], $arrayAccessor, $arrayGlue);
    }

    /**
     * Convert array to string using indexes defined by $accessor
     *
     * @param array  $array
     * @param string $accessor
     * @param string $glue
     * @return string
     */
    protected function arrayToString(array $array, $accessor, $glue)
    {
        if (isset($accessor[0])) {
            $from = $accessor[0] === '-' ?
                count($array) - abs($accessor) : (int) $accessor;

            if ($from >= count($array)) {
                return '';
            }

            $array = substr($accessor, -1) === '*' ?
                array_slice($array, $from) : [ $array[$from] ];
        }

        return implode($glue, $array);
    }
}