IssueController - Code Metrics - Inspection of "Misc: add help message to role access in tags" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( dd0d17...042fea )

by Mohamed
created 2016-06-26 00:22 UTC
IssueController A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	436
Duplicated Lines	4.82 %
Coupling/Cohesion

Components	1
Dependencies	15
Test Coverage

Coverage
94.56%
Importance

Changes	16
Bugs	6	Features	1
Metric	Value
wmc	30
c	16
b	6
f	1
lcom	1
cbo	15
dl	21
loc	436
ccs	139
cts	147
cp	0.9456
rs	9.1666
18 Methods

Rating	Name	Duplication	Size	Complexity
A	getEdit()	0	15	2
A	getIndex()	0	16	3
A	postEditComment()	0	10	2
A	getAddComment()	0	10	1
A	getDeleteComment()	0	6	1
A	getNew()	0	8	1
A	postAssign()	0	9	2
A	postNew()	0	9	1
A	postChangeKanbanTag()	0	9	1
A	postEdit()	0	17	2
A	getClose()	0	14	2
B	postUploadAttachment()	0	31	3
A	postRemoveAttachment()	0	6	1
B	getDisplayAttachment()	0	33	2
A	getDownloadAttachment()	0	9	1
A	postChangeProject()	0	6	1
B	getIssueComments()	10	28	2
B	getIssueActivity()	11	25	2
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\Http\Controllers\Project;

use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Tinyissue\Form\Comment as CommentForm;
use Tinyissue\Form\Issue as IssueForm;
use Tinyissue\Http\Controllers\Controller;
use Tinyissue\Http\Requests\FormRequest;
use Tinyissue\Model\Project;
use Tinyissue\Model\Project\Issue;
use Tinyissue\Model\Project\Issue\Attachment;
use Tinyissue\Model\Project\Issue\Comment;
use Tinyissue\Model\Tag;
use Tinyissue\Model\User\Activity as UserActivity;

/**
 * IssueController is the controller class for managing request related to projects issues.
 *
 * @author Mohamed Alsharaf <[email protected]>
 */
