CrudTrait - Code Metrics - Inspection of "Change: rename issue getAddComment() to postAddCom..." - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 6184bf...9623b5 )

by Mohamed

created 2016-08-06 03:55 UTC

CrudTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

75.96%

Importance

Changes	10
Bugs	4	Features	1

Metric	Value
wmc	18
c	10
b	4
f	1
lcom	1
cbo	8
dl	0
loc	202
ccs	79
cts	104
cp	0.7596
rs	10

6 Methods

Rating	Name	Size	Complexity
A	changeUpdatedBy()	7	1
A	reassign()	19	2
B	createIssue()	41	4
A	changeProject()	18	3
B	delete()	27	2
B	updateIssue()	39	6

<?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\Traits\Project\Issue;

use Illuminate\Database\Eloquent;
use Illuminate\Database\Eloquent\Relations;
use Tinyissue\Model;
use Tinyissue\Model\Activity;
use Tinyissue\Model\Project;
use Tinyissue\Model\Project\Issue\Attachment;
use Tinyissue\Model\User;

/**
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Project\Issue model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property int                        $id
 * @property int                        $created_by
 * @property int                        $project_id
 * @property string                     $title
 * @property string                     $body
 * @property int                        $assigned_to
 * @property int                        $time_quote
 * @property int                        $closed_by
 * @property int                        $closed_at
 * @property int                        status
 * @property int                        $updated_at
 * @property int                        $updated_by
 * @property Project                    $project
 * @property User                       $user
 * @property User                       $updatedBy
 *
 * @method   Eloquent\Model             save()
 * @method   Eloquent\Model             fill(array $attributes)
 * @method   Relations\BelongsToMany    tags()
 * @method   Relations\HasMany          activities()
 * @method   Relations\HasMany          comments()
 */
trait CrudTrait
{
    /**
     * Set the issue is updated by a user.
     *
     * @param int $userId
     *
     * @return Eloquent\Model
     */
    public function changeUpdatedBy($userId)
    {
        $this->updated_by = $userId;
        $this->touch();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this->save();
    }

    /**
     * Reassign the issue to a new user.
     *
     * @param int|User $assignTo
     * @param User     $user
     *
     * @return Eloquent\Model
     */
    public function reassign($assignTo, User $user)
    {
        $assignToId        = !$assignTo instanceof User ? $assignTo : $assignTo->id;
        $this->assigned_to = $assignToId;

        // Add event on successful save
        static::saved(function (Project\Issue $issue) use ($user) {
            $this->queueAssign($issue, $user);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        });

        $this->save();

        return $this->activities()->save(new User\Activity([
            'type_id'   => Activity::TYPE_REASSIGN_ISSUE,
            'parent_id' => $this->project->id,
            'user_id'   => $user->id,
            'action_id' => $this->assigned_to,
        ]));
    }

    /**
     * Update the given issue.
     *
     * @param array $input
     *
     * @return Eloquent\Model
     */
    public function updateIssue(array $input)
    {
        $fill = array_only($input, [
            'title', 'body', 'assigned_to',
        ]);
        $fill['updated_by'] = $this->updatedBy->id;

        if (isset($input['time_quote']['lock'])) {
            $fill['lock_quote'] = $input['time_quote']['lock'];
        }

        // Only save quote if not locked or locked & user allowed to modify it
        if (array_key_exists('time_quote', $input) &&
            (!$this->isQuoteLocked() || $this->user->permission(Model\Permission::PERM_ISSUE_LOCK_QUOTE))
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        ) {
            $fill['time_quote'] = $input['time_quote'];
        }

        /* Add to activity log for assignment if changed */
        if ($input['assigned_to'] != $this->assigned_to) {
            $this->activities()->save(new User\Activity([
                'type_id'   => Activity::TYPE_REASSIGN_ISSUE,
                'parent_id' => $this->project->id,
                'user_id'   => $this->updatedBy->id,
                'action_id' => $this->assigned_to,
            ]));
        }

        $this->fill($fill);

        $this->syncTags($input, $this->tags()->with('parent')->get());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Add event on successful save
        static::saved(function (Project\Issue $issue) {
            $this->queueUpdate($issue, $issue->updatedBy);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        });

        return $this->save();
    }

