ArgumentsTransformer::getInstanceAndValidate() - Code Metrics - Inspection of "Fields auto-guessing from Doctrine ORM annotations" - overblog/GraphQLBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — annotations (#407)

by Vincent

created 2018-12-19 15:33 UTC

ArgumentsTransformer::getInstanceAndValidate() B

↳ Parent: ArgumentsTransformer

Complexity

Conditions	7
Paths	16

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	7.0283

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	11
cts	12
cp	0.9167
rs	8.8333
c	0
b	0
f	0
cc	7
nc	16
nop	4
crap	7.0283

<?php

declare(strict_types=1);

namespace Overblog\GraphQLBundle\Transformer;

use GraphQL\Type\Definition\EnumType;
use GraphQL\Type\Definition\InputObjectType;
use GraphQL\Type\Definition\ListOfType;
use GraphQL\Type\Definition\ResolveInfo;
use GraphQL\Type\Definition\Type;
use Overblog\GraphQLBundle\Error\InvalidArgumentError;
use Overblog\GraphQLBundle\Error\InvalidArgumentsError;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessor;
use Symfony\Component\Validator\Validator\ValidatorInterface;

class ArgumentsTransformer
{
    /**
     * @var ValidatorInterface
     */
    protected $validator;

    /**
     * @var array
     */
    protected $classesMap;

    /**
     * @var PropertyAccessor
     */
    protected $accessor;

    public function __construct(ValidatorInterface $validator, $classesMap = [])
    {
        $this->validator = $validator;
        $this->accessor = PropertyAccess::createPropertyAccessor();
        $this->classesMap = $classesMap;
    }

    /**
     * Get the PHP class for a given type.
     *
     * @param string $type
     *
     * @return object|false
     */
    private function getTypeClassInstance(string $type)
    {
        $classname = isset($this->classesMap[$type]) ? $this->classesMap[$type]['class'] : false;

        return $classname ? new $classname() : false;
    }

    /**
     * Extract given type from Resolve Info.
     *
     * @param string      $type
     * @param ResolveInfo $info
     *
     * @return Type
     */
    private function getType(string $type, ResolveInfo $info): Type
    {
        return $info->schema->getType($type);
    }

    /**
     * Populate an object based on type with given data.
     *
     * @param Type        $type
     * @param mixed       $data
     * @param bool        $multiple
     * @param ResolveInfo $info
     *
     * @return mixed
     */
    private function populateObject(Type $type, $data, $multiple = false, ResolveInfo $info)
    {
        if (!$data) {
            return $data;
        }

        if ($multiple) {
            return \array_map(function ($data) use ($type, $info) {
                return $this->populateObject($type, $data, false, $info);
            }, $data);
        }

        if ($type instanceof EnumType) {
            $instance = $this->getTypeClassInstance($type->name);
            if ($instance) {
                $this->accessor->setValue($instance, 'value', $data);

                return $instance;
            } else {
                return $data;
            }
        } elseif ($type instanceof InputObjectType) {
            $instance = $this->getTypeClassInstance($type->name);
            if (!$instance) {
                return $data;
            }

            $fields = $type->getFields();

            foreach ($fields as $name => $field) {
                $fieldData = $this->accessor->getValue($data, \sprintf('[%s]', $name));

                if ($field->getType() instanceof ListOfType) {
                    $fieldValue = $this->populateObject($field->getType()->getWrappedType(), $fieldData, true, $info);
                } else {
                    $fieldValue = $this->populateObject($field->getType(), $fieldData, false, $info);
                }

                $this->accessor->setValue($instance, $name, $fieldValue);
            }

            return $instance;
        } else {
            return $data;
        }
    }

    /**
     * Given a GraphQL type and an array of data, populate corresponding object recursively
     * using annoted classes.
     *
     * @param string      $argType
     * @param mixed       $data
     * @param ResolveInfo $info
     *
     * @return mixed
     */
    public function getInstanceAndValidate(string $argType, $data, ResolveInfo $info, string $argName)
    {
        $isRequired = '!' === $argType[\strlen($argType) - 1];
        $isMultiple = '[' === $argType[0];
        $endIndex = ($isRequired ? 1 : 0) + ($isMultiple ? 1 : 0);
        $type = \substr($argType, $isMultiple ? 1 : 0, $endIndex > 0 ? -$endIndex : \strlen($argType));

        $result = $this->populateObject($this->getType($type, $info), $data, $isMultiple, $info);
        $errors = [];
        if (\is_object($result)) {
            $errors = $this->validator->validate($result);
        }

        if (\count($errors) > 0) {
            throw new InvalidArgumentError($argName, $errors);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        } else {
            return $result;
        }
    }

    /**
     * Transform a list of arguments into their corresponding php class and validate them.
     *
     * @param array       $mapping
     * @param mixed       $data
     * @param ResolveInfo $info
     *
     * @return array
     */
    public function getArguments(array $mapping, $data, ResolveInfo $info)
    {
        $args = [];
        $exceptions = [];

        foreach ($mapping as $name => $type) {
            try {
                $value = $this->getInstanceAndValidate($type, $data[$name], $info, $name);
                $args[] = $value;
            } catch (InvalidArgumentError $exception) {
                $exceptions[] = $exception;
            }
        }

        if (!empty($exceptions)) {
            throw new InvalidArgumentsError($exceptions);
        }

        return $args;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Overblog\GraphQLBundle\Transformer;
6
7		use GraphQL\Type\Definition\EnumType;
8		use GraphQL\Type\Definition\InputObjectType;
9		use GraphQL\Type\Definition\ListOfType;
10		use GraphQL\Type\Definition\ResolveInfo;
11		use GraphQL\Type\Definition\Type;
12		use Overblog\GraphQLBundle\Error\InvalidArgumentError;
13		use Overblog\GraphQLBundle\Error\InvalidArgumentsError;
14		use Symfony\Component\PropertyAccess\PropertyAccess;
15		use Symfony\Component\PropertyAccess\PropertyAccessor;
16		use Symfony\Component\Validator\Validator\ValidatorInterface;
17
18		class ArgumentsTransformer
19		{
20		/**
21		* @var ValidatorInterface
22		*/
23		protected $validator;
24
25		/**
26		* @var array
27		*/
28		protected $classesMap;
29
30		/**
31		* @var PropertyAccessor
32		*/
33		protected $accessor;
34
35	1	public function __construct(ValidatorInterface $validator, $classesMap = [])
36		{
37	1	$this->validator = $validator;
38	1	$this->accessor = PropertyAccess::createPropertyAccessor();
39	1	$this->classesMap = $classesMap;
40	1	}
41
42		/**
43		* Get the PHP class for a given type.
44		*
45		* @param string $type
46		*
47		* @return object\|false
48		*/
49	1	private function getTypeClassInstance(string $type)
50		{
51	1	$classname = isset($this->classesMap[$type]) ? $this->classesMap[$type]['class'] : false;
52
53	1	return $classname ? new $classname() : false;
54		}
55
56		/**
57		* Extract given type from Resolve Info.
58		*
59		* @param string $type
60		* @param ResolveInfo $info
61		*
62		* @return Type
63		*/
64	1	private function getType(string $type, ResolveInfo $info): Type
65		{
66	1	return $info->schema->getType($type);
67		}
68
69		/**
70		* Populate an object based on type with given data.
71		*
72		* @param Type $type
73		* @param mixed $data
74		* @param bool $multiple
75		* @param ResolveInfo $info
76		*
77		* @return mixed
78		*/
79	1	private function populateObject(Type $type, $data, $multiple = false, ResolveInfo $info)
80		{
81	1	if (!$data) {
82	1	return $data;
83		}
84
85	1	if ($multiple) {
86		return \array_map(function ($data) use ($type, $info) {
87	1	return $this->populateObject($type, $data, false, $info);
88	1	}, $data);
89		}
90
91	1	if ($type instanceof EnumType) {
92	1	$instance = $this->getTypeClassInstance($type->name);
93	1	if ($instance) {
94	1	$this->accessor->setValue($instance, 'value', $data);
95
96	1	return $instance;
97		} else {
98	1	return $data;
99		}
100	1	} elseif ($type instanceof InputObjectType) {
101	1	$instance = $this->getTypeClassInstance($type->name);
102	1	if (!$instance) {
103		return $data;
104		}
105
106	1	$fields = $type->getFields();
107
108	1	foreach ($fields as $name => $field) {
109	1	$fieldData = $this->accessor->getValue($data, \sprintf('[%s]', $name));
110
111	1	if ($field->getType() instanceof ListOfType) {
112	1	$fieldValue = $this->populateObject($field->getType()->getWrappedType(), $fieldData, true, $info);
113		} else {
114	1	$fieldValue = $this->populateObject($field->getType(), $fieldData, false, $info);
115		}
116
117	1	$this->accessor->setValue($instance, $name, $fieldValue);
118		}
119
120	1	return $instance;
121		} else {
122	1	return $data;
123		}
124		}
125
126		/**
127		* Given a GraphQL type and an array of data, populate corresponding object recursively
128		* using annoted classes.
129		*
130		* @param string $argType
131		* @param mixed $data
132		* @param ResolveInfo $info
133		*
134		* @return mixed
135		*/
136	1	public function getInstanceAndValidate(string $argType, $data, ResolveInfo $info, string $argName)
137		{
138	1	$isRequired = '!' === $argType[\strlen($argType) - 1];
139	1	$isMultiple = '[' === $argType[0];
140	1	$endIndex = ($isRequired ? 1 : 0) + ($isMultiple ? 1 : 0);
141	1	$type = \substr($argType, $isMultiple ? 1 : 0, $endIndex > 0 ? -$endIndex : \strlen($argType));
142
143	1	$result = $this->populateObject($this->getType($type, $info), $data, $isMultiple, $info);
144	1	$errors = [];
145	1	if (\is_object($result)) {
146	1	$errors = $this->validator->validate($result);
147		}
148
149	1	if (\count($errors) > 0) {
150		throw new InvalidArgumentError($argName, $errors);
		0 ignored issues – show Bug introduced 2018-12-19 15:51 UTC by Report Bug Copy Issue Report It seems like `$errors` defined by `array()` on line `144` can also be of type `array`; however, `Overblog\GraphQLBundle\E...entError::__construct()` does only seem to accept `object<Symfony\Component...ViolationListInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
151		} else {
152	1	return $result;
153		}
154		}
155
156		/**
157		* Transform a list of arguments into their corresponding php class and validate them.
158		*
159		* @param array $mapping
160		* @param mixed $data
161		* @param ResolveInfo $info
162		*
163		* @return array
164		*/
165	1	public function getArguments(array $mapping, $data, ResolveInfo $info)
166		{
167	1	$args = [];
168	1	$exceptions = [];
169
170	1	foreach ($mapping as $name => $type) {
171		try {
172	1	$value = $this->getInstanceAndValidate($type, $data[$name], $info, $name);
173	1	$args[] = $value;
174		} catch (InvalidArgumentError $exception) {
175	1	$exceptions[] = $exception;
176		}
177		}
178
179	1	if (!empty($exceptions)) {
180		throw new InvalidArgumentsError($exceptions);
181		}
182
183	1	return $args;
184		}
185		}
186

overblog / GraphQLBundle

Scrutinizer GitHub App not installed

Pull Request — annotations (#407)

ArgumentsTransformer::getInstanceAndValidate() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like