TypeGuesser::guessPrimaryTypeFromConstraint() - Code Metrics - Inspection of "Add FT & update UT" - yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — release/1.0.0 (#7)

by Yo

created 2018-11-03 15:46 UTC

TypeGuesser::guessPrimaryTypeFromConstraint() B

↳ Parent: TypeGuesser

Complexity

Conditions	9
Paths	7

Size

Total Lines	47
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	9

Importance

Changes

Metric	Value
cc	9
eloc	37
nc	7
nop	1
dl	0
loc	47
ccs	18
cts	18
cp	1
crap	9
rs	7.7724
c	0
b	0
f	0

<?php
namespace Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints as Assert;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ArrayDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\BooleanDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\CollectionDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\FloatDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\NumberDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ObjectDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ScalarDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\TypeDoc;

/**
 * Class TypeGuesser
 */
class TypeGuesser
{
    /**
     * @param array $constraintList
     *
     * @return TypeDoc|null
     */
    public function guessTypeFromConstraintList(array $constraintList)
    {
        $doc = $abstractTypeFound = null;
        foreach ($constraintList as $constraint) {
            $doc = $this->guessTypeFromConstraint($constraint);
            if (null !== $doc) {
                if ($this->isAbstractType($doc)) {
                     // Abstract type => continue to see if better type can be found
                     $abstractTypeFound = $doc;
                     $doc = null;
                } else {
                     break;
                }
            }
        }
        // Try to fallback on abstractType if found
        if (null === $doc && null !== $abstractTypeFound) {
            $doc = $abstractTypeFound;
        }

        return $doc;
    }

    /**
     * @param Constraint $constraint
     *
     * @return TypeDoc|null
     */
    protected function guessTypeFromConstraint(Constraint $constraint)
    {
        if (null !== ($type = $this->guessPrimaryTypeFromConstraint($constraint))) {
            return $type;
        }

        // If primary type is still not defined
        $constraintClass = get_class($constraint);
        if (Assert\Count::class == $constraintClass) {
            return new CollectionDoc();
        } elseif ($constraint instanceof Assert\Existence) {
            return $this->guessTypeFromConstraintList($constraint->constraints);
        }

        return null;
    }

    /**
     * @param TypeDoc $doc
     *
     * @return bool
     */
    private function isAbstractType(TypeDoc $doc) : bool
    {
        // use get_class to avoid inheritance issue
        $class = get_class($doc);

        return CollectionDoc::class === $class
            || NumberDoc::class === $class
            || ScalarDoc::class === $class
        ;
    }

    /**
     * @param Constraint $constraint
     *
     * @return null|ArrayDoc|BooleanDoc|ObjectDoc|ScalarDoc|StringDoc
     */
    private function guessPrimaryTypeFromConstraint(Constraint $constraint)
    {
        static $stringConstraintClassList = [
            Assert\Length::class, // << Applied on string only
            Assert\Date::class,  // << validator expect a string with specific format
            Assert\Time::class,  // << validator expect a string with specific format
            Assert\Bic::class,
            Assert\CardScheme::class,
            Assert\Country::class,
            Assert\Currency::class,
            Assert\Email::class,
            Assert\File::class,
            Assert\Iban::class,
            Assert\Ip::class,
            Assert\Isbn::class,
            Assert\Issn::class,
            Assert\Language::class,
            Assert\Locale::class,
            Assert\Luhn::class,
            Assert\Url::class,
            Assert\Uuid::class,
        ];
        static $booleanConstraintClassList = [
            Assert\IsTrue::class,
            Assert\IsFalse::class,
        ];

        // Try to guess primary types
        if ($this->isInstanceOfOneClassIn($constraint, $stringConstraintClassList)) {
            return new StringDoc();
        } elseif ($this->isInstanceOfOneClassIn($constraint, $booleanConstraintClassList)) {
            return new BooleanDoc();
        } elseif ($constraint instanceof Assert\DateTime) {
            return $this->guessDateTimeType($constraint);
        } elseif ($constraint instanceof Assert\Collection) {
            return $this->guestCollectionType($constraint);
        } elseif ($constraint instanceof Assert\Regex) {
            return new ScalarDoc();
        } elseif ($constraint instanceof Assert\All // << Applied only on array
            || ($constraint instanceof Assert\Choice
                && true === $constraint->multiple // << expect an array multiple choices
            )
        ) {
            return new ArrayDoc();
        }

        return null;
    }

    /**
     * @param Assert\DateTime $constraint
     *
     * @return ScalarDoc|StringDoc
     */
    private function guessDateTimeType(Assert\DateTime $constraint)
    {
        if ('U' === $constraint->format) {
            return new ScalarDoc();// Don't know if value will be an number as string or as integer
        }

        return new StringDoc();
    }

    /**
     * @param Assert\Collection $constraint
     *
     * @return ArrayDoc|ObjectDoc
     */
    private function guestCollectionType(Assert\Collection $constraint)
    {
        // If only integer => array, else object
        $integerKeyList = array_filter(array_keys($constraint->fields), 'is_int');
        if (count($constraint->fields) === count($integerKeyList)) {
            return new ArrayDoc();
        }

        return new ObjectDoc();
    }

    /**
     * @param       $object
     * @param array $classList
     *
     * @return bool
     */
    private function isInstanceOfOneClassIn($object, array $classList) : bool
    {
        $actualClassList = array_merge(
            [get_class($object)],
            class_implements($object),
            class_uses($object)
        );
        $parentClass = get_parent_class($object);
        while (false !== $parentClass) {
            $actualClassList[] = $parentClass;
            $parentClass = get_parent_class($parentClass);
        }

        return count(array_intersect($actualClassList, $classList)) > 0;
    }
}


1		<?php
2		namespace Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper;
3
4		use Symfony\Component\Validator\Constraint;
5		use Symfony\Component\Validator\Constraints as Assert;
6		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ArrayDoc;
7		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\BooleanDoc;
8		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\CollectionDoc;
9		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\FloatDoc;
10		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\NumberDoc;
11		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ObjectDoc;
12		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ScalarDoc;
13		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc;
14		use Yoanm\JsonRpcServerDoc\Domain\Model\Type\TypeDoc;
15
16		/**
17		* Class TypeGuesser
18		*/
19		class TypeGuesser
20		{
21		/**
22		* @param array $constraintList
23		*
24		* @return TypeDoc\|null
25		*/
26	29	public function guessTypeFromConstraintList(array $constraintList)
27		{
28	29	$doc = $abstractTypeFound = null;
29	29	foreach ($constraintList as $constraint) {
30	29	$doc = $this->guessTypeFromConstraint($constraint);
31	29	if (null !== $doc) {
32	28	if ($this->isAbstractType($doc)) {
33		// Abstract type => continue to see if better type can be found
34	3	$abstractTypeFound = $doc;
35	3	$doc = null;
36		} else {
37	29	break;
38		}
39		}
40		}
41		// Try to fallback on abstractType if found
42	29	if (null === $doc && null !== $abstractTypeFound) {
43	3	$doc = $abstractTypeFound;
44		}
45
46	29	return $doc;
47		}
48
49		/**
50		* @param Constraint $constraint
51		*
52		* @return TypeDoc\|null
53		*/
54	29	protected function guessTypeFromConstraint(Constraint $constraint)
55		{
56	29	if (null !== ($type = $this->guessPrimaryTypeFromConstraint($constraint))) {
57	27	return $type;
58		}
59
60		// If primary type is still not defined
61	2	$constraintClass = get_class($constraint);
62	2	if (Assert\Count::class == $constraintClass) {
63	1	return new CollectionDoc();
64	1	} elseif ($constraint instanceof Assert\Existence) {
65		return $this->guessTypeFromConstraintList($constraint->constraints);
66		}
67
68	1	return null;
69		}
70
71		/**
72		* @param TypeDoc $doc
73		*
74		* @return bool
75		*/
76	28	private function isAbstractType(TypeDoc $doc) : bool
77		{
78		// use get_class to avoid inheritance issue
79	28	$class = get_class($doc);
80
81	28	return CollectionDoc::class === $class
82	27	\|\| NumberDoc::class === $class
83	28	\|\| ScalarDoc::class === $class
84		;
85		}
86
87		/**
88		* @param Constraint $constraint
89		*
90		* @return null\|ArrayDoc\|BooleanDoc\|ObjectDoc\|ScalarDoc\|StringDoc
91		*/
92	29	private function guessPrimaryTypeFromConstraint(Constraint $constraint)
93		{
94	29	static $stringConstraintClassList = [
95		Assert\Length::class, // << Applied on string only
96		Assert\Date::class, // << validator expect a string with specific format
97		Assert\Time::class, // << validator expect a string with specific format
98		Assert\Bic::class,
99		Assert\CardScheme::class,
100		Assert\Country::class,
101		Assert\Currency::class,
102		Assert\Email::class,
103		Assert\File::class,
104		Assert\Iban::class,
105		Assert\Ip::class,
106		Assert\Isbn::class,
107		Assert\Issn::class,
108		Assert\Language::class,
109		Assert\Locale::class,
110		Assert\Luhn::class,
111		Assert\Url::class,
112		Assert\Uuid::class,
113		];
114	29	static $booleanConstraintClassList = [
115		Assert\IsTrue::class,
116		Assert\IsFalse::class,
117		];
118
119		// Try to guess primary types
120	29	if ($this->isInstanceOfOneClassIn($constraint, $stringConstraintClassList)) {
121	18	return new StringDoc();
122	11	} elseif ($this->isInstanceOfOneClassIn($constraint, $booleanConstraintClassList)) {
123	2	return new BooleanDoc();
124	9	} elseif ($constraint instanceof Assert\DateTime) {
125	2	return $this->guessDateTimeType($constraint);
126	7	} elseif ($constraint instanceof Assert\Collection) {
127	2	return $this->guestCollectionType($constraint);
128	5	} elseif ($constraint instanceof Assert\Regex) {
129	1	return new ScalarDoc();
130	4	} elseif ($constraint instanceof Assert\All // << Applied only on array
131	3	\|\| ($constraint instanceof Assert\Choice
132	4	&& true === $constraint->multiple // << expect an array multiple choices
133		)
134		) {
135	2	return new ArrayDoc();
136		}
137
138	2	return null;
139		}
140
141		/**
142		* @param Assert\DateTime $constraint
143		*
144		* @return ScalarDoc\|StringDoc
145		*/
146	2	private function guessDateTimeType(Assert\DateTime $constraint)
147		{
148	2	if ('U' === $constraint->format) {
149	1	return new ScalarDoc();// Don't know if value will be an number as string or as integer
150		}
151
152	1	return new StringDoc();
153		}
154
155		/**
156		* @param Assert\Collection $constraint
157		*
158		* @return ArrayDoc\|ObjectDoc
159		*/
160	2	private function guestCollectionType(Assert\Collection $constraint)
161		{
162		// If only integer => array, else object
163	2	$integerKeyList = array_filter(array_keys($constraint->fields), 'is_int');
164	2	if (count($constraint->fields) === count($integerKeyList)) {
165	1	return new ArrayDoc();
166		}
167
168	1	return new ObjectDoc();
169		}
170
171		/**
172		* @param $object
173		* @param array $classList
174		*
175		* @return bool
176		*/
177	29	private function isInstanceOfOneClassIn($object, array $classList) : bool
178		{
179	29	$actualClassList = array_merge(
180	29	[get_class($object)],
181	29	class_implements($object),
182	29	class_uses($object)
183		);
184	29	$parentClass = get_parent_class($object);
185	29	while (false !== $parentClass) {
186	29	$actualClassList[] = $parentClass;
187	29	$parentClass = get_parent_class($parentClass);
188		}
189
190	29	return count(array_intersect($actualClassList, $classList)) > 0;
191		}
192		}
193

yoanm / php-jsonrpc-params-symfony-constraint-doc-sdk

Pull Request — release/1.0.0 (#7)

TypeGuesser::guessPrimaryTypeFromConstraint() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like