CourseSearchController - Code Metrics - Inspection of "update controllers" - chubbyphp/chubbyphp-api-slim-skeleton - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 813e38...4a9a7a )

by Dominik

created 2017-09-05 20:17 UTC

CourseSearchController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	90
Duplicated Lines	31.11 %

Coupling/Cohesion

Components	0
Dependencies	5

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	28
loc	90
ccs	0
cts	31
cp	0
rs	10
c	0
b	0
f	0
wmc	4
lcom	0
cbo	5

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	15	15	1
B	__invoke()	13	28	3

How to fix Duplicated Code

<?php

declare(strict_types=1);

namespace Chubbyphp\ApiSkeleton\Controller\Course;

use Chubbyphp\ApiHttp\Error\Error;
use Chubbyphp\ApiHttp\Manager\RequestManagerInterface;
use Chubbyphp\ApiHttp\Manager\ResponseManagerInterface;
use Chubbyphp\Model\RepositoryInterface;
use Chubbyphp\Translation\TranslatorInterface;
use Chubbyphp\Validation\Error\NestedErrorMessages;
use Chubbyphp\Validation\ValidatorInterface;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Chubbyphp\ApiSkeleton\Search\CourseSearch;

final class CourseSearchController
{
    /**
     * @var string
     */
    private $defaultLanguage;

    /**
     * @var RepositoryInterface
     */
    private $repository;

    /**
     * @var RequestManagerInterface
     */
    private $requestManager;

    /**
     * @var ResponseManagerInterface
     */
    private $responseManager;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * @var ValidatorInterface
     */
    private $validator;

    /**
     * @param string                   $defaultLanguage
     * @param RepositoryInterface      $repository
     * @param RequestManagerInterface  $requestManager
     * @param ResponseManagerInterface $responseManager
     * @param TranslatorInterface      $translator
     * @param ValidatorInterface       $validator
     */
    public function __construct(

        string $defaultLanguage,
        RepositoryInterface $repository,
        RequestManagerInterface $requestManager,
        ResponseManagerInterface $responseManager,
        TranslatorInterface $translator,
        ValidatorInterface $validator
    ) {
        $this->defaultLanguage = $defaultLanguage;
        $this->repository = $repository;
        $this->requestManager = $requestManager;
        $this->responseManager = $responseManager;
        $this->translator = $translator;
        $this->validator = $validator;
    }

    /**
     * @param Request $request
     *
     * @return Response
     */
    public function __invoke(Request $request): Response
    {
        if (null === $accept = $this->requestManager->getAccept($request)) {
            return $this->responseManager->createAcceptNotSupportedResponse($request);
        }

        /** @var CourseSearch $courseSearch */
        $courseSearch = $this->requestManager->getDataFromRequestQuery($request, CourseSearch::class);

        if ([] !== $errors = $this->validator->validateObject($courseSearch)) {

            $locale = $this->requestManager->getAcceptLanguage($request, $this->defaultLanguage);

            return $this->responseManager->createValidationErrorResponse(
                $request,
                $accept,
                Error::SCOPE_QUERY,
                'courseSearch',
                (new NestedErrorMessages($errors, function (string $key, array $arguments) use ($locale) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    return $this->translator->translate($locale, $key, $arguments);
                }))->getMessages()
            );
        }

        /** @var CourseSearch $courseSearch */
        $courseSearch = $this->repository->search($courseSearch);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $this->responseManager->createResponse($request, 200, $accept, $courseSearch);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Chubbyphp\ApiSkeleton\Controller\Course;
6
7		use Chubbyphp\ApiHttp\Error\Error;
8		use Chubbyphp\ApiHttp\Manager\RequestManagerInterface;
9		use Chubbyphp\ApiHttp\Manager\ResponseManagerInterface;
10		use Chubbyphp\Model\RepositoryInterface;
11		use Chubbyphp\Translation\TranslatorInterface;
12		use Chubbyphp\Validation\Error\NestedErrorMessages;
13		use Chubbyphp\Validation\ValidatorInterface;
14		use Psr\Http\Message\ServerRequestInterface as Request;
15		use Psr\Http\Message\ResponseInterface as Response;
16		use Chubbyphp\ApiSkeleton\Search\CourseSearch;
17
18		final class CourseSearchController
19		{
20		/**
21		* @var string
22		*/
23		private $defaultLanguage;
24
25		/**
26		* @var RepositoryInterface
27		*/
28		private $repository;
29
30		/**
31		* @var RequestManagerInterface
32		*/
33		private $requestManager;
34
35		/**
36		* @var ResponseManagerInterface
37		*/
38		private $responseManager;
39
40		/**
41		* @var TranslatorInterface
42		*/
43		private $translator;
44
45		/**
46		* @var ValidatorInterface
47		*/
48		private $validator;
49
50		/**
51		* @param string $defaultLanguage
52		* @param RepositoryInterface $repository
53		* @param RequestManagerInterface $requestManager
54		* @param ResponseManagerInterface $responseManager
55		* @param TranslatorInterface $translator
56		* @param ValidatorInterface $validator
57		*/
58	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2017-08-24 18:32 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...
59		string $defaultLanguage,
60		RepositoryInterface $repository,
61		RequestManagerInterface $requestManager,
62		ResponseManagerInterface $responseManager,
63		TranslatorInterface $translator,
64		ValidatorInterface $validator
65		) {
66		$this->defaultLanguage = $defaultLanguage;
67		$this->repository = $repository;
68		$this->requestManager = $requestManager;
69		$this->responseManager = $responseManager;
70		$this->translator = $translator;
71		$this->validator = $validator;
72		}
73
74		/**
75		* @param Request $request
76		*
77		* @return Response
78		*/
79		public function __invoke(Request $request): Response
80		{
81		if (null === $accept = $this->requestManager->getAccept($request)) {
82		return $this->responseManager->createAcceptNotSupportedResponse($request);
83		}
84
85		/** @var CourseSearch $courseSearch */
86		$courseSearch = $this->requestManager->getDataFromRequestQuery($request, CourseSearch::class);
87
88	View Code Duplication	if ([] !== $errors = $this->validator->validateObject($courseSearch)) {
		0 ignored issues – show Duplication introduced 2017-08-24 18:32 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...
89		$locale = $this->requestManager->getAcceptLanguage($request, $this->defaultLanguage);
90
91		return $this->responseManager->createValidationErrorResponse(
92		$request,
93		$accept,
94		Error::SCOPE_QUERY,
95		'courseSearch',
96		(new NestedErrorMessages($errors, function (string $key, array $arguments) use ($locale) {
		0 ignored issues – show Documentation introduced 2017-09-05 20:22 UTC by Report Bug Copy Issue Report `$errors` is of type `array<integer,string>`, but the function expects a `array<integer,object<Chu...\Error\ErrorInterface>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
97		return $this->translator->translate($locale, $key, $arguments);
98		}))->getMessages()
99		);
100		}
101
102		/** @var CourseSearch $courseSearch */
103		$courseSearch = $this->repository->search($courseSearch);
		0 ignored issues – show Bug introduced 2017-08-25 06:53 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Chubbyphp\Model\RepositoryInterface` as the method `search()` does only exist in the following implementations of said interface: `Chubbyphp\ApiSkeleton\Repository\CourseRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
104
105		return $this->responseManager->createResponse($request, 200, $accept, $courseSearch);
106		}
107		}
108

chubbyphp / chubbyphp-api-slim-skeleton

Push — master ( 813e38...4a9a7a )

CourseSearchController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like