QueryTrait::projectsWidthIssues() - 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

QueryTrait::projectsWidthIssues() B

↳ Parent: QueryTrait

Complexity

Conditions	3
Paths	2

Size

Total Lines	25
Code Lines	14

Duplication

Lines	6
Ratio	24 %

Code Coverage

Tests	13
CRAP Score	3

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	6
loc	25
ccs	13
cts	13
cp	1
rs	8.8571
cc	3
eloc	14
nc	2
nop	2
crap	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\Project;

use Illuminate\Database\Eloquent;
use Illuminate\Database\Eloquent\Relations;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Database\Query;
use Tinyissue\Model\Project;
use Tinyissue\Model\Tag;
use Tinyissue\Model\User;

/**
 * QueryTrait is trait class containing the database queries methods for the Project model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property int $id
 *
 * @method   Eloquent\Model      where($column, $operator = null, $value = null, $boolean = 'and')
 * @method   Query\Builder       join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false)
 * @method   Relations\HasMany   users()
 * @method   Relations\HasMany   issues()
 * @method   void                filterAssignTo(Query\Builder $query, $userId)
 * @method   void                filterTitleOrBody(Query\Builder $query, $keyword)
 * @method   void                filterTags(Eloquent\Builder $query, array $tags)
 * @method   void                sortByUpdated(Query\Builder $query, $order = 'asc')
 * @method   Eloquent\Collection sortByTag(Query\Builder $query, $tagGroup, $order = 'asc')
 */
trait QueryTrait
{
    /**
     * Returns collection of active projects.
     *
     * @return Eloquent\Collection
     */
    public static function activeProjects()
    {
        return static::where('status', '=', Project::STATUS_OPEN)
            ->orderBy('name', 'ASC')
            ->get();
    }

    /**
     * Returns collection of public projects.
     *
     * @return Eloquent\Collection
     */
    public function publicProjects()
    {
        return $this->where('private', '=', Project::PRIVATE_NO)
            ->orderBy('name', 'ASC')
            ->get();
    }

    /**
     * Returns all users that are not assigned in the current project.
     *
     * @return array
     */
    public function usersNotIn()
    {
        if ($this->id > 0) {
            $userIds = $this->users()->lists('user_id')->all();
            $users   = User::where('deleted', '=', User::NOT_DELETED_USERS)->whereNotIn('id', $userIds)->get();
        } else {
            $users = User::where('deleted', '=', User::NOT_DELETED_USERS)->get();
        }

        return $users->lists('fullname', 'id')->all();
    }

    /**
     * Fetch and filter issues in the project.
     *
     * @param int   $status
     * @param array $filter
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function listIssues($status = Project\Issue::STATUS_OPEN, array $filter = [])
    {
        $sortOrder = array_get($filter, 'sort.sortorder', 'desc');
        $sortBy    = array_get($filter, 'sort.sortby', null);

        $query = $this->issues()
            ->with('countComments', 'user', 'updatedBy', 'tags', 'tags.parent')
            ->with([
                'tags' => function (Relation $query) use ($status, $sortOrder) {
                    $status = $status == Project\Issue::STATUS_OPEN ? Tag::STATUS_OPEN : Tag::STATUS_CLOSED;
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
                    $query->where('name', '!=',
                        ($status == Project\Issue::STATUS_OPEN ? Tag::STATUS_OPEN : Tag::STATUS_CLOSED));
                    $query->orderBy('name', $sortOrder);
                },
            ])
            ->where('status', '=', $status);

        // Filter issues
        $this->filterAssignTo($query, array_get($filter, 'assignto'));
        $this->filterTitleOrBody($query, array_get($filter, 'keyword'));
        $this->filterTags($query, array_get($filter, 'tags'));

        // Sort
        if ($sortBy == 'updated') {
            $this->sortByUpdated($query, $sortOrder);
        } elseif (($tagGroup = substr($sortBy, strlen('tag:'))) > 0) {
            return $this->sortByTag($query, $tagGroup, $sortOrder);
        }

        return $query->get();
    }

    /**
     * Fetch issues assigned to a user.
     *
     * @param int $userId
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function listAssignedIssues($userId)
    {
        return $this->issues()
            ->with('countComments', 'user', 'updatedBy')
            ->where('status', '=', Project\Issue::STATUS_OPEN)
            ->where('assigned_to', '=', $userId)
            ->orderBy('updated_at', 'DESC')
            ->get();
    }

    /**
     * Returns projects with issues details eager loaded.
     *
     * @param int $status
     * @param int $private
     *
     * @return Relations\HasMany
     */
    public function projectsWidthIssues($status = Project::STATUS_OPEN, $private = Project::PRIVATE_NO)
    {
        $query = $this
            ->where('status', '=', $status)
            ->orderBy('name');

        if ($private !== Project::PRIVATE_ALL) {
            $query->where('private', '=', $private);
        }

        $query->with([
            'issues' => function (Relations\Relation $query) use ($status) {

                $query->with('updatedBy');
                if ($status === Project::STATUS_OPEN) {
                    $query->where('status', '=', Project\Issue::STATUS_OPEN);
                }
            },
            'issues.user' => function () {
            },
            'issues.countComments' => function () {
            },
        ]);

        return $query;
    }

