SendsMessages::sendMessage() - Code Metrics - Inspection of "removed sendDelayedMessage, sendMessage now accept..." - fondbot/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5fdd05...737a7e )

by Vladimir

created 2017-05-26 08:36 UTC

SendsMessages::sendMessage() A

↳ Parent: SendsMessages

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	13
Ratio	100 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace FondBot\Conversation\Traits;

use FondBot\Drivers\Chat;
use FondBot\Drivers\User;
use FondBot\Contracts\Queue;
use FondBot\Templates\Attachment;
use FondBot\Conversation\Template;
use FondBot\Drivers\Commands\SendMessage;
use FondBot\Drivers\Commands\SendRequest;
use FondBot\Drivers\Commands\SendAttachment;

trait SendsMessages
{
    /**
     * Send message to user.
     *
     * @param string        $text
     * @param Template|null $template
     * @param int           $delay
     */
    protected function sendMessage(string $text, Template $template = null, int $delay = 0): void

    {
        /** @var Queue $queue */
        $queue = resolve(Queue::class);

        $command = new SendMessage($this->getChat(), $this->getUser(), $text, $template);

        if ($delay > 0) {
            $queue->later(kernel()->getChannel(), kernel()->getDriver(), $command, $delay);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        } else {
            $queue->push(kernel()->getChannel(), kernel()->getDriver(), $command);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }
    }

    /**
     * Send attachment to user.
     *
     * @param Attachment $attachment
     * @param int        $delay
     *
     * @throws \Psr\Container\ContainerExceptionInterface
     */
    protected function sendAttachment(Attachment $attachment, int $delay = 0): void

    {
        /** @var Queue $queue */
        $queue = resolve(Queue::class);

        $command = new SendAttachment($this->getChat(), $this->getUser(), $attachment);

        if ($delay === 0) {
            $queue->push(kernel()->getChannel(), kernel()->getDriver(), $command);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        } else {
            $queue->later(kernel()->getChannel(), kernel()->getDriver(), $command, $delay);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }
    }

    /**
     * Send request to the messaging service.
     *
     * @param string $endpoint
     * @param array  $parameters
     *
     * @throws \Psr\Container\ContainerExceptionInterface
     */
    protected function sendRequest(string $endpoint, array $parameters = []): void
    {
        /** @var Queue $queue */
        $queue = resolve(Queue::class);

        $command = new SendRequest($this->getChat(), $this->getUser(), $endpoint, $parameters);
        $queue->push(kernel()->getChannel(), kernel()->getDriver(), $command);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * Get chat.
     *
     * @return Chat
     */
    abstract protected function getChat(): Chat;

    /**
     * Get user.
     *
     * @return User
     */
    abstract protected function getUser(): User;
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace FondBot\Conversation\Traits;
6
7			use FondBot\Drivers\Chat;
8			use FondBot\Drivers\User;
9			use FondBot\Contracts\Queue;
10			use FondBot\Templates\Attachment;
11			use FondBot\Conversation\Template;
12			use FondBot\Drivers\Commands\SendMessage;
13			use FondBot\Drivers\Commands\SendRequest;
14			use FondBot\Drivers\Commands\SendAttachment;
15
16			trait SendsMessages
17			{
18			/**
19			* Send message to user.
20			*
21			* @param string $text
22			* @param Template\|null $template
23			* @param int $delay
24			*/
25	3	View Code Duplication	protected function sendMessage(string $text, Template $template = null, int $delay = 0): void
			0 ignored issues – show Duplication introduced 2017-04-22 11:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
26			{
27			/** @var Queue $queue */
28	3		$queue = resolve(Queue::class);
29
30	3		$command = new SendMessage($this->getChat(), $this->getUser(), $text, $template);
31
32	3		if ($delay > 0) {
33	1		$queue->later(kernel()->getChannel(), kernel()->getDriver(), $command, $delay);
			0 ignored issues – show Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getChannel()` can be `null`; however, `later()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getDriver()` can be `null`; however, `later()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
34			} else {
35	2		$queue->push(kernel()->getChannel(), kernel()->getDriver(), $command);
			0 ignored issues – show Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getChannel()` can be `null`; however, `push()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getDriver()` can be `null`; however, `push()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
36			}
37	3		}
38
39			/**
40			* Send attachment to user.
41			*
42			* @param Attachment $attachment
43			* @param int $delay
44			*
45			* @throws \Psr\Container\ContainerExceptionInterface
46			*/
47	2	View Code Duplication	protected function sendAttachment(Attachment $attachment, int $delay = 0): void
			0 ignored issues – show Duplication introduced 2017-05-26 08:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
48			{
49			/** @var Queue $queue */
50	2		$queue = resolve(Queue::class);
51
52	2		$command = new SendAttachment($this->getChat(), $this->getUser(), $attachment);
53
54	2		if ($delay === 0) {
55	1		$queue->push(kernel()->getChannel(), kernel()->getDriver(), $command);
			0 ignored issues – show Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getChannel()` can be `null`; however, `push()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getDriver()` can be `null`; however, `push()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
56			} else {
57	1		$queue->later(kernel()->getChannel(), kernel()->getDriver(), $command, $delay);
			0 ignored issues – show Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getChannel()` can be `null`; however, `later()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getDriver()` can be `null`; however, `later()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
58			}
59	2		}
60
61			/**
62			* Send request to the messaging service.
63			*
64			* @param string $endpoint
65			* @param array $parameters
66			*
67			* @throws \Psr\Container\ContainerExceptionInterface
68			*/
69	1		protected function sendRequest(string $endpoint, array $parameters = []): void
70			{
71			/** @var Queue $queue */
72	1		$queue = resolve(Queue::class);
73
74	1		$command = new SendRequest($this->getChat(), $this->getUser(), $endpoint, $parameters);
75	1		$queue->push(kernel()->getChannel(), kernel()->getDriver(), $command);
			0 ignored issues – show Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getChannel()` can be `null`; however, `push()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `kernel()->getDriver()` can be `null`; however, `push()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
76	1		}
77
78			/**
79			* Get chat.
80			*
81			* @return Chat
82			*/
83			abstract protected function getChat(): Chat;
84
85			/**
86			* Get user.
87			*
88			* @return User
89			*/
90			abstract protected function getUser(): User;
91			}
92

fondbot / framework

Push — master ( 5fdd05...737a7e )

SendsMessages::sendMessage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like