QueryAnnotHandler::handle() - Code Metrics - Inspection of "Merge pull request #72 from tebru/v3" - tebru/retrofit-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (203e41)

by Nate

created 2017-09-12 22:59 UTC

QueryAnnotHandler::handle() A

↳ Parent: QueryAnnotHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	9
nc	1
nop	4
crap	1

<?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\Query;
use Tebru\Retrofit\AnnotationHandler;
use Tebru\Retrofit\Converter;
use Tebru\Retrofit\Internal\ParameterHandler\QueryParamHandler;
use Tebru\Retrofit\ServiceMethodBuilder;
use Tebru\Retrofit\StringConverter;

/**
 * Class QueryAnnotHandler
 *
 * @author Nate Brunette <[email protected]>
 */
final class QueryAnnotHandler implements AnnotationHandler
{
    /**
     * Add a query param handler
     *
     * @param Query|AbstractAnnotation $annotation The annotation to handle
     * @param ServiceMethodBuilder $serviceMethodBuilder Used to construct a [@see ServiceMethod]
     * @param Converter|StringConverter $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
     */
    public function handle(
        AbstractAnnotation $annotation,
        ServiceMethodBuilder $serviceMethodBuilder,
        ?Converter $converter,
        ?int $index
    ): void {
        $serviceMethodBuilder->addParameterHandler(
            $index,
            new QueryParamHandler($converter, $annotation->getValue(), $annotation->isEncoded())
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.
    }
}
        );
    }
}


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\Query;
13		use Tebru\Retrofit\AnnotationHandler;
14		use Tebru\Retrofit\Converter;
15		use Tebru\Retrofit\Internal\ParameterHandler\QueryParamHandler;
16		use Tebru\Retrofit\ServiceMethodBuilder;
17		use Tebru\Retrofit\StringConverter;
18
19		/**
20		* Class QueryAnnotHandler
21		*
22		* @author Nate Brunette <[email protected]>
23		*/
24		final class QueryAnnotHandler implements AnnotationHandler
25		{
26		/**
27		* Add a query param handler
28		*
29		* @param Query\|AbstractAnnotation $annotation The annotation to handle
30		* @param ServiceMethodBuilder $serviceMethodBuilder Used to construct a [@see ServiceMethod]
31		* @param Converter\|StringConverter $converter Converter used to convert types before sending to service method
32		* @param int\|null $index The position of the parameter or null if annotation does not reference parameter
33		* @return void
34		*/
35	3	public function handle(
36		AbstractAnnotation $annotation,
37		ServiceMethodBuilder $serviceMethodBuilder,
38		?Converter $converter,
39		?int $index
40		): void {
41	3	$serviceMethodBuilder->addParameterHandler(
42	3	$index,
43	3	new QueryParamHandler($converter, $annotation->getValue(), $annotation->isEncoded())
		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 `isEncoded()` does only exist in the following sub-classes of `Tebru\AnnotationReader\AbstractAnnotation`: `Tebru\Retrofit\Annotation\Encodable`, `Tebru\Retrofit\Annotation\Field`, `Tebru\Retrofit\Annotation\FieldMap`, `Tebru\Retrofit\Annotation\Query`, `Tebru\Retrofit\Annotation\QueryMap`, `Tebru\Retrofit\Annotation\QueryName`. 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... Compatibility introduced 2017-09-12 22:35 UTC by Report Bug Copy Issue Report `$converter` of type `object<Tebru\Retrofit\Converter>` is not a sub-type of `object<Tebru\Retrofit\StringConverter>`. It seems like you assume a child interface of the interface `Tebru\Retrofit\Converter` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
44		);
45	3	}
46		}
47

tebru / retrofit-php

Branch — master (203e41)

QueryAnnotHandler::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like