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

Completed

Push — master ( 50f309...1f3d4e )

by Mohamed

created 2016-02-18 08:20 UTC

CrudTrait::unassignUser() A

↳ Parent: CrudTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

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

use Illuminate\Database\Query;
use Tinyissue\Model\Project;
use Tinyissue\Model\User;
use Illuminate\Support\Collection;
use Tinyissue\Model\Tag;

/**
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Project model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property int $id
 *
 * @method   Query\Builder where($column, $operator = null, $value = null, $boolean = 'and')
 * @method   Query\Builder join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false)
 * @method   Project       fill(array $attributes)
 * @method   RelationTrait projectUsers()
 */
trait CrudTrait
{
    /**
     * removes a user from a project.
     *
     * @param int $userId
     *
     * @return mixed
     */
    public function unassignUser($userId)
    {
        return $this->projectUsers()->where('user_id', '=', $userId)->delete();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Create a new project.
     *
     * @param array $input
     *
     * @return $this
     */
    public function createProject(array $input = [])
    {
        if (!empty($input['columns'])) {
            $this->saveTags($input['columns']);

            unset($input['columns']);
        }

        $this->fill($input)->save();

        /* Assign selected users to the project */
        if (isset($input['user']) && count($input['user']) > 0) {
            foreach ($input['user'] as $id) {
                $this->assignUser($id);
            }
        }

        return $this;
    }

    /**
     * Update project details.
     *
     * @param array $attributes
     *
     * @return bool
     */
    public function update(array $attributes = [])
    {
        if (!empty($attributes['columns'])) {
            $this->saveTags($attributes['columns']);

            unset($attributes['columns']);
        }

        return parent::update($attributes);
    }

    /**
     * Save the project tags.
     *
     * @param string $tagString
     *
     * @return bool
     */
    public function saveTags($tagString)
    {
        // Transform the user input tags into tag objects
        // Filter out invalid tags entered by the user
        $tags = new Collection(array_map('trim', explode(',', $tagString)));
        $tags = $tags->transform(function ($tagNameOrId) {
            return Tag::find($tagNameOrId);
        })->filter(function ($tag) {
            return $tag instanceof Tag;
        })->merge((new Tag())->getOpenAndCloseTags());

        // Delete all existing
        $this->kanbanTags()->detach();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Save tags
        $kanbanTags = $this->kanbanTags();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $count      = $tags->count();
        foreach ($tags as $position => $tag) {

            $position = $tag->name === Tag::STATUS_OPEN ? -1 : $position;
            $position = $tag->name === Tag::STATUS_CLOSED ? $count + 1 : $position;
            $kanbanTags->attach([$tag->id => ['position' => $position]]);
        }

        return true;
    }

    /**
     * Assign a user to a project.
     *
     * @param int $userId
     * @param int $roleId
     *
     * @return Project\User
     */
    public function assignUser($userId, $roleId = 0)
    {
        return $this->projectUsers()->save(new Project\User([
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            'user_id' => $userId,
            'role_id' => $roleId,
        ]));
    }

    /**
     *  Delete a project.
     *
     * @return void
     *
     * @throws \Exception
     */
    public function delete()
    {
        $id = $this->id;
        parent::delete();

        /* Delete all children from the project */
        Project\Issue::where('project_id', '=', $id)->delete();
        Project\Issue\Comment::where('project_id', '=', $id)->delete();
        Project\User::where('project_id', '=', $id)->delete();
        User\Activity::where('parent_id', '=', $id)->delete();
    }
}


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;
13
14			use Illuminate\Database\Query;
15			use Tinyissue\Model\Project;
16			use Tinyissue\Model\User;
17			use Illuminate\Support\Collection;
18			use Tinyissue\Model\Tag;
19
20			/**
21			* CrudTrait is trait class containing the methods for adding/editing/deleting the Project model.
22			*
23			* @author Mohamed Alsharaf <[email protected]>
24			*
25			* @property int $id
26			*
27			* @method Query\Builder where($column, $operator = null, $value = null, $boolean = 'and')
28			* @method Query\Builder join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false)
29			* @method Project fill(array $attributes)
30			* @method RelationTrait projectUsers()
31			*/
32			trait CrudTrait
33			{
34			/**
35			* removes a user from a project.
36			*
37			* @param int $userId
38			*
39			* @return mixed
40			*/
41	1		public function unassignUser($userId)
42			{
43	1		return $this->projectUsers()->where('user_id', '=', $userId)->delete();
			0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `where()` 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...
44			}
45
46			/**
47			* Create a new project.
48			*
49			* @param array $input
50			*
51			* @return $this
52			*/
53	42		public function createProject(array $input = [])
54			{
55	42		if (!empty($input['columns'])) {
56			$this->saveTags($input['columns']);
57
58			unset($input['columns']);
59			}
60
61	42		$this->fill($input)->save();
62
63			/* Assign selected users to the project */
64	42		if (isset($input['user']) && count($input['user']) > 0) {
65	24		foreach ($input['user'] as $id) {
66	24		$this->assignUser($id);
67			}
68			}
69
70	42		return $this;
71			}
72
73			/**
74			* Update project details.
75			*
76			* @param array $attributes
77			*
78			* @return bool
79			*/
80	1		public function update(array $attributes = [])
81			{
82	1		if (!empty($attributes['columns'])) {
83			$this->saveTags($attributes['columns']);
84
85			unset($attributes['columns']);
86			}
87
88	1		return parent::update($attributes);
89			}
90
91			/**
92			* Save the project tags.
93			*
94			* @param string $tagString
95			*
96			* @return bool
97			*/
98			public function saveTags($tagString)
99			{
100			// Transform the user input tags into tag objects
101			// Filter out invalid tags entered by the user
102			$tags = new Collection(array_map('trim', explode(',', $tagString)));
103			$tags = $tags->transform(function ($tagNameOrId) {
104			return Tag::find($tagNameOrId);
105			})->filter(function ($tag) {
106			return $tag instanceof Tag;
107			})->merge((new Tag())->getOpenAndCloseTags());
108
109			// Delete all existing
110			$this->kanbanTags()->detach();
			0 ignored issues – show Bug introduced 2016-02-02 06:39 UTC by Report Bug Copy Issue Report It seems like `kanbanTags()` 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...
111
112			// Save tags
113			$kanbanTags = $this->kanbanTags();
			0 ignored issues – show Bug introduced 2016-02-02 06:39 UTC by Report Bug Copy Issue Report It seems like `kanbanTags()` 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...
114			$count = $tags->count();
115		View Code Duplication	foreach ($tags as $position => $tag) {
			0 ignored issues – show Duplication introduced 2016-02-02 10:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
116			$position = $tag->name === Tag::STATUS_OPEN ? -1 : $position;
117			$position = $tag->name === Tag::STATUS_CLOSED ? $count + 1 : $position;
118			$kanbanTags->attach([$tag->id => ['position' => $position]]);
119			}
120
121			return true;
122			}
123
124			/**
125			* Assign a user to a project.
126			*
127			* @param int $userId
128			* @param int $roleId
129			*
130			* @return Project\User
131			*/
132	25		public function assignUser($userId, $roleId = 0)
133			{
134	25		return $this->projectUsers()->save(new Project\User([
			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...
135	25		'user_id' => $userId,
136	25		'role_id' => $roleId,
137			]));
138			}
139
140			/**
141			* Delete a project.
142			*
143			* @return void
144			*
145			* @throws \Exception
146			*/
147	1		public function delete()
148			{
149	1		$id = $this->id;
150	1		parent::delete();
151
152			/* Delete all children from the project */
153	1		Project\Issue::where('project_id', '=', $id)->delete();
154	1		Project\Issue\Comment::where('project_id', '=', $id)->delete();
155	1		Project\User::where('project_id', '=', $id)->delete();
156	1		User\Activity::where('parent_id', '=', $id)->delete();
157	1		}
158			}
159

satrun77 / tinyissue

Push — master ( 50f309...1f3d4e )

CrudTrait::unassignUser() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like