ProjectController - Code Metrics - Inspection of "In progress" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop-3.0 (4fe777)

by Mohamed

created 2016-09-11 10:54 UTC

ProjectController B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	412
Duplicated Lines	11.41 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

Metric	Value
wmc	46
lcom	1
cbo	11
dl	47
loc	412
rs	8.3999
c	0
b	0
f	0

19 Methods

Rating	Name	Duplication	Size	Complexity
B	indexView()	0	18	7
A	getIndex()	11	11	1
A	getIssues()	0	19	4
A	getOpenIssuesViewData()	0	8	1
A	getClosedIssuesViewData()	0	8	1
A	getAssigned()	12	12	1
A	getCreated()	12	12	1
A	getNotes()	12	12	1
C	projectMainViewTabs()	0	64	17
A	getEdit()	0	8	1
A	postEdit()	0	15	2
A	getInactiveUsers()	0	6	1
A	postAssign()	0	6	1
A	postUnassign()	0	6	1
A	postAddNote()	0	8	1
A	postEditNote()	0	12	2
A	getDeleteNote()	0	6	1
A	postExportIssues()	0	23	1
A	getDownloadExport()	0	8	1

How to fix Duplicated Code Complexity

Duplicated Code

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:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ProjectController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ProjectController, and based on these observations, apply Extract Interface, too.

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

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Http\Request;
use Tinyissue\Contracts\Repository\Project\ProjectRepository;
use Tinyissue\Form\FilterIssue as FilterForm;
use Tinyissue\Form\Note as NoteForm;
use Tinyissue\Form\Project as Form;
use Tinyissue\Http\Requests\FormRequest;
use Tinyissue\Model\Project;
use Tinyissue\Model\Project\Issue;
use Tinyissue\Model\Project\Note;
use Tinyissue\Repository\Project\Note\NoteRepository;
use Tinyissue\Repository\Role\RoleRepository;
use Tinyissue\Services\Exporter;

/**
 * ProjectController is the controller class for managing request related to a project.
 *
 * @author Mohamed Alsharaf <[email protected]>
 */
class ProjectController extends Controller
{
    protected function indexView($data, $active, ProjectRepository $project)
    {
        $isUser            = $this->isLoggedIn() && $this->getLoggedUser()->isUser();
        $isInternalProject = $project->isPrivateInternal();


        if (array_key_exists('assigned_issues_count', $data) && $this->isLoggedIn() && (!$isInternalProject || (!$isUser && $isInternalProject))) {
            $data['created_issues_count'] = $project->countCreatedIssues($this->getLoggedUser());

        } else {
            $data['assigned_issues_count'] = $project->countAssignedIssues($this->getLoggedUser());

        }

        $data['sidebar']           = 'project';
        $data['active']            = $active;
        $data['project']           = $project;
        $data['usersCanFixIssues'] = $project->getUsersCanFixIssue();

        return view('project.index', $data);
    }