    /**
     * Returns collection of tags for Kanban view.
     *
     * @return mixed
     */
    public function getKanbanTags()
    {
        $tags = $this->kanbanTags()->get();

        if (!$tags->count()) {
            $tags       = (new Tag())->getOpenAndCloseTags();
            $kanbanTags = $this->kanbanTags();

            foreach ($tags as $position => $tag) {

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

        return $tags;
    }

    /**
     * Returns collection of issues grouped by tags.
     *
     * @param $tagIds
     *
     * @return mixed
     */
    public function issuesGroupByTags($tagIds)
    {
        $issues = $this->issues()
            ->with('user', 'tags')
            ->with([
                'tags' => function (Relation $query) use ($tagIds) {
                    $query->whereIn('id', $tagIds);
                },
            ])
            ->orderBy('id')
            ->get()
            ->groupBy(function (Project\Issue $issue) {
                $tag = $issue->tags->last();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                if (!$tag) {
                    // Workaround: Some older issues before the tags feature may not have open/close tag
                    return $issue->status === Project\Issue::STATUS_OPEN ? Tag::STATUS_OPEN : Tag::STATUS_CLOSED;
                }

                return $tag->name;
            });

        return $issues;
    }
}


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

QueryTrait::projectsWidthIssues() B

Complexity

Size

Duplication

Code Coverage

Importance

Change not visible in outer-scope

Change visible in outer-scope

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\Eloquent;
15			use Illuminate\Database\Eloquent\Relations;
16			use Illuminate\Database\Eloquent\Relations\Relation;
17			use Illuminate\Database\Query;
18			use Tinyissue\Model\Project;
19			use Tinyissue\Model\Tag;
20			use Tinyissue\Model\User;
21
22			/**
23			* QueryTrait is trait class containing the database queries methods for the Project model.
24			*
25			* @author Mohamed Alsharaf <[email protected]>
26			*
27			* @property int $id
28			*
29			* @method Eloquent\Model where($column, $operator = null, $value = null, $boolean = 'and')
30			* @method Query\Builder join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false)
31			* @method Relations\HasMany users()
32			* @method Relations\HasMany issues()
33			* @method void filterAssignTo(Query\Builder $query, $userId)
34			* @method void filterTitleOrBody(Query\Builder $query, $keyword)
35			* @method void filterTags(Eloquent\Builder $query, array $tags)
36			* @method void sortByUpdated(Query\Builder $query, $order = 'asc')
37			* @method Eloquent\Collection sortByTag(Query\Builder $query, $tagGroup, $order = 'asc')
38			*/
39			trait QueryTrait
40			{
41			/**
42			* Returns collection of active projects.
43			*
44			* @return Eloquent\Collection
45			*/
46			public static function activeProjects()
47			{
48			return static::where('status', '=', Project::STATUS_OPEN)
49			->orderBy('name', 'ASC')
50			->get();
51			}
52
53			/**
54			* Returns collection of public projects.
55			*
56			* @return Eloquent\Collection
57			*/
58			public function publicProjects()
59			{
60			return $this->where('private', '=', Project::PRIVATE_NO)
61			->orderBy('name', 'ASC')
62			->get();
63			}
64
65			/**
66			* Returns all users that are not assigned in the current project.
67			*
68			* @return array
69			*/
70	1		public function usersNotIn()
71			{
72	1		if ($this->id > 0) {
73			$userIds = $this->users()->lists('user_id')->all();
74			$users = User::where('deleted', '=', User::NOT_DELETED_USERS)->whereNotIn('id', $userIds)->get();
75			} else {
76	1		$users = User::where('deleted', '=', User::NOT_DELETED_USERS)->get();
77			}
78
79	1		return $users->lists('fullname', 'id')->all();
80			}
81
82			/**
83			* Fetch and filter issues in the project.
84			*
85			* @param int $status
86			* @param array $filter
87			*
88			* @return \Illuminate\Database\Eloquent\Collection
89			*/
90	2		public function listIssues($status = Project\Issue::STATUS_OPEN, array $filter = [])
91			{
92	2		$sortOrder = array_get($filter, 'sort.sortorder', 'desc');
93	2		$sortBy = array_get($filter, 'sort.sortby', null);
94
95	2		$query = $this->issues()
96	2		->with('countComments', 'user', 'updatedBy', 'tags', 'tags.parent')
97	2		->with([
98			'tags' => function (Relation $query) use ($status, $sortOrder) {
99	2		$status = $status == Project\Issue::STATUS_OPEN ? Tag::STATUS_OPEN : Tag::STATUS_CLOSED;
			0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$status`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
100	2		$query->where('name', '!=',
101	2		($status == Project\Issue::STATUS_OPEN ? Tag::STATUS_OPEN : Tag::STATUS_CLOSED));
102	2		$query->orderBy('name', $sortOrder);
103	2		},
104			])
105	2		->where('status', '=', $status);
106
107			// Filter issues
108	2		$this->filterAssignTo($query, array_get($filter, 'assignto'));
109	2		$this->filterTitleOrBody($query, array_get($filter, 'keyword'));
110	2		$this->filterTags($query, array_get($filter, 'tags'));
111
112			// Sort
113	2		if ($sortBy == 'updated') {
114			$this->sortByUpdated($query, $sortOrder);
115	2		} elseif (($tagGroup = substr($sortBy, strlen('tag:'))) > 0) {
116			return $this->sortByTag($query, $tagGroup, $sortOrder);
117			}
118
119	2		return $query->get();
120			}
121
122			/**
123			* Fetch issues assigned to a user.
124			*
125			* @param int $userId
126			*
127			* @return \Illuminate\Database\Eloquent\Collection
128			*/
129	1		public function listAssignedIssues($userId)
130			{
131	1		return $this->issues()
132	1		->with('countComments', 'user', 'updatedBy')
133	1		->where('status', '=', Project\Issue::STATUS_OPEN)
134	1		->where('assigned_to', '=', $userId)
135	1		->orderBy('updated_at', 'DESC')
136	1		->get();
137			}
138
139			/**
140			* Returns projects with issues details eager loaded.
141			*
142			* @param int $status
143			* @param int $private
144			*
145			* @return Relations\HasMany
146			*/
147	4		public function projectsWidthIssues($status = Project::STATUS_OPEN, $private = Project::PRIVATE_NO)
148			{
149			$query = $this
150	4		->where('status', '=', $status)
151	4		->orderBy('name');
152
153	4		if ($private !== Project::PRIVATE_ALL) {
154	4		$query->where('private', '=', $private);
155			}
156
157	4		$query->with([
158		View Code Duplication	'issues' => function (Relations\Relation $query) use ($status) {
			0 ignored issues – show Duplication introduced 2016-01-10 07:09 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...
159	3		$query->with('updatedBy');
160	3		if ($status === Project::STATUS_OPEN) {
161	3		$query->where('status', '=', Project\Issue::STATUS_OPEN);
162			}
163	4		},
164			'issues.user' => function () {
165	4		},
166			'issues.countComments' => function () {
167	4		},
168			]);
169
170	4		return $query;
171			}
172
173			/**
174			* Returns collection of tags for Kanban view.
175			*
176			* @return mixed
177			*/
178			public function getKanbanTags()
179			{
180			$tags = $this->kanbanTags()->get();
			0 ignored issues – show Bug introduced 2016-02-02 10:13 UTC by Report Bug Copy Issue Report The method `kanbanTags()` does not exist on `Tinyissue\Model\Traits\Project\QueryTrait`. Did you maybe mean `getKanbanTags()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
181			if (!$tags->count()) {
182			$tags = (new Tag())->getOpenAndCloseTags();
183			$kanbanTags = $this->kanbanTags();
			0 ignored issues – show Bug introduced 2016-02-02 10:13 UTC by Report Bug Copy Issue Report The method `kanbanTags()` does not exist on `Tinyissue\Model\Traits\Project\QueryTrait`. Did you maybe mean `getKanbanTags()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
184		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...
185			$position = $tag->name === Tag::STATUS_OPEN ? -1 : $position;
186			$position = $tag->name === Tag::STATUS_CLOSED ? 100 : $position;
187			$kanbanTags->attach([$tag->id => ['position' => $position]]);
188			}
189			}
190
191			return $tags;
192			}
193
194			/**
195			* Returns collection of issues grouped by tags.
196			*
197			* @param $tagIds
198			*
199			* @return mixed
200			*/
201			public function issuesGroupByTags($tagIds)
202			{
203			$issues = $this->issues()
204			->with('user', 'tags')
205			->with([
206			'tags' => function (Relation $query) use ($tagIds) {
207			$query->whereIn('id', $tagIds);
208			},
209			])
210			->orderBy('id')
211			->get()
212			->groupBy(function (Project\Issue $issue) {
213			$tag = $issue->tags->last();
			0 ignored issues – show Documentation introduced 2016-02-02 10:13 UTC by Report Bug Copy Issue Report The property `tags` does not exist on `object<Tinyissue\Model\Project\Issue>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
214			if (!$tag) {
215			// Workaround: Some older issues before the tags feature may not have open/close tag
216			return $issue->status === Project\Issue::STATUS_OPEN ? Tag::STATUS_OPEN : Tag::STATUS_CLOSED;
217			}
218
219			return $tag->name;
220			});
221
222			return $issues;
223			}
224			}
225

satrun77 / tinyissue

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

QueryTrait::projectsWidthIssues() B

Complexity

Size

Duplication

Code Coverage

Importance

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like