StringField::makeField() - Code Metrics - Inspection of "Feature/collation" - kitloong/laravel-migrations-generator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 4.x (#41)

by Kit Loong

created 2021-07-05 15:17 UTC

StringField::makeField() C

↳ Parent: StringField

Complexity

Conditions	15
Paths	120

Size

Total Lines	49
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	240

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	15
eloc	30
c	2
b	0
f	0
nc	120
nop	3
dl	0
loc	49
ccs	0
cts	0
cp	0
crap	240
rs	5.75

How to fix Complexity

<?php
/**
 * Created by PhpStorm.
 * User: liow.kitloong
 * Date: 2020/03/29
 */

namespace KitLoong\MigrationsGenerator\Generators;

use Doctrine\DBAL\Schema\Column;
use Illuminate\Database\Schema\Builder;
use KitLoong\MigrationsGenerator\Generators\Modifier\CharsetModifier;
use KitLoong\MigrationsGenerator\Generators\Modifier\CollationModifier;
use KitLoong\MigrationsGenerator\MigrationMethod\ColumnName;
use KitLoong\MigrationsGenerator\MigrationMethod\ColumnType;
use KitLoong\MigrationsGenerator\MigrationsGeneratorSetting;
use KitLoong\MigrationsGenerator\Repositories\PgSQLRepository;
use KitLoong\MigrationsGenerator\Repositories\SQLSrvRepository;
use KitLoong\MigrationsGenerator\Support\Regex;

class StringField
{
    const SQLSRV_TEXT_TYPE = 'nvarchar';
    const SQLSRV_TEXT_LENGTH = -1;

    private $collationModifier;
    private $charsetModifier;
    private $pgSQLRepository;
    private $sqlSrvRepository;
    private $regex;

    public function __construct(
        CollationModifier $collationModifier,
        CharsetModifier $charsetModifier,
        PgSQLRepository $pgSQLRepository,
        SQLSrvRepository $sqlSrvRepository,
        Regex $regex
    ) {
        $this->collationModifier = $collationModifier;
        $this->charsetModifier = $charsetModifier;
        $this->pgSQLRepository = $pgSQLRepository;
        $this->sqlSrvRepository = $sqlSrvRepository;
        $this->regex = $regex;
    }

    public function makeField(string $tableName, array $field, Column $column): array
    {
        switch (app(MigrationsGeneratorSetting::class)->getPlatform()) {
            // It could be pgsql enum
            case Platform::POSTGRESQL:
                if (($pgSQLEnum = $this->getPgSQLEnumValue($tableName, $column->getName())) !== '') {
                    $field['type'] = ColumnType::ENUM;
                    $field['args'][] = $pgSQLEnum;
                }
                break;
            // It could be sqlsrv text
            case Platform::SQLSERVER:
                $colDef = $this->sqlSrvRepository->getColumnDefinition($tableName, $column->getName());
                if ($colDef->getType() === self::SQLSRV_TEXT_TYPE &&
                    $colDef->getLength() === self::SQLSRV_TEXT_LENGTH) {
                    $field['type'] = ColumnType::TEXT;
                }
                break;
            default:
        }

        // Continue if type is `string`
        if ($field['type'] === ColumnType::STRING) {
            if ($field['field'] === ColumnName::REMEMBER_TOKEN && $column->getLength() === 100 && !$column->getFixed()) {
                $field['type'] = ColumnType::REMEMBER_TOKEN;
                $field['field'] = null;
                $field['args'] = [];
            } else {
                if ($column->getFixed()) {
                    $field['type'] = ColumnType::CHAR;
                }

                if ($column->getLength() && $column->getLength() !== Builder::$defaultStringLength) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                    $field['args'][] = $column->getLength();
                }
            }
        }

        $charset = $this->charsetModifier->generate($tableName, $column);
        if ($charset !== '') {
            $field['decorators'][] = $charset;
        }

        $collation = $this->collationModifier->generate($tableName, $column);
        if ($collation !== '') {
            $field['decorators'][] = $collation;
        }

        return $field;
    }

    private function getPgSQLEnumValue(string $tableName, string $column): string
    {
        $definition = ($this->pgSQLRepository->getCheckConstraintDefinition($tableName, $column));
        if (!empty($definition)) {
            $enumValues = $this->regex->getTextBetweenAll($definition, "'", "'::");
            if (!empty($enumValues)) {
                return "['".implode("', '", $enumValues)."']";
            }
        }
        return '';
    }
}


