TypesDumper::getTypeCode() - Code Metrics - Inspection of "Support default value for generated Doctrine types" - Elao/PhpEnums - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#132)

by Mathias

created 2021-06-02 07:50 UTC

TypesDumper::getTypeCode() B

↳ Parent: TypesDumper

Complexity

Conditions	7
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	67
rs	7.7866
c	0
b	0
f	0
cc	7
nc	7
nop	5

How to fix Long Method

<?php

/*
 * This file is part of the "elao/enum" package.
 *
 * Copyright (C) Elao
 *
 * @author Elao <[email protected]>
 */

namespace Elao\Enum\Bridge\Doctrine\DBAL\Types;

use Elao\Enum\Exception\LogicException;

/**
 * @internal
 */
class TypesDumper
{
    public const TYPE_INT = 'int';
    public const TYPE_STRING = 'string';
    public const TYPE_ENUM = 'enum';
    public const TYPE_JSON_COLLECTION = 'json_collection';
    public const TYPE_CSV_COLLECTION = 'csv_collection';
    public const TYPES = [
        self::TYPE_INT,
        self::TYPE_STRING,
        self::TYPE_ENUM,
        self::TYPE_JSON_COLLECTION,
        self::TYPE_CSV_COLLECTION,
    ];

    public const TYPES_SUFFIXES = [
        self::TYPE_INT => 'Type',
        self::TYPE_STRING => 'Type',
        self::TYPE_ENUM => 'Type',
        self::TYPE_JSON_COLLECTION => 'JsonCollectionType',
        self::TYPE_CSV_COLLECTION => 'CsvCollectionType',
    ];

    public const MARKER = 'ELAO_ENUM_DT';

    public function dumpToFile(string $file, array $types)
    {
        file_put_contents($file, $this->dump($types));
    }

    private function dump(array $types): string
    {
        $namespaces = [];
        foreach ($types as [$enumClass, $type, $name, $default]) {
            $fqcn = self::getTypeClassname($enumClass, $type);

            $classname = basename(str_replace('\\', '/', $fqcn));
            $ns = substr($fqcn, 0, -\strlen($classname) - 1);

            if (!isset($namespaces[$ns])) {
                $namespaces[$ns] = '';
            }

            $namespaces[$ns] .= $this->getTypeCode(
                $classname,
                $enumClass,
                $type,
                $name,

                $default

            );
        }

        $code = "<?php\n";
        foreach ($namespaces as $namespace => $typeCode) {
            $code .= <<<PHP

namespace $namespace {
$typeCode
}

PHP;
        }

        return $code;
    }

    private function getTypeCode(
        string $classname,
        string $enumClass,
        string $type,
        string $name,
        $defaultOnNull
    ): string {
        $code = <<<PHP
            public const NAME = '$name';

            protected function getEnumClass(): string
            {
                return \\{$enumClass}::class;
            }

            public function getName(): string
            {
                return static::NAME;
            }
PHP;
        switch ($type) {
            case self::TYPE_INT:
                $baseClass = AbstractIntegerEnumType::class;
                break;
            case self::TYPE_STRING:
                $baseClass = AbstractEnumType::class;

                if ($defaultOnNull !== null) {
                    $defaultOnNullCode = $this->valueAsCode($defaultOnNull);
                    $code .= <<<PHP

            protected function onNullFromDatabase()
            {
                return \\{$enumClass}::get({$defaultOnNullCode});
            }

            protected function onNullFromPhp()
            {
                return {$defaultOnNullCode};
            }
PHP;
                }
                break;
            case self::TYPE_ENUM:
                $baseClass = AbstractEnumSQLDeclarationType::class;
                break;
            case self::TYPE_JSON_COLLECTION:
                $baseClass = AbstractJsonCollectionEnumType::class;
                break;
            case self::TYPE_CSV_COLLECTION:
                $baseClass = AbstractCsvCollectionEnumType::class;
                break;
            default:
                throw new LogicException(sprintf('Unexpected type "%s"', $type));
        }

        return <<<PHP

    if (!\class_exists($classname::class)) {
        class $classname extends \\{$baseClass}
        {
$code
        }
    }

PHP;
    }

    private function valueAsCode($value): string
    {
        if (is_string($value)) {
            if (strpos($value, '::') !== false) { // Constant name
                return sprintf('\\%s', ltrim($value, '\\'));
            }

            return sprintf('\'%s\'', $value); // plain string
        }

        if (is_bool($value)) {
            return $value ? 'true': 'false';
        }

        return (string)$value;
    }

    public static function getTypeClassname(string $class, string $type): string
    {
        $suffix = self::TYPES_SUFFIXES[$type];

        return self::MARKER . "\\{$class}{$suffix}";
    }
}


