ColumnRenderer::castDefault() - Code Metrics - Inspection of "cs rendering columns" - spiral/components - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — feature/pre-split (60f5c0)

by Anton

created 2016-12-27 20:05 UTC

ColumnRenderer::castDefault() B

↳ Parent: ColumnRenderer

Complexity

Conditions	6
Paths	6

Size

Total Lines	25
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	16
nc	6
nop	1
dl	0
loc	25
rs	8.439
c	0
b	0
f	0

<?php
/**
 * components
 *
 * @author    Wolfy-J
 */
namespace Spiral\ORM\Helpers;

use Spiral\Database\Schemas\Prototypes\AbstractColumn;
use Spiral\Database\Schemas\Prototypes\AbstractTable;
use Spiral\ORM\Exceptions\ColumnRenderException;
use Spiral\ORM\Exceptions\DefinitionException;

/**
 * Implements ability to define column in AbstractSchema based on string representation and default
 * value (if defined).
 */
class ColumnRenderer
{
    /**
     * Render columns in table based on string definition.
     *
     * Example:
     * renderColumns([
     *    'id'     => 'primary',
     *    'time'   => 'datetime, nullable',
     *    'status' => 'enum(active, disabled)'
     * ], [
     *    'status' => 'active',
     *    'time'   => null, //idential as if define column as null
     * ], $table);
     *
     * Attention, new table instance will be returned!
     *
     * @param array         $fields
     * @param array         $defaults
     * @param AbstractTable $table
     *
     * @return AbstractTable
     *
     * @throws ColumnRenderException
     */
    public function renderColumns(
        array $fields,
        array $defaults,
        AbstractTable $table
    ): AbstractTable {
        foreach ($fields as $name => $definition) {
            $column = $table->column($name);

            //Declaring our column
            $this->declareColumn(
                $column,
                $definition,
                array_key_exists($name, $defaults),
                $defaults[$name] ?? null
            );
        }

        return clone $table;
    }

    /**
     * Cast (specify) column schema based on provided column definition and default value.
     * Spiral will force default values (internally) for every NOT NULL column except primary keys!
     *
     * Column definition are compatible with database Migrations and AbstractColumn types.
     *
     * Column definition examples (by default all columns has flag NOT NULL):
     * protected $schema = [
     *      'id'           => 'primary',
     *      'name'         => 'string',                          //Default length is 255 characters.
     *      'email'        => 'string(255), nullable',           //Can be NULL
     *      'status'       => 'enum(active, pending, disabled)', //Enum values, trimmed
     *      'balance'      => 'decimal(10, 2)',
     *      'message'      => 'text, null',                      //Alias for nullable
     *      'time_expired' => 'timestamp'
     * ];
     *
     * Attention, column state will be affected!
     *
     * @see AbstractColumn
     *
     * @param AbstractColumn $column
     * @param string         $definition
     * @param bool           $hasDefault Must be set to true if default value was set by user.
     * @param mixed          $default    Default value declared by record schema.
     *
     * @return mixed
     *
     * @throws DefinitionException
     * @throws \Spiral\Database\Exceptions\SchemaException
     */
    public function declareColumn(
        AbstractColumn $column,
        string $definition,
        bool $hasDefault,
        $default = null
    ) {
        //Expression used to declare column type, easy to read
        $pattern = '/(?P<type>[a-z]+)(?: *\((?P<options>[^\)]+)\))?(?: *, *(?P<nullable>null(?:able)?))?/i';

        if (!preg_match($pattern, $definition, $type)) {
            throw new DefinitionException(
                "Invalid column type definition in '{$this}'.'{$column->getName()}'"
            );
        }

        if (!empty($type['options'])) {
            //Exporting and trimming
            $type['options'] = array_map('trim', explode(',', $type['options']));
        }

        //ORM force EVERY column to NOT NULL state unless different is said
        $column->nullable(false);

        if (!empty($type['nullable'])) {
            //Indication that column is nullable
            $column->nullable(true);
        }

        //Bypassing call to AbstractColumn->__call method (or specialized column method)
        call_user_func_array(
            [$column, $type['type']],
            !empty($type['options']) ? $type['options'] : []
        );

        if (in_array($column->abstractType(), ['primary', 'bigPrimary'])) {
            //No default value can be set of primary keys
            return $column;
        }
        if (!$hasDefault && !$column->isNullable()) {
            //We have to come up with some default value
            return $column->defaultValue($this->castDefault($column));
        }

        if (is_null($default)) {
            //Default value is stated and NULL, clear what to do
            $column->nullable(true);
        }

        return $column->defaultValue($default);
    }

    /**
     * Cast default value based on column type. Required to prevent conflicts when not nullable
     * column added to existed table with data in.
     *
     * @param AbstractColumn $column
     *
     * @return mixed
     */
    public function castDefault(AbstractColumn $column)
    {
        if (in_array($column->abstractType(), ['timestamp', 'datetime', 'time', 'date'])) {
            return 0;
        }

        if ($column->abstractType() == 'enum') {
            //We can use first enum value as default
            return $column->getEnumValues()[0];
        }

        switch ($column->phpType()) {
            case 'int':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                return 0;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'float':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                return 0.0;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'bool':
                return false;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }

        return '';
    }
}

