DocumentBuilder::build() - Code Metrics - Inspection of "JsonApiViewListener refactored: Document builder a..." - mikemirten/JsonApi-Bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 20fa94...bcb279 )

by Michael

created 2017-06-30 20:05 UTC

DocumentBuilder::build() A

↳ Parent: DocumentBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	7
cts	7
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1
crap	2

<?php
declare(strict_types = 1);

namespace Mikemirten\Bundle\JsonApiBundle\Builder;

use Mikemirten\Component\JsonApi\Mapper\Handler\LinkRepository\RepositoryProvider;
use Mikemirten\Component\JsonApi\Mapper\ObjectMapper;
use Mikemirten\Bundle\JsonApiBundle\Response\{
    Behaviour\IncludedObjectsAwareInterface,
    AbstractJsonApiView,
    JsonApiIteratorView,
    JsonApiObjectView
};
use Mikemirten\Component\JsonApi\Document\{
    AbstractDocument,
    SingleResourceDocument,
    ResourceCollectionDocument,
    ResourceObject,
    JsonApiObject,
    LinkObject
};

/**
 * JSON API Document builder
 *
 * @package DocumentBuilder
 */
class DocumentBuilder
{
    /**
     * @var ObjectMapper
     */
    protected $mapper;

    /**
     * Link-repositories provider
     *
     * @var RepositoryProvider
     */
    protected $repositoryProvider;

    /**
     * Builder constructor.
     *
     * @param ObjectMapper       $mapper
     * @param RepositoryProvider $repositoryProvider
     */
    public function __construct(ObjectMapper $mapper, RepositoryProvider $repositoryProvider)
    {
        $this->mapper             = $mapper;
        $this->repositoryProvider = $repositoryProvider;
    }

    /**
     * Build a document by a view
     *
     * @param  AbstractJsonApiView $view
     * @return AbstractDocument
     */
    public function build(AbstractJsonApiView $view): AbstractDocument
    {
        $document = $this->createDocument($view);

        $this->handleIncludedResources($document, $view);
        $this->handleDocumentLinks($document, $view);

        if ($view->hasDocumentCallback()) {
            ($view->getDocumentCallback())($document);
        }

        return $document;
    }

    /**
     * Create a document by a view
     *
     * @param  AbstractJsonApiView $view
     * @return AbstractDocument
     */
    protected function createDocument(AbstractJsonApiView $view): AbstractDocument
    {
        if ($view instanceof JsonApiObjectView) {
            return $this->createSingleResourceDocument($view);
        }

        if ($view instanceof JsonApiIteratorView) {
            return $this->createCollectionDocument($view);
        }

        throw new \LogicException('Unknown extension of AbstractJsonApiView cannot be processed: ' . get_class($view));
    }

    /**
     * Handle single object Json API view
     *
     * @param  JsonApiObjectView $view
     * @return SingleResourceDocument
     */
    protected function createSingleResourceDocument(JsonApiObjectView $view): SingleResourceDocument
    {
        $resource = $this->handleObject($view->getObject());

        if ($view->hasResourceCallback()) {
            ($view->getResourceCallback())($resource);
        }

        $document = new SingleResourceDocument($resource);
        $document->setJsonApi(new JsonApiObject());

        return $document;
    }

    /**
     * Handle object-iterator
     *
     * @param  JsonApiIteratorView $view
     * @return ResourceCollectionDocument
     */
    protected function createCollectionDocument(JsonApiIteratorView $view): ResourceCollectionDocument
    {
        $document = new ResourceCollectionDocument();
        $document->setJsonApi(new JsonApiObject());

        foreach ($view as $object)
        {
            $resource = $this->handleObject($object);

            if ($view->hasResourceCallback()) {
                ($view->getResourceCallback())($resource);
            }

            $document->addResource($resource);
        }

        return $document;
    }

    /**
     * Handle object
     *
     * @param  $object
     * @return ResourceObject
     */
    protected function handleObject($object): ResourceObject
    {
        if ($object instanceof ResourceObject) {
            return $object;
        }

        return $this->mapper->toResource($object);
    }

    /**
     * Handle supposed to be included to document resources
     *
     * @param AbstractDocument              $document
     * @param IncludedObjectsAwareInterface $view
     */
    protected function handleIncludedResources(AbstractDocument $document, IncludedObjectsAwareInterface $view)
    {
        foreach ($view->getIncludedObjects() as $object)
        {
            $resource = $this->handleObject($object);
            $document->addIncludedResource($resource);
        }
    }

    /**
     * Handle links of document
     *
     * @param AbstractJsonApiView $view
     * @param AbstractDocument    $document
     */
    protected function handleDocumentLinks(AbstractDocument $document, AbstractJsonApiView $view)
    {
        foreach ($view->getDocumentLinks() as $definition)
        {
            $repositoryName = $definition->getRepositoryName();
            $linkName       = $definition->getLinkName();
            $parameters     = $definition->getParameters();

            $linkData = $this->repositoryProvider
                ->getRepository($repositoryName)
                ->getLink($linkName, $parameters);

            $metadata = array_replace(
                $linkData->getMetadata(),
                $definition->getMetadata()
            );

            $link = new LinkObject($linkData->getReference(), $metadata);

            $document->setLink($definition->getName(), $link);
        }
    }
}

