Rules::getListRule() - Code Metrics - Inspection of "issue #124 - improvements in generated Struct/Stru..." - WsdlToPhp/PackageGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/issue-124 ( 91e4aa...dde646 )

by Mikaël

created 2021-02-08 22:26 UTC

Rules::getListRule() A

↳ Parent: Rules

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace WsdlToPhp\PackageGenerator\File\Validation;

use WsdlToPhp\PackageGenerator\Container\PhpElement\Method as MethodContainer;
use WsdlToPhp\PackageGenerator\File\AbstractModelFile;
use WsdlToPhp\PackageGenerator\Generator\Generator;
use WsdlToPhp\PackageGenerator\Model\StructAttribute;
use WsdlToPhp\PhpGenerator\Element\PhpMethod;

final class Rules
{
    private StructAttribute $attribute;

    private AbstractModelFile $file;

    private PhpMethod $method;

    private MethodContainer $methods;

    private static array $rulesAppliedToAttribute = [];

    public function __construct(AbstractModelFile $file, PhpMethod $method, StructAttribute $attribute, MethodContainer $methods)
    {
        $this->file = $file;
        $this->method = $method;
        $this->attribute = $attribute;
        $this->methods = $methods;
    }

    public function applyRules(string $parameterName, bool $itemType = false): void
    {
        if ($this->attribute->isArray() && !$itemType) {
            $this->getArrayRule()->applyRule($parameterName, null, $itemType);
        } elseif ($this->attribute->isXml() && !$itemType) {
            $this->getXmlRule()->applyRule($parameterName, null, $itemType);
        } elseif ($this->attribute->isList() && !$itemType) {
            $this->getListRule()->applyRule($parameterName, null, $itemType);
        } elseif ($this->getFile()->getRestrictionFromStructAttribute($this->attribute)) {
            $this->getEnumerationRule()->applyRule($parameterName, null);
        } elseif ($itemType) {
            $this->getItemTypeRule()->applyRule($parameterName, null);
        } elseif (($rule = $this->getRule($this->getFile()->getStructAttributeTypeAsPhpType($this->attribute))) instanceof AbstractRule) {
            $rule->applyRule($parameterName, null, $itemType);
        }
        $this->applyRulesFromAttribute($parameterName, $itemType);
    }

    public function getRule(string $name): ?AbstractRule
    {
        if (is_string($name)) {

            $className = sprintf('%s\%sRule', __NAMESPACE__, ucfirst($name));
            if (class_exists($className)) {
                return new $className($this);
            }
        }

        return null;
    }

    public function getArrayRule(): ArrayRule
    {
        return $this->getRule('array');

    }

    public function getXmlRule(): XmlRule
    {
        return $this->getRule('xml');

    }

    public function getEnumerationRule(): EnumerationRule
    {
        return $this->getRule('enumeration');

    }

    public function getItemTypeRule(): ItemTypeRule
    {
        return $this->getRule('itemType');

    }

    public function getListRule(): ListRule
    {
        return $this->getRule('list');

    }

    public function getAttribute(): StructAttribute
    {
        return $this->attribute;
    }

    public function setAttribute(StructAttribute $attribute): self
    {
        $this->attribute = $attribute;

        return $this;
    }

    public function getFile(): AbstractModelFile
    {
        return $this->file;
    }

    public function getMethod(): PhpMethod
    {
        return $this->method;
    }

    public function setMethod(PhpMethod $method): self
    {
        $this->method = $method;

        return $this;
    }

    public function getMethods(): MethodContainer
    {
        return $this->methods;
    }

    public function getGenerator(): Generator
    {
        return $this->file->getGenerator();
    }

    public static function ruleHasBeenAppliedToAttribute(AbstractRule $rule, $value, StructAttribute $attribute): void
    {
        self::$rulesAppliedToAttribute[self::getAppliedRuleToAttributeKey($rule, $value, $attribute)] = true;
    }

