DocumentParser::getItemKey() - Code Metrics - Inspection of "Merge pull request #64 from swisnl/feature/validat..." - swisnl/json-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f23b05...de431b )

by Jasper

created 2019-10-04 14:04 UTC

DocumentParser::getItemKey() A

↳ Parent: DocumentParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Swis\JsonApi\Client\Parsers;

use Swis\JsonApi\Client\Collection;
use Swis\JsonApi\Client\CollectionDocument;
use Swis\JsonApi\Client\Document;
use Swis\JsonApi\Client\Exceptions\ValidationException;
use Swis\JsonApi\Client\Interfaces\DocumentInterface;
use Swis\JsonApi\Client\Interfaces\DocumentParserInterface;
use Swis\JsonApi\Client\Interfaces\ItemInterface;
use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;
use Swis\JsonApi\Client\Interfaces\OneRelationInterface;
use Swis\JsonApi\Client\ItemDocument;

class DocumentParser implements DocumentParserInterface
{
    /**
     * @var \Swis\JsonApi\Client\Parsers\ItemParser
     */
    private $itemParser;

    /**
     * @var \Swis\JsonApi\Client\Parsers\CollectionParser
     */
    private $collectionParser;

    /**
     * @var \Swis\JsonApi\Client\Parsers\ErrorCollectionParser
     */
    private $errorCollectionParser;

    /**
     * @var \Swis\JsonApi\Client\Parsers\LinksParser
     */
    private $linksParser;

    /**
     * @var \Swis\JsonApi\Client\Parsers\JsonapiParser
     */
    private $jsonapiParser;

    /**
     * @var \Swis\JsonApi\Client\Parsers\MetaParser
     */
    private $metaParser;

    /**
     * @param \Swis\JsonApi\Client\Parsers\ItemParser            $itemParser
     * @param \Swis\JsonApi\Client\Parsers\CollectionParser      $collectionParser
     * @param \Swis\JsonApi\Client\Parsers\ErrorCollectionParser $errorCollectionParser
     * @param \Swis\JsonApi\Client\Parsers\LinksParser           $linksParser
     * @param \Swis\JsonApi\Client\Parsers\JsonapiParser         $jsonapiParser
     * @param \Swis\JsonApi\Client\Parsers\MetaParser            $metaParser
     */
    public function __construct(
        ItemParser $itemParser,
        CollectionParser $collectionParser,
        ErrorCollectionParser $errorCollectionParser,
        LinksParser $linksParser,
        JsonapiParser $jsonapiParser,
        MetaParser $metaParser
    ) {
        $this->itemParser = $itemParser;
        $this->collectionParser = $collectionParser;
        $this->errorCollectionParser = $errorCollectionParser;
        $this->linksParser = $linksParser;
        $this->jsonapiParser = $jsonapiParser;
        $this->metaParser = $metaParser;
    }

    /**
     * @param string $json
     *
     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
     */
    public function parse(string $json): DocumentInterface
    {
        $data = $this->decodeJson($json);

        if (!is_object($data)) {
            throw new ValidationException(sprintf('Document MUST be an object, "%s" given.', gettype($data)));
        }
        if (!property_exists($data, 'data') && !property_exists($data, 'errors') && !property_exists($data, 'meta')) {
            throw new ValidationException('Document MUST contain at least one of the following properties: `data`, `errors`, `meta`.');
        }
        if (property_exists($data, 'data') && property_exists($data, 'errors')) {
            throw new ValidationException('The properties `data` and `errors` MUST NOT coexist in Document.');
        }
        if (!property_exists($data, 'data') && property_exists($data, 'included')) {
            throw new ValidationException('If Document does not contain a `data` property, the `included` property MUST NOT be present either.');
        }
        if (property_exists($data, 'data') && !is_object($data->data) && !is_array($data->data) && $data->data !== null) {
            throw new ValidationException(sprintf('Document property "data" MUST be null, an array or an object, "%s" given.', gettype($data->data)));
        }
        if (property_exists($data, 'included') && !is_array($data->included)) {
            throw new ValidationException(sprintf('Document property "included" MUST be an array, "%s" given.', gettype($data->included)));
        }

        $document = $this->getDocument($data);

        if (property_exists($data, 'links')) {
            $document->setLinks($this->linksParser->parse($data->links, LinksParser::SOURCE_DOCUMENT));
        }

        if (property_exists($data, 'errors')) {
            $document->setErrors($this->errorCollectionParser->parse($data->errors));
        }

        if (property_exists($data, 'meta')) {
            $document->setMeta($this->metaParser->parse($data->meta));
        }

        if (property_exists($data, 'jsonapi')) {
            $document->setJsonapi($this->jsonapiParser->parse($data->jsonapi));
        }

        return $document;
    }