    /**
     * Display activity for a project.
     *
     * @param ProjectRepository $project
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getIndex(ProjectRepository $project)

    {
        $activities = $project->getRecentActivities($this->getLoggedUser());

        return $this->indexView([
            'activities'          => $activities,
            'notes_count'         => $project->countNotes(),

            'open_issues_count'   => $project->countOpenIssues($this->getLoggedUser()),

            'closed_issues_count' => $project->countClosedIssues($this->getLoggedUser()),

        ], 'activity', $project);
    }

    /**
     * Display issues for a project.
     *
     * @param FilterForm        $filterForm
     * @param Request           $request
     * @param ProjectRepository $project
     * @param int               $status
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getIssues(FilterForm $filterForm, Request $request, ProjectRepository $project, $status = Issue::STATUS_OPEN)
    {
        if ($project->isPrivateInternal() && $this->getLoggedUser()->isUser()) {

            $request['created_by'] = $this->getLoggedUser()->id;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }
        $issues = $project->getIssues($status, $request->all());

        if ($status === Issue::STATUS_OPEN) {
            $data = $this->getOpenIssuesViewData($issues, $project);
        } else {
            $data = $this->getClosedIssuesViewData($issues, $project);
        }

        $data['notes_count'] = $project->countNotes();

        $data['issues']      = $issues;
        $data['filterForm']  = $filterForm;

        return $this->indexView($data, $data['active'], $project);
    }

    protected function getOpenIssuesViewData(Collection $issues, ProjectRepository $project)
    {
        return [
            'open_issues_count'   => $issues->count(),
            'closed_issues_count' => $project->countClosedIssues($this->getLoggedUser()),

            'active'              => 'open_issues',
        ];
    }

    protected function getClosedIssuesViewData(Collection $issues, ProjectRepository $project)
    {
        return [
            'open_issues_count'   => $project->countOpenIssues($this->getLoggedUser()),

            'closed_issues_count' => $issues->count(),
            'active'              => 'closed_issues',
        ];
    }

    /**
     * Display issues assigned to current user for a project.
     *
     * @param ProjectRepository $project
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getAssigned(ProjectRepository $project)

    {
        $issues = $project->getAssignedOrCreatedIssues($this->getLoggedUser());

        return $this->indexView([
            'notes_count'           => $project->countNotes(),

            'open_issues_count'     => $project->countOpenIssues($this->getLoggedUser()),

            'closed_issues_count'   => $project->countClosedIssues($this->getLoggedUser()),

            'assigned_issues_count' => $issues->count(),
            'issues'                => $issues,
        ], 'activity', $project);
    }

    /**
     * Display issues created to current user for a project.
     *
     * @param ProjectRepository $project
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getCreated(ProjectRepository $project)

    {
        $issues = $project->getAssignedOrCreatedIssues($this->getLoggedUser());

        return $this->indexView([
            'notes_count'           => $project->countNotes(),

            'open_issues_count'     => $project->countOpenIssues($this->getLoggedUser()),

            'closed_issues_count'   => $project->countClosedIssues($this->getLoggedUser()),

            'assigned_issues_count' => $issues->count(),
            'issues'                => $issues,
        ], 'issue_created_by_you', $project);
    }

    /**
     * Display notes for a project.
     *
     * @param ProjectRepository $project
     * @param NoteForm          $form
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getNotes(ProjectRepository $project, NoteForm $form)

    {
        $notes = $project->getNotes();

        return $this->indexView([
            'notes_count'         => $project->countNotes(),

            'open_issues_count'   => $project->countOpenIssues($this->getLoggedUser()),

            'closed_issues_count' => $project->countClosedIssues($this->getLoggedUser()),

            'notes'               => $notes,
            'notes_count'         => $notes->count(),
        ], 'notes', $project);
    }

    /**
     * @param Project $project
     * @param string  $view
     * @param null    $data
     * @param bool    $status
     *
     * @return array
     */
    protected function projectMainViewTabs(ProjectRepository $project, $view, $data = null, $status = false)

    {
        return null;
        $user              = $this->getLoggedUser();
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        $isLoggedIn        = !$this->auth->guest();
        $isUser            = $isLoggedIn && $user->isUser();
        $isInternalProject = $project->isPrivateInternal();

        if ($view === 'note') {
            $notesCount = !is_null($data) ? $data->count() : 0;
        } else {
            $notesCount = $project->countNotes();
        }

        if ($view === 'issues') {
            if ($status == Issue::STATUS_OPEN) {
                $closedIssuesCount = $project->closedIssuesCount($user)->count();
                $openIssuesCount   = !is_null($data) ? $data->count() : 0;
            } else {
                $closedIssuesCount = !is_null($data) ? $data->count() : 0;
                $openIssuesCount   = $project->openIssuesCount($user)->count();
            }
        } else {
            $openIssuesCount   = $project->openIssuesCount($user)->count();
            $closedIssuesCount = $project->closedIssuesCount($user)->count();
        }

        $tabs   = [];
        $tabs[] = [
            'url'  => $project->to(),
            'page' => 'activity',
        ];
        $tabs[] = [
            'url'    => $project->to('issues'),
            'page'   => 'open_issue',
            'prefix' => $openIssuesCount,
        ];
        $tabs[] = [
            'url'    => $project->to('issues') . '/0',
            'page'   => 'closed_issue',
            'prefix' => $closedIssuesCount,
        ];
        if ($isLoggedIn && (!$isInternalProject || (!$isUser && $isInternalProject))) {
            if ($view !== 'assigned') {
                $method              = $isUser ? 'createdIssuesCount' : 'assignedIssuesCount';
                $assignedIssuesCount = $this->getLoggedUser()->$method($project->id);
            } else {
                $assignedIssuesCount = !is_null($data) ? $data->count() : 0;
            }

            $tabs[] = [
                'url'    => $project->to($isUser ? 'created' : 'assigned'),
                'page'   => ($isUser ? 'issue_created_by_you' : 'issue_assigned_to_you'),
                'prefix' => $assignedIssuesCount,
            ];
        }
        $tabs[] = [
            'url'    => $project->to('notes'),
            'page'   => 'notes',
            'prefix' => $notesCount,
        ];

        return $tabs;
    }

