RestController::createApiOperation() - Code Metrics - Inspection of "Grand refactoring. Band and Organizer logic united..." - VAPC/RockParade-API - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 25c2e9...26c6a8 )

by Petr

created 2016-09-15 22:59 UTC

RestController::createApiOperation() A

↳ Parent: RestController

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace AppBundle\Controller\Infrastructure;

use AppBundle\Entity\Infrasctucture\AbstractRepository;
use AppBundle\Enum\ApiOperation;
use AppBundle\Exception\EntityNotFoundException;
use AppBundle\Form\FormOptions;
use AppBundle\Response\ApiError;
use AppBundle\Response\ApiResponse;
use AppBundle\Response\CollectionApiResponse;
use AppBundle\Response\FileResponse;
use AppBundle\Response\Infrastructure\AbstractApiResponse;
use AppBundle\Response\Infrastructure\HttpLocationInterface;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * @author Vehsamrak
 */
class RestController extends Controller
{

    const MIME_TYPE_JSON = 'application/json';

    public function respond(AbstractApiResponse $apiResponse): Response
    {
        $response = $this->get('rockparade.http_response_factory')->createResponse($apiResponse);

        $this->setLocation($response, $apiResponse);
        $this->setContentType($apiResponse, $response);

        return $response;
    }

    protected function createAndProcessForm(
        Request $request,
        string $type,
        $data = null,
        $options = []
    ) {
        $form = parent::createForm($type, $data, $options);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $this->processForm($request, $form);

        return $form;
    }

    /**
     * Process form
     * @param Request $request
     * @param FormInterface $form
     */
    protected function processForm(Request $request, FormInterface $form)
    {
        $formData = json_decode($request->getContent(), true) ?? $request->request->all();
        $clearMissing = $request->getMethod() != Request::METHOD_PATCH;

        $form->submit($formData, $clearMissing);
    }

    /** {@inheritDoc} */
    protected function createFormBuilder($data = null, array $options = []): FormBuilder
    {
        $options['allow_extra_fields'] = true;

        return parent::createFormBuilder($data, $options);
    }

    /**
     * Create collection api response with total, limit and offset parameters
     * @param integer|null $limit
     * @param integer|null $offset
     */
    protected function listEntities(AbstractRepository $repository, $limit, $offset): Response
    {
        $limit = (int) filter_var($limit, FILTER_VALIDATE_INT);
        $offset = (int) filter_var($offset, FILTER_VALIDATE_INT);

        $entities = $repository->findAllWithLimitAndOffset($limit, $offset);
        $entitiesQuantity = $repository->countAll();

        $response = new CollectionApiResponse($entities, Response::HTTP_OK, $entitiesQuantity, $limit, $offset);

        return $this->respond($response);
    }

    /**
     * @param string $entityFullName Entity class name
     * @param string|int $id Entity id
     * @return ApiError
     * @throws EntityNotFoundException
     */
    protected function createEntityNotFoundResponse(string $entityFullName, $id): ApiError
    {
        return $this->get('rockparade.entity_service')->createEntityNotFoundResponse($entityFullName, $id);
    }

    /**
     * @param string|int $id
     */
    protected function viewEntity(AbstractRepository $repository, $id): Response

    {
        $entity = $repository->findOneById($id);
        $entityClass = $repository->getClassName();

        if ($entity) {
            $response = new ApiResponse($entity, Response::HTTP_OK);
        } else {
            $response = $this->createEntityNotFoundResponse($entityClass, $id);
        }

        return $this->respond($response);
    }

    private function setLocation(Response $response, AbstractApiResponse $apiResponse)
    {
        if ($apiResponse instanceof HttpLocationInterface) {
            $response->headers->set('Location', $apiResponse->getLocation());
        }
    }

    private function setContentType(AbstractApiResponse $apiResponse, Response $response)
    {
        if (!$apiResponse instanceof FileResponse) {
            $response->headers->set('Content-Type', self::MIME_TYPE_JSON);
        }
    }

    /**
     * Create ApiOperation from Request method
     */
    protected function createApiOperation(Request $request): ApiOperation
    {
        return new ApiOperation($request->getMethod());
    }
}


