TechTipsController::storeUpdatedTip() - Code Metrics - Inspection of "Updated Tech Tip Index and Create" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — dev5 ( c2dc0b...cbc2fc )

by Ron
created 2020-04-25 01:19 UTC
TechTipsController::storeUpdatedTip() B

↳ Parent: TechTipsController
Complexity

Conditions	7
Paths	28
Size

Total Lines	55
Code Lines	26
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	24
CRAP Score	7.0671
Importance

Changes
Metric	Value
cc	7
eloc	26
c	0
b	0
f	0
nc	28
nop	2
dl	0
loc	55
ccs	24
cts	27
cp	0.8889
crap	7.0671
rs	8.5706
How to fix Long Method

<?php

namespace App\Http\Controllers\TechTips;

use App\Domains\Equipment\GetEquipmentData;
use App\Domains\TechTips\GetTechTips;
use App\User;
use App\Files;
use App\TechTips;
use App\TechTipFavs;
use App\TechTipFiles;
use App\TechTipTypes;
use App\TechTipSystems;
use Illuminate\Http\File;
use App\SystemCategories;
use Illuminate\Http\Request;
use App\Notifications\NewTechTip;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Log;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use App\Http\Resources\TechTipsCollection;
use Illuminate\Support\Facades\Notification;
use App\Http\Resources\TechTipTypesCollection;
use App\Http\Resources\SystemCategoriesCollection;
use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
use App\Http\Resources\SystemCategoriesCollection as CategoriesCollection;


use App\Domains\TechTips\GetTechTipTypes;
use App\Domains\TechTips\SetTechTips;
use App\Http\Requests\TechTipNewTipRequest;
use App\Http\Requests\TechTipProcessImageRequest;
use App\Http\Requests\TechTipSearchRequest;

