SendCommentMomentHandler - Code Metrics - Inspection of "Moments related enhancements" - gitaminhq/Gitamin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#106)

by Phecho

created 2015-12-17 03:49 UTC

SendCommentMomentHandler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	36
Duplicated Lines	30.56 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	3
c	1
b	0
f	1
lcom	0
cbo	2
dl	11
loc	36
rs	10

2 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	10	2
A	trigger()	11	11	1

How to fix Duplicated Code

<?php

/*
 * This file is part of Gitamin.
 *
 * Copyright (C) 2015-2016 The Gitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gitamin\Handlers\Events\Comment;

use Gitamin\Events\Comment\CommentEventInterface;
use Gitamin\Events\Comment\CommentWasAddedEvent;
use Gitamin\Models\Comment;
use Gitamin\Models\Moment;
use Illuminate\Foundation\Bus\DispatchesJobs;

class SendCommentMomentHandler
{
    use DispatchesJobs;

    /**
     * Handle the comment updated moment.
     */
    public function handle(CommentEventInterface $event)
    {
        if ($event instanceof CommentWasAddedEvent) {
            $action = Moment::COMMENTED;
        } else {
            $action = Moment::COMMENTED;
        }

        $this->trigger($event->comment, $action);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

    /**
     * Trigger the moment.
     *
     * @param \Gitamin\Models\Comment $comment
     * @param int                     $action
     */
    protected function trigger(Comment &$comment, $action)

    {
        $data = [
            'target_type' => 'Comment',
            'target_id' => $comment->id,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'action' => $action,
            'author_id' => $comment->author_id,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'project_id' => $comment->project->id,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        ];
        $moment = Moment::create($data);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }
}


1		<?php
2
3		/*
4		* This file is part of Gitamin.
5		*
6		* Copyright (C) 2015-2016 The Gitamin Team
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Gitamin\Handlers\Events\Comment;
13
14		use Gitamin\Events\Comment\CommentEventInterface;
15		use Gitamin\Events\Comment\CommentWasAddedEvent;
16		use Gitamin\Models\Comment;
17		use Gitamin\Models\Moment;
18		use Illuminate\Foundation\Bus\DispatchesJobs;
19
20		class SendCommentMomentHandler
21		{
22		use DispatchesJobs;
23
24		/**
25		* Handle the comment updated moment.
26		*/
27		public function handle(CommentEventInterface $event)
28		{
29		if ($event instanceof CommentWasAddedEvent) {
30		$action = Moment::COMMENTED;
31		} else {
32		$action = Moment::COMMENTED;
33		}
34
35		$this->trigger($event->comment, $action);
		0 ignored issues – show Bug introduced 2015-12-17 03:40 UTC by Report Bug Copy Issue Report Accessing `comment` on the interface `Gitamin\Events\Comment\CommentEventInterface` 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...
36		}
37
38		/**
39		* Trigger the moment.
40		*
41		* @param \Gitamin\Models\Comment $comment
42		* @param int $action
43		*/
44	View Code Duplication	protected function trigger(Comment &$comment, $action)
		0 ignored issues – show Duplication introduced 2015-12-17 03:40 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...
45		{
46		$data = [
47		'target_type' => 'Comment',
48		'target_id' => $comment->id,
		0 ignored issues – show Documentation introduced 2015-12-17 03:40 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Gitamin\Models\Comment>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
49		'action' => $action,
50		'author_id' => $comment->author_id,
		0 ignored issues – show Documentation introduced 2015-12-17 03:40 UTC by Report Bug Copy Issue Report The property `author_id` does not exist on `object<Gitamin\Models\Comment>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
51		'project_id' => $comment->project->id,
		0 ignored issues – show Documentation introduced 2015-12-17 03:40 UTC by Report Bug Copy Issue Report The property `project` does not exist on `object<Gitamin\Models\Comment>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
52		];
53		$moment = Moment::create($data);
		0 ignored issues – show Unused Code introduced 2015-12-17 03:40 UTC by Report Bug Copy Issue Report `$moment` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
54		}
55		}
56

gitaminhq / Gitamin

Pull Request — master (#106)

SendCommentMomentHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like