1		<?php
2		/**
3		* Created by PhpStorm.
4		* User: liow.kitloong
5		* Date: 2020/03/29
6		*/
7
8		namespace KitLoong\MigrationsGenerator\Generators;
9
10		use Doctrine\DBAL\Schema\Column;
11		use Illuminate\Database\Schema\Builder;
12		use KitLoong\MigrationsGenerator\Generators\Modifier\CharsetModifier;
13		use KitLoong\MigrationsGenerator\Generators\Modifier\CollationModifier;
14		use KitLoong\MigrationsGenerator\MigrationMethod\ColumnName;
15		use KitLoong\MigrationsGenerator\MigrationMethod\ColumnType;
16		use KitLoong\MigrationsGenerator\MigrationsGeneratorSetting;
17	12	use KitLoong\MigrationsGenerator\Repositories\PgSQLRepository;
18		use KitLoong\MigrationsGenerator\Repositories\SQLSrvRepository;
19	12	use KitLoong\MigrationsGenerator\Support\Regex;
20	3
21	3	class StringField
22	3	{
23		const SQLSRV_TEXT_TYPE = 'nvarchar';
24	3	const SQLSRV_TEXT_LENGTH = -1;
25
26		private $collationModifier;
27	9	private $charsetModifier;
28	3	private $pgSQLRepository;
29		private $sqlSrvRepository;
30		private $regex;
31	9
32	6	public function __construct(
33		CollationModifier $collationModifier,
34		CharsetModifier $charsetModifier,
35	9	PgSQLRepository $pgSQLRepository,
36		SQLSrvRepository $sqlSrvRepository,
37		Regex $regex
38		) {
39		$this->collationModifier = $collationModifier;
40		$this->charsetModifier = $charsetModifier;
41		$this->pgSQLRepository = $pgSQLRepository;
42		$this->sqlSrvRepository = $sqlSrvRepository;
43		$this->regex = $regex;
44		}
45
46		public function makeField(string $tableName, array $field, Column $column): array
47		{
48		switch (app(MigrationsGeneratorSetting::class)->getPlatform()) {
49		// It could be pgsql enum
50		case Platform::POSTGRESQL:
51		if (($pgSQLEnum = $this->getPgSQLEnumValue($tableName, $column->getName())) !== '') {
52		$field['type'] = ColumnType::ENUM;
53		$field['args'][] = $pgSQLEnum;
54		}
55		break;
56		// It could be sqlsrv text
57		case Platform::SQLSERVER:
58		$colDef = $this->sqlSrvRepository->getColumnDefinition($tableName, $column->getName());
59		if ($colDef->getType() === self::SQLSRV_TEXT_TYPE &&
60		$colDef->getLength() === self::SQLSRV_TEXT_LENGTH) {
61		$field['type'] = ColumnType::TEXT;
62		}
63		break;
64		default:
65		}
66
67		// Continue if type is `string`
68		if ($field['type'] === ColumnType::STRING) {
69		if ($field['field'] === ColumnName::REMEMBER_TOKEN && $column->getLength() === 100 && !$column->getFixed()) {
70		$field['type'] = ColumnType::REMEMBER_TOKEN;
71		$field['field'] = null;
72		$field['args'] = [];
73		} else {
74		if ($column->getFixed()) {
75		$field['type'] = ColumnType::CHAR;
76		}
77
78		if ($column->getLength() && $column->getLength() !== Builder::$defaultStringLength) {
		0 ignored issues – show Bug Best Practice introduced 2020-04-08 15:12 UTC by Report Bug Copy Issue Report The expression `$column->getLength()` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
79		$field['args'][] = $column->getLength();
80		}
81		}
82		}
83
84		$charset = $this->charsetModifier->generate($tableName, $column);
85		if ($charset !== '') {
86		$field['decorators'][] = $charset;
87		}
88
89		$collation = $this->collationModifier->generate($tableName, $column);
90		if ($collation !== '') {
91		$field['decorators'][] = $collation;
92		}
93
94		return $field;
95		}
96
97		private function getPgSQLEnumValue(string $tableName, string $column): string
98		{
99		$definition = ($this->pgSQLRepository->getCheckConstraintDefinition($tableName, $column));
100		if (!empty($definition)) {
101		$enumValues = $this->regex->getTextBetweenAll($definition, "'", "'::");
102		if (!empty($enumValues)) {
103		return "['".implode("', '", $enumValues)."']";
104		}
105		}
106		return '';
107		}
108		}
109

kitloong / laravel-migrations-generator

Pull Request — 4.x (#41)

StringField::makeField() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like