    public static function hasRuleBeenAppliedToAttribute(AbstractRule $rule, $value, StructAttribute $attribute): bool
    {
        return array_key_exists(self::getAppliedRuleToAttributeKey($rule, $value, $attribute), self::$rulesAppliedToAttribute);
    }

    private function applyRulesFromAttribute(string $parameterName, bool $itemType = false): void
    {
        foreach ($this->attribute->getMeta() as $metaName => $metaValue) {
            $rule = $this->getRule($metaName);
            if ($rule instanceof AbstractRule) {
                $rule->applyRule($parameterName, $metaValue, $itemType);
            }
        }
    }

    private static function getAppliedRuleToAttributeKey(AbstractRule $rule, $value, StructAttribute $attribute): string
    {
        return implode('_', [
            $rule->validationRuleComment($value),
            $attribute->getOwner()->getName(),
            $attribute->getName(),
        ]);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace WsdlToPhp\PackageGenerator\File\Validation;
6
7		use WsdlToPhp\PackageGenerator\Container\PhpElement\Method as MethodContainer;
8		use WsdlToPhp\PackageGenerator\File\AbstractModelFile;
9		use WsdlToPhp\PackageGenerator\Generator\Generator;
10		use WsdlToPhp\PackageGenerator\Model\StructAttribute;
11		use WsdlToPhp\PhpGenerator\Element\PhpMethod;
12
13		final class Rules
14		{
15		private StructAttribute $attribute;
16
17		private AbstractModelFile $file;
18
19		private PhpMethod $method;
20
21		private MethodContainer $methods;
22
23		private static array $rulesAppliedToAttribute = [];
24
25	158	public function __construct(AbstractModelFile $file, PhpMethod $method, StructAttribute $attribute, MethodContainer $methods)
26		{
27	158	$this->file = $file;
28	158	$this->method = $method;
29	158	$this->attribute = $attribute;
30	158	$this->methods = $methods;
31	158	}
32
33	112	public function applyRules(string $parameterName, bool $itemType = false): void
34		{
35	112	if ($this->attribute->isArray() && !$itemType) {
36	52	$this->getArrayRule()->applyRule($parameterName, null, $itemType);
37	102	} elseif ($this->attribute->isXml() && !$itemType) {
38	4	$this->getXmlRule()->applyRule($parameterName, null, $itemType);
39	102	} elseif ($this->attribute->isList() && !$itemType) {
40	6	$this->getListRule()->applyRule($parameterName, null, $itemType);
41	102	} elseif ($this->getFile()->getRestrictionFromStructAttribute($this->attribute)) {
42	48	$this->getEnumerationRule()->applyRule($parameterName, null);
43	102	} elseif ($itemType) {
44	36	$this->getItemTypeRule()->applyRule($parameterName, null);
45	96	} elseif (($rule = $this->getRule($this->getFile()->getStructAttributeTypeAsPhpType($this->attribute))) instanceof AbstractRule) {
46	82	$rule->applyRule($parameterName, null, $itemType);
47		}
48	112	$this->applyRulesFromAttribute($parameterName, $itemType);
49	112	}
50
51	112	public function getRule(string $name): ?AbstractRule
52		{
53	112	if (is_string($name)) {
		0 ignored issues – show introduced 2019-01-23 22:00 UTC by Report Bug Copy Issue Report The condition `is_string($name)` is always `true`. Loading history...
54	112	$className = sprintf('%s\%sRule', __NAMESPACE__, ucfirst($name));
55	112	if (class_exists($className)) {
56	102	return new $className($this);
57		}
58		}
59
60	86	return null;
61		}
62
63	52	public function getArrayRule(): ArrayRule
64		{
65	52	return $this->getRule('array');
		0 ignored issues – show Bug Best Practice introduced 2021-02-02 00:09 UTC by Report Bug Copy Issue Report The expression `return $this->getRule('array')` returns the type `null` which is incompatible with the type-hinted return `WsdlToPhp\PackageGenerat...le\Validation\ArrayRule`. Loading history...
66		}
67
68	4	public function getXmlRule(): XmlRule
69		{
70	4	return $this->getRule('xml');
		0 ignored issues – show Bug Best Practice introduced 2021-02-08 22:36 UTC by Report Bug Copy Issue Report The expression `return $this->getRule('xml')` returns the type `null` which is incompatible with the type-hinted return `WsdlToPhp\PackageGenerator\File\Validation\XmlRule`. Loading history...
71		}
72
73	60	public function getEnumerationRule(): EnumerationRule
74		{
75	60	return $this->getRule('enumeration');
		0 ignored issues – show Bug Best Practice introduced 2021-02-02 00:09 UTC by Report Bug Copy Issue Report The expression `return $this->getRule('enumeration')` returns the type `null` which is incompatible with the type-hinted return `WsdlToPhp\PackageGenerat...idation\EnumerationRule`. Loading history...
76		}
77
78	50	public function getItemTypeRule(): ItemTypeRule
79		{
80	50	return $this->getRule('itemType');
		0 ignored issues – show Bug Best Practice introduced 2021-02-02 00:09 UTC by Report Bug Copy Issue Report The expression `return $this->getRule('itemType')` returns the type `null` which is incompatible with the type-hinted return `WsdlToPhp\PackageGenerat...Validation\ItemTypeRule`. Loading history...
81		}
82
83	6	public function getListRule(): ListRule
84		{
85	6	return $this->getRule('list');
		0 ignored issues – show Bug Best Practice introduced 2021-02-02 00:09 UTC by Report Bug Copy Issue Report The expression `return $this->getRule('list')` returns the type `null` which is incompatible with the type-hinted return `WsdlToPhp\PackageGenerat...ile\Validation\ListRule`. Loading history...
86		}
87
88	146	public function getAttribute(): StructAttribute
89		{
90	146	return $this->attribute;
91		}
92
93	4	public function setAttribute(StructAttribute $attribute): self
94		{
95	4	$this->attribute = $attribute;
96
97	4	return $this;
98		}
99
100	112	public function getFile(): AbstractModelFile
101		{
102	112	return $this->file;
103		}
104
105	146	public function getMethod(): PhpMethod
106		{
107	146	return $this->method;
108		}
109
110	54	public function setMethod(PhpMethod $method): self
111		{
112	54	$this->method = $method;
113
114	54	return $this;
115		}
116
117	66	public function getMethods(): MethodContainer
118		{
119	66	return $this->methods;
120		}
121
122	4	public function getGenerator(): Generator
123		{
124	4	return $this->file->getGenerator();
125		}
126
127	146	public static function ruleHasBeenAppliedToAttribute(AbstractRule $rule, $value, StructAttribute $attribute): void
128		{
129	146	self::$rulesAppliedToAttribute[self::getAppliedRuleToAttributeKey($rule, $value, $attribute)] = true;
130	146	}
131
132	4	public static function hasRuleBeenAppliedToAttribute(AbstractRule $rule, $value, StructAttribute $attribute): bool
133		{
134	4	return array_key_exists(self::getAppliedRuleToAttributeKey($rule, $value, $attribute), self::$rulesAppliedToAttribute);
135		}
136
137	112	private function applyRulesFromAttribute(string $parameterName, bool $itemType = false): void
138		{
139	112	foreach ($this->attribute->getMeta() as $metaName => $metaValue) {
140	100	$rule = $this->getRule($metaName);
141	100	if ($rule instanceof AbstractRule) {
142	94	$rule->applyRule($parameterName, $metaValue, $itemType);
143		}
144		}
145	112	}
146
147	146	private static function getAppliedRuleToAttributeKey(AbstractRule $rule, $value, StructAttribute $attribute): string
148		{
149	146	return implode('_', [
150	146	$rule->validationRuleComment($value),
151	146	$attribute->getOwner()->getName(),
152	146	$attribute->getName(),
153		]);
154		}
155		}
156

WsdlToPhp / PackageGenerator

Push — feature/issue-124 ( 91e4aa...dde646 )

Rules::getListRule() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like