FieldInterfaceCreator::__construct() - Code Metrics - Inspection of "Mess detector fixes" - edmondscommerce/doctrine-static-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#214)

by joseph

created 2019-08-14 15:47 UTC

FieldInterfaceCreator::__construct() A

↳ Parent: FieldInterfaceCreator

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	7
dl	0
loc	11
ccs	0
cts	3
cp	0
crap	2
rs	10
c	1
b	0
f	0

<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\Fields\Interfaces;

use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\CodeHelper;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\AbstractCreator;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\FindReplaceProcess;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\Fields\AbstractFieldCreator;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\Fields\Traits\FieldTraitCreator;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FileFactory;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FindReplaceFactory;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\Writer;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\NamespaceHelper;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\TypeHelper;
use EdmondsCommerce\DoctrineStaticMeta\Config;
use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;
use InvalidArgumentException;
use RuntimeException;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class FieldInterfaceCreator extends AbstractFieldCreator
{
    public const TEMPLATE_PATH = self::ROOT_TEMPLATE_PATH .
                                 '/src/Entity/Fields/Interfaces/' .
                                 self::FIND_NAME . 'FieldInterface.php';


    public const SUFFIX = FieldTraitCreator::INTERFACE_SUFFIX;
    /**
     * @var TypeHelper
     */
    private $typeHelper;

    public function __construct(
        FileFactory $fileFactory,
        NamespaceHelper $namespaceHelper,
        Writer $fileWriter,
        Config $config,
        FindReplaceFactory $findReplaceFactory,
        CodeHelper $codeHelper,
        TypeHelper $typeHelper
    ) {
        parent::__construct($fileFactory, $namespaceHelper, $fileWriter, $config, $findReplaceFactory, $codeHelper);
        $this->typeHelper = $typeHelper;
    }


    public function setNewObjectFqn(string $newObjectFqn): AbstractCreator
    {
        $this->validateFqnEndsWithSuffix($newObjectFqn);

        return parent::setNewObjectFqn($newObjectFqn);
    }

    private function validateFqnEndsWithSuffix(string $newObjectFqn): void
    {
        if (substr($newObjectFqn, 0 - strlen(self::SUFFIX)) === self::SUFFIX) {
            return;
        }
        throw new InvalidArgumentException('$newObjectFqn must end in ' . self::SUFFIX);
    }


    protected function configurePipeline(): void
    {
        parent::configurePipeline();
        $this->registerReplaceDefaultValue();
        $this->registerReplacePropertyName();
        $this->registerReplaceType();
    }

    private function registerReplaceDefaultValue(): void
    {
        $find    = "'defaultValue'";
        $replace = $this->getReplaceForDefaultValue();
        $process = new FindReplaceProcess($find, $replace);
        $this->pipeline->register($process);
    }

    /**
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     * @return string
     */
    private function getReplaceForDefaultValue(): string
    {
        $defaultType = $this->typeHelper->getType($this->defaultValue);
        switch (true) {
            case $defaultType === 'null':
                return 'null';
            case $this->phpType === 'string':
                return "'$this->defaultValue'";
            case $this->phpType === 'bool':
                return (true === $this->defaultValue) ? 'true' : 'false';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case $this->phpType === 'float':
                $replace = (string)$this->defaultValue;
                if (false === \ts\stringContains($replace, '.')) {

                    $replace .= '.0';
                }

                return $replace;
            case $this->phpType === 'int':
                return (string)$this->defaultValue;
            case $this->phpType === trim(MappingHelper::PHP_TYPE_DATETIME, '\\'):
                if ($this->defaultValue !== null) {
                    throw new InvalidArgumentException(
                        'Invalid default value ' . $this->defaultValue
                        . 'Currently we only support null as a default for DateTime'
                    );
                }

                return 'null';
            default:
                throw new RuntimeException(
                    'failed to calculate replace based on defaultType ' . $defaultType
                    . ' and phpType ' . $this->phpType . ' in ' . __METHOD__
                );
        }
    }
}


