TicketControllable - Code Metrics - Inspection of "Fixed some bugs, updated readme, removed controlle..." - rexlManu/laravel-tickets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ac2f13...c623e5 )

by Emmanuel

created 2020-11-19 09:52 UTC

TicketControllable A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	301
Duplicated Lines	11.3 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

Metric	Value
wmc	40
lcom	1
cbo	14
dl	34
loc	301
rs	9.2
c	0
b	0
f	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	2
A	index()	0	15	3
A	create()	0	4	1
B	store()	0	70	8
A	show()	4	21	4
B	message()	13	47	7
B	close()	13	26	6
A	download()	4	14	5
A	handleFiles()	0	15	4

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 TicketControllable 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 TicketControllable, and based on these observations, apply Extract Interface, too.

<?php


namespace RexlManu\LaravelTickets\Controllers;


use Illuminate\Http\JsonResponse;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Validation\Rule;
use Illuminate\View\View;
use RexlManu\LaravelTickets\Events\TicketCloseEvent;
use RexlManu\LaravelTickets\Events\TicketMessageEvent;
use RexlManu\LaravelTickets\Events\TicketOpenEvent;
use RexlManu\LaravelTickets\Models\Ticket;
use RexlManu\LaravelTickets\Models\TicketMessage;
use RexlManu\LaravelTickets\Models\TicketReference;
use RexlManu\LaravelTickets\Models\TicketUpload;
use RexlManu\LaravelTickets\Rule\TicketReferenceRule;
use Symfony\Component\HttpFoundation\BinaryFileResponse;

/**
 * Class TicketController
 *
 * The main logic of the ticket system. All actions are performed here.
 *
 * If the accept header is json, the response will be a json response
 *
 * @package RexlManu\LaravelTickets\Controllers
 */
trait TicketControllable
{