    /**
     * Edit the project.
     *
     * @param Project $project
     * @param Form    $form
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getEdit(ProjectRepository $project, Form $form)
    {
        return view('project.edit', [
            'form'    => $form,
            'project' => $project,
            'sidebar' => 'project',
        ]);
    }

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


            return redirect('projects')
                ->with('notice', trans('tinyissue.project_has_been_deleted'));
        }

        $project->update($request->all());


        return redirect($project->to())

            ->with('notice', trans('tinyissue.project_has_been_updated'));
    }

    /**
     * Ajax: returns list of users that are not in the project.
     *
     * @param Project $project
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getInactiveUsers(ProjectRepository $project)
    {
        $users = $project->getNotMembers()->dropdown('fullname');


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

    /**
     * Ajax: add user to the project.
     *
     * @param Project $project
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postAssign(ProjectRepository $project, Request $request)
    {
        $status = $project->assignUser((int) $request->input('user_id'));


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

    /**
     * Ajax: remove user from the project.
     *
     * @param Project $project
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postUnassign(RoleRepository $project, Request $request)
    {
        $status = $project->unassignUser((int) $request->input('user_id'));
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

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

    /**
     * To add a new note to the project.
     *
     * @param Project          $project
     * @param Note             $note
     * @param FormRequest\Note $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postAddNote(ProjectRepository $project, NoteRepository $note, FormRequest\Note $request)
    {
        $note->setRelation('project', $project);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $note->setRelation('createdBy', $this->getLoggedUser());
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $note->createNote($request->all());
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        return redirect($note->to())->with('notice', trans('tinyissue.your_note_added'));
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Ajax: To update project note.
     *
     * @param Project $project
     * @param Note    $note
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postEditNote(ProjectRepository $project, \Tinyissue\Contracts\Repository\Project\NoteRepository $note, Request $request)
    {
        $body = '';
        if ($request->has('body')) {
            $note->setRelation('project', $project);
            $note->updateBody($request->input('body'), $this->getLoggedUser());

            $body = \Html::format($note->body);
        }

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

    /**
     * Ajax: to delete a project note.
     *
     * @param Project $project
     * @param Note    $note
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getDeleteNote(ProjectRepository $project, \Tinyissue\Contracts\Repository\Project\NoteRepository $note)

    {
        $note->deleteNote($this->getLoggedUser());

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

    /**
     * Ajax: generate the issues export file.
     *
     * @param Project  $project
     * @param Exporter $exporter
     * @param Request  $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postExportIssues(ProjectRepository $project, Exporter $exporter, Request $request)
    {
        // Generate export file
        $info = $exporter->exportFile(
            'Project\Issue',
            $request->input('format', Exporter::TYPE_CSV),

            $request->all()
        );

        // Download link
        $link = link_to(
            $project->to('download_export/' . $info['file']),

            trans('tinyissue.download_export'),

            ['class' => 'btn btn-link']
        );

        return response()->json([
            'link'  => $link,
            'title' => $info['title'],
            'file'  => $info['file'],
            'ext'   => $info['ext'],
        ]);
    }

    /**
     * Download and then delete an export file.
     *
     * @param Project $project
     * @param string  $file
     *
     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
     */
    public function getDownloadExport(ProjectRepository $project, $file)

    {
        // Filter out any characters that are not in pattern
        $file = preg_replace('/[^a-z0-9\_\.]/mi', '', $file);

        // Download export
        return response()->download(storage_path('exports/' . $file), $file)->deleteFileAfterSend(true);
    }
}


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\Http\Controllers;
13
14			use Illuminate\Database\Eloquent\Collection;
15			use Illuminate\Http\Request;
16			use Tinyissue\Contracts\Repository\Project\ProjectRepository;
17			use Tinyissue\Form\FilterIssue as FilterForm;
18			use Tinyissue\Form\Note as NoteForm;
19			use Tinyissue\Form\Project as Form;
20			use Tinyissue\Http\Requests\FormRequest;
21			use Tinyissue\Model\Project;
22			use Tinyissue\Model\Project\Issue;
23			use Tinyissue\Model\Project\Note;
24			use Tinyissue\Repository\Project\Note\NoteRepository;
25			use Tinyissue\Repository\Role\RoleRepository;
26			use Tinyissue\Services\Exporter;
27
28			/**
29			* ProjectController is the controller class for managing request related to a project.
30			*
31			* @author Mohamed Alsharaf <[email protected]>
32			*/
33			class ProjectController extends Controller
34			{
35			protected function indexView($data, $active, ProjectRepository $project)
36			{
37			$isUser = $this->isLoggedIn() && $this->getLoggedUser()->isUser();
38			$isInternalProject = $project->isPrivateInternal();
			0 ignored issues – show Bug introduced 2016-09-11 11:05 UTC by Report Bug Copy Issue Report The method `isPrivateInternal()` does not seem to exist on `object<Tinyissue\Contrac...ject\ProjectRepository>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
39

satrun77 / tinyissue