FetchAndHydrateService::handle() - Code Metrics - Inspection of "Move duplicated logic from clients and resources i..." - php-api-clients/travis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Cees-Jan

created 2016-12-20 16:40 UTC

FetchAndHydrateService::handle() A

↳ Parent: FetchAndHydrateService

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	7
cts	7
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	11
nc	1
nop	3
crap	1

<?php declare(strict_types=1);

namespace ApiClients\Client\Travis\Service;

use ApiClients\Foundation\Hydrator\Hydrator;
use ApiClients\Foundation\Service\ServiceInterface;
use ApiClients\Foundation\Transport\Service\RequestService;
use Psr\Http\Message\ResponseInterface;
use React\Promise\CancellablePromiseInterface;
use RingCentral\Psr7\Request;
use Rx\Observable;
use function React\Promise\resolve;
use function WyriHaximus\React\futureFunctionPromise;

class FetchAndHydrateService implements ServiceInterface
{
    /**
     * @var RequestService
     */
    private $requestService;

    /**
     * @var Hydrator
     */
    private $hydrator;

    /**
     * @param RequestService $requestService
     * @param Hydrator $hydrator
     */
    public function __construct(RequestService $requestService, Hydrator $hydrator)
    {
        $this->requestService = $requestService;
        $this->hydrator = $hydrator;
    }

    /**
     * @param string|null $path
     * @param string|null $index
     * @param string|null $hydrateClass
     * @return CancellablePromiseInterface
     */
    public function handle(
        string $path = null,
        string $index = null,
        string $hydrateClass = null
    ): CancellablePromiseInterface {
        return $this->requestService->handle(
            new Request('GET', $path)
        )->then(function (ResponseInterface $response) use ($hydrateClass, $index) {
            return $this->hydrator->hydrate(
                $hydrateClass,
                $response->getBody()->getJson()[$index]
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.
    }
}
            );
        });
    }
}


GitHub Access Token became invalid

Pull Request — master (#1)

FetchAndHydrateService::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Client\Travis\Service;
4
5		use ApiClients\Foundation\Hydrator\Hydrator;
6		use ApiClients\Foundation\Service\ServiceInterface;
7		use ApiClients\Foundation\Transport\Service\RequestService;
8		use Psr\Http\Message\ResponseInterface;
9		use React\Promise\CancellablePromiseInterface;
10		use RingCentral\Psr7\Request;
11		use Rx\Observable;
12		use function React\Promise\resolve;
13		use function WyriHaximus\React\futureFunctionPromise;
14
15		class FetchAndHydrateService implements ServiceInterface
16		{
17		/**
18		* @var RequestService
19		*/
20		private $requestService;
21
22		/**
23		* @var Hydrator
24		*/
25		private $hydrator;
26
27		/**
28		* @param RequestService $requestService
29		* @param Hydrator $hydrator
30		*/
31	4	public function __construct(RequestService $requestService, Hydrator $hydrator)
32		{
33	4	$this->requestService = $requestService;
34	4	$this->hydrator = $hydrator;
35	4	}
36
37		/**
38		* @param string\|null $path
39		* @param string\|null $index
40		* @param string\|null $hydrateClass
41		* @return CancellablePromiseInterface
42		*/
43	4	public function handle(
44		string $path = null,
45		string $index = null,
46		string $hydrateClass = null
47		): CancellablePromiseInterface {
48	4	return $this->requestService->handle(
49	4	new Request('GET', $path)
50	4	)->then(function (ResponseInterface $response) use ($hydrateClass, $index) {
51	4	return $this->hydrator->hydrate(
52		$hydrateClass,
53	4	$response->getBody()->getJson()[$index]
		0 ignored issues – show Bug introduced 2016-12-20 07:05 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\StreamInterface` as the method `getJson()` does only exist in the following implementations of said interface: `ApiClients\Foundation\Transport\JsonStream`. 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...
54		);
55	4	});
56		}
57		}
58

php-api-clients / travis

GitHub Access Token became invalid

Pull Request — master (#1)

FetchAndHydrateService::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like