CrudTagTrait::setCurrentTag() - Code Metrics - Inspection of "Bug: prevent removing open tag from kanban view" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c323cb...66e3b1 )

by Mohamed

created 2016-03-16 09:09 UTC

CrudTagTrait::setCurrentTag() B

↳ Parent: CrudTagTrait

Complexity

Conditions	5
Paths	4

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	15
ccs	0
cts	7
cp	0
rs	8.8571
cc	5
eloc	9
nc	4
nop	3
crap	30

<?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\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 <[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 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();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            $activityType = Activity::TYPE_REOPEN_ISSUE;
            $removeTag    = Tag::STATUS_CLOSED;
            $addTagName   = Tag::STATUS_OPEN;

            /** @var \Illuminate\Support\Collection $ids */
            $ids = $this->getTagsExcept($removeTag)->getRelatedIds();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

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

        $this->tags()->sync($ids->unique()->all());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        /* Add to activity log */
        $this->activities()->save(new User\Activity([
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            'type_id'   => $activityType,
            'parent_id' => $this->project->id,
            'user_id'   => $userId,
        ]));

        $this->status = $status;

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

    /**
     * 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());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // 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([
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                '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);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
            $this->tags()->attach($newTag);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this;
    }
}


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\Support\Collection;
16		use Tinyissue\Model;
17		use Tinyissue\Model\Activity;
18		use Tinyissue\Model\Project;
19		use Tinyissue\Model\Tag;
20		use Tinyissue\Model\Traits\Tag\DataMappingTrait;
21		use Tinyissue\Model\Traits\Tag\FilterTrait;
22		use Tinyissue\Model\User;
23
24		/**
25		* CrudTagTrait is trait class containing the methods for adding/editing/deleting the tags of Project\Issue model.
26		*
27		* @author Mohamed Alsharaf <[email protected]>
28		*
29		* @property int $id
30		* @property int $created_by
31		* @property int $project_id
32		* @property string $title
33		* @property string $body
34		* @property int $assigned_to
35		* @property int $time_quote
36		* @property int $closed_by
37		* @property int $closed_at
38		* @property int status
39		* @property int $updated_at
40		* @property int $updated_by
41		* @property Model\Project $project
42		* @property Model\User $user
43		* @property Model\User $updatedBy
44		*/
45		trait CrudTagTrait
46		{
47		use DataMappingTrait,
48		FilterTrait;
49
50		/**
51		* Change the status of an issue.
52		*
53		* @param int $status
54		* @param int $userId
55		*
56		* @return Eloquent\Model
57		*/
58	5	public function changeStatus($status, $userId)
59		{
60	5	if ($status == 0) {
61	5	$this->closed_by = $userId;
62	5	$this->closed_at = (new \DateTime())->format('Y-m-d H:i:s');
63
64	5	$activityType = Activity::TYPE_CLOSE_ISSUE;
65	5	$addTagName = Tag::STATUS_CLOSED;
66
67		/** @var \Illuminate\Support\Collection $ids */
68	5	$ids = $this->getTagsExceptStatus()->getRelatedIds();
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `getTagsExceptStatus()` 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...
69		} else {
70	1	$activityType = Activity::TYPE_REOPEN_ISSUE;
71	1	$removeTag = Tag::STATUS_CLOSED;
72	1	$addTagName = Tag::STATUS_OPEN;
73
74		/** @var \Illuminate\Support\Collection $ids */
75	1	$ids = $this->getTagsExcept($removeTag)->getRelatedIds();
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `getTagsExcept()` 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...
76		}
77
78	5	$ids->push((new Tag())->getTagByName($addTagName)->id);
79
80	5	$this->tags()->sync($ids->unique()->all());
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `tags()` 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...
81
82		/* Add to activity log */
83	5	$this->activities()->save(new User\Activity([
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `activities()` 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...
84	5	'type_id' => $activityType,
85	5	'parent_id' => $this->project->id,
86	5	'user_id' => $userId,
87		]));
88
89	5	$this->status = $status;
90
91	5	return $this->save();
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `save()` 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...
92		}
93
94		/**
95		* Sync the issue tags.
96		*
97		* @param Collection $tags
98		* @param Collection $currentTags
99		*
100		* @return bool
101		*/
102	28	public function syncTags(Collection $tags, Collection $currentTags = null)
103		{
104	28	$removedTags = [];
105	28	if (null === $currentTags) {
106		// Open status tag
107	28	$openTag = (new Tag())->getTagByName(Tag::STATUS_OPEN);
108
109		// Add the following tags except for open status
110		$addedTags = $tags
111	28	->filter([$this, 'tagsExceptStatusOpenCallback'])
112	28	->map([$this, 'toArrayCallback'])
113	28	->toArray();
114		} else {
115		// Open status tag
116	1	$openTag = $currentTags->first([$this, 'onlyStatusOpenCallback']);
117
118		// Remove status tag
119	1	$currentTags = $currentTags->filter([$this, 'tagsExceptStatusOpenCallback']);
120
121		// Make sure the tags does not includes the open status
122	1	$tags = $tags->filter([$this, 'tagsExceptStatusOpenCallback']);
123
124		// Tags remove from the issue
125		$removedTags = $currentTags
126	1	->diff($tags)
127	1	->map([$this, 'toArrayCallback'])
128	1	->toArray();
129
130		// Check if we are adding new tags
131		$addedTags = $tags
132		->filter(function (Tag $tag) use ($currentTags) {
133	1	return $currentTags->where('id', $tag->id)->count() === 0;
134	1	})
135	1	->map([$this, 'toArrayCallback'])
136	1	->toArray();
137
138		// No new tags to add or remove
139	1	if (empty($removedTags) && empty($addedTags)) {
140	1	return true;
141		}
142		}
143
144		// Make sure open status exists
145	28	$tags->put($openTag->id, $openTag);
146
147		// Save relation
148	28	$this->tags()->sync($tags->lists('id')->all());
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `tags()` 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...
149
150		// Activity is added when new issue create with tags or updated with tags excluding the open status tag
151	28	if (!empty($removedTags) \|\| !empty($addedTags)) {
152		// Add to activity log for tags if changed
153	4	$this->activities()->save(new User\Activity([
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `activities()` 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...
154	4	'type_id' => Activity::TYPE_ISSUE_TAG,
155	4	'parent_id' => $this->project->id,
156	4	'user_id' => $this->user->id,
157	4	'data' => ['added_tags' => $addedTags, 'removed_tags' => $removedTags],
158		]));
159		}
160
161	28	return true;
162		}
163
164		/**
165		* Create new tags from a string "group:tag_name" and fetch tag from a tag id.
166		*
167		* @param array $tags
168		* @param bool $isAdmin
169		*
170		* @return Collection
171		*/
172	28	protected function createTags(array $tags, $isAdmin = false)
173		{
174	28	$newTags = new Collection($tags);
175
176		// Transform the user input tags into tag objects
177		$newTags->transform(function ($tagNameOrId) use ($isAdmin) {
178	28	if (strpos($tagNameOrId, ':') !== false && $isAdmin) {
179	1	return (new Tag())->createTagFromString($tagNameOrId);
180		} else {
181	28	return Tag::find($tagNameOrId);
182		}
183	28	});
184
185		// Filter out invalid tags entered by the user
186	28	$newTags = $newTags->filter(function ($tag) {
187	28	return $tag instanceof Tag;
188	28	});
189
190	28	return $newTags;
191		}
192
193		/**
194		* Add tag to the issue & close issue if added tag is Closed.
195		*
196		* @param Tag $newTag
197		* @param Tag $oldTag
198		* @param User $user
199		*
200		* @return $this
201		*/
202		public function setCurrentTag(Tag $newTag, Tag $oldTag, User $user)
203		{
204		if ($newTag->name === Tag::STATUS_CLOSED \|\| $newTag->name === Tag::STATUS_OPEN) {
205		$status = $newTag->name === Tag::STATUS_CLOSED ? 0 : 1;
206		$this->changeStatus($status, $user->id);
207		} else {
208		// Remove tag only if its not open tag. Open tag removed on closing the issue only.
209		if ($oldTag->name !== Tag::STATUS_OPEN) {
210		$this->tags()->detach($oldTag);
		0 ignored issues – show Bug introduced 2016-02-02 06:39 UTC by Report Bug Copy Issue Report It seems like `tags()` 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...
211		}
212		$this->tags()->attach($newTag);
		0 ignored issues – show Bug introduced 2016-02-02 06:39 UTC by Report Bug Copy Issue Report It seems like `tags()` 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...
213		}
214
215		return $this;
216		}
217		}
218

satrun77 / tinyissue

Push — develop ( c323cb...66e3b1 )

CrudTagTrait::setCurrentTag() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like