GenericEntityFetchController::__invoke() - Code Metrics - Inspection of "added magic invoke methods to generic controllers;" - addiks/symfony_generics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 27d676...dee7dc )

by Gerrit

created 2019-04-22 18:55 UTC

GenericEntityFetchController::__invoke() A

↳ Parent: GenericEntityFetchController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	12
Ratio	100 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	12
loc	12
ccs	5
cts	5
cp	1
rs	9.8666
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
/**
 * Copyright (C) 2018 Gerrit Addiks.
 * This package (including this file) was released under the terms of the GPL-3.0.
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <http://www.gnu.org/licenses/> or send me a mail so i can send you a copy.
 *
 * @license GPL-3.0
 *
 * @author Gerrit Addiks <[email protected]>
 */

namespace Addiks\SymfonyGenerics\Controllers\API;

use Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface;
use InvalidArgumentException;
use Webmozart\Assert\Assert;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Serializer\Encoder\EncoderInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use DOMDocument;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use ErrorException;
use Addiks\SymfonyGenerics\Controllers\ApplyDataTemplateTrait;
use Addiks\SymfonyGenerics\Events\EntityInteractionEvent;
use Symfony\Component\HttpFoundation\Request;

final class GenericEntityFetchController
{
    use ApplyDataTemplateTrait;

    /**
     * @var ControllerHelperInterface
     */
    private $controllerHelper;

    /**
     * @var EncoderInterface|null
     */
    private $encoder;

    /**
     * @var NormalizerInterface|null
     */
    private $normalizer;

    /**
     * @var array|null
     */
    private $dataTemplate;

    /**
     * @var string|null
     */
    private $authorizationAttribute;

    /**
     * @var string
     */
    private $entityClass;

    /**
     * @var string
     */
    private $entityIdKey;

    /**
     * @var string
     */
    private $format;

    public function __construct(

        ControllerHelperInterface $controllerHelper,
        array $options
    ) {
        Assert::null($this->controllerHelper);
        Assert::keyExists($options, 'entity-class');

        $options = array_merge([
            'format' => 'json',
            'encoder' => null,
            'normalizer' => null,
            'data-template' => null,
            'authorization-attribute' => null,
            'entity-id-key' => 'entityId',
        ], $options);

        Assert::true(is_null($options['encoder']) || $options['encoder'] instanceof EncoderInterface);
        Assert::true(is_null($options['normalizer']) || $options['normalizer'] instanceof NormalizerInterface);
        Assert::classExists($options['entity-class']);

        $this->controllerHelper = $controllerHelper;
        $this->entityIdKey = $options['entity-id-key'];
        $this->encoder = $options['encoder'];
        $this->normalizer = $options['normalizer'];
        $this->entityClass = $options['entity-class'];
        $this->format = $options['format'];
        $this->dataTemplate = $options['data-template'];
        $this->authorizationAttribute = $options['authorization-attribute'];
    }

    public function __invoke(): Response

    {
        /** @var Request $request */
        $request = $this->controllerHelper->getCurrentRequest();

        Assert::isInstanceOf($request, Request::class, "Cannot use controller outside of request-scope!");

        /** @var string $entityId */
        $entityId = (string)$request->get($this->entityIdKey);

        return $this->fetchEntity($entityId);
    }

    public function fetchEntity(string $entityId): Response
    {
        /** @var object|null $entity */
        $entity = $this->controllerHelper->findEntity($this->entityClass, $entityId);

        if (is_null($entity)) {
            throw new InvalidArgumentException(sprintf(
                "Could not find entity with id '%s'!",
                $entityId
            ));
        }

        if (!empty($this->authorizationAttribute)) {
            $this->controllerHelper->denyAccessUnlessGranted($this->authorizationAttribute, $entity);
        }

        $this->controllerHelper->dispatchEvent("symfony_generics.entity_interaction", new EntityInteractionEvent(
            $this->entityClass,
            $entityId,
            $entity,
            "*FETCH*"
        ));

        /** @var array $normalizedEntity */
        $normalizedEntity = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($this->normalizer instanceof NormalizerInterface) {

            $normalizedEntity = $this->normalizer->normalize($entity);

        } else {
            $normalizer = new ObjectNormalizer();

            $normalizedEntity = $normalizer->normalize($entity);
        }

        if (!is_array($normalizedEntity)) {
            throw new ErrorException("Result of normalize process must be an array!");
        }

        if (!is_null($this->dataTemplate)) {
            $normalizedEntity = $this->applyDataTemplate($normalizedEntity, $this->dataTemplate);
        }

        /** @var string $serializedEntity */
        $serializedEntity = "";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($this->encoder instanceof EncoderInterface) {

            $serializedEntity = $this->encoder->encode($normalizedEntity, $this->format);

        } else {
            $serializedEntity = json_encode($normalizedEntity);
        }

        return new Response($serializedEntity);
    }

}


