Tinyissue\Model\Traits\Project\CrudTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	127
Duplicated Lines	3.94 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

95.24%

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	unassignUser()	0	4	1
A	assignUser()	0	7	1
A	delete()	0	11	1
B	createProject()	0	19	5
A	update()	0	10	2
B	saveTags()	5	25	4

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

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 <mohamed.alsharaf@gmail.com>
 *
 * @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();

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

    }

    /**
     * Create a new project.
     *
     * @param array $input
     *
     * @return $this
     */
    public function createProject(array $input = [])
    {
        $this->fill($input)->save();

        if (!empty($input['columns'])) {
            $this->saveTags($input['columns']);

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

        /* 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 (array_key_exists('columns', $attributes)) {
            $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();

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

        // Save tags
        $kanbanTags = $this->kanbanTags();

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

        $count      = $tags->count();
        foreach ($tags as $position => $tag) {

This code seems to be duplicated across your project.

            $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([

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

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