NotificationMarkedAsUnreadEventHandler - Code Metrics - Inspection of "Feature/notifier" - kreta/Kreta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#366)

by Beñat

created 2017-07-11 17:38 UTC

NotificationMarkedAsUnreadEventHandler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	24
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	1
dl	24
loc	24
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	4	4	1
A	isSubscribeTo()	4	4	1
A	handle()	9	9	1

How to fix Duplicated Code

<?php

/*
 * This file is part of the Kreta package.
 *
 * (c) Beñat Espiña <[email protected]>
 * (c) Gorka Laucirica <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Kreta\Notifier\Domain\ReadEvent\Inbox\Notification;

use Kreta\Notifier\Domain\Model\Inbox\Notification\NotificationMarkedAsUnread;
use Kreta\Notifier\Domain\ReadModel\Inbox\Notification\NotificationView;
use Kreta\SharedKernel\Domain\Model\DomainEvent;
use Kreta\SharedKernel\Domain\ReadEvent\EventHandler;

class NotificationMarkedAsUnreadEventHandler implements EventHandler

{
    private $view;

    public function __construct(NotificationView $view)
    {
        $this->view = $view;
    }

    public function isSubscribeTo() : string
    {
        return NotificationMarkedAsUnread::class;
    }

    public function handle(DomainEvent $event) : void
    {
        $notification = $this->view->notificationOfId($event->notificationId());
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.
    }
}

        $notification->status = $event->status()->status();
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.
    }
}
        $notification->readOn = null;

        $this->view->save($notification);
    }
}


1		<?php
2
3		/*
4		* This file is part of the Kreta package.
5		*
6		* (c) Beñat Espiña <[email protected]>
7		* (c) Gorka Laucirica <[email protected]>
8		*
9		* For the full copyright and license information, please view the LICENSE
10		* file that was distributed with this source code.
11		*/
12
13		declare(strict_types=1);
14
15		namespace Kreta\Notifier\Domain\ReadEvent\Inbox\Notification;
16
17		use Kreta\Notifier\Domain\Model\Inbox\Notification\NotificationMarkedAsUnread;
18		use Kreta\Notifier\Domain\ReadModel\Inbox\Notification\NotificationView;
19		use Kreta\SharedKernel\Domain\Model\DomainEvent;
20		use Kreta\SharedKernel\Domain\ReadEvent\EventHandler;
21
22	View Code Duplication	class NotificationMarkedAsUnreadEventHandler implements EventHandler
		0 ignored issues – show Duplication introduced 2017-06-11 10:23 UTC by Report Bug Copy Issue Report This class 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...
23		{
24		private $view;
25
26		public function __construct(NotificationView $view)
27		{
28		$this->view = $view;
29		}
30
31		public function isSubscribeTo() : string
32		{
33		return NotificationMarkedAsUnread::class;
34		}
35
36		public function handle(DomainEvent $event) : void
37		{
38		$notification = $this->view->notificationOfId($event->notificationId());
		0 ignored issues – show Bug introduced 2017-06-11 10:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kreta\SharedKernel\Domain\Model\DomainEvent` as the method `notificationId()` does only exist in the following implementations of said interface: `Kreta\Notifier\Domain\Mo...otificationMarkedAsRead`, `Kreta\Notifier\Domain\Mo...ificationMarkedAsUnread`, `Kreta\Notifier\Domain\Mo...n\NotificationPublished`. 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...
39
40		$notification->status = $event->status()->status();
		0 ignored issues – show Bug introduced 2017-06-11 10:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kreta\SharedKernel\Domain\Model\DomainEvent` as the method `status()` does only exist in the following implementations of said interface: `Kreta\Notifier\Domain\Mo...otificationMarkedAsRead`, `Kreta\Notifier\Domain\Mo...ificationMarkedAsUnread`, `Kreta\Notifier\Domain\Mo...n\NotificationPublished`. 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...
41		$notification->readOn = null;
42
43		$this->view->save($notification);
44		}
45		}
46

kreta / Kreta

Pull Request — master (#366)

NotificationMarkedAsUnreadEventHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like