    /**
     * @link TicketControllable constructor
     */
    public function __construct()
    {
        if (! config('laravel-tickets.permission')) {
            return;
        }

        $this->middleware(config('laravel-tickets.permissions.list-ticket'))->only('index');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->middleware(config('laravel-tickets.permissions.create-ticket'))->only('store', 'create');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->middleware(config('laravel-tickets.permissions.close-ticket'))->only('close');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->middleware(config('laravel-tickets.permissions.show-ticket'))->only('show');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->middleware(config('laravel-tickets.permissions.message-ticket'))->only('message');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->middleware(config('laravel-tickets.permissions.download-ticket'))->only('download');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Show every @return View|JsonResponse
     *
     * @link Ticket that the user has created
     *
     * If the accept header is json, the response will be a json response
     *
     */
    public function index()
    {
        if (\request()->user()->can(config('laravel-tickets.permissions.all-ticket'))) {
            $tickets = Ticket::query();
        } else {
            $tickets = request()->user()->tickets();
        }
        $tickets = $tickets->orderBy('id', 'desc')->paginate(10);

        return request()->wantsJson() ?
            response()->json(compact('tickets')) :
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            view('laravel-tickets::tickets.index',
                compact('tickets')
            );
    }

    /**
     * Show the create form
     *
     * @return View
     */
    public function create()
    {
        return view('laravel-tickets::tickets.create');
    }

    /**
     * Creates a @param Request $request the request
     *
     * @return View|JsonResponse|RedirectResponse
     * @link Ticket
     *
     */
    public function store(Request $request)
    {
        $rules = [
            'subject' => [ 'required', 'string', 'max:191' ],
            'priority' => [ 'required', Rule::in(config('laravel-tickets.priorities')) ],
            'message' => [ 'required', 'string' ],
            'files' => [ 'max:' . config('laravel-tickets.file.max-files') ],
            'files.*' => [
                'sometimes',
                'file',
                'max:' . config('laravel-tickets.file.size-limit'),
                'mimes:' . config('laravel-tickets.file.memes'),
            ],
        ];
        if (config('laravel-tickets.category')) {
            $rules[ 'category_id' ] = [
                'required',
                Rule::exists(config('laravel-tickets.database.ticket-categories-table'), 'id'),
            ];
        }
        if (config('laravel-tickets.references')) {
            $rules[ 'reference' ] = [
                config('laravel-tickets.references-nullable') ? 'nullable' : 'required',
                new TicketReferenceRule(),
            ];
        }
        $data = $request->validate($rules);

        if ($request->user()->tickets()->where('state', '!=', 'CLOSED')->count() >= config('laravel-tickets.maximal-open-tickets')) {
            $message = trans('You have reached the limit of open tickets');
            return \request()->wantsJson() ?
                response()->json(compact('message')) :
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                back()->with(
                    'message',
                    $message
                );
        }
        $ticket = $request->user()->tickets()->create(
            $data
        );

        if (array_key_exists('reference', $data)) {
            $reference = explode(',', $data[ 'reference' ]);
            $ticketReference = new TicketReference();
            $ticketReference->ticket()->associate($ticket);
            $ticketReference->referenceable()->associate(
                resolve($reference[ 0 ])->find($reference[ 1 ])
            );
            $ticketReference->save();
        }

        $ticketMessage = new TicketMessage($data);
        $ticketMessage->user()->associate($request->user());
        $ticketMessage->ticket()->associate($ticket);
        $ticketMessage->save();

        $this->handleFiles($data[ 'files' ] ?? [], $ticketMessage);

        event(new TicketOpenEvent($ticket));

        $message = trans('The ticket was successfully created');
        return $request->wantsJson() ?
            response()->json(compact('message', 'ticket', 'ticketMessage')) :
            redirect(route(
                'laravel-tickets.tickets.show',
                compact('ticket')
            ))->with(
                'message',
                $message
            );
    }

    /**
     * Show detailed informations about the @param Ticket $ticket
     *
     * @return View|JsonResponse|RedirectResponse|void
     * @link Ticket and the informations
     *
     */
    public function show(Ticket $ticket)
    {
        if (! $ticket->user()->get()->contains(\request()->user()) &&

            ! request()->user()->can(config('laravel-tickets.permissions.all-ticket'))) {
            return abort(403);
        }

        $messages = $ticket->messages()->with('uploads')->orderBy('created_at', 'desc')->paginate(4);

        return \request()->wantsJson() ?
            response()->json(compact(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                'ticket',
                'messages'
            )) :
            view('laravel-tickets::tickets.show',
                compact(
                    'ticket',
                    'messages'
                )
            );
    }

    /**
     * Send a message to the @param Request $request
     *
     * @param Ticket $ticket
     *
     * @return JsonResponse|RedirectResponse|void
     * @link Ticket
     *
     */
    public function message(Request $request, Ticket $ticket)
    {
        if (! $ticket->user()->get()->contains(\request()->user()) &&

            ! request()->user()->can(config('laravel-tickets.permissions.all-ticket'))) {
            return abort(403);
        }

        if (! config('laravel-tickets.open-ticket-with-answer') && $ticket->state === 'CLOSED') {

            $message = trans('You cannot reply to a closed ticket');
            return \request()->wantsJson() ?
                response()->json(compact('message')) :
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                back()->with(
                    'message',
                    $message
                );
        }

        $data = $request->validate([

            'message' => [ 'required', 'string' ],
            'files' => [ 'max:' . config('laravel-tickets.file.max-files') ],
            'files.*' => [
                'sometimes',
                'file',
                'max:' . config('laravel-tickets.file.size-limit'),
                'mimes:' . config('laravel-tickets.file.memes'),
            ]
        ]);

        $ticketMessage = new TicketMessage($data);
        $ticketMessage->user()->associate($request->user());
        $ticketMessage->ticket()->associate($ticket);
        $ticketMessage->save();

        $this->handleFiles($data[ 'files' ] ?? [], $ticketMessage);

        $ticket->update([ 'state' => 'OPEN' ]);

        event(new TicketMessageEvent($ticket, $ticketMessage));

        $message = trans('Your answer was sent successfully');
        return $request->wantsJson() ?
            response()->json(compact('message')) :
            back()->with(
                'message',
                $message
            );
    }

    /**
     * Declare the @param Ticket $ticket
     *
     * @return JsonResponse|RedirectResponse|void
     * @link Ticket as closed.
     *
     */
    public function close(Ticket $ticket)
    {
        if (! $ticket->user()->get()->contains(\request()->user()) &&

            ! request()->user()->can(config('laravel-tickets.permissions.all-ticket'))) {
            return abort(403);
        }
        if ($ticket->state === 'CLOSED') {

            $message = trans('The ticket is already closed');
            return \request()->wantsJson() ?
                response()->json(compact('message')) :
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                back()->with(
                    'message',
                    $message
                );
        }
        $ticket->update([ 'state' => 'CLOSED' ]);
        event(new TicketCloseEvent($ticket));

        $message = trans('The ticket was successfully closed');
        return \request()->wantsJson() ?
            response()->json(compact('message')) :
            back()->with(
                'message',
                $message
            );
    }

    /**
     * Downloads the file from @param Ticket $ticket
     *
     * @param TicketUpload $ticketUpload
     *
     * @return BinaryFileResponse
     * @link TicketUpload
     *
     */
    public function download(Ticket $ticket, TicketUpload $ticketUpload)
    {
        if (! $ticket->user()->get()->contains(\request()->user()) &&

            ! request()->user()->can(config('laravel-tickets.permissions.all-ticket'))) {
            return abort(403);
        }

        $storagePath = storage_path('app/' . $ticketUpload->path);
        if (config('laravel-tickets.pdf-force-preview') && pathinfo($ticketUpload->path, PATHINFO_EXTENSION) === 'pdf') {
            return response()->file($storagePath);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        return response()->download($storagePath);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Handles the uploaded files for the @param $files array uploaded files
     *
     * @param TicketMessage $ticketMessage
     *
     * @link TicketMessage
     *
     */
    private function handleFiles($files, TicketMessage $ticketMessage)
    {
        if (! config('laravel-tickets.files') || $files === null) {
            return;
        }
        foreach ($files as $file) {
            $ticketMessage->uploads()->create([
                'path' => $file->storeAs(
                    config('laravel-tickets.file.path') . $ticketMessage->id,
                    $file->getClientOriginalName(),
                    config('laravel-tickets.file.driver')
                )
            ]);
        }
    }

}


Push — master ( ac2f13...c623e5 )

TicketControllable A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

rexlManu / laravel-tickets

Push — master ( ac2f13...c623e5 )

TicketControllable A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like