Notifier - Code Metrics - Inspection of "Update the Notifier to notify only once the same d..." - jeancsil/flight-spy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 028b55...c232a2 )

by Jean

created 2017-01-28 20:16 UTC

Notifier A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	9
lcom	1
cbo	8
dl	0
loc	93
ccs	0
cts	50
cp	0
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	notify()	20	2
A	wasNotified()	8	1
B	createNotifications()	25	4
A	setElasticSearchRequester()	4	1

<?php
/**
 * @author Jean Silva <[email protected]>
 * @license MIT
 */
namespace Jeancsil\FlightSpy\Notifier\Slack;

use Jeancsil\FlightSpy\Api\DataTransfer\SessionParameters;
use Jeancsil\FlightSpy\Service\ElasticSearch\ElasticSearchWriterTrait;
use Jeancsil\FlightSpy\Service\ElasticSearch\ElasticSearchRequester;
use Jeancsil\FlightSpy\Notifier\Deal;
use Jeancsil\FlightSpy\Notifier\NotifiableInterface;
use Maknz\Slack\Client;

class Notifier implements NotifiableInterface
{
    use ElasticSearchWriterTrait;

    /**
     * @var ElasticSearchRequester
     */
    private $elasticSearchRequester;
    /**
     * @var Client
     */
    private $slackClient;
    /**
     * @var string
     */
    private $slackUserName;

    public function __construct(Client $slackClient, $slackUserName)
    {
        $this->slackClient = $slackClient;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->slackUserName = $slackUserName;
    }

    /**
     * @param Deal[] $deals
     * @param SessionParameters $sessionParameters
     */
    public function notify(array $deals, SessionParameters $sessionParameters)
    {
        $notifications = $this->createNotifications($deals, $sessionParameters);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        /**
         * @var string $identifier
         * @var SlackNotification $notification
         */
        foreach ($notifications as $identifier => $notification) {
            $this->slackClient
                ->createMessage()
                ->send($notification->message);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

            $this->elasticSearchWriter
                ->writeOne([
                    'identifier' => $identifier,
                    'notified' => $notification->to
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                ]);
        }
    }

    /** @inheritdoc */
    public function wasNotified(Deal $deal, $notifyTo)
    {
        return $this->elasticSearchRequester
            ->wasNotified(
                $deal->getIdentifier(),
                $notifyTo
            );
    }

    /** @inheritdoc */
    public function createNotifications(SessionParameters $parameters, array $deals = [])
    {
        $notifications = [];
        /** @var Deal $deal */
        foreach ($deals as $deal) {
            $to = "@{$this->slackUserName}";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);

            if ($this->wasNotified($deal, $to)) {
                continue;
            }

            $notification = new SlackNotification();
$a = "a";
$ab = "ab";
$abc = "abc";
            $notification->to = $to;
            $message = $deal->getAgentName() . $parameters->currency . number_format($deal->getPrice());
$a = "a";
$ab = "ab";
$abc = "abc";

            if ($deal->getDeepLinkUrl()) {
                $message .=  PHP_EOL . "<{$deal->getDeepLinkUrl()}|Deep Link>";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            }

            $notification->message = $message;
$a = "a";
$ab = "ab";
$abc = "abc";
            $notifications[$deal->getIdentifier()] = $notification;
        }

        return $notifications;
    }

    /**
     * @param ElasticSearchRequester $elasticSearchRequester
     */
    public function setElasticSearchRequester(ElasticSearchRequester $elasticSearchRequester)

    {
        $this->elasticSearchRequester = $elasticSearchRequester;
    }
}


