ObservableBunny::consume() - Code Metrics - WyriHaximus/reactphp-observable-bunny - Measure and Improve Code Quality continuously with Scrutinizer

ObservableBunny::consume() B
last analyzed 2018-05-26 21:31 UTC

↳ Parent: ObservableBunny

Complexity

Conditions	4
Paths	1

Size

Total Lines	59
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	38
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	59
ccs	38
cts	38
cp	1
rs	8.9846
c	0
b	0
f	0
cc	4
eloc	45
nc	1
nop	8
crap	4

How to fix Long Method Many Parameters

<?php declare(strict_types=1);

namespace WyriHaximus\React\ObservableBunny;

use Bunny\Async\Client;
use Bunny\Channel;
use Bunny\Message as BunnyMessage;
use Bunny\Protocol\MethodBasicConsumeOkFrame;
use React\EventLoop\LoopInterface;
use React\EventLoop\TimerInterface;
use React\Promise\PromiseInterface;
use Rx\Subject\Subject;
use Throwable;

final class ObservableBunny
{
    /**
     * @var LoopInterface
     */
    private $loop;

    /**
     * @var Client
     */
    private $bunny;

    /**
     * @var float
     */
    private $checkInterval;

    /**
     * @param LoopInterface $loop
     * @param Client        $bunny
     * @param float         $checkInterval
     */
    public function __construct(LoopInterface $loop, Client $bunny, float $checkInterval = 1.0)
    {
        $this->loop = $loop;
        $this->bunny = $bunny;
        $this->checkInterval = $checkInterval;
    }

    public function consume(
        string $queue = '',
        array $qos = [],
        string $consumerTag = '',
        bool $noLocal = false,
        bool $noAck = false,
        bool $exclusive = false,
        bool $nowait = false,
        array $arguments = []
    ): Subject {
        $subject = new Subject();
        $consumeArgs = [$queue, $consumerTag, $noLocal, $noAck, $exclusive, $nowait, $arguments];

        $channel = $this->bunny->channel();
        $channel->then(function (Channel $channel) use ($qos) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            if (count($qos) === 0) {
                return $channel;
            }

            return $channel->qos(...$qos)->then(function () use ($channel) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return $channel;
            });
        })->then(function (Channel $channel) use ($subject, $consumeArgs) {
            /** @var string $consumerTag */
            $consumerTag = null;
            $timer = $this->loop->addPeriodicTimer($this->checkInterval, function () use ($channel, $subject, &$timer, &$consumerTag) {
                if (!$subject->isDisposed()) {
                    return;
                }

                $this->cancelSubscription(
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.
    }
}
                    $timer,
                    $channel,
                    $consumerTag
                )->done([$subject, 'onComplete'], $this->onError($subject, $timer));
            });
            $channel->consume(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                function (BunnyMessage $message, Channel $channel) use ($subject, &$timer, &$consumerTag) {
                    if ($subject->isDisposed()) {
                        $channel->nack($message);
                        $this->cancelSubscription(
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.
    }
}
                            $timer,
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                            $channel,
                            $consumerTag
                        )->done([$subject, 'onComplete'], $this->onError($subject, $timer));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

                        return;
                    }

                    $subject->onNext(new Message($message, $channel));
                },
                ...$consumeArgs
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            )->then(function (MethodBasicConsumeOkFrame $response) use (&$consumerTag) {
                $consumerTag = $response->consumerTag;
            })->done(null, $this->onError($subject, $timer));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        })->done(null, [$subject, 'onError']);

        return $subject;
    }

    private function cancelSubscription(TimerInterface $timer, Channel $channel, string $consumerTag): PromiseInterface
    {
        $this->loop->cancelTimer($timer);

        return $channel->cancel($consumerTag)->then(function () use ($channel) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return $channel->close();
        });
    }

    private function onError(Subject $subject, TimerInterface $timer): callable
    {
        return function (Throwable $et) use ($subject, $timer) {
            $this->loop->cancelTimer($timer);
            $subject->onError($et);
        };
    }
}


