DocumentParser::__construct() - Code Metrics - Inspection of "Add factory methods for DocumentClient, ResponsePa..." - swisnl/json-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#79)

by Jasper

created 2020-09-25 13:05 UTC

DocumentParser::__construct() A

↳ Parent: DocumentParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	6
c	0
b	0
f	0
nc	1
nop	6
dl	0
loc	14
ccs	7
cts	7
cp	1
crap	1
rs	10

<?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\Interfaces\TypeMapperInterface;
use Swis\JsonApi\Client\ItemDocument;
use Swis\JsonApi\Client\TypeMapper;

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 \Swis\JsonApi\Client\Interfaces\TypeMapperInterface|null $typeMapper
     *
     * @return static
     */
    public static function create(TypeMapperInterface $typeMapper = null): self
    {
        $metaParser = new MetaParser();
        $linksParser = new LinksParser($metaParser);
        $itemParser = new ItemParser($typeMapper ?? new TypeMapper(), $linksParser, $metaParser);

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

swisnl / json-api-client

Pull Request — master (#79)

DocumentParser::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like