1			<?php
2
3			/*
4			* This file is part of the "elao/enum" package.
5			*
6			* Copyright (C) Elao
7			*
8			* @author Elao <[email protected]>
9			*/
10
11			namespace Elao\Enum\Bridge\Doctrine\DBAL\Types;
12
13			use Elao\Enum\Exception\LogicException;
14
15			/**
16			* @internal
17			*/
18			class TypesDumper
19			{
20			public const TYPE_INT = 'int';
21			public const TYPE_STRING = 'string';
22			public const TYPE_ENUM = 'enum';
23			public const TYPE_JSON_COLLECTION = 'json_collection';
24			public const TYPE_CSV_COLLECTION = 'csv_collection';
25			public const TYPES = [
26			self::TYPE_INT,
27			self::TYPE_STRING,
28			self::TYPE_ENUM,
29			self::TYPE_JSON_COLLECTION,
30			self::TYPE_CSV_COLLECTION,
31			];
32
33			public const TYPES_SUFFIXES = [
34			self::TYPE_INT => 'Type',
35			self::TYPE_STRING => 'Type',
36			self::TYPE_ENUM => 'Type',
37			self::TYPE_JSON_COLLECTION => 'JsonCollectionType',
38			self::TYPE_CSV_COLLECTION => 'CsvCollectionType',
39			];
40
41			public const MARKER = 'ELAO_ENUM_DT';
42
43			public function dumpToFile(string $file, array $types)
44			{
45			file_put_contents($file, $this->dump($types));
46			}
47
48			private function dump(array $types): string
49			{
50			$namespaces = [];
51			foreach ($types as [$enumClass, $type, $name, $default]) {
52			$fqcn = self::getTypeClassname($enumClass, $type);
			0 ignored issues – show Bug introduced 2020-03-31 16:08 UTC by Report Bug Copy Issue Report The variable `$enumClass` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2020-10-22 13:38 UTC by Report Bug Copy Issue Report The variable `$type` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
53			$classname = basename(str_replace('\\', '/', $fqcn));
54			$ns = substr($fqcn, 0, -\strlen($classname) - 1);
55
56			if (!isset($namespaces[$ns])) {
57			$namespaces[$ns] = '';
58			}
59
60			$namespaces[$ns] .= $this->getTypeCode(
61			$classname,
62			$enumClass,
63			$type,
64			$name,
			0 ignored issues – show Bug introduced 2020-03-31 16:08 UTC by Report Bug Copy Issue Report The variable `$name` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
65			$default
			0 ignored issues – show Bug introduced 2021-05-27 07:35 UTC by Report Bug Copy Issue Report The variable `$default` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
66			);
67			}
68
69			$code = "<?php\n";
70			foreach ($namespaces as $namespace => $typeCode) {
71			$code .= <<<PHP
72
73			namespace $namespace {
74			$typeCode
75			}
76
77			PHP;
78			}
79
80			return $code;
81			}
82
83			private function getTypeCode(
84			string $classname,
85			string $enumClass,
86			string $type,
87			string $name,
88			$defaultOnNull
89			): string {
90			$code = <<<PHP
91			public const NAME = '$name';
92
93			protected function getEnumClass(): string
94			{
95			return \\{$enumClass}::class;
96			}
97
98			public function getName(): string
99			{
100			return static::NAME;
101			}
102			PHP;
103			switch ($type) {
104			case self::TYPE_INT:
105			$baseClass = AbstractIntegerEnumType::class;
106			break;
107			case self::TYPE_STRING:
108			$baseClass = AbstractEnumType::class;
109
110			if ($defaultOnNull !== null) {
111			$defaultOnNullCode = $this->valueAsCode($defaultOnNull);
112			$code .= <<<PHP
113
114			protected function onNullFromDatabase()
115			{
116			return \\{$enumClass}::get({$defaultOnNullCode});
117			}
118
119			protected function onNullFromPhp()
120			{
121			return {$defaultOnNullCode};
122			}
123			PHP;
124			}
125			break;
126			case self::TYPE_ENUM:
127			$baseClass = AbstractEnumSQLDeclarationType::class;
128			break;
129			case self::TYPE_JSON_COLLECTION:
130			$baseClass = AbstractJsonCollectionEnumType::class;
131			break;
132			case self::TYPE_CSV_COLLECTION:
133			$baseClass = AbstractCsvCollectionEnumType::class;
134			break;
135			default:
136			throw new LogicException(sprintf('Unexpected type "%s"', $type));
137			}
138
139			return <<<PHP
140
141			if (!\class_exists($classname::class)) {
142			class $classname extends \\{$baseClass}
143			{
144			$code
145			}
146			}
147
148			PHP;
149			}
150
151			private function valueAsCode($value): string
152			{
153			if (is_string($value)) {
154			if (strpos($value, '::') !== false) { // Constant name
155			return sprintf('\\%s', ltrim($value, '\\'));
156			}
157
158			return sprintf('\'%s\'', $value); // plain string
159			}
160
161			if (is_bool($value)) {
162			return $value ? 'true': 'false';
163			}
164
165			return (string)$value;
166			}
167
168			public static function getTypeClassname(string $class, string $type): string
169			{
170			$suffix = self::TYPES_SUFFIXES[$type];
171
172			return self::MARKER . "\\{$class}{$suffix}";
173			}
174			}
175

Elao / PhpEnums

Pull Request — master (#132)

TypesDumper::getTypeCode() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like