CourseCreateController   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 95
Duplicated Lines 32.63 %

Coupling/Cohesion

Components 0
Dependencies 5

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
dl 31
loc 95
rs 10
c 0
b 0
f 0
ccs 0
cts 41
cp 0
wmc 6
lcom 0
cbo 5

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 15 15 1
A __invoke() 16 33 5

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

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\Model\Course;
17
18
final class CourseCreateController
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 by
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 View Code Duplication
        if (null === $contentType = $this->requestManager->getContentType($request)) {
0 ignored issues
show
Duplication introduced by
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...
86
            return $this->responseManager->createContentTypeNotSupportedResponse($request, $accept);
87
        }
88
89
        /** @var Course $course */
90
        if (null === $course = $this->requestManager->getDataFromRequestBody($request, Course::class, $contentType)) {
91
            return $this->responseManager->createBodyNotDeserializableResponse($request, $accept, $contentType);
92
        }
93
94 View Code Duplication
        if ([] !== $errors = $this->validator->validateObject($course)) {
0 ignored issues
show
Duplication introduced by
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...
Bug introduced by
It seems like you code against a concrete implementation and not the interface Chubbyphp\Validation\ValidatorInterface as the method validateObject() does only exist in the following implementations of said interface: Chubbyphp\Validation\Validator.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
95
            $locale = $this->requestManager->getAcceptLanguage($request, $this->defaultLanguage);
96
97
            return $this->responseManager->createValidationErrorResponse(
98
                $request,
99
                $accept,
100
                Error::SCOPE_BODY,
101
                'course',
102
                (new NestedErrorMessages($errors, function (string $key, array $arguments) use ($locale) {
103
                    return $this->translator->translate($locale, $key, $arguments);
104
                }))->getMessages()
105
            );
106
        }
107
108
        $this->repository->persist($course);
109
110
        return $this->responseManager->createResponse($request, 201, $accept, $course);
111
    }
112
}
113