    /**
     * @param string $json
     *
     * @return mixed
     */
    private function decodeJson(string $json)
    {
        $data = json_decode($json, false);

        if (json_last_error() !== JSON_ERROR_NONE) {
            throw new ValidationException(sprintf('Unable to parse JSON data: %s', json_last_error_msg()), json_last_error());
        }

        return $data;
    }

    /**
     * @param mixed $data
     *
     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
     */
    private function getDocument($data): DocumentInterface
    {
        if (!property_exists($data, 'data') || $data->data === null) {
            return new Document();
        }

        if (is_array($data->data)) {
            $document = (new CollectionDocument())
                ->setData($this->collectionParser->parse($data->data));
        } else {
            $document = (new ItemDocument())
                ->setData($this->itemParser->parse($data->data));
        }

        if (property_exists($data, 'included')) {
            $document->setIncluded($this->collectionParser->parse($data->included));
        }

        $allItems = Collection::wrap($document->getData())
            ->concat($document->getIncluded());

        $duplicateItems = $this->getDuplicateItems($allItems);

        if ($duplicateItems->isNotEmpty()) {
            throw new ValidationException(sprintf('Resources MUST be unique based on their `type` and `id`, %d duplicate(s) found.', $duplicateItems->count()));
        }

        $this->linkRelationships($allItems);

        return $document;
    }

    /**
     * @param \Swis\JsonApi\Client\Collection $items
     */
    private function linkRelationships(Collection $items): void
    {
        $keyedItems = $items->keyBy(
            function (ItemInterface $item) {
                return $this->getItemKey($item);
            }
        );

        $items->each(
            function (ItemInterface $item) use ($keyedItems) {
                foreach ($item->getRelations() as $name => $relation) {
                    if ($relation instanceof OneRelationInterface) {
                        /** @var \Swis\JsonApi\Client\Interfaces\ItemInterface|null $relatedItem */
                        $relatedItem = $relation->getIncluded();

                        if ($relatedItem === null) {
                            continue;
                        }

                        $includedItem = $this->getItem($keyedItems, $relatedItem);
                        if ($includedItem !== null) {
                            $relation->associate($includedItem);
                        }
                    } elseif ($relation instanceof ManyRelationInterface) {
                        /** @var \Swis\JsonApi\Client\Collection $relatedCollection */
                        $relatedCollection = $relation->getIncluded();

                        /** @var \Swis\JsonApi\Client\Interfaces\ItemInterface $relatedItem */
                        foreach ($relatedCollection as $key => $relatedItem) {
                            $includedItem = $this->getItem($keyedItems, $relatedItem);
                            if ($includedItem !== null) {
                                $relatedCollection->put($key, $includedItem);
                            }
                        }
                    }
                }
            }
        );
    }

    /**
     * @param \Swis\JsonApi\Client\Collection               $included
     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
     *
     * @return \Swis\JsonApi\Client\Interfaces\ItemInterface|null
     */
    private function getItem(Collection $included, ItemInterface $item): ?ItemInterface
    {
        return $included->get($this->getItemKey($item));
    }

