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 |
||
32 | class IssueController extends Controller |
||
33 | { |
||
34 | /** |
||
35 | * Project issue index page (List project issues). |
||
36 | * |
||
37 | * @param Project $project |
||
38 | * @param Issue $issue |
||
39 | * @param CommentForm $form |
||
40 | * |
||
41 | * @return \Illuminate\View\View |
||
42 | */ |
||
43 | public function getIndex(Project $project, Issue $issue, CommentForm $form) |
||
44 | { |
||
45 | // Projects should be limited to issue-modify |
||
46 | $projects = null; |
||
47 | if (!$this->auth->guest() && $this->auth->user()->permission('issue-modify')) { |
||
|
|||
48 | $projects = $this->auth->user()->projects()->get(); |
||
49 | } |
||
50 | |||
51 | return view('project.issue.index', [ |
||
52 | 'issue' => $issue, |
||
53 | 'project' => $project, |
||
54 | 'commentForm' => $form, |
||
55 | 'sidebar' => 'project', |
||
56 | 'projects' => $projects, |
||
57 | ]); |
||
58 | } |
||
59 | |||
60 | /** |
||
61 | * Ajax: Assign new user to an issue. |
||
62 | * |
||
63 | * @param Issue $issue |
||
64 | * @param Request $request |
||
65 | * |
||
66 | * @return \Symfony\Component\HttpFoundation\Response |
||
67 | */ |
||
68 | View Code Duplication | public function postAssign(Issue $issue, Request $request) |
|
69 | { |
||
70 | $response = ['status' => false]; |
||
71 | if ($issue->reassign((int) $request->input('user_id'), $this->auth->user()->id)) { |
||
72 | $response['status'] = true; |
||
73 | } |
||
74 | |||
75 | return response()->json($response); |
||
76 | } |
||
77 | |||
78 | /** |
||
79 | * Ajax: save comment. |
||
80 | * |
||
81 | * @param Comment $comment |
||
82 | * @param Request $request |
||
83 | * |
||
84 | * @return \Symfony\Component\HttpFoundation\Response |
||
85 | */ |
||
86 | public function postEditComment(Comment $comment, Request $request) |
||
87 | { |
||
88 | $body = ''; |
||
89 | if ($request->has('body')) { |
||
90 | $comment->updateBody($request->input('body')); |
||
91 | $body = \Html::format($comment->comment); |
||
92 | } |
||
93 | |||
94 | return response()->json(['text' => $body]); |
||
95 | } |
||
96 | |||
97 | /** |
||
98 | * To add new comment to an issue. |
||
99 | * |
||
100 | * @param Project $project |
||
101 | * @param Issue $issue |
||
102 | * @param Comment $comment |
||
103 | * @param FormRequest\Comment $request |
||
104 | * |
||
105 | * @return \Illuminate\Http\RedirectResponse |
||
106 | */ |
||
107 | public function getAddComment(Project $project, Issue $issue, Comment $comment, FormRequest\Comment $request) |
||
108 | { |
||
109 | $comment->setRelation('project', $project); |
||
110 | $comment->setRelation('issue', $issue); |
||
111 | $comment->setRelation('user', $this->auth->user()); |
||
112 | $comment->createComment($request->all()); |
||
113 | |||
114 | return redirect($issue->to() . '#comment' . $comment->id) |
||
115 | ->with('notice', trans('tinyissue.your_comment_added')); |
||
116 | } |
||
117 | |||
118 | /** |
||
119 | * Ajax: to delete a comment. |
||
120 | * |
||
121 | * @param Comment $comment |
||
122 | * |
||
123 | * @return \Symfony\Component\HttpFoundation\Response |
||
124 | */ |
||
125 | public function getDeleteComment(Comment $comment) |
||
126 | { |
||
127 | $comment->deleteComment(); |
||
128 | |||
129 | return response()->json(['status' => true]); |
||
130 | } |
||
131 | |||
132 | /** |
||
133 | * New issue form. |
||
134 | * |
||
135 | * @param Project $project |
||
136 | * @param IssueForm $form |
||
137 | * |
||
138 | * @return \Illuminate\View\View |
||
139 | */ |
||
140 | 4 | public function getNew(Project $project, IssueForm $form) |
|
141 | { |
||
142 | 4 | return view('project.issue.new', [ |
|
143 | 4 | 'project' => $project, |
|
144 | 4 | 'form' => $form, |
|
145 | 4 | 'sidebar' => 'project', |
|
146 | ]); |
||
147 | } |
||
148 | |||
149 | /** |
||
150 | * To create a new issue. |
||
151 | * |
||
152 | * @param Project $project |
||
153 | * @param Issue $issue |
||
154 | * @param FormRequest\Issue $request |
||
155 | * |
||
156 | * @return \Illuminate\Http\RedirectResponse |
||
157 | */ |
||
158 | 2 | View Code Duplication | public function postNew(Project $project, Issue $issue, FormRequest\Issue $request) |
159 | { |
||
160 | 2 | $issue->setRelation('project', $project); |
|
161 | 2 | $issue->setRelation('user', $this->auth->user()); |
|
162 | 2 | $issue->createIssue($request->all()); |
|
163 | |||
164 | return redirect($issue->to()) |
||
165 | ->with('notice', trans('tinyissue.issue_has_been_created')); |
||
166 | } |
||
167 | |||
168 | /** |
||
169 | * Edit an existing issue form. |
||
170 | * |
||
171 | * @param Project $project |
||
172 | * @param Issue $issue |
||
173 | * @param IssueForm $form |
||
174 | * |
||
175 | * @return \Illuminate\View\View |
||
176 | */ |
||
177 | public function getEdit(Project $project, Issue $issue, IssueForm $form) |
||
178 | { |
||
179 | // Cannot edit closed issue |
||
180 | if ($issue->status == Issue::STATUS_CLOSED) { |
||
181 | return redirect($issue->to()) |
||
182 | ->with('notice', trans('tinyissue.cant_edit_closed_issue')); |
||
183 | } |
||
184 | |||
185 | return view('project.issue.edit', [ |
||
186 | 'issue' => $issue, |
||
187 | 'project' => $project, |
||
188 | 'form' => $form, |
||
189 | 'sidebar' => 'project', |
||
190 | ]); |
||
191 | } |
||
192 | |||
193 | /** |
||
194 | * To update an existing issue details. |
||
195 | * |
||
196 | * @param Project $project |
||
197 | * @param Issue $issue |
||
198 | * @param FormRequest\Issue $request |
||
199 | * |
||
200 | * @return \Illuminate\Http\RedirectResponse |
||
201 | */ |
||
202 | View Code Duplication | public function postEdit(Project $project, Issue $issue, FormRequest\Issue $request) |
|
203 | { |
||
204 | $issue->setRelation('project', $project); |
||
205 | $issue->setRelation('updatedBy', $this->auth->user()); |
||
206 | $issue->updateIssue($request->all()); |
||
207 | |||
208 | return redirect($issue->to()) |
||
209 | ->with('notice', trans('tinyissue.issue_has_been_updated')); |
||
210 | } |
||
211 | |||
212 | /** |
||
213 | * To close or reopen an issue. |
||
214 | * |
||
215 | * @param Project $project |
||
216 | * @param Issue $issue |
||
217 | * @param int $status |
||
218 | * |
||
219 | * @return \Illuminate\Http\RedirectResponse |
||
220 | */ |
||
221 | public function getClose(Project $project, Issue $issue, $status = 0) |
||
222 | { |
||
223 | if ($status == 0) { |
||
224 | $message = trans('tinyissue.issue_has_been_closed'); |
||
225 | } else { |
||
226 | $message = trans('tinyissue.issue_has_been_reopened'); |
||
227 | } |
||
228 | |||
229 | $issue->setRelation('project', $project); |
||
230 | $issue->changeStatus($status, $this->auth->user()->id); |
||
231 | |||
232 | return redirect($issue->to()) |
||
233 | ->with('notice', $message); |
||
234 | } |
||
235 | |||
236 | /** |
||
237 | * To upload an attachment file. |
||
238 | * |
||
239 | * @param Project $project |
||
240 | * @param Attachment $attachment |
||
241 | * @param Request $request |
||
242 | * |
||
243 | * @return \Symfony\Component\HttpFoundation\Response |
||
244 | */ |
||
245 | 1 | public function postUploadAttachment(Project $project, Attachment $attachment, Request $request) |
|
246 | { |
||
247 | try { |
||
248 | 1 | if (!$this->auth->user()->permission('project-all')) { |
|
249 | abort(404); |
||
250 | } |
||
251 | |||
252 | 1 | $attachment->upload($request->all(), $project, $this->auth->user()); |
|
253 | |||
254 | $response = [ |
||
255 | 'upload' => [ |
||
256 | [ |
||
257 | 1 | 'name' => $attachment->filename, |
|
258 | 1 | 'size' => $attachment->filesize, |
|
259 | 1 | 'fileId' => $attachment->id, |
|
260 | ], |
||
261 | ], |
||
262 | ]; |
||
263 | } catch (\Exception $exception) { |
||
264 | $file = $request->file('upload'); |
||
265 | |||
266 | $response = [ |
||
267 | 'status' => false, |
||
268 | 'name' => $file->getClientOriginalName(), |
||
269 | 'error' => $exception->getMessage(), |
||
270 | 'trace' => $exception->getTraceAsString(), |
||
271 | ]; |
||
272 | } |
||
273 | |||
274 | 1 | return response()->json($response); |
|
275 | } |
||
276 | |||
277 | /** |
||
278 | * Ajax: to remove an attachment file. |
||
279 | * |
||
280 | * @param Project $project |
||
281 | * @param Attachment $attachment |
||
282 | * @param Request $request |
||
283 | * |
||
284 | * @return \Symfony\Component\HttpFoundation\Response |
||
285 | */ |
||
286 | public function postRemoveAttachment(Project $project, Attachment $attachment, Request $request) |
||
287 | { |
||
288 | $attachment->remove($request->all(), $project, $this->auth->user()); |
||
289 | |||
290 | return response()->json(['status' => true]); |
||
291 | } |
||
292 | |||
293 | /** |
||
294 | * Display an attachment file such as image. |
||
295 | * |
||
296 | * @param Project $project |
||
297 | * @param Issue $issue |
||
298 | * @param Attachment $attachment |
||
299 | * @param Request $request |
||
300 | * |
||
301 | * @return Response |
||
302 | */ |
||
303 | public function getDisplayAttachment(Project $project, Issue $issue, Attachment $attachment, Request $request) |
||
304 | { |
||
305 | $issue->setRelation('project', $project); |
||
306 | $attachment->setRelation('issue', $issue); |
||
307 | |||
308 | $path = config('tinyissue.uploads_dir') . '/' . $issue->project_id . '/' . $attachment->upload_token . '/' . $attachment->filename; |
||
309 | $storage = \Storage::disk('local'); |
||
310 | $length = $storage->size($path); |
||
311 | $time = $storage->lastModified($path); |
||
312 | $type = $storage->getDriver()->getMimetype($path); |
||
313 | |||
314 | $response = new Response(); |
||
315 | $response->setEtag(md5($time . $path)); |
||
316 | $response->setExpires(new \DateTime('@' . ($time + 60))); |
||
317 | $response->setLastModified(new \DateTime('@' . $time)); |
||
318 | $response->setPublic(); |
||
319 | $response->setStatusCode(200); |
||
320 | |||
321 | $response->header('Content-Type', $type); |
||
322 | $response->header('Content-Length', $length); |
||
323 | $response->header('Content-Disposition', 'inline; filename="' . $attachment->filename . '"'); |
||
324 | $response->header('Cache-Control', 'must-revalidate'); |
||
325 | |||
326 | if ($response->isNotModified($request)) { |
||
327 | // Return empty response if not modified |
||
328 | return $response; |
||
329 | } |
||
330 | |||
331 | // Return file if first request / modified |
||
332 | $response->setContent($storage->get($path)); |
||
333 | |||
334 | return $response; |
||
335 | } |
||
336 | |||
337 | /** |
||
338 | * Download an attachment file. |
||
339 | * |
||
340 | * @param Project $project |
||
341 | * @param Issue $issue |
||
342 | * @param Attachment $attachment |
||
343 | * |
||
344 | * @return \Symfony\Component\HttpFoundation\BinaryFileResponse |
||
345 | */ |
||
346 | public function getDownloadAttachment(Project $project, Issue $issue, Attachment $attachment) |
||
347 | { |
||
348 | $issue->setRelation('project', $project); |
||
349 | $attachment->setRelation('issue', $issue); |
||
350 | |||
351 | $path = config('filesystems.disks.local.root') . '/' . config('tinyissue.uploads_dir') . '/' . $issue->project_id . '/' . $attachment->upload_token . '/' . $attachment->filename; |
||
352 | |||
353 | return response()->download($path, $attachment->filename); |
||
354 | } |
||
355 | |||
356 | /** |
||
357 | * Ajax: move an issue to another project. |
||
358 | * |
||
359 | * @param Issue $issue |
||
360 | * @param Request $request |
||
361 | * |
||
362 | * @return \Symfony\Component\HttpFoundation\Response |
||
363 | */ |
||
364 | public function postChangeProject(Issue $issue, Request $request) |
||
365 | { |
||
366 | $issue->changeProject($request->input('project_id')); |
||
367 | |||
368 | return response()->json(['status' => true, 'url' => $issue->to()]); |
||
369 | } |
||
370 | |||
371 | /** |
||
372 | * Ajax: change status of an issue. |
||
373 | * |
||
374 | * @param Issue $issue |
||
375 | * @param Request $request |
||
376 | * |
||
377 | * @return \Symfony\Component\HttpFoundation\Response |
||
378 | */ |
||
379 | public function postChangeKanbanTag(Issue $issue, Request $request) |
||
388 | |||
389 | /** |
||
390 | * Ajax: returns comments for an issue. |
||
391 | * |
||
392 | * @param Project $project |
||
393 | * @param Issue $issue |
||
394 | * |
||
395 | * @return \Symfony\Component\HttpFoundation\Response |
||
396 | */ |
||
397 | public function getIssueComments(Project $project, Issue $issue) |
||
398 | { |
||
399 | $issue->attachments->each(function (Attachment $attachment) use ($issue) { |
||
400 | $attachment->setRelation('issue', $issue); |
||
401 | }); |
||
402 | $activities = $issue->commentActivities()->with('activity', 'user', 'comment', 'assignTo', |
||
403 | 'comment.attachments')->get(); |
||
425 | |||
426 | /** |
||
427 | * Ajax: returns activities for an issue excluding comments. |
||
428 | * |
||
429 | * @param Project $project |
||
430 | * @param Issue $issue |
||
431 | * |
||
432 | * @return \Symfony\Component\HttpFoundation\Response |
||
433 | */ |
||
434 | public function getIssueActivity(Project $project, Issue $issue) |
||
459 | } |
||
460 |
Let’s take a look at an example:
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:
Add an additional type-check:
Add the method to the interface: