QueryParameters::validateFieldSets() - Code Metrics - Inspection of "Support request query parameters parsing" - reva2/jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fab3df...c703cd )

by Sergey

created 2016-07-22 14:10 UTC

QueryParameters::validateFieldSets() A

↳ Parent: QueryParameters

Complexity

Conditions	4
Paths	4

Size

Total Lines	21
Code Lines	14

Duplication

Lines	10
Ratio	47.62 %

Code Coverage

Tests	16
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	10
loc	21
ccs	16
cts	16
cp	1
rs	9.0534
cc	4
eloc	14
nc	4
nop	1
crap	4

<?php
/*
 * This file is part of the reva2/jsonapi.
 *
 * (c) OrbitScripts LLC <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */


namespace Reva2\JsonApi\Http\Query;

use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

/**
 * JSON API single resource query parameters
 *
 * @package Reva2\JsonApi\Http\Query
 * @author Sergey Revenko <[email protected]>
 *
 * @Reva2\JsonApi\Annotations\ApiObject()
 */
class QueryParameters implements EncodingParametersInterface
{
    const INVALID_INCLUDE_PATHS = '9f4922b8-8e8b-4847-baf2-5831adfd6813';
    const INVALID_FIELD_SET = 'ec7d2c6b-97d1-4f94-ba94-d141d985fc6f';

    /**
     * @var string[]|null
     * @Reva2\JsonApi\Annotations\Property(path="[include]", parser="parseIncludePaths")
     * @Symfony\Component\Validator\Constraints\Type(type="array")
     * @Symfony\Component\Validator\Constraints\All({
     *     @Symfony\Component\Validator\Constraints\Type(type="string")
     * })
     */
    protected $includePaths;

    /**
     * @var array[]|null
     * @Reva2\JsonApi\Annotations\Property(path="[fields]", parser="parseFieldSets")
     * @Symfony\Component\Validator\Constraints\Type(type="array")
     * @Symfony\Component\Validator\Constraints\All({
     *     @Symfony\Component\Validator\Constraints\Type(type="string")
     * })
     */
    protected $fieldSets;

    /**
     * @inheritdoc
     */
    public function getIncludePaths()
    {
        return $this->includePaths;
    }