1			<?php
2			/**
3			* @author Jean Silva <[email protected]>
4			* @license MIT
5			*/
6			namespace Jeancsil\FlightSpy\Notifier\Slack;
7
8			use Jeancsil\FlightSpy\Api\DataTransfer\SessionParameters;
9			use Jeancsil\FlightSpy\Service\ElasticSearch\ElasticSearchWriterTrait;
10			use Jeancsil\FlightSpy\Service\ElasticSearch\ElasticSearchRequester;
11			use Jeancsil\FlightSpy\Notifier\Deal;
12			use Jeancsil\FlightSpy\Notifier\NotifiableInterface;
13			use Maknz\Slack\Client;
14
15			class Notifier implements NotifiableInterface
16			{
17			use ElasticSearchWriterTrait;
18
19			/**
20			* @var ElasticSearchRequester
21			*/
22			private $elasticSearchRequester;
23			/**
24			* @var Client
25			*/
26			private $slackClient;
27			/**
28			* @var string
29			*/
30			private $slackUserName;
31
32			public function __construct(Client $slackClient, $slackUserName)
33			{
34			$this->slackClient = $slackClient;
			0 ignored issues – show Coding Style introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
35			$this->slackUserName = $slackUserName;
36			}
37
38			/**
39			* @param Deal[] $deals
40			* @param SessionParameters $sessionParameters
41			*/
42			public function notify(array $deals, SessionParameters $sessionParameters)
43			{
44			$notifications = $this->createNotifications($deals, $sessionParameters);
			0 ignored issues – show Documentation introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report `$deals` is of type `array<integer,object<Jea...ightSpy\Notifier\Deal>>`, but the function expects a `object<Jeancsil\FlightSp...sfer\SessionParameters>`. 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... Documentation introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report `$sessionParameters` is of type `object<Jeancsil\FlightSp...sfer\SessionParameters>`, but the function expects a `array`. 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...
45
46			/**
47			* @var string $identifier
48			* @var SlackNotification $notification
49			*/
50			foreach ($notifications as $identifier => $notification) {
51			$this->slackClient
52			->createMessage()
53			->send($notification->message);
			0 ignored issues – show Bug introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report Accessing `message` on the interface `Jeancsil\FlightSpy\Notifier\Notification` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
54
55			$this->elasticSearchWriter
56			->writeOne([
57			'identifier' => $identifier,
58			'notified' => $notification->to
			0 ignored issues – show Bug introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report Accessing `to` on the interface `Jeancsil\FlightSpy\Notifier\Notification` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
59			]);
60			}
61			}
62
63			/** @inheritdoc */
64			public function wasNotified(Deal $deal, $notifyTo)
65			{
66			return $this->elasticSearchRequester
67			->wasNotified(
68			$deal->getIdentifier(),
69			$notifyTo
70			);
71			}
72
73			/** @inheritdoc */
74			public function createNotifications(SessionParameters $parameters, array $deals = [])
75			{
76			$notifications = [];
77			/** @var Deal $deal */
78			foreach ($deals as $deal) {
79			$to = "@{$this->slackUserName}";
			0 ignored issues – show Coding Style Best Practice introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$this` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
80
81			if ($this->wasNotified($deal, $to)) {
82			continue;
83			}
84
85			$notification = new SlackNotification();
			0 ignored issues – show Coding Style introduced 2016-10-03 13:03 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
86			$notification->to = $to;
87			$message = $deal->getAgentName() . $parameters->currency . number_format($deal->getPrice());
			0 ignored issues – show Coding Style introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 10 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
88
89			if ($deal->getDeepLinkUrl()) {
90			$message .= PHP_EOL . "<{$deal->getDeepLinkUrl()}\|Deep Link>";
			0 ignored issues – show Coding Style Best Practice introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$deal` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
91			}
92
93			$notification->message = $message;
			0 ignored issues – show Coding Style introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 17 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
94			$notifications[$deal->getIdentifier()] = $notification;
95			}
96
97			return $notifications;
98			}
99
100			/**
101			* @param ElasticSearchRequester $elasticSearchRequester
102			*/
103			public function setElasticSearchRequester(ElasticSearchRequester $elasticSearchRequester)
			0 ignored issues – show Comprehensibility Naming introduced 2017-01-28 20:24 UTC by Report Bug Copy Issue Report The variable name `$elasticSearchRequester` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
104			{
105			$this->elasticSearchRequester = $elasticSearchRequester;
106			}
107			}
108

jeancsil / flight-spy

Push — master ( 028b55...c232a2 )

Notifier A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like