1			<?php
2			/**
3			* components
4			*
5			* @author Wolfy-J
6			*/
7			namespace Spiral\ORM\Helpers;
8
9			use Spiral\Database\Schemas\Prototypes\AbstractColumn;
10			use Spiral\Database\Schemas\Prototypes\AbstractTable;
11			use Spiral\ORM\Exceptions\ColumnRenderException;
12			use Spiral\ORM\Exceptions\DefinitionException;
13
14			/**
15			* Implements ability to define column in AbstractSchema based on string representation and default
16			* value (if defined).
17			*/
18			class ColumnRenderer
19			{
20			/**
21			* Render columns in table based on string definition.
22			*
23			* Example:
24			* renderColumns([
25			* 'id' => 'primary',
26			* 'time' => 'datetime, nullable',
27			* 'status' => 'enum(active, disabled)'
28			* ], [
29			* 'status' => 'active',
30			* 'time' => null, //idential as if define column as null
31			* ], $table);
32			*
33			* Attention, new table instance will be returned!
34			*
35			* @param array $fields
36			* @param array $defaults
37			* @param AbstractTable $table
38			*
39			* @return AbstractTable
40			*
41			* @throws ColumnRenderException
42			*/
43			public function renderColumns(
44			array $fields,
45			array $defaults,
46			AbstractTable $table
47			): AbstractTable {
48			foreach ($fields as $name => $definition) {
49			$column = $table->column($name);
50
51			//Declaring our column
52			$this->declareColumn(
53			$column,
54			$definition,
55			array_key_exists($name, $defaults),
56			$defaults[$name] ?? null
57			);
58			}
59
60			return clone $table;
61			}
62
63			/**
64			* Cast (specify) column schema based on provided column definition and default value.
65			* Spiral will force default values (internally) for every NOT NULL column except primary keys!
66			*
67			* Column definition are compatible with database Migrations and AbstractColumn types.
68			*
69			* Column definition examples (by default all columns has flag NOT NULL):
70			* protected $schema = [
71			* 'id' => 'primary',
72			* 'name' => 'string', //Default length is 255 characters.
73			* 'email' => 'string(255), nullable', //Can be NULL
74			* 'status' => 'enum(active, pending, disabled)', //Enum values, trimmed
75			* 'balance' => 'decimal(10, 2)',
76			* 'message' => 'text, null', //Alias for nullable
77			* 'time_expired' => 'timestamp'
78			* ];
79			*
80			* Attention, column state will be affected!
81			*
82			* @see AbstractColumn
83			*
84			* @param AbstractColumn $column
85			* @param string $definition
86			* @param bool $hasDefault Must be set to true if default value was set by user.
87			* @param mixed $default Default value declared by record schema.
88			*
89			* @return mixed
90			*
91			* @throws DefinitionException
92			* @throws \Spiral\Database\Exceptions\SchemaException
93			*/
94			public function declareColumn(
95			AbstractColumn $column,
96			string $definition,
97			bool $hasDefault,
98			$default = null
99			) {
100			//Expression used to declare column type, easy to read
101			$pattern = '/(?P<type>[a-z]+)(?: \((?P<options>[^\)]+)\))?(?: , *(?P<nullable>null(?:able)?))?/i';
102
103			if (!preg_match($pattern, $definition, $type)) {
104			throw new DefinitionException(
105			"Invalid column type definition in '{$this}'.'{$column->getName()}'"
106			);
107			}
108
109			if (!empty($type['options'])) {
110			//Exporting and trimming
111			$type['options'] = array_map('trim', explode(',', $type['options']));
112			}
113
114			//ORM force EVERY column to NOT NULL state unless different is said
115			$column->nullable(false);
116
117			if (!empty($type['nullable'])) {
118			//Indication that column is nullable
119			$column->nullable(true);
120			}
121
122			//Bypassing call to AbstractColumn->__call method (or specialized column method)
123			call_user_func_array(
124			[$column, $type['type']],
125			!empty($type['options']) ? $type['options'] : []
126			);
127
128			if (in_array($column->abstractType(), ['primary', 'bigPrimary'])) {
129			//No default value can be set of primary keys
130			return $column;
131			}
132			if (!$hasDefault && !$column->isNullable()) {
133			//We have to come up with some default value
134			return $column->defaultValue($this->castDefault($column));
135			}
136
137			if (is_null($default)) {
138			//Default value is stated and NULL, clear what to do
139			$column->nullable(true);
140			}
141
142			return $column->defaultValue($default);
143			}
144
145			/**
146			* Cast default value based on column type. Required to prevent conflicts when not nullable
147			* column added to existed table with data in.
148			*
149			* @param AbstractColumn $column
150			*
151			* @return mixed
152			*/
153			public function castDefault(AbstractColumn $column)
154			{
155			if (in_array($column->abstractType(), ['timestamp', 'datetime', 'time', 'date'])) {
156			return 0;
157			}
158
159			if ($column->abstractType() == 'enum') {
160			//We can use first enum value as default
161			return $column->getEnumValues()[0];
162			}
163
164			switch ($column->phpType()) {
165			case 'int':
			1 ignored issue – show Coding Style introduced 2016-12-27 20:08 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
166			return 0;
167			break;
			0 ignored issues – show Unused Code introduced 2016-12-27 20:08 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
168			case 'float':
			1 ignored issue – show Coding Style introduced 2016-12-27 20:08 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
169			return 0.0;
170			break;
			0 ignored issues – show Unused Code introduced 2016-12-27 20:08 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
171			case 'bool':
172			return false;
173			break;
			0 ignored issues – show Unused Code introduced 2016-12-27 20:08 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
174			}
175
176			return '';
177			}
178			}

spiral / components

Branch — feature/pre-split (60f5c0)

ColumnRenderer::castDefault() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like