    /**
     * Sets include paths
     *
     * @param string[]|null $paths
     * @return $this
     */
    public function setIncludePaths(array $paths = null)
    {
        $this->includePaths = $paths;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getFieldSets()
    {
        return $this->fieldSets;
    }

    /**
     * @inheritdoc
     */
    public function getFieldSet($type)
    {
        return (isset($this->fieldSets[$type])) ? $this->fieldSets[$type] : null;

    }

    /**
     * @param \array[]|null $fieldSets
     * @return $this
     */
    public function setFieldSets(array $fieldSets = null)
    {
        $this->fieldSets = $fieldSets;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getSortParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getPaginationParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getFilteringParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getUnrecognizedParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function isEmpty()
    {
        if (empty($this->getIncludePaths()) &&
            empty($this->getFieldSets()) &&
            empty($this->getSortParameters()) &&
            empty($this->getPaginationParameters()) &&
            empty($this->getFilteringParameters())
        ) {
            return true;
        }

        return false;
    }

    /**
     * Parse value of parameter that store include paths
     * which should be included into response
     *
     * @param string|null $value
     * @return array|null
     */
    public function parseIncludePaths($value = null) {
        if (empty($value)) {
            return null;
        }

        if (!is_string($value)) {
            throw new \InvalidArgumentException('Include paths value must be a string', 400);
        }

        return explode(',', $value);
    }

    /**
     * Parse value of parameter that store fields which
     * should be included into response
     *
     * @param array|null $value
     * @return array|null
     */
    public function parseFieldSets($value = null) {
        if (empty($value)) {
            return null;
        }

        if (!is_array($value)) {
            throw new \InvalidArgumentException('Field sets value must be an array', 400);
        }

        foreach ($value as $resource => $fields) {
            $value[$resource] = explode(',', $fields);
        }

        return $value;
    }

    /**
     * Validate specified include paths
     *
     * @param ExecutionContextInterface $context
     * @Symfony\Component\Validator\Constraints\Callback()
     */
    public function validateIncludePaths(ExecutionContextInterface $context)
    {
        if (!is_array($this->includePaths)) {
            return;
        }

        $invalidPaths = array_diff($this->includePaths, $this->getAllowedIncludePaths());
        if (count($invalidPaths) > 0) {

            $context
                ->buildViolation('Invalid include paths: %paths%')
                ->setParameter('%paths%', sprintf("'%s'", implode("', '", $invalidPaths)))
                ->setPlural(count($invalidPaths))
                ->setInvalidValue($invalidPaths)
                ->setCode(self::INVALID_INCLUDE_PATHS)
                ->atPath('includePaths')
                ->addViolation();
        }
    }

    /**
     * Validate specified fields sets
     *
     * @param ExecutionContextInterface $context
     * @Symfony\Component\Validator\Constraints\Callback()
     */
    public function validateFieldSets(ExecutionContextInterface $context)
    {
        if (!is_array($this->fieldSets)) {
            return;
        }

        foreach ($this->fieldSets as $resource => $fields) {
            $invalidFields = array_diff($fields, $this->getAllowedFields($resource));

            if (count($invalidFields) > 0) {

                $context
                    ->buildViolation('Invalid fields: %fields%')
                    ->setParameter('%fields%', sprintf("'%s'", implode("', '", $invalidFields)))
                    ->setPlural(count($invalidFields))
                    ->setInvalidValue($invalidFields)
                    ->setCode(self::INVALID_FIELD_SET)
                    ->atPath('fieldSets.' . $resource)
                    ->addViolation();
            }
        }
    }

    /**
     * Returns list of allowed include paths
     *
     * @return string[]
     */
    protected function getAllowedIncludePaths()
    {
        return [];
    }

    /**
     * Returns list of fields available in specified resource
     *
     * @param string $resource
     * @return array[]
     */
    protected function getAllowedFields($resource)

    {
        return [];
    }
}


1			<?php
2			/*
3			* This file is part of the reva2/jsonapi.
4			*
5			* (c) OrbitScripts LLC <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11
12			namespace Reva2\JsonApi\Http\Query;
13
14			use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
15			use Symfony\Component\Validator\Context\ExecutionContextInterface;
16
17			/**
18			* JSON API single resource query parameters
19			*
20			* @package Reva2\JsonApi\Http\Query
21			* @author Sergey Revenko <[email protected]>
22			*
23			* @Reva2\JsonApi\Annotations\ApiObject()
24			*/
25			class QueryParameters implements EncodingParametersInterface
26			{
27			const INVALID_INCLUDE_PATHS = '9f4922b8-8e8b-4847-baf2-5831adfd6813';
28			const INVALID_FIELD_SET = 'ec7d2c6b-97d1-4f94-ba94-d141d985fc6f';
29
30			/**
31			* @var string[]\|null
32			* @Reva2\JsonApi\Annotations\Property(path="[include]", parser="parseIncludePaths")
33			* @Symfony\Component\Validator\Constraints\Type(type="array")
34			* @Symfony\Component\Validator\Constraints\All({
35			* @Symfony\Component\Validator\Constraints\Type(type="string")
36			* })
37			*/
38			protected $includePaths;
39
40			/**
41			* @var array[]\|null
42			* @Reva2\JsonApi\Annotations\Property(path="[fields]", parser="parseFieldSets")
43			* @Symfony\Component\Validator\Constraints\Type(type="array")
44			* @Symfony\Component\Validator\Constraints\All({
45			* @Symfony\Component\Validator\Constraints\Type(type="string")
46			* })
47			*/
48			protected $fieldSets;
49
50			/**
51			* @inheritdoc
52			*/
53	2		public function getIncludePaths()
54			{
55	2		return $this->includePaths;
56			}
57
58			/**
59			* Sets include paths
60			*
61			* @param string[]\|null $paths
62			* @return $this
63			*/
64	3		public function setIncludePaths(array $paths = null)
65			{
66	3		$this->includePaths = $paths;
67
68	3		return $this;
69			}
70
71			/**
72			* @inheritdoc
73			*/
74	1		public function getFieldSets()
75			{
76	1		return $this->fieldSets;
77			}
78
79			/**
80			* @inheritdoc
81			*/
82	1		public function getFieldSet($type)
83			{
84	1		return (isset($this->fieldSets[$type])) ? $this->fieldSets[$type] : null;
			1 ignored issue – show Bug Compatibility introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report The expression `isset($this->fieldSets[$...ieldSets[$type] : null;` of type `array\|null` adds the type `array` to the return on line 84 which is incompatible with the return type declared by the interface `Neomerx\JsonApi\Contract...sInterface::getFieldSet` of type `string[]\|null`. Loading history...
85			}
86
87			/**
88			* @param \array[]\|null $fieldSets
89			* @return $this
90			*/
91	3		public function setFieldSets(array $fieldSets = null)
92			{
93	3		$this->fieldSets = $fieldSets;
			0 ignored issues – show Documentation Bug introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report It seems like `$fieldSets` can also be of type `array<integer,object<array>>`. However, the property `$fieldSets` is declared as type `array<integer,array>\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
94
95	3		return $this;
96			}
97
98			/**
99			* @inheritdoc
100			*/
101	1		public function getSortParameters()
102			{
103	1		return null;
104			}
105
106			/**
107			* @inheritdoc
108			*/
109	1		public function getPaginationParameters()
110			{
111	1		return null;
112			}
113
114			/**
115			* @inheritdoc
116			*/
117	1		public function getFilteringParameters()
118			{
119	1		return null;
120			}
121
122			/**
123			* @inheritdoc
124			*/
125			public function getUnrecognizedParameters()
126			{
127			return null;
128			}
129
130			/**
131			* @inheritdoc
132			*/
133	1		public function isEmpty()
134			{
135	1		if (empty($this->getIncludePaths()) &&
136	1		empty($this->getFieldSets()) &&
137	1		empty($this->getSortParameters()) &&
138	1		empty($this->getPaginationParameters()) &&
139	1		empty($this->getFilteringParameters())
140	1		) {
141	1		return true;
142			}
143
144	1		return false;
145			}
146
147			/**
148			* Parse value of parameter that store include paths
149			* which should be included into response
150			*
151			* @param string\|null $value
152			* @return array\|null
153			*/
154	2		public function parseIncludePaths($value = null) {
155	2		if (empty($value)) {
156	1		return null;
157			}
158
159	2		if (!is_string($value)) {
160	1		throw new \InvalidArgumentException('Include paths value must be a string', 400);
161			}
162
163	1		return explode(',', $value);
164			}
165
166			/**
167			* Parse value of parameter that store fields which
168			* should be included into response
169			*
170			* @param array\|null $value
171			* @return array\|null
172			*/
173	2		public function parseFieldSets($value = null) {
174	2		if (empty($value)) {
175	1		return null;
176			}
177
178	2		if (!is_array($value)) {
179	1		throw new \InvalidArgumentException('Field sets value must be an array', 400);
180			}
181
182	1		foreach ($value as $resource => $fields) {
183	1		$value[$resource] = explode(',', $fields);
184	1		}
185
186	1		return $value;
187			}
188
189			/**
190			* Validate specified include paths
191			*
192			* @param ExecutionContextInterface $context
193			* @Symfony\Component\Validator\Constraints\Callback()
194			*/
195	1		public function validateIncludePaths(ExecutionContextInterface $context)
196			{
197	1		if (!is_array($this->includePaths)) {
198	1		return;
199			}
200
201	1		$invalidPaths = array_diff($this->includePaths, $this->getAllowedIncludePaths());
202	1	View Code Duplication	if (count($invalidPaths) > 0) {
			0 ignored issues – show Duplication introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
203			$context
204	1		->buildViolation('Invalid include paths: %paths%')
205	1		->setParameter('%paths%', sprintf("'%s'", implode("', '", $invalidPaths)))
206	1		->setPlural(count($invalidPaths))
207	1		->setInvalidValue($invalidPaths)
208	1		->setCode(self::INVALID_INCLUDE_PATHS)
209	1		->atPath('includePaths')
210	1		->addViolation();
211	1		}
212	1		}
213
214			/**
215			* Validate specified fields sets
216			*
217			* @param ExecutionContextInterface $context
218			* @Symfony\Component\Validator\Constraints\Callback()
219			*/
220	1		public function validateFieldSets(ExecutionContextInterface $context)
221			{
222	1		if (!is_array($this->fieldSets)) {
223	1		return;
224			}
225
226	1		foreach ($this->fieldSets as $resource => $fields) {
227	1		$invalidFields = array_diff($fields, $this->getAllowedFields($resource));
228
229	1	View Code Duplication	if (count($invalidFields) > 0) {
			0 ignored issues – show Duplication introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
230			$context
231	1		->buildViolation('Invalid fields: %fields%')
232	1		->setParameter('%fields%', sprintf("'%s'", implode("', '", $invalidFields)))
233	1		->setPlural(count($invalidFields))
234	1		->setInvalidValue($invalidFields)
235	1		->setCode(self::INVALID_FIELD_SET)
236	1		->atPath('fieldSets.' . $resource)
237	1		->addViolation();
238	1		}
239	1		}
240	1		}
241
242			/**
243			* Returns list of allowed include paths
244			*
245			* @return string[]
246			*/
247	1		protected function getAllowedIncludePaths()
248			{
249	1		return [];
250			}
251
252			/**
253			* Returns list of fields available in specified resource
254			*
255			* @param string $resource
256			* @return array[]
257			*/
258	1		protected function getAllowedFields($resource)
			0 ignored issues – show Unused Code introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report The parameter `$resource` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
259			{
260	1		return [];
261			}
262			}
263

reva2 / jsonapi

GitHub Access Token became invalid

Push — master ( fab3df...c703cd )

QueryParameters::validateFieldSets() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like