IteratePagesService::__construct() - Code Metrics - Inspection of "Merge pull request #1 from php-api-clients/feature..." - php-api-clients/github - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 430f59...c8c9fd )

by Cees-Jan

created 2017-03-18 10:20 UTC

IteratePagesService::__construct() A

↳ Parent: IteratePagesService

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php declare(strict_types=1);

namespace ApiClients\Client\Github\Service;

use ApiClients\Foundation\Service\ServiceInterface;
use ApiClients\Foundation\Transport\Service\RequestService;
use Psr\Http\Message\ResponseInterface;
use React\Promise\CancellablePromiseInterface;
use React\Promise\FulfilledPromise;
use RingCentral\Psr7\Request;
use Rx\Disposable\CallbackDisposable;
use Rx\Observable;
use Rx\ObserverInterface;
use Rx\SchedulerInterface;
use function React\Promise\all;
use function React\Promise\resolve;

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

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

    public function handle(string $path = null): CancellablePromiseInterface
    {
        return resolve(Observable::create(function (
            ObserverInterface $observer,
            SchedulerInterface $scheduler

        ) use ($path) {
            $promise = $this->requestService->
                handle(new Request('GET', $path))->
                then(
                    function ($response) use ($observer) {
                        return $this->handleResponse($response, $observer);
                    },
                    function ($error) use ($observer) {
                        $observer->onError($error);
                    }
                )
            ;

            return new CallbackDisposable(function () use ($promise) {
                //$promise->cancel();

            });
        }));
    }

    private function handleResponse(
        ResponseInterface $response,
        ObserverInterface $observer
    ): CancellablePromiseInterface {
        if (!$response->hasHeader('link')) {
            return $this->handleResponseContentsComplete($response, $observer);
        }

        $links = [
            'next' => false,
            'last' => false,
        ];
        foreach (explode(', ', $response->getHeader('link')[0]) as $link) {
            list($url, $rel) = explode('>; rel="', ltrim(rtrim($link, '"'), '<'));
            if (isset($links[$rel])) {
                $links[$rel] = $url;
            }
        }

        if ($links['next'] === false || $links['last'] === false) {
            return $this->handleResponseContentsComplete($response, $observer);
        }

        $promises = [];

        $promises[] = $this->requestService->
            handle(new Request('GET', $links['next']))->
            then(function (ResponseInterface $response) use ($observer) {
                return $this->handleResponse($response, $observer);
            })
        ;

        $promises[] = $this->handleResponseContents($response, $observer);

        return all($promises);
    }

    private function handleResponseContentsComplete(
        ResponseInterface $response,
        ObserverInterface $observer
    ): CancellablePromiseInterface {
        return $this->handleResponseContents($response, $observer)->then(function () use ($observer) {
            $observer->onCompleted();
            return new FulfilledPromise();
        }, function ($error) use ($observer) {
            $observer->onError($error);
            return new FulfilledPromise();
        });
    }

    private function handleResponseContents(
        ResponseInterface $response,
        ObserverInterface $observer
    ): CancellablePromiseInterface {
        $observer->onNext($response->getBody()->getJson());
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 new FulfilledPromise();
    }
}


1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Client\Github\Service;
4
5		use ApiClients\Foundation\Service\ServiceInterface;
6		use ApiClients\Foundation\Transport\Service\RequestService;
7		use Psr\Http\Message\ResponseInterface;
8		use React\Promise\CancellablePromiseInterface;
9		use React\Promise\FulfilledPromise;
10		use RingCentral\Psr7\Request;
11		use Rx\Disposable\CallbackDisposable;
12		use Rx\Observable;
13		use Rx\ObserverInterface;
14		use Rx\SchedulerInterface;
15		use function React\Promise\all;
16		use function React\Promise\resolve;
17
18		class IteratePagesService implements ServiceInterface
19		{
20		/**
21		* @var RequestService
22		*/
23		private $requestService;
24
25		/**
26		* @param RequestService $requestService
27		*/
28	1	public function __construct(RequestService $requestService)
29		{
30	1	$this->requestService = $requestService;
31	1	}
32
33	1	public function handle(string $path = null): CancellablePromiseInterface
34		{
35		return resolve(Observable::create(function (
36		ObserverInterface $observer,
37		SchedulerInterface $scheduler
		0 ignored issues – show Unused Code introduced 2017-01-14 12:57 UTC by Report Bug Copy Issue Report The parameter `$scheduler` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
38		) use ($path) {
39	1	$promise = $this->requestService->
40	1	handle(new Request('GET', $path))->
41	1	then(
42		function ($response) use ($observer) {
43	1	return $this->handleResponse($response, $observer);
44	1	},
45		function ($error) use ($observer) {
46		$observer->onError($error);
47	1	}
48		)
49		;
50
51		return new CallbackDisposable(function () use ($promise) {
52		//$promise->cancel();
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-14 12:57 UTC by Report Bug Copy Issue Report `84%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
53	1	});
54	1	}));
55		}
56
57	1	private function handleResponse(
58		ResponseInterface $response,
59		ObserverInterface $observer
60		): CancellablePromiseInterface {
61	1	if (!$response->hasHeader('link')) {
62		return $this->handleResponseContentsComplete($response, $observer);
63		}
64
65		$links = [
66	1	'next' => false,
67		'last' => false,
68		];
69	1	foreach (explode(', ', $response->getHeader('link')[0]) as $link) {
70	1	list($url, $rel) = explode('>; rel="', ltrim(rtrim($link, '"'), '<'));
71	1	if (isset($links[$rel])) {
72	1	$links[$rel] = $url;
73		}
74		}
75
76	1	if ($links['next'] === false \|\| $links['last'] === false) {
77	1	return $this->handleResponseContentsComplete($response, $observer);
78		}
79
80	1	$promises = [];
81
82	1	$promises[] = $this->requestService->
83	1	handle(new Request('GET', $links['next']))->
84		then(function (ResponseInterface $response) use ($observer) {
85	1	return $this->handleResponse($response, $observer);
86	1	})
87		;
88
89	1	$promises[] = $this->handleResponseContents($response, $observer);
90
91		return all($promises);
92		}
93
94		private function handleResponseContentsComplete(
95		ResponseInterface $response,
96		ObserverInterface $observer
97		): CancellablePromiseInterface {
98		return $this->handleResponseContents($response, $observer)->then(function () use ($observer) {
99		$observer->onCompleted();
100		return new FulfilledPromise();
101		}, function ($error) use ($observer) {
102		$observer->onError($error);
103		return new FulfilledPromise();
104		});
105		}
106
107	1	private function handleResponseContents(
108		ResponseInterface $response,
109		ObserverInterface $observer
110		): CancellablePromiseInterface {
111	1	$observer->onNext($response->getBody()->getJson());
		0 ignored issues – show Bug introduced 2017-01-14 12:57 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...
112		return new FulfilledPromise();
113		}
114		}
115

php-api-clients / github

GitHub Access Token became invalid

Push — master ( 430f59...c8c9fd )

IteratePagesService::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like