1		<?php
2		declare(strict_types = 1);
3
4		namespace Mikemirten\Bundle\JsonApiBundle\Builder;
5
6		use Mikemirten\Component\JsonApi\Mapper\Handler\LinkRepository\RepositoryProvider;
7		use Mikemirten\Component\JsonApi\Mapper\ObjectMapper;
8		use Mikemirten\Bundle\JsonApiBundle\Response\{
9		Behaviour\IncludedObjectsAwareInterface,
10		AbstractJsonApiView,
11		JsonApiIteratorView,
12		JsonApiObjectView
13		};
14		use Mikemirten\Component\JsonApi\Document\{
15		AbstractDocument,
16		SingleResourceDocument,
17		ResourceCollectionDocument,
18		ResourceObject,
19		JsonApiObject,
20		LinkObject
21		};
22
23		/**
24		* JSON API Document builder
25		*
26		* @package DocumentBuilder
27		*/
28		class DocumentBuilder
29		{
30		/**
31		* @var ObjectMapper
32		*/
33		protected $mapper;
34
35		/**
36		* Link-repositories provider
37		*
38		* @var RepositoryProvider
39		*/
40		protected $repositoryProvider;
41
42		/**
43		* Builder constructor.
44		*
45		* @param ObjectMapper $mapper
46		* @param RepositoryProvider $repositoryProvider
47		*/
48	10	public function __construct(ObjectMapper $mapper, RepositoryProvider $repositoryProvider)
49		{
50	10	$this->mapper = $mapper;
51	10	$this->repositoryProvider = $repositoryProvider;
52	10	}
53
54		/**
55		* Build a document by a view
56		*
57		* @param AbstractJsonApiView $view
58		* @return AbstractDocument
59		*/
60	9	public function build(AbstractJsonApiView $view): AbstractDocument
61		{
62	9	$document = $this->createDocument($view);
63
64	9	$this->handleIncludedResources($document, $view);
65	9	$this->handleDocumentLinks($document, $view);
66
67	9	if ($view->hasDocumentCallback()) {
68	2	($view->getDocumentCallback())($document);
69		}
70
71	9	return $document;
72		}
73
74		/**
75		* Create a document by a view
76		*
77		* @param AbstractJsonApiView $view
78		* @return AbstractDocument
79		*/
80	9	protected function createDocument(AbstractJsonApiView $view): AbstractDocument
81		{
82	9	if ($view instanceof JsonApiObjectView) {
83	5	return $this->createSingleResourceDocument($view);
84		}
85
86	4	if ($view instanceof JsonApiIteratorView) {
87	4	return $this->createCollectionDocument($view);
88		}
89
90		throw new \LogicException('Unknown extension of AbstractJsonApiView cannot be processed: ' . get_class($view));
91		}
92
93		/**
94		* Handle single object Json API view
95		*
96		* @param JsonApiObjectView $view
97		* @return SingleResourceDocument
98		*/
99	5	protected function createSingleResourceDocument(JsonApiObjectView $view): SingleResourceDocument
100		{
101	5	$resource = $this->handleObject($view->getObject());
102
103	5	if ($view->hasResourceCallback()) {
104	1	($view->getResourceCallback())($resource);
105		}
106
107	5	$document = new SingleResourceDocument($resource);
108	5	$document->setJsonApi(new JsonApiObject());
109
110	5	return $document;
111		}
112
113		/**
114		* Handle object-iterator
115		*
116		* @param JsonApiIteratorView $view
117		* @return ResourceCollectionDocument
118		*/
119	4	protected function createCollectionDocument(JsonApiIteratorView $view): ResourceCollectionDocument
120		{
121	4	$document = new ResourceCollectionDocument();
122	4	$document->setJsonApi(new JsonApiObject());
123
124	4	foreach ($view as $object)
125		{
126	3	$resource = $this->handleObject($object);
127
128	3	if ($view->hasResourceCallback()) {
129	1	($view->getResourceCallback())($resource);
130		}
131
132	3	$document->addResource($resource);
133		}
134
135	4	return $document;
136		}
137
138		/**
139		* Handle object
140		*
141		* @param $object
142		* @return ResourceObject
143		*/
144	9	protected function handleObject($object): ResourceObject
145		{
146	9	if ($object instanceof ResourceObject) {
147		return $object;
148		}
149
150	9	return $this->mapper->toResource($object);
151		}
152
153		/**
154		* Handle supposed to be included to document resources
155		*
156		* @param AbstractDocument $document
157		* @param IncludedObjectsAwareInterface $view
158		*/
159	9	protected function handleIncludedResources(AbstractDocument $document, IncludedObjectsAwareInterface $view)
160		{
161	9	foreach ($view->getIncludedObjects() as $object)
162		{
163	2	$resource = $this->handleObject($object);
164	2	$document->addIncludedResource($resource);
165		}
166	9	}
167
168		/**
169		* Handle links of document
170		*
171		* @param AbstractJsonApiView $view
172		* @param AbstractDocument $document
173		*/
174	9	protected function handleDocumentLinks(AbstractDocument $document, AbstractJsonApiView $view)
175		{
176	9	foreach ($view->getDocumentLinks() as $definition)
177		{
178	1	$repositoryName = $definition->getRepositoryName();
179	1	$linkName = $definition->getLinkName();
180	1	$parameters = $definition->getParameters();
181
182	1	$linkData = $this->repositoryProvider
183	1	->getRepository($repositoryName)
184	1	->getLink($linkName, $parameters);
185
186	1	$metadata = array_replace(
187	1	$linkData->getMetadata(),
188	1	$definition->getMetadata()
189		);
190
191	1	$link = new LinkObject($linkData->getReference(), $metadata);
192
193	1	$document->setLink($definition->getName(), $link);
194		}
195		}
196		}

mikemirten / JsonApi-Bundle

Push — master ( 20fa94...bcb279 )

DocumentBuilder::build() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like