1			<?php
2			/**
3			* Copyright (C) 2018 Gerrit Addiks.
4			* This package (including this file) was released under the terms of the GPL-3.0.
5			* You should have received a copy of the GNU General Public License along with this program.
6			* If not, see <http://www.gnu.org/licenses/> or send me a mail so i can send you a copy.
7			*
8			* @license GPL-3.0
9			*
10			* @author Gerrit Addiks <[email protected]>
11			*/
12
13			namespace Addiks\SymfonyGenerics\Controllers\API;
14
15			use Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface;
16			use InvalidArgumentException;
17			use Webmozart\Assert\Assert;
18			use Symfony\Component\Serializer\SerializerInterface;
19			use Symfony\Component\HttpFoundation\Response;
20			use Symfony\Component\Serializer\Encoder\EncoderInterface;
21			use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
22			use DOMDocument;
23			use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
24			use ErrorException;
25			use Addiks\SymfonyGenerics\Controllers\ApplyDataTemplateTrait;
26			use Addiks\SymfonyGenerics\Events\EntityInteractionEvent;
27			use Symfony\Component\HttpFoundation\Request;
28
29			final class GenericEntityFetchController
30			{
31			use ApplyDataTemplateTrait;
32
33			/**
34			* @var ControllerHelperInterface
35			*/
36			private $controllerHelper;
37
38			/**
39			* @var EncoderInterface\|null
40			*/
41			private $encoder;
42
43			/**
44			* @var NormalizerInterface\|null
45			*/
46			private $normalizer;
47
48			/**
49			* @var array\|null
50			*/
51			private $dataTemplate;
52
53			/**
54			* @var string\|null
55			*/
56			private $authorizationAttribute;
57
58			/**
59			* @var string
60			*/
61			private $entityClass;
62
63			/**
64			* @var string
65			*/
66			private $entityIdKey;
67
68			/**
69			* @var string
70			*/
71			private $format;
72
73	13	View Code Duplication	public function __construct(
			0 ignored issues – show Duplication introduced 2019-04-22 18:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
74			ControllerHelperInterface $controllerHelper,
75			array $options
76			) {
77	13		Assert::null($this->controllerHelper);
78	13		Assert::keyExists($options, 'entity-class');
79
80	12		$options = array_merge([
81	12		'format' => 'json',
82			'encoder' => null,
83			'normalizer' => null,
84			'data-template' => null,
85			'authorization-attribute' => null,
86			'entity-id-key' => 'entityId',
87	12		], $options);
88
89	12		Assert::true(is_null($options['encoder']) \|\| $options['encoder'] instanceof EncoderInterface);
90	11		Assert::true(is_null($options['normalizer']) \|\| $options['normalizer'] instanceof NormalizerInterface);
91	10		Assert::classExists($options['entity-class']);
92
93	9		$this->controllerHelper = $controllerHelper;
94	9		$this->entityIdKey = $options['entity-id-key'];
95	9		$this->encoder = $options['encoder'];
96	9		$this->normalizer = $options['normalizer'];
97	9		$this->entityClass = $options['entity-class'];
98	9		$this->format = $options['format'];
99	9		$this->dataTemplate = $options['data-template'];
100	9		$this->authorizationAttribute = $options['authorization-attribute'];
101	9		}
102
103	2	View Code Duplication	public function __invoke(): Response
			0 ignored issues – show Duplication introduced 2019-04-22 18:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
104			{
105			/** @var Request $request */
106	2		$request = $this->controllerHelper->getCurrentRequest();
107
108	2		Assert::isInstanceOf($request, Request::class, "Cannot use controller outside of request-scope!");
109
110			/** @var string $entityId */
111	1		$entityId = (string)$request->get($this->entityIdKey);
112
113	1		return $this->fetchEntity($entityId);
114			}
115
116	7		public function fetchEntity(string $entityId): Response
117			{
118			/** @var object\|null $entity */
119	7		$entity = $this->controllerHelper->findEntity($this->entityClass, $entityId);
120
121	7		if (is_null($entity)) {
122	1		throw new InvalidArgumentException(sprintf(
123	1		"Could not find entity with id '%s'!",
124	1		$entityId
125			));
126			}
127
128	6		if (!empty($this->authorizationAttribute)) {
129	1		$this->controllerHelper->denyAccessUnlessGranted($this->authorizationAttribute, $entity);
130			}
131
132	5		$this->controllerHelper->dispatchEvent("symfony_generics.entity_interaction", new EntityInteractionEvent(
133	5		$this->entityClass,
134	5		$entityId,
135	5		$entity,
136	5		"FETCH"
137			));
138
139			/** @var array $normalizedEntity */
140	5		$normalizedEntity = array();
			0 ignored issues – show Unused Code introduced 2018-11-06 19:38 UTC by Report Bug Copy Issue Report `$normalizedEntity` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
141
142	5	View Code Duplication	if ($this->normalizer instanceof NormalizerInterface) {
			0 ignored issues – show Duplication introduced 2018-11-06 21:31 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...
143	1		$normalizedEntity = $this->normalizer->normalize($entity);
144
145			} else {
146	4		$normalizer = new ObjectNormalizer();
147
148	4		$normalizedEntity = $normalizer->normalize($entity);
149			}
150
151	5		if (!is_array($normalizedEntity)) {
152	1		throw new ErrorException("Result of normalize process must be an array!");
153			}
154
155	4		if (!is_null($this->dataTemplate)) {
156	2		$normalizedEntity = $this->applyDataTemplate($normalizedEntity, $this->dataTemplate);
157			}
158
159			/** @var string $serializedEntity */
160	3		$serializedEntity = "";
			0 ignored issues – show Unused Code introduced 2018-11-06 19:38 UTC by Report Bug Copy Issue Report `$serializedEntity` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
161
162	3	View Code Duplication	if ($this->encoder instanceof EncoderInterface) {
			0 ignored issues – show Duplication introduced 2018-11-06 21:31 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...
163			$serializedEntity = $this->encoder->encode($normalizedEntity, $this->format);
164
165			} else {
166	3		$serializedEntity = json_encode($normalizedEntity);
167			}
168
169	3		return new Response($serializedEntity);
170			}
171
172			}
173

addiks / symfony_generics

Push — master ( 27d676...dee7dc )

GenericEntityFetchController::__invoke() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like