    /**
     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
     *
     * @return string
     */
    private function getItemKey(ItemInterface $item): string
    {
        return sprintf('%s:%s', $item->getType(), $item->getId());
    }

    /**
     * @param \Swis\JsonApi\Client\Collection $items
     *
     * @return \Swis\JsonApi\Client\Collection
     */
    private function getDuplicateItems(Collection $items): Collection
    {
        $valueRetriever = function (ItemInterface $item) {
            return $this->getItemKey($item);
        };

        // Collection->duplicates was introduced in Laravel 5.8
        if (method_exists($items, 'duplicates')) {
            return $items->duplicates($valueRetriever);
        }

        /*
         * Duplicates code copied, and simplified for our use case, from Laravel 6.
         *
         * @see https://github.com/laravel/framework/blob/v6.1.0/src/Illuminate/Support/Collection.php#L275
         */
        $values = $items->map($valueRetriever);

        $uniqueValues = $values->unique();

        $compare = static function ($a, $b) {
            return $a === $b;
        };

        $duplicates = new Collection();

        foreach ($values as $key => $value) {
            if ($uniqueValues->isNotEmpty() && $compare($value, $uniqueValues->first())) {
                $uniqueValues->shift();
            } else {
                $duplicates[$key] = $value;
            }
        }

        return $duplicates;
    }
}


