IteratePagesService::iterate() - Code Metrics - php-api-clients/appveyor - Measure and Improve Code Quality continuously with Scrutinizer

IteratePagesService::iterate() A
last analyzed 2019-01-22 01:16 UTC

↳ Parent: IteratePagesService

Complexity

Conditions	4
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	32
CRAP Score	4.0032

Importance

Changes

Metric	Value
cc	4
nc	1
nop	5
dl	0
loc	54
ccs	32
cts	34
cp	0.9412
crap	4.0032
rs	9.0036
c	0
b	0
f	0

How to fix Long Method

<?php declare(strict_types=1);

namespace ApiClients\Client\AppVeyor\Service;

use ApiClients\Foundation\Transport\Service\RequestService;
use Psr\Http\Message\ResponseInterface;
use RingCentral\Psr7\Request;
use Rx\AsyncSchedulerInterface;
use Rx\Observable;
use Rx\Scheduler;
use Rx\Subject\Subject;
use function igorw\get_in;

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

    /**
     * @var AsyncSchedulerInterface
     */
    private $scheduler;

    /**
     * @param RequestService               $requestService
     * @param AsyncSchedulerInterface|null $scheduler
     */
    public function __construct(RequestService $requestService, AsyncSchedulerInterface $scheduler = null)
    {
        $this->requestService = $requestService;
        $this->scheduler = $scheduler ?: Scheduler::getAsync();
    }

    public function iterate(
        string $path,
        string $collectionIndex,
        string $identifierIndex,
        string $identifierQueryKey,
        array $options = []
    ): Observable {
        $paths = new Subject();

        return Observable::of($path, $this->scheduler)
            ->merge($paths)
            ->flatMap(function ($path) use ($options) {
                return Observable::fromPromise($this->requestService->request(
                    new Request('GET', $path),
                    $options
                ));
            })
            ->do(function (ResponseInterface $response) use (
                $path,
                $paths,
                $collectionIndex,
                $identifierIndex,
                $identifierQueryKey
            ) {
                $json = $response->getBody()->getParsedContents();
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.
    }
}
                $items = $json;
                if ($collectionIndex !== '') {
                    $items = get_in($json, explode('.', $collectionIndex));
                }

                if (count($items) === 0) {
                    $paths->onCompleted();

                    return;
                }

                $item = array_pop($items);
                $identifier = get_in($item, explode('.', $identifierIndex), false);

                if ($identifier === false) {
                    $paths->onCompleted();

                    return;
                }

                $this->scheduler->schedule(function () use ($path, $paths, $identifier, $identifierQueryKey) {
                    $paths->onNext($path . '&' . $identifierQueryKey . '=' . rawurlencode((string)$identifier));
                });
            })
            ->map(function (ResponseInterface $response) {
                return $response->getBody()->getParsedContents();
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

IteratePagesService::iterate() A
last analyzed 2019-01-22 01:16 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Client\AppVeyor\Service;
4
5		use ApiClients\Foundation\Transport\Service\RequestService;
6		use Psr\Http\Message\ResponseInterface;
7		use RingCentral\Psr7\Request;
8		use Rx\AsyncSchedulerInterface;
9		use Rx\Observable;
10		use Rx\Scheduler;
11		use Rx\Subject\Subject;
12		use function igorw\get_in;
13
14		class IteratePagesService
15		{
16		/**
17		* @var RequestService
18		*/
19		private $requestService;
20
21		/**
22		* @var AsyncSchedulerInterface
23		*/
24		private $scheduler;
25
26		/**
27		* @param RequestService $requestService
28		* @param AsyncSchedulerInterface\|null $scheduler
29		*/
30	1	public function __construct(RequestService $requestService, AsyncSchedulerInterface $scheduler = null)
31		{
32	1	$this->requestService = $requestService;
33	1	$this->scheduler = $scheduler ?: Scheduler::getAsync();
34	1	}
35
36	1	public function iterate(
37		string $path,
38		string $collectionIndex,
39		string $identifierIndex,
40		string $identifierQueryKey,
41		array $options = []
42		): Observable {
43	1	$paths = new Subject();
44
45	1	return Observable::of($path, $this->scheduler)
46	1	->merge($paths)
47	1	->flatMap(function ($path) use ($options) {
48	1	return Observable::fromPromise($this->requestService->request(
49	1	new Request('GET', $path),
50	1	$options
51		));
52	1	})
53	1	->do(function (ResponseInterface $response) use (
54	1	$path,
55	1	$paths,
56	1	$collectionIndex,
57	1	$identifierIndex,
58	1	$identifierQueryKey
59		) {
60	1	$json = $response->getBody()->getParsedContents();
		0 ignored issues – show Bug introduced 2017-12-23 19:08 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 `getParsedContents()` does only exist in the following implementations of said interface: `ApiClients\Middleware\Json\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...
61	1	$items = $json;
62	1	if ($collectionIndex !== '') {
63	1	$items = get_in($json, explode('.', $collectionIndex));
64		}
65
66	1	if (count($items) === 0) {
67	1	$paths->onCompleted();
68
69	1	return;
70		}
71
72	1	$item = array_pop($items);
73	1	$identifier = get_in($item, explode('.', $identifierIndex), false);
74
75	1	if ($identifier === false) {
76		$paths->onCompleted();
77
78		return;
79		}
80
81	1	$this->scheduler->schedule(function () use ($path, $paths, $identifier, $identifierQueryKey) {
82	1	$paths->onNext($path . '&' . $identifierQueryKey . '=' . rawurlencode((string)$identifier));
83	1	});
84	1	})
85	1	->map(function (ResponseInterface $response) {
86	1	return $response->getBody()->getParsedContents();
		0 ignored issues – show Bug introduced 2017-12-23 19:08 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 `getParsedContents()` does only exist in the following implementations of said interface: `ApiClients\Middleware\Json\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...
87	1	})
88		;
89		}
90		}
91

php-api-clients / appveyor

GitHub Access Token became invalid

IteratePagesService::iterate() A last analyzed 2019-01-22 01:16 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

IteratePagesService::iterate() A
last analyzed 2019-01-22 01:16 UTC