class TechTipsController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth');
    }

    //  Tech Tips landing page
    public function index()
    {
        return view('tips.index', [
            'tipTypes' => (new GetTechTipTypes)->execute(true),
            'sysTypes' => (new GetEquipmentData)->getAllEquipmentWithDataList(),
        ]);
    }

    //  Search for an existing tip - If no paramaters, return all tips
    public function search(TechTipSearchRequest $request)
    {
        return (new GetTechTips)->searchTips($request);
    }

    //  Process an image that is attached to a tech tip
    public function processImage(TechTipProcessImageRequest $request)
    {
        $this->authorize('hasAccess', 'Create Tech Tip');

        $imgLocation = (new SetTechTips)->processTipImage($request);
        return response()->json(['location' => $imgLocation]);

    }

    //  Create a new Tech Tip form
    public function create()
    {
        $this->authorize('hasAccess', 'Create Tech Tip');

        return view('tips.create', [
            'tipTypes' => (new GetTechTipTypes)->execute(true),
            'sysTypes' => (new GetEquipmentData)->getAllEquipmentWithDataList(),
        ]);
    }

    //  Submit the form to create a new tech tip
    public function store(TechTipNewTipRequest $request)
    {
        $this->authorize('hasAccess', 'Create Tech Tip');

        $tipData = (new SetTechTips)->processNewTip($request);
        return response()->json(['success' => $tipData]);
    }








    //  Details controller - will move to the show controller with just the tech tip id
    public function details($id, $subject)
    {
        if(session()->has('newTipFile')) {
            session()->forget('newTipFile');
        }

        return $this->show($id);
    }

    //  Show the details about the tech tip
    public function show($id)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by '.Auth::user()->full_name);

        $tipData = TechTips::where('tip_id', $id)->with('User')->with('SystemTypes')->first();

        if(!$tipData)
        {
            return view('tips.tipNotFound');
        }

        $isFav = TechTipFavs::where('user_id', Auth::user()->user_id)->where('tip_id', $id)->first();
        $files = TechTipFiles::where('tip_id', $id)->with('Files')->get();

        return view('tips.details', [
            'details' => $tipData,
            'isFav'   => empty($isFav) ? 'false' : 'true',
            'files'   => $files,
        ]);
    }

    //  Add or remove this tip as a favorite of the user
    public function toggleFav($action, $id)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by '.Auth::user()->full_name);

        switch($action) {
            case 'add':
                TechTipFavs::create([
                    'user_id' => Auth::user()->user_id,
                    'tip_id' => $id
                ]);
                break;
            case 'remove':
                $tipFav = TechTipFavs::where('user_id', Auth::user()->user_id)->where('tip_id', $id)->first();
                $tipFav->delete();
                break;
        }

        Log::debug('Tech Tip Bookmark Updated.', [
            'user_id' => Auth::user()->user_id,
            'tip_id' => $id,
            'action'  => $action
        ]);
        return response()->json(['success' => true]);
    }

    //  Edit an existing tech tip
    public function edit($id)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by '.Auth::user()->full_name);

        $this->authorize('hasAccess', 'Edit Tech Tip');
        $tipData = TechTips::where('tip_id', $id)->with('User')->with('SystemTypes')->with('TechTipTypes')->first();

        if(!$tipData) {
            return view('tips.tipNotFound');
        }

        $typesArr   = new TechTipTypesCollection(TechTipTypes::all());
        $systemsArr = new SystemCategoriesCollection(SystemCategories::with('SystemTypes')->get());
        $files = TechTipFiles::where('tip_id', $id)->with('Files')->get();

        return view('tips.editTip', [
            'tipTypes' => $typesArr,
            'sysTypes' => $systemsArr,
            'details' => $tipData,
            'files'   => $files,
        ]);
    }

    //  Store the edited Tech Tip
    public function update(Request $request, $id)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by '.Auth::user()->full_name.'. Submitted Data - ', $request->toArray());

        $this->authorize('hasAccess', 'Edit Tech Tip');

        $request->validate([
            'subject'   => 'required',
            'equipment' => 'required',
            'tipType'   => 'required',
            'tip'       => 'required',
        ]);

        $receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));

        //  Verify if there is a file to be processed or not
        if($receiver->isUploaded() === false || $request->_completed) {
            $this->storeUpdatedTip($request, $id);
            Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
            return response()->json(['tip_id' => $id]);
        }

        //  Recieve and process the file
        $save = $receiver->receive();

        //  See if the uploade has finished
        if($save->isFinished()) {
            $this->saveFile($save->getFile(), $id);
                   saveFile($save->getFile(), $id);

            return 'uploaded successfully';
        }

        //  Get the current progress
        $handler = $save->handler();

        Log::debug('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
        return response()->json([
            'done'   => $handler->getPercentageDone(),
            'status' => true
        ]);
    }

    //  Store the updated tip
    public function storeUpdatedTip($tipData, $id)
    {
        $this->authorize('hasAccess', 'Edit Tech Tip');

        //  Remove any forward slash (/) from the Subject Field
        $tipData->merge(['subject' => str_replace('/', '-', $tipData->subject)]);

        //  Enter the tip details and return the tip ID
        TechTips::find($id)->update([
            'tip_type_id' => $tipData->tipType,
            'subject'     => $tipData->subject,
            'description' => $tipData->tip,
            // 'user_id'     => Auth::user()->user_id TODO - updated user who modified tip
        ]);

        //  Add any additional equipment types to the tip
        $tipEquip = TechTipSystems::where('tip_id', $id)->get();
        foreach($tipData->equipment as $equip)
        {
            $found = false;
            foreach($tipEquip as $key => $value)
            {
                if($equip['sys_id'] == $value->sys_id)
                {
                    $tipEquip->forget($key);
                    $found = true;
                    break;
                }
            }
            if(!$found)
            {
                TechTipSystems::create([
                    'tip_id' => $id,
                    'sys_id' => $equip['sys_id'],
                ]);
            }
        }

        //  Remove the remainaing equipment types that have been removed
        foreach($tipEquip as $remaining)
        {
            TechTipSystems::find($remaining->tip_tag_id)->delete();
        }

        //  Remove any files that no longer apply
        foreach($tipData->deletedFileList as $file)
        {
            $file = TechTipFiles::find($file);
            $fileID = $file->file_id;
            $file->delete();
            //  Try to delete the file itself
            Files::deleteFile($fileID);
        }

        return true;
    }

    //  Soft delet the Tech Tip
    public function destroy($id)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by '.Auth::user()->full_name);

        $this->authorize('hasAccess', 'Delete Tech Tip');

        //  Remove the Tip from any users favorites
        TechTipFavs::where('tip_id', $id)->delete();

        //  Disable the tip
        TechTips::find($id)->delete();
        Log::warning('User - '.Auth::user()->user_id.' deleted Tech Tip ID - '.$id);
        return response()->json(['success' => true]);
    }
}

butcherman / Tech_Bench

Push — dev5 ( c2dc0b...cbc2fc )

TechTipsController::storeUpdatedTip() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