1		<?php
2
3		namespace Swis\JsonApi\Client\Parsers;
4
5		use Swis\JsonApi\Client\Collection;
6		use Swis\JsonApi\Client\CollectionDocument;
7		use Swis\JsonApi\Client\Document;
8		use Swis\JsonApi\Client\Exceptions\ValidationException;
9		use Swis\JsonApi\Client\Interfaces\DocumentInterface;
10		use Swis\JsonApi\Client\Interfaces\DocumentParserInterface;
11		use Swis\JsonApi\Client\Interfaces\ItemInterface;
12		use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;
13		use Swis\JsonApi\Client\Interfaces\OneRelationInterface;
14		use Swis\JsonApi\Client\ItemDocument;
15
16		class DocumentParser implements DocumentParserInterface
17		{
18		/**
19		* @var \Swis\JsonApi\Client\Parsers\ItemParser
20		*/
21		private $itemParser;
22
23		/**
24		* @var \Swis\JsonApi\Client\Parsers\CollectionParser
25		*/
26		private $collectionParser;
27
28		/**
29		* @var \Swis\JsonApi\Client\Parsers\ErrorCollectionParser
30		*/
31		private $errorCollectionParser;
32
33		/**
34		* @var \Swis\JsonApi\Client\Parsers\LinksParser
35		*/
36		private $linksParser;
37
38		/**
39		* @var \Swis\JsonApi\Client\Parsers\JsonapiParser
40		*/
41		private $jsonapiParser;
42
43		/**
44		* @var \Swis\JsonApi\Client\Parsers\MetaParser
45		*/
46		private $metaParser;
47
48		/**
49		* @param \Swis\JsonApi\Client\Parsers\ItemParser $itemParser
50		* @param \Swis\JsonApi\Client\Parsers\CollectionParser $collectionParser
51		* @param \Swis\JsonApi\Client\Parsers\ErrorCollectionParser $errorCollectionParser
52		* @param \Swis\JsonApi\Client\Parsers\LinksParser $linksParser
53		* @param \Swis\JsonApi\Client\Parsers\JsonapiParser $jsonapiParser
54		* @param \Swis\JsonApi\Client\Parsers\MetaParser $metaParser
55		*/
56	231	public function __construct(
57		ItemParser $itemParser,
58		CollectionParser $collectionParser,
59		ErrorCollectionParser $errorCollectionParser,
60		LinksParser $linksParser,
61		JsonapiParser $jsonapiParser,
62		MetaParser $metaParser
63		) {
64	231	$this->itemParser = $itemParser;
65	231	$this->collectionParser = $collectionParser;
66	231	$this->errorCollectionParser = $errorCollectionParser;
67	231	$this->linksParser = $linksParser;
68	231	$this->jsonapiParser = $jsonapiParser;
69	231	$this->metaParser = $metaParser;
70	231	}
71
72		/**
73		* @param string $json
74		*
75		* @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
76		*/
77	231	public function parse(string $json): DocumentInterface
78		{
79	231	$data = $this->decodeJson($json);
80
81	224	if (!is_object($data)) {
82	42	throw new ValidationException(sprintf('Document MUST be an object, "%s" given.', gettype($data)));
83		}
84	182	if (!property_exists($data, 'data') && !property_exists($data, 'errors') && !property_exists($data, 'meta')) {
85	7	throw new ValidationException('Document MUST contain at least one of the following properties: `data`, `errors`, `meta`.');
86		}
87	175	if (property_exists($data, 'data') && property_exists($data, 'errors')) {
88	7	throw new ValidationException('The properties `data` and `errors` MUST NOT coexist in Document.');
89		}
90	168	if (!property_exists($data, 'data') && property_exists($data, 'included')) {
91	7	throw new ValidationException('If Document does not contain a `data` property, the `included` property MUST NOT be present either.');
92		}
93	161	if (property_exists($data, 'data') && !is_object($data->data) && !is_array($data->data) && $data->data !== null) {
94	28	throw new ValidationException(sprintf('Document property "data" MUST be null, an array or an object, "%s" given.', gettype($data->data)));
95		}
96	133	if (property_exists($data, 'included') && !is_array($data->included)) {
97	42	throw new ValidationException(sprintf('Document property "included" MUST be an array, "%s" given.', gettype($data->included)));
98		}
99
100	91	$document = $this->getDocument($data);
101
102	91	if (property_exists($data, 'links')) {
103	7	$document->setLinks($this->linksParser->parse($data->links, LinksParser::SOURCE_DOCUMENT));
104		}
105
106	91	if (property_exists($data, 'errors')) {
107	7	$document->setErrors($this->errorCollectionParser->parse($data->errors));
108		}
109
110	91	if (property_exists($data, 'meta')) {
111	14	$document->setMeta($this->metaParser->parse($data->meta));
112		}
113
114	91	if (property_exists($data, 'jsonapi')) {
115	7	$document->setJsonapi($this->jsonapiParser->parse($data->jsonapi));
116		}
117
118	91	return $document;
119		}
120
121		/**
122		* @param string $json
123		*
124		* @return mixed
125		*/
126	231	private function decodeJson(string $json)
127		{
128	231	$data = json_decode($json, false);
129
130	231	if (json_last_error() !== JSON_ERROR_NONE) {
131	7	throw new ValidationException(sprintf('Unable to parse JSON data: %s', json_last_error_msg()), json_last_error());
132		}
133
134	224	return $data;
135		}
136
137		/**
138		* @param mixed $data
139		*
140		* @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
141		*/
142	91	private function getDocument($data): DocumentInterface
143		{
144	91	if (!property_exists($data, 'data') \|\| $data->data === null) {
145	14	return new Document();
146		}
147
148	77	if (is_array($data->data)) {
149	42	$document = (new CollectionDocument())
150	42	->setData($this->collectionParser->parse($data->data));
151		} else {
152	35	$document = (new ItemDocument())
153	35	->setData($this->itemParser->parse($data->data));
154		}
155
156	77	if (property_exists($data, 'included')) {
157	35	$document->setIncluded($this->collectionParser->parse($data->included));
158		}
159
160	77	$allItems = Collection::wrap($document->getData())
161	77	->concat($document->getIncluded());
162
163	77	$duplicateItems = $this->getDuplicateItems($allItems);
164
165	77	if ($duplicateItems->isNotEmpty()) {
166		throw new ValidationException(sprintf('Resources MUST be unique based on their `type` and `id`, %d duplicate(s) found.', $duplicateItems->count()));
167		}
168
169		$this->linkRelationships($allItems);
170
171	77	return $document;
172		}
173
174	77	/**
175	22	* @param \Swis\JsonApi\Client\Collection $items
176	49	*/
177	77	private function linkRelationships(Collection $items): void
178		{
179		$keyedItems = $items->keyBy(
180	77	function (ItemInterface $item) {
181	22	return $this->getItemKey($item);
182	49	}
183	28	);
184
185	14	$items->each(
186		function (ItemInterface $item) use ($keyedItems) {
187	14	foreach ($item->getRelations() as $name => $relation) {
188	7	if ($relation instanceof OneRelationInterface) {
189		/** @var \Swis\JsonApi\Client\Interfaces\ItemInterface\|null $relatedItem */
190		$relatedItem = $relation->getIncluded();
191	7
192	7	if ($relatedItem === null) {
193	7	continue;
194		}
195	14
196		$includedItem = $this->getItem($keyedItems, $relatedItem);
197	14	if ($includedItem !== null) {
198		$relation->associate($includedItem);
199		}
200	14	} elseif ($relation instanceof ManyRelationInterface) {
201	7	/** @var \Swis\JsonApi\Client\Collection $relatedCollection */
202	7	$relatedCollection = $relation->getIncluded();
203	9
204		/** @var \Swis\JsonApi\Client\Interfaces\ItemInterface $relatedItem */
205		foreach ($relatedCollection as $key => $relatedItem) {
206		$includedItem = $this->getItem($keyedItems, $relatedItem);
207		if ($includedItem !== null) {
208	77	$relatedCollection->put($key, $includedItem);
209		}
210	77	}
211		}
212		}
213		}
214		);
215		}
216
217		/**
218	14	* @param \Swis\JsonApi\Client\Collection $included
219		* @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
220	14	*
221		* @return \Swis\JsonApi\Client\Interfaces\ItemInterface\|null
222		*/
223		private function getItem(Collection $included, ItemInterface $item): ?ItemInterface
224		{
225		return $included->get($this->getItemKey($item));
226		}
227
228	49	/**
229		* @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
230	49	*
231		* @return string
232		*/
233		private function getItemKey(ItemInterface $item): string
234		{
235		return sprintf('%s:%s', $item->getType(), $item->getId());
236		}
237
238		/**
239		* @param \Swis\JsonApi\Client\Collection $items
240		*
241		* @return \Swis\JsonApi\Client\Collection
242		*/
243		private function getDuplicateItems(Collection $items): Collection
244		{
245		$valueRetriever = function (ItemInterface $item) {
246		return $this->getItemKey($item);
247		};
248
249		// Collection->duplicates was introduced in Laravel 5.8
250		if (method_exists($items, 'duplicates')) {
251		return $items->duplicates($valueRetriever);
252		}
253
254		/*
255		* Duplicates code copied, and simplified for our use case, from Laravel 6.
256		*
257		* @see https://github.com/laravel/framework/blob/v6.1.0/src/Illuminate/Support/Collection.php#L275
258		*/
259		$values = $items->map($valueRetriever);
260
261		$uniqueValues = $values->unique();
262
263		$compare = static function ($a, $b) {
264		return $a === $b;
265		};
266
267		$duplicates = new Collection();
268
269		foreach ($values as $key => $value) {
270		if ($uniqueValues->isNotEmpty() && $compare($value, $uniqueValues->first())) {
271		$uniqueValues->shift();
272		} else {
273		$duplicates[$key] = $value;
274		}
275		}
276
277		return $duplicates;
278		}
279		}
280

swisnl / json-api-client

Push — master ( f23b05...de431b )

DocumentParser::getItemKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like