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

Completed

Push — master ( 52b2ea...d5cfd4 )

by Jasper

created 2019-07-22 12:20 UTC

DocumentParser::parseMeta() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	1
dl	0
loc	7
ccs	4
cts	4
cp	1
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 has to 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" has to be null, an array or an object, "%s" given.', gettype($data)));
        }

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

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

        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());

        $this->linkRelationships($allItems);

        return $document;
    }

    /**
     * @param \Swis\JsonApi\Client\Collection $items
     */
    private function linkRelationships(Collection $items): void
    {
        // N.B. We reverse the items to make sure the first item in the collection takes precedence
        $keyedItems = $items->reverse()->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 $relatedItem */
                        $relatedItem = $relation->getIncluded();

                        $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());
    }
}


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	156	public function __construct(
57		ItemParser $itemParser,
58		CollectionParser $collectionParser,
59		ErrorCollectionParser $errorCollectionParser,
60		LinksParser $linksParser,
61		JsonapiParser $jsonapiParser,
62		MetaParser $metaParser
63		) {
64	156	$this->itemParser = $itemParser;
65	156	$this->collectionParser = $collectionParser;
66	156	$this->errorCollectionParser = $errorCollectionParser;
67	156	$this->linksParser = $linksParser;
68	156	$this->jsonapiParser = $jsonapiParser;
69	156	$this->metaParser = $metaParser;
70	156	}
71
72		/**
73		* @param string $json
74		*
75		* @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
76		*/
77	156	public function parse(string $json): DocumentInterface
78		{
79	156	$data = $this->decodeJson($json);
80
81	144	if (!is_object($data)) {
82	36	throw new ValidationException(sprintf('Document has to be an object, "%s" given.', gettype($data)));
83		}
84	108	if (!property_exists($data, 'data') && !property_exists($data, 'errors') && !property_exists($data, 'meta')) {
85	6	throw new ValidationException('Document MUST contain at least one of the following properties: `data`, `errors`, `meta`.');
86		}
87	102	if (property_exists($data, 'data') && property_exists($data, 'errors')) {
88	6	throw new ValidationException('The properties `data` and `errors` MUST NOT coexist in Document.');
89		}
90	96	if (!property_exists($data, 'data') && property_exists($data, 'included')) {
91	6	throw new ValidationException('If Document does not contain a `data` property, the `included` property MUST NOT be present either.');
92		}
93	90	if (property_exists($data, 'data') && !is_object($data->data) && !is_array($data->data) && $data->data !== null) {
94	24	throw new ValidationException(sprintf('Document property "data" has to be null, an array or an object, "%s" given.', gettype($data)));
95		}
96
97	66	$document = $this->getDocument($data);
98
99	66	if (property_exists($data, 'links')) {
100	6	$document->setLinks($this->linksParser->parse($data->links));
101		}
102
103	66	if (property_exists($data, 'errors')) {
104	6	$document->setErrors($this->errorCollectionParser->parse($data->errors));
105		}
106
107	66	if (property_exists($data, 'meta')) {
108	12	$document->setMeta($this->metaParser->parse($data->meta));
109		}
110
111	66	if (property_exists($data, 'jsonapi')) {
112	6	$document->setJsonapi($this->jsonapiParser->parse($data->jsonapi));
113		}
114
115	66	return $document;
116		}
117
118		/**
119		* @param string $json
120		*
121		* @return mixed
122		*/
123	156	private function decodeJson(string $json)
124		{
125	156	$data = json_decode($json, false);
126
127	156	if (json_last_error() !== JSON_ERROR_NONE) {
128	12	throw new ValidationException(sprintf('Unable to parse JSON data: %s', json_last_error_msg()), json_last_error());
129		}
130
131	144	return $data;
132		}
133
134		/**
135		* @param mixed $data
136		*
137		* @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
138		*/
139	66	private function getDocument($data): DocumentInterface
140		{
141	66	if (!property_exists($data, 'data') \|\| $data->data === null) {
142	12	return new Document();
143		}
144
145	54	if (is_array($data->data)) {
146	36	$document = (new CollectionDocument())
147	36	->setData($this->collectionParser->parse($data->data));
148		} else {
149	18	$document = (new ItemDocument())
150	18	->setData($this->itemParser->parse($data->data));
151		}
152
153	54	if (property_exists($data, 'included')) {
154	18	$document->setIncluded($this->collectionParser->parse($data->included));
155		}
156
157	54	$allItems = Collection::wrap($document->getData())
158	54	->concat($document->getIncluded());
159
160	54	$this->linkRelationships($allItems);
161
162	54	return $document;
163		}
164
165		/**
166		* @param \Swis\JsonApi\Client\Collection $items
167		*/
168	54	private function linkRelationships(Collection $items): void
169		{
170		// N.B. We reverse the items to make sure the first item in the collection takes precedence
171	54	$keyedItems = $items->reverse()->keyBy(
172	18	function (ItemInterface $item) {
173	30	return $this->getItemKey($item);
174	54	}
175		);
176
177	54	$items->each(
178	18	function (ItemInterface $item) use ($keyedItems) {
179	30	foreach ($item->getRelations() as $name => $relation) {
180	12	if ($relation instanceof OneRelationInterface) {
181		/** @var \Swis\JsonApi\Client\Interfaces\ItemInterface $relatedItem */
182	6	$relatedItem = $relation->getIncluded();
183
184	6	$includedItem = $this->getItem($keyedItems, $relatedItem);
185	6	if ($includedItem !== null) {
186	6	$relation->associate($includedItem);
187		}
188	6	} elseif ($relation instanceof ManyRelationInterface) {
189		/** @var \Swis\JsonApi\Client\Collection $relatedCollection */
190	6	$relatedCollection = $relation->getIncluded();
191
192		/** @var \Swis\JsonApi\Client\Interfaces\ItemInterface $relatedItem */
193	6	foreach ($relatedCollection as $key => $relatedItem) {
194	6	$includedItem = $this->getItem($keyedItems, $relatedItem);
195	6	if ($includedItem !== null) {
196	7	$relatedCollection->put($key, $includedItem);
197		}
198		}
199		}
200		}
201	54	}
202		);
203	54	}
204
205		/**
206		* @param \Swis\JsonApi\Client\Collection $included
207		* @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
208		*
209		* @return \Swis\JsonApi\Client\Interfaces\ItemInterface\|null
210		*/
211	12	private function getItem(Collection $included, ItemInterface $item): ?ItemInterface
212		{
213	12	return $included->get($this->getItemKey($item));
214		}
215
216		/**
217		* @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
218		*
219		* @return string
220		*/
221	30	private function getItemKey(ItemInterface $item): string
222		{
223	30	return sprintf('%s:%s', $item->getType(), $item->getId());
224		}
225		}
226

swisnl / json-api-client

Push — master ( 52b2ea...d5cfd4 )

DocumentParser::parseMeta() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like