QueryTrait - Code Metrics - Inspection of "Bug: filter out deleted users from project assinge..." - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( e54750...4239da )

by Mohamed

created 2016-08-01 11:35 UTC

QueryTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	116
Duplicated Lines	6.03 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

70.45%

Importance

Changes	7
Bugs	1	Features	0

Metric	Value
wmc	11
c	7
b	1
f	0
lcom	1
cbo	4
dl	7
loc	116
ccs	31
cts	44
cp	0.7045
rs	10

5 Methods

Rating	Name	Duplication	Size	Complexity
B	projectsWidthActivities()	0	24	2
A	projectsWidthIssues()	7	18	3
A	issuesGroupByTags()	0	21	3
A	loadPermissions()	0	8	2
A	activeUsers()	0	6	1

How to fix Duplicated Code

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

use Illuminate\Database\Eloquent;
use Illuminate\Database\Eloquent\Relations;
use Tinyissue\Model\Project;
use Tinyissue\Model\Role;

/**
 * QueryTrait is trait class containing the database queries methods for the User model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property int                 $id
 * @property Eloquent\Collection $permission
 *
 * @method   Relations\HasMany projects($status = Project::STATUS_OPEN)
 * @method   Relations\HasMany permissions()
 */
trait QueryTrait
{
    /**
     * Returns public users.
     *
     * @return Eloquent\Collection
     */
    public function activeUsers()
    {
        return $this->with('role')
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->where('private', '=', false)
            ->orderBy('firstname', 'ASC')->get();
    }

