SendMessages::getProject() - Code Metrics - Inspection of "Misc: increment version & update changes doc" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 195b94...7a36f1 )

by Mohamed

created 2016-08-19 09:32 UTC

SendMessages::getProject() A

↳ Parent: SendMessages

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	14
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	14
loc	14
rs	9.4285
cc	3
eloc	7
nc	3
nop	0

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Model\Project\Note;

use Tinyissue\Model\Project;
use Tinyissue\Model\Project\Issue;
use Tinyissue\Model\Message\Queue;
use Illuminate\Support\Collection;
use Tinyissue\Model\User;
use Tinyissue\Services\SendMessagesAbstract;

/**
 * SendMessages is a class to manage & process of sending messages about note changes.
 *
 * @author Mohamed Alsharaf <[email protected]>
 */
class SendMessages extends SendMessagesAbstract
{
    protected $template = 'update_note';

    /**
     * Returns the subject text.
     *
     * @return string
     */
    protected function getSubject()
    {
        return $this->getProject()->name;
    }

    /**
     * Note: changes is belongs to the project (no issue here).
     *
     * @return bool
     */
    protected function getIssue()
    {
        return false;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Returns an instance of Project.
     *
     * @return Project
     */
    protected function getProject()

    {
        if ($this->getModel()) {
            return $this->getModel()->project;
        }

        // Possible deleted note
        if (null === $this->project) {
            $projectId     = $this->latestMessage->getDataFromPayload('origin.project_id');
            $this->project = (new Project())->find($projectId);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }

        return $this->project;
    }

    /**
     * Returns the project id.
     *
     * @return int
     */
    protected function getProjectId()
    {
        return $this->getProject()->id;
    }

    /**
     * Returns message data belongs to adding a note.
     *
     * @param Queue $queue
     *
     * @return array
     */
    protected function getMessageDataForAddNote(Queue $queue)
    {
        $messageData                    = [];
        $messageData['changeByHeading'] = $queue->changeBy->fullname . ' added a note';
        $messageData['changes']['note'] = [
            'noLabel' => true,
            'date'    => $this->getModel()->created_at,
            'now'     => \Html::format($this->getModel()->body),
        ];

        return $messageData;
    }

    /**
     * Returns message data belongs to updating a note.
     *
     * @param Queue $queue
     *
     * @return array
     */
    protected function getMessageDataForUpdateNote(Queue $queue)

    {
        $messageData                    = [];
        $messageData['changeByHeading'] = $queue->changeBy->fullname . ' updated a note in ' . link_to($this->getProject()->to(), $this->getProject()->name);
        $messageData['changes']['note'] = [
            'noLabel' => true,
            'date'    => $queue->getDataFromPayload('origin.updated_at'),
            'was'     => \Html::format($queue->getDataFromPayload('origin.body')),
            'now'     => \Html::format($queue->getDataFromPayload('dirty.body')),
        ];

        return $messageData;
    }

    /**
     * Returns message data belongs to deleting a note.
     *
     * @param Queue $queue
     *
     * @return array
     */
    protected function getMessageDataForDeleteNote(Queue $queue)

    {
        $messageData                    = [];
        $messageData['changeByHeading'] = $queue->changeBy->fullname . ' deleted a note in ' . link_to($this->getProject()->to(), $this->getProject()->name);
        $messageData['changes']['note'] = [
            'noLabel' => true,
            'date'    => $queue->created_at,
            'was'     => \Html::format($queue->getDataFromPayload('origin.body')),
            'now'     => '',
        ];

        return $messageData;
    }

    /**
     * Return text to be used for the message heading.
     *
     * @param Queue           $queue
     * @param Collection|null $changes
     *
     * @return string
     */
    protected function getMessageHeading(Queue $queue, Collection $changes = null)
    {
        $heading = parent::getMessageHeading($queue, $changes);
        $heading .= ' updated a note in ' . link_to($this->getProject()->to(), '#' . $this->getProjectId());

        return $heading;
    }

    /**
     * Check that the project is loaded and the note is belongs to the project.
     *
     * @return bool
     */
    protected function validateData()
    {
        return $this->getProject() && $this->getModel() && $this->getModel()->project_id === $this->getProject()->id;
    }

    /**
     * Check if the latest message is about deleting a note.
     *
     * @return bool
     */
    public function isStatusMessage()
    {
        return $this->latestMessage->event === Queue::DELETE_NOTE;
    }
}


1		<?php
2
3		/*
4		* This file is part of the Tinyissue package.
5		*
6		* (c) Mohamed Alsharaf <[email protected]>
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 Tinyissue\Model\Project\Note;
13
14		use Tinyissue\Model\Project;
15		use Tinyissue\Model\Project\Issue;
16		use Tinyissue\Model\Message\Queue;
17		use Illuminate\Support\Collection;
18		use Tinyissue\Model\User;
19		use Tinyissue\Services\SendMessagesAbstract;
20
21		/**
22		* SendMessages is a class to manage & process of sending messages about note changes.
23		*
24		* @author Mohamed Alsharaf <[email protected]>
25		*/
26		class SendMessages extends SendMessagesAbstract
27		{
28		protected $template = 'update_note';
29
30		/**
31		* Returns the subject text.
32		*
33		* @return string
34		*/
35		protected function getSubject()
36		{
37		return $this->getProject()->name;
38		}
39
40		/**
41		* Note: changes is belongs to the project (no issue here).
42		*
43		* @return bool
44		*/
45		protected function getIssue()
46		{
47		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-06-06 00:05 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the abstract method `Tinyissue\Services\SendMessagesAbstract::getIssue` of type `Tinyissue\Model\Project\Issue`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
48		}
49
50		/**
51		* Returns an instance of Project.
52		*
53		* @return Project
54		*/
55	View Code Duplication	protected function getProject()
		1 ignored issue – show Duplication introduced 2016-06-06 00:05 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...
56		{
57		if ($this->getModel()) {
58		return $this->getModel()->project;
59		}
60
61		// Possible deleted note
62		if (null === $this->project) {
63		$projectId = $this->latestMessage->getDataFromPayload('origin.project_id');
64		$this->project = (new Project())->find($projectId);
		0 ignored issues – show Documentation Bug introduced 2016-06-06 00:05 UTC by Report Bug Copy Issue Report The method `find` does not exist on `object<Tinyissue\Model\Project>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
65		}
66
67		return $this->project;
68		}
69
70		/**
71		* Returns the project id.
72		*
73		* @return int
74		*/
75		protected function getProjectId()
76		{
77		return $this->getProject()->id;
78		}
79
80		/**
81		* Returns message data belongs to adding a note.
82		*
83		* @param Queue $queue
84		*
85		* @return array
86		*/
87		protected function getMessageDataForAddNote(Queue $queue)
88		{
89		$messageData = [];
90		$messageData['changeByHeading'] = $queue->changeBy->fullname . ' added a note';
91		$messageData['changes']['note'] = [
92		'noLabel' => true,
93		'date' => $this->getModel()->created_at,
94		'now' => \Html::format($this->getModel()->body),
95		];
96
97		return $messageData;
98		}
99
100		/**
101		* Returns message data belongs to updating a note.
102		*
103		* @param Queue $queue
104		*
105		* @return array
106		*/
107	View Code Duplication	protected function getMessageDataForUpdateNote(Queue $queue)
		1 ignored issue – show Duplication introduced 2016-06-06 00:05 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...
108		{
109		$messageData = [];
110		$messageData['changeByHeading'] = $queue->changeBy->fullname . ' updated a note in ' . link_to($this->getProject()->to(), $this->getProject()->name);
111		$messageData['changes']['note'] = [
112		'noLabel' => true,
113		'date' => $queue->getDataFromPayload('origin.updated_at'),
114		'was' => \Html::format($queue->getDataFromPayload('origin.body')),
115		'now' => \Html::format($queue->getDataFromPayload('dirty.body')),
116		];
117
118		return $messageData;
119		}
120
121		/**
122		* Returns message data belongs to deleting a note.
123		*
124		* @param Queue $queue
125		*
126		* @return array
127		*/
128	View Code Duplication	protected function getMessageDataForDeleteNote(Queue $queue)
		1 ignored issue – show Duplication introduced 2016-06-06 00:05 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...
129		{
130		$messageData = [];
131		$messageData['changeByHeading'] = $queue->changeBy->fullname . ' deleted a note in ' . link_to($this->getProject()->to(), $this->getProject()->name);
132		$messageData['changes']['note'] = [
133		'noLabel' => true,
134		'date' => $queue->created_at,
135		'was' => \Html::format($queue->getDataFromPayload('origin.body')),
136		'now' => '',
137		];
138
139		return $messageData;
140		}
141
142		/**
143		* Return text to be used for the message heading.
144		*
145		* @param Queue $queue
146		* @param Collection\|null $changes
147		*
148		* @return string
149		*/
150		protected function getMessageHeading(Queue $queue, Collection $changes = null)
151		{
152		$heading = parent::getMessageHeading($queue, $changes);
153		$heading .= ' updated a note in ' . link_to($this->getProject()->to(), '#' . $this->getProjectId());
154
155		return $heading;
156		}
157
158		/**
159		* Check that the project is loaded and the note is belongs to the project.
160		*
161		* @return bool
162		*/
163		protected function validateData()
164		{
165		return $this->getProject() && $this->getModel() && $this->getModel()->project_id === $this->getProject()->id;
166		}
167
168		/**
169		* Check if the latest message is about deleting a note.
170		*
171		* @return bool
172		*/
173		public function isStatusMessage()
174		{
175		return $this->latestMessage->event === Queue::DELETE_NOTE;
176		}
177		}
178

satrun77 / tinyissue

Push — master ( 195b94...7a36f1 )

SendMessages::getProject() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like