1		<?php declare(strict_types=1);
2
3		namespace WyriHaximus\React\ObservableBunny;
4
5		use Bunny\Async\Client;
6		use Bunny\Channel;
7		use Bunny\Message as BunnyMessage;
8		use Bunny\Protocol\MethodBasicConsumeOkFrame;
9		use React\EventLoop\LoopInterface;
10		use React\EventLoop\TimerInterface;
11		use React\Promise\PromiseInterface;
12		use Rx\Subject\Subject;
13		use Throwable;
14
15		final class ObservableBunny
16		{
17		/**
18		* @var LoopInterface
19		*/
20		private $loop;
21
22		/**
23		* @var Client
24		*/
25		private $bunny;
26
27		/**
28		* @var float
29		*/
30		private $checkInterval;
31
32		/**
33		* @param LoopInterface $loop
34		* @param Client $bunny
35		* @param float $checkInterval
36		*/
37	4	public function __construct(LoopInterface $loop, Client $bunny, float $checkInterval = 1.0)
38		{
39	4	$this->loop = $loop;
40	4	$this->bunny = $bunny;
41	4	$this->checkInterval = $checkInterval;
42	4	}
43
44	4	public function consume(
45		string $queue = '',
46		array $qos = [],
47		string $consumerTag = '',
48		bool $noLocal = false,
49		bool $noAck = false,
50		bool $exclusive = false,
51		bool $nowait = false,
52		array $arguments = []
53		): Subject {
54	4	$subject = new Subject();
55	4	$consumeArgs = [$queue, $consumerTag, $noLocal, $noAck, $exclusive, $nowait, $arguments];
56
57	4	$channel = $this->bunny->channel();
58	3	$channel->then(function (Channel $channel) use ($qos) {
		0 ignored issues – show Bug introduced 2018-02-17 20:20 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Channel`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
59	3	if (count($qos) === 0) {
60	2	return $channel;
61		}
62
63	1	return $channel->qos(...$qos)->then(function () use ($channel) {
		0 ignored issues – show Documentation introduced 2018-02-17 20:20 UTC by Report Bug Copy Issue Report `$qos` is of type `array`, but the function expects a `integer`. 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... Bug introduced 2018-02-17 20:20 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Protocol\MethodBasicQosOkFrame`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
64	1	return $channel;
65	1	});
66		})->then(function (Channel $channel) use ($subject, $consumeArgs) {
67		/** @var string $consumerTag */
68	3	$consumerTag = null;
69	3	$timer = $this->loop->addPeriodicTimer($this->checkInterval, function () use ($channel, $subject, &$timer, &$consumerTag) {
70	1	if (!$subject->isDisposed()) {
71	1	return;
72		}
73
74	1	$this->cancelSubscription(
		0 ignored issues – show Bug introduced 2018-02-15 21:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `done()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. 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...
75	1	$timer,
76	1	$channel,
77	1	$consumerTag
78	1	)->done([$subject, 'onComplete'], $this->onError($subject, $timer));
79	3	});
80	3	$channel->consume(
		0 ignored issues – show Bug introduced 2018-02-14 22:29 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Protocol\MethodBasicConsumeOkFrame`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
81	3	function (BunnyMessage $message, Channel $channel) use ($subject, &$timer, &$consumerTag) {
82	2	if ($subject->isDisposed()) {
83	1	$channel->nack($message);
84	1	$this->cancelSubscription(
		0 ignored issues – show Bug introduced 2018-02-15 21:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `done()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. 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...
85	1	$timer,
		0 ignored issues – show Documentation introduced 2018-04-07 13:15 UTC by Report Bug Copy Issue Report `$timer` is of type `object<React\EventLoop\Timer\TimerInterface>`, but the function expects a `object<React\EventLoop\TimerInterface>`. 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...
86	1	$channel,
87	1	$consumerTag
88	1	)->done([$subject, 'onComplete'], $this->onError($subject, $timer));
		0 ignored issues – show Documentation introduced 2018-04-07 13:15 UTC by Report Bug Copy Issue Report `$timer` is of type `object<React\EventLoop\Timer\TimerInterface>`, but the function expects a `object<React\EventLoop\TimerInterface>`. 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...
89
90	1	return;
91		}
92
93	1	$subject->onNext(new Message($message, $channel));
94	3	},
95	3	...$consumeArgs
		0 ignored issues – show Documentation introduced 2018-02-14 22:29 UTC by Report Bug Copy Issue Report `$consumeArgs` is of type `array<integer,string\|boo..."boolean","6":"array"}>`, but the function expects a `string`. 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...
96	3	)->then(function (MethodBasicConsumeOkFrame $response) use (&$consumerTag) {
97	2	$consumerTag = $response->consumerTag;
98	3	})->done(null, $this->onError($subject, $timer));
		0 ignored issues – show Documentation introduced 2018-04-07 13:15 UTC by Report Bug Copy Issue Report `$timer` is of type `object<React\EventLoop\Timer\TimerInterface>`, but the function expects a `object<React\EventLoop\TimerInterface>`. 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...
99	4	})->done(null, [$subject, 'onError']);
100
101	4	return $subject;
102		}
103
104	2	private function cancelSubscription(TimerInterface $timer, Channel $channel, string $consumerTag): PromiseInterface
105		{
106	2	$this->loop->cancelTimer($timer);
107
108	2	return $channel->cancel($consumerTag)->then(function () use ($channel) {
		0 ignored issues – show Bug introduced 2018-02-15 21:08 UTC by Report Bug Copy Issue Report The method `then` does only exist in `React\Promise\PromiseInterface`, but not in `Bunny\Protocol\MethodBasicCancelOkFrame`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
109	2	return $channel->close();
110	2	});
111		}
112
113		private function onError(Subject $subject, TimerInterface $timer): callable
114		{
115	3	return function (Throwable $et) use ($subject, $timer) {
116	1	$this->loop->cancelTimer($timer);
117	1	$subject->onError($et);
118	3	};
119		}
120		}
121

WyriHaximus / reactphp-observable-bunny

GitHub Access Token became invalid

ObservableBunny::consume() B last analyzed 2018-05-26 21:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ObservableBunny::consume() B
last analyzed 2018-05-26 21:31 UTC