    /**
     * Returns user projects with activities details eager loaded.
     *
     * @param int $status
     *
     * @return Relations\HasMany
     */
    public function projectsWidthActivities($status = Project::STATUS_OPEN)
    {
        return $this->projects($status)
            ->with([
                'activities' => function (Relations\Relation $query) {
                    $query->with('activity', 'issue', 'user', 'assignTo', 'comment', 'note');
                    $query->orderBy('users_activity.created_at', 'DESC');

                    // For logged users with role User, show issues that are created by them in internal projects
                    // of issue create by any for other project statuses
                    if (auth()->user()->isUser()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                        $query->join('projects_issues', 'projects_issues.id', '=', 'item_id');
                        $query->join('projects', 'projects.id', '=', 'parent_id');
                        $query->where(function (Eloquent\Builder $query) {
                            $query->where(function (Eloquent\Builder $query) {
                                $query->where('created_by', '=', auth()->user()->id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                                $query->where('private', '=', Project::INTERNAL_YES);
                            });
                            $query->orWhere('private', '<>', Project::INTERNAL_YES);
                        });
                    }
                },
            ]);
    }

    /**
     * Returns projects with issues details eager loaded.
     *
     * @param int $status
     *
     * @return Relations\HasMany
     */
    public function projectsWidthIssues($status = Project::STATUS_OPEN)
    {
        $assignedOrCreate = $this->isUser() ? 'created_by' : 'assigned_to';
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this
            ->projects($status)
            ->with([
                'issues' => function (Relations\Relation $query) use ($status, $assignedOrCreate) {

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

    /**
     * Returns collection of issues grouped by tags.
     *
     * @param $tagIds
     * @param int $projectId
     *
     * @return mixed
     */
    public function issuesGroupByTags($tagIds, $projectId = null)
    {
        $assignedOrCreate = $this->isUser() ? 'issuesCreatedBy' : 'issues';
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $issues           = $this->$assignedOrCreate()
            ->with('user', 'tags')
            ->where('status', '=', Project\Issue::STATUS_OPEN)
            ->whereIn('projects_issues_tags.tag_id', $tagIds)
            ->join('projects_issues_tags', 'issue_id', '=', 'id')
            ->orderBy('id');

        // Limit by project id
        if ($projectId > 0) {
            $issues->where('project_id', '=', $projectId);
        }

        $issues = $issues->get()->groupBy(function (Project\Issue $issue) {
            return $issue->getStatusTag()->name;
        });

        return $issues;
    }

    /**
     * Load user permissions.
     *
     * @return Eloquent\Collection
     */
    protected function loadPermissions()
    {
        if (null === $this->permission) {
            $this->permission = $this->permissions()->with('permission')->get();
        }

        return $this->permission;
    }
}


Push — develop ( e54750...4239da )

QueryTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

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\User;
13
14			use Illuminate\Database\Eloquent;
15			use Illuminate\Database\Eloquent\Relations;
16			use Tinyissue\Model\Project;
17			use Tinyissue\Model\Role;
18
19			/**
20			* QueryTrait is trait class containing the database queries methods for the User model.
21			*
22			* @author Mohamed Alsharaf <[email protected]>
23			*
24			* @property int $id
25			* @property Eloquent\Collection $permission
26			*
27			* @method Relations\HasMany projects($status = Project::STATUS_OPEN)
28			* @method Relations\HasMany permissions()
29			*/
30			trait QueryTrait
31			{
32			/**
33			* Returns public users.
34			*
35			* @return Eloquent\Collection
36			*/
37	5		public function activeUsers()
38			{
39	5		return $this->with('role')
			0 ignored issues – show Bug introduced 2016-01-10 07:09 UTC by Report Bug Copy Issue Report It seems like `with()` 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...
40	5		->where('private', '=', false)
41	5		->orderBy('firstname', 'ASC')->get();
42			}
43
44			/**
45			* Returns user projects with activities details eager loaded.
46			*
47			* @param int $status
48			*
49			* @return Relations\HasMany
50			*/
51	10		public function projectsWidthActivities($status = Project::STATUS_OPEN)
52			{
53	10		return $this->projects($status)
54	10		->with([
55			'activities' => function (Relations\Relation $query) {
56	2		$query->with('activity', 'issue', 'user', 'assignTo', 'comment', 'note');
57	2		$query->orderBy('users_activity.created_at', 'DESC');
58
59			// For logged users with role User, show issues that are created by them in internal projects
60			// of issue create by any for other project statuses
61	2		if (auth()->user()->isUser()) {
			0 ignored issues – show Bug introduced 2016-07-18 07:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `isUser()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
62	2		$query->join('projects_issues', 'projects_issues.id', '=', 'item_id');
63	2		$query->join('projects', 'projects.id', '=', 'parent_id');
64			$query->where(function (Eloquent\Builder $query) {
65			$query->where(function (Eloquent\Builder $query) {
66	2		$query->where('created_by', '=', auth()->user()->id);
			0 ignored issues – show Bug introduced 2016-07-18 07:18 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
67	2		$query->where('private', '=', Project::INTERNAL_YES);
68	2		});
69	2		$query->orWhere('private', '<>', Project::INTERNAL_YES);
70	2		});
71			}
72	10		},
73			]);
74			}
75
76			/**
77			* Returns projects with issues details eager loaded.
78			*
79			* @param int $status
80			*
81			* @return Relations\HasMany
82			*/
83	1		public function projectsWidthIssues($status = Project::STATUS_OPEN)
84			{
85	1		$assignedOrCreate = $this->isUser() ? 'created_by' : 'assigned_to';
			0 ignored issues – show Bug introduced 2016-07-02 18:29 UTC by Report Bug Copy Issue Report It seems like `isUser()` 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...
86
87			return $this
88	1		->projects($status)
89	1		->with([
90		View Code Duplication	'issues' => function (Relations\Relation $query) use ($status, $assignedOrCreate) {
			0 ignored issues – show Duplication introduced 2016-07-02 18:29 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...
91	1		$query->with('updatedBy');
92	1		$query->where($assignedOrCreate, '=', $this->id);
93	1		if ($status === Project::STATUS_OPEN) {
94	1		$query->where('status', '=', Project\Issue::STATUS_OPEN);
95			}
96	1		},
97			'issues.user' => function () {},
98			'issues.countComments' => function () {},
99			]);
100			}
101
102			/**
103			* Returns collection of issues grouped by tags.
104			*
105			* @param $tagIds
106			* @param int $projectId
107			*
108			* @return mixed
109			*/
110			public function issuesGroupByTags($tagIds, $projectId = null)
111			{
112			$assignedOrCreate = $this->isUser() ? 'issuesCreatedBy' : 'issues';
			0 ignored issues – show Bug introduced 2016-07-02 18:29 UTC by Report Bug Copy Issue Report It seems like `isUser()` 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...
113			$issues = $this->$assignedOrCreate()
114			->with('user', 'tags')
115			->where('status', '=', Project\Issue::STATUS_OPEN)
116			->whereIn('projects_issues_tags.tag_id', $tagIds)
117			->join('projects_issues_tags', 'issue_id', '=', 'id')
118			->orderBy('id');
119
120			// Limit by project id
121			if ($projectId > 0) {
122			$issues->where('project_id', '=', $projectId);
123			}
124
125			$issues = $issues->get()->groupBy(function (Project\Issue $issue) {
126			return $issue->getStatusTag()->name;
127			});
128
129			return $issues;
130			}
131
132			/**
133			* Load user permissions.
134			*
135			* @return Eloquent\Collection
136			*/
137	62		protected function loadPermissions()
138			{
139	62		if (null === $this->permission) {
140	62		$this->permission = $this->permissions()->with('permission')->get();
141			}
142
143	62		return $this->permission;
144			}
145			}
146

satrun77 / tinyissue

Push — develop ( e54750...4239da )

QueryTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like