AsyncClient::extract() - Code Metrics - Inspection of "Require api-clients/transport 3" - php-api-clients/github - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8f129d...f20c64 )

by Cees-Jan

created 2017-08-21 18:36 UTC

AsyncClient::extract() A

↳ Parent: AsyncClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);

namespace ApiClients\Client\Github;

use ApiClients\Client\Github\CommandBus\Command;
use ApiClients\Foundation\ClientInterface;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use ApiClients\Foundation\Factory;
use ApiClients\Foundation\Options;
use ApiClients\Foundation\Resource\ResourceInterface;
use React\EventLoop\LoopInterface;
use React\Promise\CancellablePromiseInterface;
use React\Promise\PromiseInterface;
use React\Stream\ReadableStreamInterface;
use Rx\Observable;
use Rx\Scheduler;
use function ApiClients\Tools\Rx\unwrapObservableFromPromise;

final class AsyncClient implements AsyncClientInterface
{
    /**
     * @var ClientInterface
     */
    private $client;

    /**
     * @var RateLimitState
     */
    private $rateLimitState;

    /**
     * @param ClientInterface $client
     * @param RateLimitState  $rateLimitState
     */
    private function __construct(ClientInterface $client, RateLimitState $rateLimitState)
    {
        $this->client = $client;
        $this->rateLimitState = $rateLimitState;
    }

    /**
     * @param  LoopInterface           $loop
     * @param  AuthenticationInterface $auth
     * @param  array                   $options
     * @return AsyncClient
     */
    public static function create(
        LoopInterface $loop,
        AuthenticationInterface $auth,
        array $options = []
    ): self {
        $options = ApiSettings::getOptions($auth, $options, 'Async');
        $rateLimitState = new RateLimitState();
        $options[Options::CONTAINER_DEFINITIONS][RateLimitState::class] = $rateLimitState;
        $client = Factory::create($loop, $options);

        try {
            Scheduler::setAsyncFactory(function () use ($loop) {
                return new Scheduler\EventLoopScheduler($loop);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            });
        } catch (\Throwable $t) {

        }

        return new self($client, $rateLimitState);
    }

    /**
     * @internal
     * @param  ClientInterface $client
     * @param  RateLimitState  $rateLimitState
     * @return AsyncClient
     */
    public static function createFromClient(ClientInterface $client, RateLimitState $rateLimitState): self
    {
        return new self($client, $rateLimitState);
    }

    public function hydrate(string $resource): CancellablePromiseInterface
    {
        return $this->client->hydrate($resource);
    }

    public function extract(ResourceInterface $resource): CancellablePromiseInterface
    {
        return $this->client->extract($resource);
    }

    public function meta(): PromiseInterface
    {
        return $this->client->handle(new Command\MetaCommand());
    }

    /**
     * @param  string           $user
     * @return PromiseInterface
     */
    public function user(string $user): PromiseInterface
    {
        return $this->client->handle(new Command\UserCommand($user));
    }

    /**
     * @return PromiseInterface
     */
    public function whoami(): PromiseInterface
    {
        return $this->client->handle(new Command\UserCommand());
    }

    /**
     * @return Observable
     */
    public function emojis(): Observable
    {
        return unwrapObservableFromPromise($this->client->handle(new Command\EmojisCommand()));
    }

    public function myOrganizations(): Observable
    {
        return unwrapObservableFromPromise($this->client->handle(new Command\MyOrganizationsCommand()));
    }

    public function licenses(): Observable
    {
        return unwrapObservableFromPromise($this->client->handle(new Command\LicensesCommand()));
    }

    public function watching(): Observable
    {
        return unwrapObservableFromPromise($this->client->handle(new Command\WatchingCommand()));
    }

    /**
     * @return RateLimitState
     */
    public function getRateLimitState(): RateLimitState
    {
        return clone $this->rateLimitState;
    }

    public function rateLimit(): PromiseInterface
    {
        return $this->client->handle(new Command\RateLimitCommand());
    }

    public function renderMarkdown(
        ReadableStreamInterface $stream,
        string $mode = 'markdown',
        string $context = ''
    ): PromiseInterface {
        $stream->pause();

        return $this->client->handle(new Command\RenderMarkdownCommand(
            $stream,
            $mode,
            $context
        ));
    }
}


1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Client\Github;
4
5		use ApiClients\Client\Github\CommandBus\Command;
6		use ApiClients\Foundation\ClientInterface;
		0 ignored issues – show Bug introduced 2017-04-16 14:00 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `ApiClients\Client\Github\ClientInterface`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
