Tinyissue\Model\Traits\Project\Issue\CrudTagTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

71.43%

Importance

Changes	14
Bugs	5	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	changeStatus()	0	23	2
B	changeKanbanTag()	0	33	4
B	syncTags()	0	56	6

<?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\Support\Collection;
use Tinyissue\Model;
use Tinyissue\Model\Activity;
use Tinyissue\Model\Project;
use Tinyissue\Model\Tag;
use Tinyissue\Model\User;

/**
 * CrudTagTrait is trait class containing the methods for adding/editing/deleting the tags of 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 Model\Project $project
 * @property Model\User $user
 * @property Model\User $updatedBy
 */
trait CrudTagTrait
{
    /**
     * Change the status of an issue.
     *
     * @param int $status
     * @param int $userId
     *
     * @return Eloquent\Model
     */
    public function changeStatus($status, $userId)
    {
        if ($status == 0) {
            $this->closed_by = $userId;
            $this->closed_at = (new \DateTime())->format('Y-m-d H:i:s');
            $activityType    = Activity::TYPE_CLOSE_ISSUE;
        } else {
            $this->closed_by = 0;
            $this->closed_at = null;
            $activityType    = Activity::TYPE_REOPEN_ISSUE;
        }

        /* Add to activity log */
        $this->activities()->save(new User\Activity([

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

            'type_id'   => $activityType,
            'parent_id' => $this->project->id,
            'user_id'   => $userId,
        ]));

        $this->status = $status;

        return $this->save();

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

    }

    /**
     * Sync the issue tags.
     *
     * @param array      $input
     * @param Collection $currentTags
     *
     * @return bool
     */
    public function syncTags(array $input, Collection $currentTags = null)
    {
        $tagIds = array_only($input, [
            'tag_type', 'tag_status', 'tag_resolution',
        ]);
        $tags = (new Tag())->whereIn('id', $tagIds)->get();

        $removedTags = [];
        if (null === $currentTags) {
            // Add the following tags except for open status
            $addedTags = $tags

The method map cannot be called on $tags (of type array).

                ->map(function (Tag $tag) {
                    return $tag->toShortArray();
                })
                ->toArray();
        } else {
            // Tags remove from the issue
            $removedTags = $currentTags
                ->diff($tags)
                ->map(function (Tag $tag) {
                    return $tag->toShortArray();
                })
                ->toArray();

            // Check if we are adding new tags
            $addedTags = $tags

The method filter cannot be called on $tags (of type array).

                ->filter(function (Tag $tag) use ($currentTags) {
                    return $currentTags->where('id', $tag->id)->count() === 0;
                })
                ->map(function (Tag $tag) {
                    return $tag->toShortArray();
                })
                ->toArray();

            // No new tags to add or remove
            if (empty($removedTags) && empty($addedTags)) {
                return true;
            }
        }

        // Save relation
        $this->tags()->sync($tags->lists('id')->all());

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

The method lists cannot be called on $tags (of type array).

        // Activity is added when new issue create with tags or updated with tags excluding the open status tag
        if (!empty($removedTags) || !empty($addedTags)) {
            // Add to activity log for tags if changed
            $this->activities()->save(new User\Activity([

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

                'type_id'   => Activity::TYPE_ISSUE_TAG,
                'parent_id' => $this->project->id,
                'user_id'   => $this->user->id,
                'data'      => ['added_tags' => $addedTags, 'removed_tags' => $removedTags],
            ]));
        }

        return true;
    }

    /**
     * Add tag to the issue & close issue if added tag is Closed.
     *
     * @param Tag $newTag
     * @param Tag $oldTag
     *
     * @return $this
     */
    public function changeKanbanTag(Tag $newTag, Tag $oldTag)
    {
        //  skip if there is no change in status tags
        if ($oldTag->name === $newTag->name) {
            return $this;
        }

        // Open issue
        $data = ['added_tags' => [], 'removed_tags' => []];

        // Remove previous status tag
        $this->tags()->detach($oldTag);

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

        $data['removed_tags'][] = $oldTag->toShortArray();

        // Add new tag
        if (!$this->tags->contains($newTag)) {

The property tags does not exist. Did you maybe forget to declare it?

            $this->tags()->attach($newTag);

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

            $data['added_tags'][] = $newTag->toShortArray();
        }

        // Add to activity log for tags if changed
        if (!empty($data)) {
            $this->activities()->save(new User\Activity([

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

                'type_id'   => Activity::TYPE_ISSUE_TAG,
                'parent_id' => $this->project->id,
                'user_id'   => $this->user->id,
                'data'      => $data,
            ]));
        }

        return $this;
    }
}