1			<?php
2
3			namespace AppBundle\Controller\Infrastructure;
4
5			use AppBundle\Entity\Infrasctucture\AbstractRepository;
6			use AppBundle\Enum\ApiOperation;
7			use AppBundle\Exception\EntityNotFoundException;
8			use AppBundle\Form\FormOptions;
9			use AppBundle\Response\ApiError;
10			use AppBundle\Response\ApiResponse;
11			use AppBundle\Response\CollectionApiResponse;
12			use AppBundle\Response\FileResponse;
13			use AppBundle\Response\Infrastructure\AbstractApiResponse;
14			use AppBundle\Response\Infrastructure\HttpLocationInterface;
15			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
16			use Symfony\Component\Form\FormBuilder;
17			use Symfony\Component\Form\FormInterface;
18			use Symfony\Component\HttpFoundation\Request;
19			use Symfony\Component\HttpFoundation\Response;
20
21			/**
22			* @author Vehsamrak
23			*/
24			class RestController extends Controller
25			{
26
27			const MIME_TYPE_JSON = 'application/json';
28
29	41		public function respond(AbstractApiResponse $apiResponse): Response
30			{
31	41		$response = $this->get('rockparade.http_response_factory')->createResponse($apiResponse);
32
33	41		$this->setLocation($response, $apiResponse);
34	41		$this->setContentType($apiResponse, $response);
35
36	41		return $response;
37			}
38
39	4		protected function createAndProcessForm(
40			Request $request,
41			string $type,
42			$data = null,
43			$options = []
44			) {
45	4		$form = parent::createForm($type, $data, $options);
			0 ignored issues – show Comprehensibility Bug introduced 2016-09-15 23:08 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`createForm()` instead of `createAndProcessForm()`). Are you sure this is correct? If so, you might want to change this to `$this->createForm()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
46	4		$this->processForm($request, $form);
47
48	4		return $form;
49			}
50
51			/**
52			* Process form
53			* @param Request $request
54			* @param FormInterface $form
55			*/
56	15		protected function processForm(Request $request, FormInterface $form)
57			{
58	15		$formData = json_decode($request->getContent(), true) ?? $request->request->all();
59	15		$clearMissing = $request->getMethod() != Request::METHOD_PATCH;
60
61	15		$form->submit($formData, $clearMissing);
62	15		}
63
64			/** {@inheritDoc} */
65	8		protected function createFormBuilder($data = null, array $options = []): FormBuilder
66			{
67	8		$options['allow_extra_fields'] = true;
68
69	8		return parent::createFormBuilder($data, $options);
70			}
71
72			/**
73			* Create collection api response with total, limit and offset parameters
74			* @param integer\|null $limit
75			* @param integer\|null $offset
76			*/
77	4		protected function listEntities(AbstractRepository $repository, $limit, $offset): Response
78			{
79	4		$limit = (int) filter_var($limit, FILTER_VALIDATE_INT);
80	4		$offset = (int) filter_var($offset, FILTER_VALIDATE_INT);
81
82	4		$entities = $repository->findAllWithLimitAndOffset($limit, $offset);
83	4		$entitiesQuantity = $repository->countAll();
84
85	4		$response = new CollectionApiResponse($entities, Response::HTTP_OK, $entitiesQuantity, $limit, $offset);
86
87	4		return $this->respond($response);
88			}
89
90			/**
91			* @param string $entityFullName Entity class name
92			* @param string\|int $id Entity id
93			* @return ApiError
94			* @throws EntityNotFoundException
95			*/
96	5		protected function createEntityNotFoundResponse(string $entityFullName, $id): ApiError
97			{
98	5		return $this->get('rockparade.entity_service')->createEntityNotFoundResponse($entityFullName, $id);
99			}
100
101			/**
102			* @param string\|int $id
103			*/
104	14	View Code Duplication	protected function viewEntity(AbstractRepository $repository, $id): Response
			0 ignored issues – show Duplication introduced 2016-09-09 00:44 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...
105			{
106	14		$entity = $repository->findOneById($id);
107	14		$entityClass = $repository->getClassName();
108
109	14		if ($entity) {
110	10		$response = new ApiResponse($entity, Response::HTTP_OK);
111			} else {
112	5		$response = $this->createEntityNotFoundResponse($entityClass, $id);
113			}
114
115	14		return $this->respond($response);
116			}
117
118	41		private function setLocation(Response $response, AbstractApiResponse $apiResponse)
119			{
120	41		if ($apiResponse instanceof HttpLocationInterface) {
121	5		$response->headers->set('Location', $apiResponse->getLocation());
122			}
123	41		}
124
125	41		private function setContentType(AbstractApiResponse $apiResponse, Response $response)
126			{
127	41		if (!$apiResponse instanceof FileResponse) {
128	41		$response->headers->set('Content-Type', self::MIME_TYPE_JSON);
129			}
130	41		}
131
132			/**
133			* Create ApiOperation from Request method
134			*/
135	4		protected function createApiOperation(Request $request): ApiOperation
136			{
137	4		return new ApiOperation($request->getMethod());
138			}
139			}
140

VAPC / RockParade-API

Push — master ( 25c2e9...26c6a8 )

RestController::createApiOperation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like