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

Completed

Push — master ( 1f3d4e...dec0dd )

by Mohamed

created 2016-03-09 06:06 UTC

CrudTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

89.66%

Importance

Changes	5
Bugs	1	Features	2

Metric	Value
wmc	13
c	5
b	1
f	2
lcom	0
cbo	1
dl	0
loc	97
ccs	26
cts	29
cp	0.8966
rs	10

5 Methods

Rating	Name	Size	Complexity
A	createTag()	4	1
A	update()	4	1
A	createTagFromString()	14	2
B	validOrCreate()	21	6
A	prepareTagToSave()	11	3

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

use Illuminate\Database\Eloquent;
use Tinyissue\Model\Tag;

/**
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Tag model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @method Eloquent\Model where($column, $operator = null, $value = null, $boolean = 'and')
 */
trait CrudTrait
{
    /**
     * Create a new tag.
     *
     * @param array $input
     *
     * @return mixed
     */
    public function createTag(array $input)
    {
        return $this->fill($this->prepareTagToSave($input))->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Update the tags in the database.
     *
     * @param array $attributes
     *
     * @return bool|int
     */
    public function update(array $attributes = [])
    {
        return parent::update($this->prepareTagToSave($attributes));
    }

    /**
     * Create new tag from string of group name and tag name.
     *
     * @param string $tagFullName
     *
     * @return $this|bool
     */
    public function createTagFromString($tagFullName)
    {
        list($groupName, $tagName) = explode(':', $tagFullName);

        // Check if group name is valid
        $groupTag = $this->validOrCreate($groupName);

        if (!$groupTag) {
            return false;
        }

        // Create new tag or return existing one
        return $this->validOrCreate($tagName, $groupTag);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create a new tag if valid or return existing one.
     *
     * @param string   $name
     * @param null|Tag $parent
     *
     * @return bool|$this
     */
    public function validOrCreate($name, Tag $parent = null)
    {
        $group = $parent === null ? true : false;
        $tag   = $this->where('name', '=', $name)->first();
        if ($tag && $tag->group != $group) {
            return false;
        }

        if (!$tag) {
            $tag        = new Tag();
            $tag->name  = $name;
            $tag->group = $group;
            if (!is_null($parent)) {
                $tag->parent_id = $parent->id;
                $tag->setRelation('parent', $parent);
            }
            $tag->save();
        }

        return $tag;
    }

    /**
     * Prepare tag details to save.
     *
     * @param array $input
     *
     * @return array
     */
    protected function prepareTagToSave(array $input)
    {
        // If parent id is set, then tag is not group
        if (array_key_exists('parent_id', $input) && $input['parent_id'] > 0) {
            $input['group'] = 0;
        } else {
            $input['group'] = 1;
        }

        return $input;
    }
}


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\Tag;
13
14		use Illuminate\Database\Eloquent;
15		use Tinyissue\Model\Tag;
16
17		/**
18		* CrudTrait is trait class containing the methods for adding/editing/deleting the Tag model.
19		*
20		* @author Mohamed Alsharaf <[email protected]>
21		*
22		* @method Eloquent\Model where($column, $operator = null, $value = null, $boolean = 'and')
23		*/
24		trait CrudTrait
25		{
26		/**
27		* Create a new tag.
28		*
29		* @param array $input
30		*
31		* @return mixed
32		*/
33	1	public function createTag(array $input)
34		{
35	1	return $this->fill($this->prepareTagToSave($input))->save();
		0 ignored issues – show Bug introduced 2016-03-07 09:48 UTC by Report Bug Copy Issue Report It seems like `fill()` 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...
36		}
37
38		/**
39		* Update the tags in the database.
40		*
41		* @param array $attributes
42		*
43		* @return bool\|int
44		*/
45	1	public function update(array $attributes = [])
46		{
47	1	return parent::update($this->prepareTagToSave($attributes));
48		}
49
50		/**
51		* Create new tag from string of group name and tag name.
52		*
53		* @param string $tagFullName
54		*
55		* @return $this\|bool
56		*/
57	1	public function createTagFromString($tagFullName)
58		{
59	1	list($groupName, $tagName) = explode(':', $tagFullName);
60
61		// Check if group name is valid
62	1	$groupTag = $this->validOrCreate($groupName);
63
64	1	if (!$groupTag) {
65		return false;
66		}
67
68		// Create new tag or return existing one
69	1	return $this->validOrCreate($tagName, $groupTag);
		0 ignored issues – show Documentation introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report `$groupTag` is of type `boolean\|object<Tinyissue...l\Traits\Tag\CrudTrait>`, but the function expects a `null\|object<Tinyissue\Model\Tag>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
70		}
71
72		/**
73		* Create a new tag if valid or return existing one.
74		*
75		* @param string $name
76		* @param null\|Tag $parent
77		*
78		* @return bool\|$this
79		*/
80	1	public function validOrCreate($name, Tag $parent = null)
81		{
82	1	$group = $parent === null ? true : false;
83	1	$tag = $this->where('name', '=', $name)->first();
84	1	if ($tag && $tag->group != $group) {
85		return false;
86		}
87
88	1	if (!$tag) {
89	1	$tag = new Tag();
90	1	$tag->name = $name;
91	1	$tag->group = $group;
92	1	if (!is_null($parent)) {
93	1	$tag->parent_id = $parent->id;
94	1	$tag->setRelation('parent', $parent);
95		}
96	1	$tag->save();
97		}
98
99	1	return $tag;
100		}
101
102		/**
103		* Prepare tag details to save.
104		*
105		* @param array $input
106		*
107		* @return array
108		*/
109	2	protected function prepareTagToSave(array $input)
110		{
111		// If parent id is set, then tag is not group
112	2	if (array_key_exists('parent_id', $input) && $input['parent_id'] > 0) {
113	2	$input['group'] = 0;
114		} else {
115		$input['group'] = 1;
116		}
117
118	2	return $input;
119		}
120		}
121

satrun77 / tinyissue

Push — master ( 1f3d4e...dec0dd )

CrudTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like