Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
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() |
||
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 ($sortOrder) { |
||
99 | 2 | $query->orderBy('name', $sortOrder); |
|
100 | 2 | }, |
|
101 | ]) |
||
102 | 2 | ->where('status', '=', $status); |
|
103 | |||
104 | // Filter issues |
||
105 | 2 | $this->filterAssignTo($query, array_get($filter, 'assignto')); |
|
106 | 2 | $this->filterTitleOrBody($query, array_get($filter, 'keyword')); |
|
107 | 2 | $this->filterTags($query, array_get($filter, 'tag_status')); |
|
108 | 2 | $this->filterTags($query, array_get($filter, 'tag_type')); |
|
109 | 2 | $this->filterCreatedBy($query, array_get($filter, 'created_by'), $this->isPrivateInternal()); |
|
110 | |||
111 | // Sort |
||
112 | 2 | if ($sortBy == 'updated') { |
|
113 | $this->sortByUpdated($query, $sortOrder); |
||
114 | 2 | } elseif (($tagGroup = substr($sortBy, strlen('tag:'))) > 0) { |
|
115 | return $this->sortByTag($query, $tagGroup, $sortOrder); |
||
116 | } |
||
117 | |||
118 | 2 | return $query->get(); |
|
119 | } |
||
120 | |||
121 | /** |
||
122 | * Fetch issues assigned to a user. |
||
123 | * |
||
124 | * @param User $user |
||
125 | * |
||
126 | * @return \Illuminate\Database\Eloquent\Collection |
||
127 | */ |
||
128 | 1 | public function listAssignedOrCreatedIssues(User $user) |
|
129 | { |
||
130 | 1 | $assignedOrCreate = $user->isUser() ? 'created_by' : 'assigned_to'; |
|
131 | |||
132 | 1 | return $this->issues() |
|
133 | 1 | ->with('countComments', 'user', 'updatedBy') |
|
134 | 1 | ->where('status', '=', Project\Issue::STATUS_OPEN) |
|
135 | 1 | ->where($assignedOrCreate, '=', $user->id) |
|
136 | 1 | ->orderBy('updated_at', 'DESC') |
|
137 | 1 | ->get(); |
|
138 | } |
||
139 | |||
140 | /** |
||
141 | * Returns projects with issues details eager loaded. |
||
142 | * |
||
143 | * @param int $status |
||
144 | * @param int $private |
||
145 | * |
||
146 | * @return Relations\HasMany |
||
147 | */ |
||
148 | 4 | public function projectsWidthIssues($status = Project::STATUS_OPEN, $private = Project::PRIVATE_NO) |
|
173 | |||
174 | /** |
||
175 | * Returns collection of tags for Kanban view. |
||
176 | * |
||
177 | * @param User $user |
||
178 | * |
||
179 | * @return mixed |
||
180 | */ |
||
181 | public function getKanbanTagsForUser(User $user) |
||
192 | |||
193 | /** |
||
194 | * Returns collection of issues grouped by tags. |
||
195 | * |
||
196 | * @param $tagIds |
||
197 | * |
||
198 | * @return mixed |
||
199 | */ |
||
200 | public function issuesGroupByTags($tagIds) |
||
215 | |||
216 | /** |
||
217 | * Returns users assigned to the project that can fix issues (with edit permission). |
||
218 | * |
||
219 | * @return Relations\BelongsToMany |
||
220 | */ |
||
221 | 8 | public function usersCanFixIssue() |
|
225 | } |
||
226 |
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
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. 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.