Tinyissue\Model\Traits\Project\Issue\CrudTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

73.52%

Importance

Changes	11
Bugs	5	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	changeUpdatedBy()	0	7	1
B	createIssue()	0	41	4
B	updateIssue()	0	31	2
A	reassign()	0	20	3
A	changeProject()	0	18	3

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 *
 * 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 <mohamed.alsharaf@gmail.com>
 *
 * @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();

It seems like touch() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this->save();
    }

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

        // Add event on successful save
        static::saved(function (Project\Issue $issue) use ($userId) {
            $this->queueAssign($issue, $userId);

It seems like queueAssign() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        });

        $this->save();

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

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

        /* 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());

It seems like syncTags() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Add event on successful save
        static::saved(function (Project\Issue $issue) {
            $this->queueUpdate($issue, $issue->updatedBy);

It seems like queueUpdate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        });

        return $this->save();
    }

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

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?

     */
    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);

It seems like queueAdd() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        /* 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'])

The call to Attachment::where() has too many arguments starting with '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);

It seems like syncTags() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        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;
    }
}