1			<?php declare(strict_types=1);
2
3			namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\Fields\Interfaces;
4
5			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\CodeHelper;
6			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\AbstractCreator;
7			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\FindReplaceProcess;
8			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\Fields\AbstractFieldCreator;
9			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\Fields\Traits\FieldTraitCreator;
10			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FileFactory;
11			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FindReplaceFactory;
12			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\Writer;
13			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\NamespaceHelper;
14			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\TypeHelper;
15			use EdmondsCommerce\DoctrineStaticMeta\Config;
16			use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;
17			use InvalidArgumentException;
18			use RuntimeException;
19
20			/**
21			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
22			*/
23			class FieldInterfaceCreator extends AbstractFieldCreator
24			{
25			public const TEMPLATE_PATH = self::ROOT_TEMPLATE_PATH .
26			'/src/Entity/Fields/Interfaces/' .
27			self::FIND_NAME . 'FieldInterface.php';
28
29
30			public const SUFFIX = FieldTraitCreator::INTERFACE_SUFFIX;
31			/**
32			* @var TypeHelper
33			*/
34			private $typeHelper;
35
36			public function __construct(
37			FileFactory $fileFactory,
38			NamespaceHelper $namespaceHelper,
39			Writer $fileWriter,
40			Config $config,
41			FindReplaceFactory $findReplaceFactory,
42			CodeHelper $codeHelper,
43			TypeHelper $typeHelper
44			) {
45			parent::__construct($fileFactory, $namespaceHelper, $fileWriter, $config, $findReplaceFactory, $codeHelper);
46			$this->typeHelper = $typeHelper;
47			}
48
49
50			public function setNewObjectFqn(string $newObjectFqn): AbstractCreator
51			{
52			$this->validateFqnEndsWithSuffix($newObjectFqn);
53
54			return parent::setNewObjectFqn($newObjectFqn);
55			}
56
57			private function validateFqnEndsWithSuffix(string $newObjectFqn): void
58			{
59			if (substr($newObjectFqn, 0 - strlen(self::SUFFIX)) === self::SUFFIX) {
60			return;
61			}
62			throw new InvalidArgumentException('$newObjectFqn must end in ' . self::SUFFIX);
63			}
64
65
66			protected function configurePipeline(): void
67			{
68			parent::configurePipeline();
69			$this->registerReplaceDefaultValue();
70			$this->registerReplacePropertyName();
71			$this->registerReplaceType();
72			}
73
74			private function registerReplaceDefaultValue(): void
75			{
76			$find = "'defaultValue'";
77			$replace = $this->getReplaceForDefaultValue();
78			$process = new FindReplaceProcess($find, $replace);
79			$this->pipeline->register($process);
80			}
81
82			/**
83			* @SuppressWarnings(PHPMD.CyclomaticComplexity)
84			* @return string
85			*/
86			private function getReplaceForDefaultValue(): string
87			{
88			$defaultType = $this->typeHelper->getType($this->defaultValue);
89			switch (true) {
90			case $defaultType === 'null':
91			return 'null';
92			case $this->phpType === 'string':
93			return "'$this->defaultValue'";
94			case $this->phpType === 'bool':
95			return (true === $this->defaultValue) ? 'true' : 'false';
96			break;
			0 ignored issues – show Unused Code introduced 2019-08-14 10:55 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...
97			case $this->phpType === 'float':
98			$replace = (string)$this->defaultValue;
99			if (false === \ts\stringContains($replace, '.')) {
			0 ignored issues – show introduced 2019-08-14 10:55 UTC by Report Bug Copy Issue Report The condition `false === stringContains($replace, '.')` is always `false`. Loading history...
100			$replace .= '.0';
101			}
102
103			return $replace;
104			case $this->phpType === 'int':
105			return (string)$this->defaultValue;
106			case $this->phpType === trim(MappingHelper::PHP_TYPE_DATETIME, '\\'):
107			if ($this->defaultValue !== null) {
108			throw new InvalidArgumentException(
109			'Invalid default value ' . $this->defaultValue
110			. 'Currently we only support null as a default for DateTime'
111			);
112			}
113
114			return 'null';
115			default:
116			throw new RuntimeException(
117			'failed to calculate replace based on defaultType ' . $defaultType
118			. ' and phpType ' . $this->phpType . ' in ' . __METHOD__
119			);
120			}
121			}
122			}
123

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

Pull Request — master (#214)

FieldInterfaceCreator::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like