7		use ApiClients\Foundation\Factory;
8		use ApiClients\Foundation\Options;
9		use ApiClients\Foundation\Resource\ResourceInterface;
10		use React\EventLoop\LoopInterface;
11		use React\Promise\CancellablePromiseInterface;
12		use React\Promise\PromiseInterface;
13		use React\Stream\ReadableStreamInterface;
14		use Rx\Observable;
15		use Rx\Scheduler;
16		use function ApiClients\Tools\Rx\unwrapObservableFromPromise;
17
18		final class AsyncClient implements AsyncClientInterface
19		{
20		/**
21		* @var ClientInterface
22		*/
23		private $client;
24
25		/**
26		* @var RateLimitState
27		*/
28		private $rateLimitState;
29
30		/**
31		* @param ClientInterface $client
32		* @param RateLimitState $rateLimitState
33		*/
34	2	private function __construct(ClientInterface $client, RateLimitState $rateLimitState)
35		{
36	2	$this->client = $client;
37	2	$this->rateLimitState = $rateLimitState;
38	2	}
39
40		/**
41		* @param LoopInterface $loop
42		* @param AuthenticationInterface $auth
43		* @param array $options
44		* @return AsyncClient
45		*/
46	1	public static function create(
47		LoopInterface $loop,
48		AuthenticationInterface $auth,
49		array $options = []
50		): self {
51	1	$options = ApiSettings::getOptions($auth, $options, 'Async');
52	1	$rateLimitState = new RateLimitState();
53	1	$options[Options::CONTAINER_DEFINITIONS][RateLimitState::class] = $rateLimitState;
54	1	$client = Factory::create($loop, $options);
55
56		try {
57	1	Scheduler::setAsyncFactory(function () use ($loop) {
58		return new Scheduler\EventLoopScheduler($loop);
		0 ignored issues – show Documentation introduced 2017-03-25 16:00 UTC by Report Bug Copy Issue Report `$loop` is of type `object<React\EventLoop\LoopInterface>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
59	1	});
60		} catch (\Throwable $t) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-25 16:00 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
61		}
62
63	1	return new self($client, $rateLimitState);
64		}
65
66		/**
67		* @internal
68		* @param ClientInterface $client
69		* @param RateLimitState $rateLimitState
70		* @return AsyncClient
71		*/
72	1	public static function createFromClient(ClientInterface $client, RateLimitState $rateLimitState): self
73		{
74	1	return new self($client, $rateLimitState);
75		}
76
77		public function hydrate(string $resource): CancellablePromiseInterface
78		{
79		return $this->client->hydrate($resource);
80		}
81
82		public function extract(ResourceInterface $resource): CancellablePromiseInterface
83		{
84		return $this->client->extract($resource);
85		}
86
87		public function meta(): PromiseInterface
88		{
89		return $this->client->handle(new Command\MetaCommand());
90		}
91
92		/**
93		* @param string $user
94		* @return PromiseInterface
95		*/
96		public function user(string $user): PromiseInterface
97		{
98		return $this->client->handle(new Command\UserCommand($user));
99		}
100
101		/**
102		* @return PromiseInterface
103		*/
104		public function whoami(): PromiseInterface
105		{
106		return $this->client->handle(new Command\UserCommand());
107		}
108
109		/**
110		* @return Observable
111		*/
112		public function emojis(): Observable
113		{
114		return unwrapObservableFromPromise($this->client->handle(new Command\EmojisCommand()));
115		}
116
117		public function myOrganizations(): Observable
118		{
119		return unwrapObservableFromPromise($this->client->handle(new Command\MyOrganizationsCommand()));
120		}
121
122		public function licenses(): Observable
123		{
124		return unwrapObservableFromPromise($this->client->handle(new Command\LicensesCommand()));
125		}
126
127		public function watching(): Observable
128		{
129		return unwrapObservableFromPromise($this->client->handle(new Command\WatchingCommand()));
130		}
131
132		/**
133		* @return RateLimitState
134		*/
135	2	public function getRateLimitState(): RateLimitState
136		{
137	2	return clone $this->rateLimitState;
138		}
139
140		public function rateLimit(): PromiseInterface
141		{
142		return $this->client->handle(new Command\RateLimitCommand());
143		}
144
145		public function renderMarkdown(
146		ReadableStreamInterface $stream,
147		string $mode = 'markdown',
148		string $context = ''
149		): PromiseInterface {
150		$stream->pause();
151
152		return $this->client->handle(new Command\RenderMarkdownCommand(
153		$stream,
154		$mode,
155		$context
156		));
157		}
158		}
159

php-api-clients / github

GitHub Access Token became invalid

Push — master ( 8f129d...f20c64 )

AsyncClient::extract() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like