    /**
     * Create a new issue.
     *
     * @param array $input
     *
     * @return CrudTrait

     */
    public function createIssue(array $input)
    {
        $fill = [
            'created_by' => $this->user->id,
            'project_id' => $this->project->id,
            'title'      => $input['title'],
            'body'       => $input['body'],
        ];

        if ($this->user->permission('issue-modify')) {
            $fill['assigned_to'] = $input['assigned_to'];
            $fill['time_quote']  = $input['time_quote'];
        }

        $this->fill($fill)->save();

        // Add issue to messages queue
        $this->queueAdd($this, $this->user);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        /* Add to user's activity log */
        $this->activities()->save(new User\Activity([
            'type_id'   => Activity::TYPE_CREATE_ISSUE,
            'parent_id' => $this->project->id,
            'user_id'   => $this->user->id,
        ]));

        /* Add attachments to issue */
        Attachment::where('upload_token', '=', $input['upload_token'])

            ->where('uploaded_by', '=', $this->user->id)
            ->update(['issue_id' => $this->id]);

        // Add default tag to newly created issue
        $defaultTag = app('tinyissue.settings')->getFirstStatusTagId();
        if ($defaultTag > 0 && empty($input['tag_status'])) {
            $input['tag_status'] = $defaultTag;
        }

        $this->syncTags($input);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    /**
     * Move the issue (comments & activities) to another project.
     *
     * @param int $projectId
     *
     * @return $this
     */
    public function changeProject($projectId)
    {
        $this->project_id = $projectId;
        $this->save();
        $comments = $this->comments()->get();
        foreach ($comments as $comment) {
            $comment->project_id = $projectId;
            $comment->save();
        }

        $activities = $this->activities()->get();
        foreach ($activities as $activity) {
            $activity->parent_id = $projectId;
            $activity->save();
        }

        return $this;
    }

    /**
     * Delete an issue.
     *
     * @return bool
     *
     * @throws \Exception
     */
    public function delete()
    {
        $id          = $this->id;
        $projectId   = $this->project_id;
        $comments    = $this->comments;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $attachments = $this->attachments;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        $status = parent::delete();

        if ($status) {
            $attachments->each(function (Attachment $attachment) use ($projectId) {
                $path = config('filesystems.disks.local.root')
                    . '/' . config('tinyissue.uploads_dir')
                    . '/' . $projectId
                    . '/' . $attachment->upload_token;
                $attachment->deleteFile($path, $attachment->filename);
                $attachment->delete();
            });
            $comments->each(function (Project\Issue\Comment $comment) {
                $comment->deleteComment(auth()->user());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            });
            User\Activity::where('parent_id', '=', $projectId)->where('item_id', '=', $id)->delete();
            \DB::table('projects_issues_tags')->where('issue_id', '=', $id)->delete();
        }

        return $status;
    }
}


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\Traits\Project\Issue;
13
14		use Illuminate\Database\Eloquent;
15		use Illuminate\Database\Eloquent\Relations;
16		use Tinyissue\Model;
17		use Tinyissue\Model\Activity;
18		use Tinyissue\Model\Project;
19		use Tinyissue\Model\Project\Issue\Attachment;
20		use Tinyissue\Model\User;
21
22		/**
23		* CrudTrait is trait class containing the methods for adding/editing/deleting the Project\Issue model.
24		*
25		* @author Mohamed Alsharaf <[email protected]>
26		*
27		* @property int $id
28		* @property int $created_by
29		* @property int $project_id
30		* @property string $title
31		* @property string $body
32		* @property int $assigned_to
33		* @property int $time_quote
34		* @property int $closed_by
35		* @property int $closed_at
36		* @property int status
37		* @property int $updated_at
38		* @property int $updated_by
39		* @property Project $project
40		* @property User $user
41		* @property User $updatedBy
42		*
43		* @method Eloquent\Model save()
44		* @method Eloquent\Model fill(array $attributes)
45		* @method Relations\BelongsToMany tags()
46		* @method Relations\HasMany activities()
47		* @method Relations\HasMany comments()
48		*/
49		trait CrudTrait
50		{
51		/**
52		* Set the issue is updated by a user.
53		*
54		* @param int $userId
55		*
56		* @return Eloquent\Model
57		*/
58	10	public function changeUpdatedBy($userId)
59		{
60	10	$this->updated_by = $userId;
61	10	$this->touch();
		0 ignored issues – show Bug introduced 2016-06-06 00:05 UTC by Report Bug Copy Issue Report It seems like `touch()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
62
63	10	return $this->save();
64		}
65
66		/**
67		* Reassign the issue to a new user.
68		*
69		* @param int\|User $assignTo
70		* @param User $user
71		*
72		* @return Eloquent\Model
73		*/
74	3	public function reassign($assignTo, User $user)
75	1	{
76	3	$assignToId = !$assignTo instanceof User ? $assignTo : $assignTo->id;
77	3	$this->assigned_to = $assignToId;
78
79		// Add event on successful save
80		static::saved(function (Project\Issue $issue) use ($user) {
81	3	$this->queueAssign($issue, $user);
		0 ignored issues – show Bug introduced 2016-06-18 11:47 UTC by Report Bug Copy Issue Report It seems like `queueAssign()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
82	3	});
83
84	3	$this->save();
85
86	3	return $this->activities()->save(new User\Activity([
87	3	'type_id' => Activity::TYPE_REASSIGN_ISSUE,
88	3	'parent_id' => $this->project->id,
89	3	'user_id' => $user->id,
90	3	'action_id' => $this->assigned_to,
91	3	]));
92		}
93
94		/**
95		* Update the given issue.
96		*
97		* @param array $input
98		*
99		* @return Eloquent\Model
100		*/
101	8	public function updateIssue(array $input)
102		{
103	6	$fill = array_only($input, [
104	6	'title', 'body', 'assigned_to',
105	6	]);
106	6	$fill['updated_by'] = $this->updatedBy->id;
107
108	6	if (isset($input['time_quote']['lock'])) {
109		$fill['lock_quote'] = $input['time_quote']['lock'];
110		}
111
112		// Only save quote if not locked or locked & user allowed to modify it
113	6	if (array_key_exists('time_quote', $input) &&
114	6	(!$this->isQuoteLocked() \|\| $this->user->permission(Model\Permission::PERM_ISSUE_LOCK_QUOTE))
		0 ignored issues – show Bug introduced 2016-07-03 11:44 UTC by Report Bug Copy Issue Report It seems like `isQuoteLocked()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
115	6	) {
116	6	$fill['time_quote'] = $input['time_quote'];
117	6	}
118
119		/* Add to activity log for assignment if changed */
120	6	if ($input['assigned_to'] != $this->assigned_to) {
121	1	$this->activities()->save(new User\Activity([
122	1	'type_id' => Activity::TYPE_REASSIGN_ISSUE,
123	1	'parent_id' => $this->project->id,
124	1	'user_id' => $this->updatedBy->id,
125	1	'action_id' => $this->assigned_to,
126	1	]));
127	1	}
128
129	6	$this->fill($fill);
130
131	6	$this->syncTags($input, $this->tags()->with('parent')->get());
		0 ignored issues – show Bug introduced 2016-04-19 08:26 UTC by Report Bug Copy Issue Report It seems like `syncTags()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
132
133		// Add event on successful save
134		static::saved(function (Project\Issue $issue) {
135	6	$this->queueUpdate($issue, $issue->updatedBy);
		0 ignored issues – show Bug introduced 2016-06-08 11:20 UTC by Report Bug Copy Issue Report It seems like `queueUpdate()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
136	8	});
137
138	6	return $this->save();
139		}
140
141		/**
142		* Create a new issue.
143		*
144		* @param array $input
145		*
146		* @return CrudTrait
		0 ignored issues – show Comprehensibility Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report The return type `CrudTrait` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
147		*/
148	37	public function createIssue(array $input)
149		{
150		$fill = [
151	37	'created_by' => $this->user->id,
152	37	'project_id' => $this->project->id,
153	37	'title' => $input['title'],
154	37	'body' => $input['body'],
155	37	];
156
157	37	if ($this->user->permission('issue-modify')) {
158	36	$fill['assigned_to'] = $input['assigned_to'];
159	36	$fill['time_quote'] = $input['time_quote'];
160	36	}
161
162	37	$this->fill($fill)->save();
163
164		// Add issue to messages queue
165	37	$this->queueAdd($this, $this->user);
		0 ignored issues – show Bug introduced 2016-06-08 11:20 UTC by Report Bug Copy Issue Report It seems like `queueAdd()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
166
167		/* Add to user's activity log */
168	37	$this->activities()->save(new User\Activity([
169	37	'type_id' => Activity::TYPE_CREATE_ISSUE,
170	37	'parent_id' => $this->project->id,
171	37	'user_id' => $this->user->id,
172	37	]));
173
174		/* Add attachments to issue */
175	37	Attachment::where('upload_token', '=', $input['upload_token'])
		0 ignored issues – show Unused Code introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report The call to `Attachment::where()` has too many arguments starting with `'upload_token'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
176	37	->where('uploaded_by', '=', $this->user->id)
177	37	->update(['issue_id' => $this->id]);
178
179		// Add default tag to newly created issue
180	37	$defaultTag = app('tinyissue.settings')->getFirstStatusTagId();
181	37	if ($defaultTag > 0 && empty($input['tag_status'])) {
182		$input['tag_status'] = $defaultTag;
183		}
184
185	37	$this->syncTags($input);
		0 ignored issues – show Bug introduced 2016-04-19 08:26 UTC by Report Bug Copy Issue Report It seems like `syncTags()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
186
187	37	return $this;
188		}
189
190		/**
191		* Move the issue (comments & activities) to another project.
192		*
193		* @param int $projectId
194		*
195		* @return $this
196		*/
197	7	public function changeProject($projectId)
198		{
199	1	$this->project_id = $projectId;
200	1	$this->save();
201	7	$comments = $this->comments()->get();
202	1	foreach ($comments as $comment) {
203	1	$comment->project_id = $projectId;
204	1	$comment->save();
205	1	}
206
207	1	$activities = $this->activities()->get();
208	1	foreach ($activities as $activity) {
209	1	$activity->parent_id = $projectId;
210	1	$activity->save();
211	1	}
212
213	1	return $this;
214		}
215
216		/**
217		* Delete an issue.
218		*
219		* @return bool
220		*
221		* @throws \Exception
222		*/
223		public function delete()
224		{
225		$id = $this->id;
226		$projectId = $this->project_id;
227		$comments = $this->comments;
		0 ignored issues – show Bug introduced 2016-06-25 13:20 UTC by Report Bug Copy Issue Report The property `comments` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
228		$attachments = $this->attachments;
		0 ignored issues – show Bug introduced 2016-06-25 13:20 UTC by Report Bug Copy Issue Report The property `attachments` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
229
230		$status = parent::delete();
231
232		if ($status) {
233		$attachments->each(function (Attachment $attachment) use ($projectId) {
234		$path = config('filesystems.disks.local.root')
235		. '/' . config('tinyissue.uploads_dir')
236		. '/' . $projectId
237		. '/' . $attachment->upload_token;
238		$attachment->deleteFile($path, $attachment->filename);
239		$attachment->delete();
240		});
241		$comments->each(function (Project\Issue\Comment $comment) {
242		$comment->deleteComment(auth()->user());
		0 ignored issues – show Documentation introduced 2016-06-25 13:20 UTC by Report Bug Copy Issue Report `auth()->user()` is of type `object<Illuminate\Contra...h\Authenticatable>\|null`, but the function expects a `object<Tinyissue\Model\User>`. 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...
243		});
244		User\Activity::where('parent_id', '=', $projectId)->where('item_id', '=', $id)->delete();
245		\DB::table('projects_issues_tags')->where('issue_id', '=', $id)->delete();
246		}
247
248		return $status;
249		}
250		}
251

satrun77 / tinyissue

Push — develop ( 6184bf...9623b5 )

CrudTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like