Tinyissue\Model\Traits\Project\Issue\CrudTagTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

89.06%

Importance

Changes	9
Bugs	3	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	createTags()	0	20	3
B	syncTags()	0	61	6
B	changeStatus()	0	35	2
B	setCurrentTag()	0	15	5

<?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\Traits\Tag\DataMappingTrait;
use Tinyissue\Model\Traits\Tag\FilterTrait;
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
{
    use DataMappingTrait,
        FilterTrait;

    /**
     * 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;
            $addTagName   = Tag::STATUS_CLOSED;

            /** @var \Illuminate\Support\Collection $ids */
            $ids = $this->getTagsExceptStatus()->getRelatedIds();

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

        } else {
            $activityType = Activity::TYPE_REOPEN_ISSUE;
            $removeTag    = Tag::STATUS_CLOSED;
            $addTagName   = Tag::STATUS_OPEN;

            /** @var \Illuminate\Support\Collection $ids */
            $ids = $this->getTagsExcept($removeTag)->getRelatedIds();

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

        }

        $ids->push((new Tag())->getTagByName($addTagName)->id);

        $this->tags()->sync($ids->unique()->all());

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

        /* 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 Collection $tags
     * @param Collection $currentTags
     *
     * @return bool
     */
    public function syncTags(Collection $tags, Collection $currentTags = null)
    {
        $removedTags = [];
        if (null === $currentTags) {
            // Open status tag
            $openTag = (new Tag())->getTagByName(Tag::STATUS_OPEN);

            // Add the following tags except for open status
            $addedTags = $tags
                ->filter([$this, 'tagsExceptStatusOpenCallback'])
                ->map([$this, 'toArrayCallback'])
                ->toArray();
        } else {
            // Open status tag
            $openTag = $currentTags->first([$this, 'onlyStatusOpenCallback']);

            // Remove status tag
            $currentTags = $currentTags->filter([$this, 'tagsExceptStatusOpenCallback']);

            // Make sure the tags does not includes the open status
            $tags = $tags->filter([$this, 'tagsExceptStatusOpenCallback']);

            // Tags remove from the issue
            $removedTags = $currentTags
                ->diff($tags)
                ->map([$this, 'toArrayCallback'])
                ->toArray();

            // Check if we are adding new tags
            $addedTags = $tags
                ->filter(function (Tag $tag) use ($currentTags) {
                    return $currentTags->where('id', $tag->id)->count() === 0;
                })
                ->map([$this, 'toArrayCallback'])
                ->toArray();

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

        // Make sure open status exists
        $tags->put($openTag->id, $openTag);

        // 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?

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

    /**
     * Create new tags from a string "group:tag_name" and fetch tag from a tag id.
     *
     * @param array $tags
     * @param bool  $isAdmin
     *
     * @return Collection
     */
    protected function createTags(array $tags, $isAdmin = false)
    {
        $newTags = new Collection($tags);

        // Transform the user input tags into tag objects
        $newTags->transform(function ($tagNameOrId) use ($isAdmin) {
            if (strpos($tagNameOrId, ':') !== false && $isAdmin) {
                return (new Tag())->createTagFromString($tagNameOrId);
            } else {
                return Tag::find($tagNameOrId);
            }
        });

        // Filter out invalid tags entered by the user
        $newTags = $newTags->filter(function ($tag) {
            return $tag instanceof Tag;
        });

        return $newTags;
    }

    /**
     * Add tag to the issue & close issue if added tag is Closed.
     *
     * @param Tag  $newTag
     * @param Tag  $oldTag
     * @param User $user
     *
     * @return $this
     */
    public function setCurrentTag(Tag $newTag, Tag $oldTag, User $user)
    {
        if ($newTag->name === Tag::STATUS_CLOSED || $newTag->name === Tag::STATUS_OPEN) {
            $status = $newTag->name === Tag::STATUS_CLOSED ? 0 : 1;
            $this->changeStatus($status, $user->id);
        } else {
            // Remove tag only if its not open tag. Open tag removed on closing the issue only.
            if ($oldTag->name !== Tag::STATUS_OPEN) {
                $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?

            }
            $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?

        }

        return $this;
    }
}