CrudTagTrait::changeStatus() - Code Metrics - Inspection of "Misc: increment version & update changes doc" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 195b94...858be2 )

by Mohamed

created 2016-05-09 08:41 UTC

CrudTagTrait::changeStatus() A

↳ Parent: CrudTagTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	23
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	2

Importance

Changes	9
Bugs	4	Features	1

Metric	Value
c	9
b	4
f	1
dl	0
loc	23
ccs	14
cts	14
cp	1
rs	9.0856
cc	2
eloc	15
nc	2
nop	2
crap	2

<?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\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
{
    /**
     * 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([
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 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

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

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

    /**
     * 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);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $data['removed_tags'][] = $oldTag->toShortArray();

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

$x = new MyClass();
$x->foo = true;
            $this->tags()->attach($newTag);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

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

        // Add to activity log for tags if changed
        if (!empty($data)) {
            $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'      => $data,
            ]));
        }

        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\User;
21
22		/**
23		* CrudTagTrait is trait class containing the methods for adding/editing/deleting the tags of 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 Model\Project $project
40		* @property Model\User $user
41		* @property Model\User $updatedBy
42		*/
43		trait CrudTagTrait
44		{
45		/**
46		* Change the status of an issue.
47		*
48		* @param int $status
49		* @param int $userId
50		*
51		* @return Eloquent\Model
52		*/
53	5	public function changeStatus($status, $userId)
54		{
55	5	if ($status == 0) {
56	5	$this->closed_by = $userId;
57	5	$this->closed_at = (new \DateTime())->format('Y-m-d H:i:s');
58	5	$activityType = Activity::TYPE_CLOSE_ISSUE;
59		} else {
60	1	$this->closed_by = 0;
61	1	$this->closed_at = null;
62	1	$activityType = Activity::TYPE_REOPEN_ISSUE;
63		}
64
65		/* Add to activity log */
66	5	$this->activities()->save(new User\Activity([
		0 ignored issues – show Bug introduced 2016-05-04 10:54 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...
67	5	'type_id' => $activityType,
68	5	'parent_id' => $this->project->id,
69	5	'user_id' => $userId,
70		]));
71
72	5	$this->status = $status;
73
74	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...
75		}
76
77		/**
78		* Sync the issue tags.
79		*
80		* @param array $input
81		* @param Collection $currentTags
82		*
83		* @return bool
84		*/
85	28	public function syncTags(array $input, Collection $currentTags = null)
86		{
87	28	$tagIds = array_only($input, [
88	28	'tag_type', 'tag_status', 'tag_resolution',
89		]);
90	28	$tags = (new Tag())->whereIn('id', $tagIds)->get();
91
92	28	$removedTags = [];
93	28	if (null === $currentTags) {
94		// Add the following tags except for open status
95		$addedTags = $tags
		0 ignored issues – show Bug introduced 2016-05-04 10:54 UTC by Report Bug Copy Issue Report The method `map` cannot be called on `$tags` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
96		->map(function (Tag $tag) {
97	2	return $tag->toShortArray();
98	28	})
99	28	->toArray();
100		} else {
101		// Tags remove from the issue
102		$removedTags = $currentTags
103	1	->diff($tags)
104		->map(function (Tag $tag) {
105		return $tag->toShortArray();
106	1	})
107	1	->toArray();
108
109		// Check if we are adding new tags
110		$addedTags = $tags
		0 ignored issues – show Bug introduced 2016-04-19 08:26 UTC by Report Bug Copy Issue Report The method `filter` cannot be called on `$tags` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
111		->filter(function (Tag $tag) use ($currentTags) {
112		return $currentTags->where('id', $tag->id)->count() === 0;
113	1	})
114	1	->map(function (Tag $tag) {
115		return $tag->toShortArray();
116	1	})
117	1	->toArray();
118
119		// No new tags to add or remove
120	1	if (empty($removedTags) && empty($addedTags)) {
121	1	return true;
122		}
123		}
124
125		// Save relation
126	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... Bug introduced 2016-05-04 10:54 UTC by Report Bug Copy Issue Report The method `lists` cannot be called on `$tags` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
127
128		// Activity is added when new issue create with tags or updated with tags excluding the open status tag
129	28	if (!empty($removedTags) \|\| !empty($addedTags)) {
130		// Add to activity log for tags if changed
131	2	$this->activities()->save(new User\Activity([
		0 ignored issues – show Bug introduced 2016-04-19 08:26 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...
132	2	'type_id' => Activity::TYPE_ISSUE_TAG,
133	2	'parent_id' => $this->project->id,
134	2	'user_id' => $this->user->id,
135	2	'data' => ['added_tags' => $addedTags, 'removed_tags' => $removedTags],
136		]));
137		}
138
139	28	return true;
140		}
141
142		/**
143		* Add tag to the issue & close issue if added tag is Closed.
144		*
145		* @param Tag $newTag
146		* @param Tag $oldTag
147		*
148		* @return $this
149		*/
150		public function changeKanbanTag(Tag $newTag, Tag $oldTag)
151		{
152		// skip if there is no change in status tags
153		if ($oldTag->name === $newTag->name) {
154		return $this;
155		}
156
157		// Open issue
158		$data = ['added_tags' => [], 'removed_tags' => []];
159
160		// Remove previous status tag
161		$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...
162		$data['removed_tags'][] = $oldTag->toShortArray();
163
164		// Add new tag
165		if (!$this->tags->contains($newTag)) {
		0 ignored issues – show Bug introduced 2016-03-27 09:56 UTC by Report Bug Copy Issue Report The property `tags` 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...
166		$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...
167
168		$data['added_tags'][] = $newTag->toShortArray();
169		}
170
171		// Add to activity log for tags if changed
172		if (!empty($data)) {
173		$this->activities()->save(new User\Activity([
		0 ignored issues – show Bug introduced 2016-03-27 09:56 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...
174		'type_id' => Activity::TYPE_ISSUE_TAG,
175		'parent_id' => $this->project->id,
176		'user_id' => $this->user->id,
177		'data' => $data,
178		]));
179		}
180
181		return $this;
182		}
183		}
184

satrun77 / tinyissue

Push — master ( 195b94...858be2 )

CrudTagTrait::changeStatus() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like