HttpRequestAnnotHandler::handle() - Code Metrics - Inspection of "Retrofit 3" - tebru/retrofit-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#72)

by Nate

created 2017-09-12 22:37 UTC

HttpRequestAnnotHandler::handle() A

↳ Parent: HttpRequestAnnotHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	11
nc	2
nop	4

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

declare(strict_types=1);

namespace Tebru\Retrofit\Internal\AnnotationHandler;

use Tebru\AnnotationReader\AbstractAnnotation;
use Tebru\Retrofit\Annotation\HttpRequest;
use Tebru\Retrofit\AnnotationHandler;
use Tebru\Retrofit\Converter;
use Tebru\Retrofit\ServiceMethodBuilder;

/**
 * Class HttpRequestAnnotHandler
 *
 * @author Nate Brunette <[email protected]>
 */
final class HttpRequestAnnotHandler implements AnnotationHandler
{
    /**
     * Sets the request method, uri, and whether or not the request contains a body
     *
     * @param HttpRequest|AbstractAnnotation $annotation The annotation to handle
     * @param ServiceMethodBuilder $serviceMethodBuilder Used to construct a [@see ServiceMethod]
     * @param Converter|null $converter Converter used to convert types before sending to service method
     * @param int|null $index The position of the parameter or null if annotation does not reference parameter
     * @return void
     * @throws \LogicException
     */
    public function handle(
        AbstractAnnotation $annotation,
        ServiceMethodBuilder $serviceMethodBuilder,
        ?Converter $converter,
        ?int $index
    ): void {
        $uri = $annotation->getValue();

        $serviceMethodBuilder->setMethod($annotation->getType());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        $serviceMethodBuilder->setPath($uri);

        if (!$annotation->hasBody()) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $serviceMethodBuilder->setHasBody($annotation->hasBody());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        }
    }
}


Pull Request — master (#72)

HttpRequestAnnotHandler::handle() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/*
3			* Copyright (c) Nate Brunette.
4			* Distributed under the MIT License (http://opensource.org/licenses/MIT)
5			*/
6
7			declare(strict_types=1);
8
9			namespace Tebru\Retrofit\Internal\AnnotationHandler;
10
11			use Tebru\AnnotationReader\AbstractAnnotation;
12			use Tebru\Retrofit\Annotation\HttpRequest;
13			use Tebru\Retrofit\AnnotationHandler;
14			use Tebru\Retrofit\Converter;
15			use Tebru\Retrofit\ServiceMethodBuilder;
16
17			/**
18			* Class HttpRequestAnnotHandler
19			*
20			* @author Nate Brunette <[email protected]>
21			*/
22			final class HttpRequestAnnotHandler implements AnnotationHandler
23			{
24			/**
25			* Sets the request method, uri, and whether or not the request contains a body
26			*
27			* @param HttpRequest\|AbstractAnnotation $annotation The annotation to handle
28			* @param ServiceMethodBuilder $serviceMethodBuilder Used to construct a [@see ServiceMethod]
29			* @param Converter\|null $converter Converter used to convert types before sending to service method
30			* @param int\|null $index The position of the parameter or null if annotation does not reference parameter
31			* @return void
32			* @throws \LogicException
33			*/
34			public function handle(
35			AbstractAnnotation $annotation,
36			ServiceMethodBuilder $serviceMethodBuilder,
37			?Converter $converter,
38			?int $index
39			): void {
40			$uri = $annotation->getValue();
41
42			$serviceMethodBuilder->setMethod($annotation->getType());
			0 ignored issues – show Bug introduced 2017-09-12 22:35 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tebru\AnnotationReader\AbstractAnnotation` as the method `getType()` does only exist in the following sub-classes of `Tebru\AnnotationReader\AbstractAnnotation`: `Tebru\Retrofit\Annotation\DELETE`, `Tebru\Retrofit\Annotation\GET`, `Tebru\Retrofit\Annotation\HEAD`, `Tebru\Retrofit\Annotation\OPTIONS`, `Tebru\Retrofit\Annotation\PATCH`, `Tebru\Retrofit\Annotation\POST`, `Tebru\Retrofit\Annotation\PUT`, `Tebru\Retrofit\Annotation\REQUEST`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
43			$serviceMethodBuilder->setPath($uri);
44
45			if (!$annotation->hasBody()) {
			0 ignored issues – show Bug introduced 2017-09-12 22:35 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tebru\AnnotationReader\AbstractAnnotation` as the method `hasBody()` does only exist in the following sub-classes of `Tebru\AnnotationReader\AbstractAnnotation`: `Tebru\Retrofit\Annotation\DELETE`, `Tebru\Retrofit\Annotation\GET`, `Tebru\Retrofit\Annotation\HEAD`, `Tebru\Retrofit\Annotation\OPTIONS`, `Tebru\Retrofit\Annotation\PATCH`, `Tebru\Retrofit\Annotation\POST`, `Tebru\Retrofit\Annotation\PUT`, `Tebru\Retrofit\Annotation\REQUEST`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
46			$serviceMethodBuilder->setHasBody($annotation->hasBody());
			0 ignored issues – show Bug introduced 2017-09-12 22:35 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Tebru\AnnotationReader\AbstractAnnotation` as the method `hasBody()` does only exist in the following sub-classes of `Tebru\AnnotationReader\AbstractAnnotation`: `Tebru\Retrofit\Annotation\DELETE`, `Tebru\Retrofit\Annotation\GET`, `Tebru\Retrofit\Annotation\HEAD`, `Tebru\Retrofit\Annotation\OPTIONS`, `Tebru\Retrofit\Annotation\PATCH`, `Tebru\Retrofit\Annotation\POST`, `Tebru\Retrofit\Annotation\PUT`, `Tebru\Retrofit\Annotation\REQUEST`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
47			}
48			}
49			}
50

tebru / retrofit-php

Pull Request — master (#72)

HttpRequestAnnotHandler::handle() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like