class IssueController extends Controller
{
    /**
     * Project issue index page (List project issues).
     *
     * @param Project     $project
     * @param Issue       $issue
     * @param CommentForm $form
     *
     * @return \Illuminate\View\View
     */
    public function getIndex(Project $project, Issue $issue, CommentForm $form)
    {
        // Projects should be limited to issue-modify
        $projects = null;
        if (!$this->auth->guest() && $this->auth->user()->permission('issue-modify')) {
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.
    }
}
            $projects = $this->auth->user()->projects()->get();
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.
    }
}
        }

        return view('project.issue.index', [

            'issue'       => $issue,
            'project'     => $project,
            'commentForm' => $form,
            'sidebar'     => 'project',
            'projects'    => $projects,
        ]);
    }

    /**
     * Ajax: Assign new user to an issue.
     *
     * @param Issue   $issue
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postAssign(Issue $issue, Request $request)
    {
        $response = ['status' => false];
        if ($issue->reassign((int) $request->input('user_id'), $this->auth->user())) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $response['status'] = true;
        }

        return response()->json($response);
    }

    /**
     * Ajax: save comment.
     *
     * @param Comment $comment
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postEditComment(Comment $comment, Request $request)
    {
        $body = '';
        if ($request->has('body')) {
            $comment->updateBody($request->input('body'), $this->auth->user());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $body = \Html::format($comment->comment);
        }

        return response()->json(['text' => $body]);
    }

    /**
     * To add new comment to an issue.
     *
     * @param Project             $project
     * @param Issue               $issue
     * @param Comment             $comment
     * @param FormRequest\Comment $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function getAddComment(Project $project, Issue $issue, Comment $comment, FormRequest\Comment $request)
    {
        $comment->setRelation('project', $project);
        $comment->setRelation('issue', $issue);
        $comment->setRelation('user', $this->auth->user());
        $comment->createComment($request->all());

        return redirect($issue->to() . '#comment' . $comment->id)
            ->with('notice', trans('tinyissue.your_comment_added'));
    }

    /**
     * Ajax: to delete a comment.
     *
     * @param Comment $comment
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getDeleteComment(Comment $comment)
    {
        $comment->deleteComment($this->auth->user());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return response()->json(['status' => true]);
    }

    /**
     * New issue form.
     *
     * @param Project   $project
     * @param IssueForm $form
     *
     * @return \Illuminate\View\View
     */
    public function getNew(Project $project, IssueForm $form)
    {
        return view('project.issue.new', [

            'project' => $project,
            'form'    => $form,
            'sidebar' => 'project',
        ]);
    }

    /**
     * To create a new issue.
     *
     * @param Project           $project
     * @param Issue             $issue
     * @param FormRequest\Issue $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postNew(Project $project, Issue $issue, FormRequest\Issue $request)
    {
        $issue->setRelation('project', $project);
        $issue->setRelation('user', $this->auth->user());
        $issue->createIssue($request->all());

        return redirect($issue->to())
            ->with('notice', trans('tinyissue.issue_has_been_created'));
    }

    /**
     * Edit an existing issue form.
     *
     * @param Project   $project
     * @param Issue     $issue
     * @param IssueForm $form
     *
     * @return \Illuminate\View\View
     */
    public function getEdit(Project $project, Issue $issue, IssueForm $form)
    {
        // Cannot edit closed issue
        if ($issue->status == Issue::STATUS_CLOSED) {
            return redirect($issue->to())
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                ->with('notice', trans('tinyissue.cant_edit_closed_issue'));
        }

        return view('project.issue.edit', [

            'issue'   => $issue,
            'project' => $project,
            'form'    => $form,
            'sidebar' => 'project',
        ]);
    }

    /**
     * To update an existing issue details.
     *
     * @param Project           $project
     * @param Issue             $issue
     * @param FormRequest\Issue $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postEdit(Project $project, Issue $issue, FormRequest\Issue $request)
    {
        // Delete the issue
        if ($request->has('delete-issue')) {
            $issue->delete();

            return redirect($project->to())
                ->with('notice', trans('tinyissue.issue_has_been_deleted'));
        }

        $issue->setRelation('project', $project);
        $issue->setRelation('updatedBy', $this->auth->user());
        $issue->updateIssue($request->all());

        return redirect($issue->to())
            ->with('notice', trans('tinyissue.issue_has_been_updated'));
    }

    /**
     * To close or reopen an issue.
     *
     * @param Project $project
     * @param Issue   $issue
     * @param int     $status
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function getClose(Project $project, Issue $issue, $status = 0)
    {
        if ($status == 0) {
            $message = trans('tinyissue.issue_has_been_closed');
        } else {
            $message = trans('tinyissue.issue_has_been_reopened');
        }

        $issue->setRelation('project', $project);
        $issue->changeStatus($status, $this->auth->user());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return redirect($issue->to())
            ->with('notice', $message);
    }

    /**
     * To upload an attachment file.
     *
     * @param Project    $project
     * @param Attachment $attachment
     * @param Request    $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postUploadAttachment(Project $project, Attachment $attachment, Request $request)
    {
        try {
            if (!$this->auth->user()->permission('project-all')) {
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.
    }
}
                abort(404);
            }

            $attachment->upload($request->all(), $project, $this->auth->user());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            $response = [
                'upload' => [
                    [
                        'name'   => $attachment->filename,
                        'size'   => $attachment->filesize,
                        'fileId' => $attachment->id,
                    ],
                ],
            ];
        } catch (\Exception $exception) {
            $file = $request->file('upload');

            $response = [
                'status' => false,
                'name'   => $file->getClientOriginalName(),
                'error'  => $exception->getMessage(),
                'trace'  => $exception->getTraceAsString(),
            ];
        }

        return response()->json($response);
    }

    /**
     * Ajax: to remove an attachment file.
     *
     * @param Project    $project
     * @param Attachment $attachment
     * @param Request    $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postRemoveAttachment(Project $project, Attachment $attachment, Request $request)
    {
        $attachment->remove($request->all(), $project, $this->auth->user());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return response()->json(['status' => true]);
    }

    /**
     * Display an attachment file such as image.
     *
     * @param Project    $project
     * @param Issue      $issue
     * @param Attachment $attachment
     * @param Request    $request
     *
     * @return Response
     */
    public function getDisplayAttachment(Project $project, Issue $issue, Attachment $attachment, Request $request)
    {
        $issue->setRelation('project', $project);
        $attachment->setRelation('issue', $issue);

        $path    = config('tinyissue.uploads_dir') . '/' . $issue->project_id . '/' . $attachment->upload_token . '/' . $attachment->filename;
        $storage = \Storage::disk('local');
        $length  = $storage->size($path);
        $time    = $storage->lastModified($path);
        $type    = $storage->getDriver()->getMimetype($path);

        $response = new Response();
        $response->setEtag(md5($time . $path));
        $response->setExpires(new \DateTime('@' . ($time + 60)));
        $response->setLastModified(new \DateTime('@' . $time));
        $response->setPublic();
        $response->setStatusCode(200);

        $response->header('Content-Type', $type);
        $response->header('Content-Length', $length);
        $response->header('Content-Disposition', 'inline; filename="' . $attachment->filename . '"');
        $response->header('Cache-Control', 'must-revalidate');

        if ($response->isNotModified($request)) {
            // Return empty response if not modified
            return $response;
        }

        // Return file if first request / modified
        $response->setContent($storage->get($path));

        return $response;
    }

    /**
     * Download an attachment file.
     *
     * @param Project    $project
     * @param Issue      $issue
     * @param Attachment $attachment
     *
     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
     */
    public function getDownloadAttachment(Project $project, Issue $issue, Attachment $attachment)
    {
        $issue->setRelation('project', $project);
        $attachment->setRelation('issue', $issue);

        $path = config('filesystems.disks.local.root') . '/' . config('tinyissue.uploads_dir') . '/' . $issue->project_id . '/' . $attachment->upload_token . '/' . $attachment->filename;

        return response()->download($path, $attachment->filename);
    }

    /**
     * Ajax: move an issue to another project.
     *
     * @param Issue   $issue
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postChangeProject(Issue $issue, Request $request)
    {
        $issue->changeProject($request->input('project_id'));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return response()->json(['status' => true, 'url' => $issue->to()]);
    }

    /**
     * Ajax: change status of an issue.
     *
     * @param Issue   $issue
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postChangeKanbanTag(Issue $issue, Request $request)
    {
        $newTag = Tag::find((int) $request->input('newtag'));
        $oldTag = Tag::find((int) $request->input('oldtag'));

        $issue->changeKanbanTag($newTag, $oldTag);

        return response()->json(['status' => true, 'issue' => $issue->id]);
    }

    /**
     * Ajax: returns comments for an issue.
     *
     * @param Project $project
     * @param Issue   $issue
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getIssueComments(Project $project, Issue $issue)
    {
        $issue->attachments->each(function (Attachment $attachment) use ($issue) {
<?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.");
        }
    }

}
            $attachment->setRelation('issue', $issue);
        });
        $activities = $issue->commentActivities()->with('activity', 'user', 'comment', 'assignTo',
            'comment.attachments')->get();
        $activities->each(function (UserActivity $activity) use ($issue) {
            $activity->setRelation('issue', $issue);
        });

        $activityString = $activities->map(function (UserActivity $activity) use ($project, $issue) {

            return view('project/issue/activity/' . $activity->activity->activity, [
<?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.");
        }
    }

}
                'issue'           => $issue,
                'userActivity'    => $activity,
                'project'         => $project,
                'user'            => $activity->user,
<?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.");
        }
    }

}
                'comment'         => $activity->comment,
<?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.");
        }
    }

}
                'assigned'        => $activity->assignTo,
<?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.");
        }
    }

}
            ])->render();
        })->implode('');

        if (empty($activityString)) {
            $activityString = '<li class="no-records">There are no comments yet on this issue.</li>';
        }

        return response()->json(['status' => true, 'activity' => $activityString]);
    }

    /**
     * Ajax: returns activities for an issue excluding comments.
     *
     * @param Project $project
     * @param Issue   $issue
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getIssueActivity(Project $project, Issue $issue)
    {
        $activities = $issue->generalActivities()->with('activity', 'user', 'assignTo')->get();
        $activities->each(function (UserActivity $activity) use ($issue) {
            $activity->setRelation('issue', $issue);
        });

        $activityString = $activities->map(function (UserActivity $activity) use ($project, $issue) {

            return view('project/issue/activity/' . $activity->activity->activity, [
<?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.");
        }
    }

}
                'issue'           => $issue,
                'userActivity'    => $activity,
                'activity'        => $activity,
                'project'         => $project,
                'user'            => $activity->user,
<?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.");
        }
    }

}
                'comment'         => $activity->comment,
<?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.");
        }
    }

}
                'assigned'        => $activity->assignTo,
<?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.");
        }
    }

}
            ])->render();
        })->implode('');

        if (empty($activityString)) {
            $activityString = '<li class="no-records">There are no activity yet on this issue.</li>';
        }

        return response()->json(['status' => true, 'activity' => $activityString]);
    }
}

Push — develop ( dd0d17...042fea )

IssueController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

satrun77 / tinyissue

Push — develop ( dd0d17...042fea )

IssueController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
