ImportCrudController - Code Metrics - Inspection of "1b8e354d4c0dad913f1b592a148a59ad0348eb9c" - jonphipps/Metadata-Registry - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — beta (1b8e35)

by Jon
created 2018-01-22 22:04 UTC
ImportCrudController A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	333
Duplicated Lines	0 %
Importance

Changes
Metric	Value
wmc	27
dl	0
loc	333
rs	10
c	0
b	0
f	0
9 Methods

Rating	Name	Size	Complexity
B	setup()	41	1
A	setWizardData()	5	1
A	update()	7	1
A	createBatch()	12	2
D	importProject()	59	13
A	store()	7	1
A	__construct()	6	1
B	processImportProject()	33	3
B	getWizardStep()	35	4
<?php

namespace App\Http\Controllers\Frontend;

// VALIDATION: change the requests to match your own file names if you need form validation
use App\Http\Requests\Frontend\ImportRequest;
use App\Http\Requests\Frontend\ImportRequest as StoreRequest;
use App\Http\Requests\Frontend\ImportRequest as UpdateRequest;
use App\Http\Traits\UsesEnums;
use App\Http\Traits\UsesPolicies;
use App\Models\Batch;
use App\Models\Import;
use App\Models\Project;
use App\Wizard\Import\ProjectSteps\ApproveImportStep;
use App\Wizard\Import\ProjectSteps\DisplayResultsStep;
use App\Wizard\Import\ProjectSteps\SelectWorksheetsStep;
use App\Wizard\Import\ProjectSteps\SetSpreadsheetStep;
use Backpack\CRUD\app\Http\Controllers\CrudController;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Smajti1\Laravel\Exceptions\StepNotFoundException;
use Smajti1\Laravel\Wizard;
use const null;
use function method_exists;

class ImportCrudController extends CrudController
{
    use UsesPolicies, UsesEnums;
    /**
     * @var array
     */
    public $steps = [
        'spreadsheet' => SetSpreadsheetStep::class,
        'worksheets'  => SelectWorksheetsStep::class,
        'approve'     => ApproveImportStep::class,
        'report'      => DisplayResultsStep::class,
    ];
    /**
     * @var Wizard
     */
    protected $wizard;

    /**
     * ImportCrudController constructor.
     *
     * @throws \Smajti1\Laravel\Exceptions\StepNotFoundException
     */
    public function __construct()
    {
        parent::__construct();
        $this->wizard = new Wizard($this->steps, $sessionKeyName = 'project-import');

        view()->share(['wizard' => $this->wizard]);
    }

    /**
     * @throws \Exception
     */
    public function setup()
    {
        /*
        |--------------------------------------------------------------------------
        | BASIC CRUD INFORMATION
        |--------------------------------------------------------------------------
        */
        $this->crud->setModel(Import::class);
        $this->crud->setRoute(config('backpack.base.route_prefix') . '/projects/' . request()->project . '/imports');
        $this->crud->setEntityNameStrings('Import', 'Imports');
        $this->addCustomDoctrineColumnTypes();
        //$this->crud->setFromDb();


        // ------ CRUD FIELDS

        // $this->crud->addFields();

        // $this->crud->addFields($array_of_arrays, 'update/create/both');

        // $this->crud->removeField('name', 'update/create/both');

        // $this->crud->removeFields($array_of_names, 'update/create/both');


        // ------ CRUD COLUMNS
        // $this->crud->addColumn(); // add a single column, at the end of the stack

        // $this->crud->addColumns(); // add multiple columns, at the end of the stack

        // $this->crud->removeColumn('column_name'); // remove a column from the stack

        // $this->crud->removeColumns(['column_name_1', 'column_name_2']); // remove an array of columns from the stack

        // $this->crud->setColumnDetails('column_name', ['attribute' => 'value']); // adjusts the properties of the passed in column (by name)

        // $this->crud->setColumnsDetails(['column_1', 'column_2'], ['attribute' => 'value']);


        // ------ CRUD BUTTONS
        // possible positions: 'beginning' and 'end'; defaults to 'beginning' for the 'line' stack, 'end' for the others;
        // $this->crud->addButton($stack, $name, $type, $content, $position); // add a button; possible types are: view, model_function

        // $this->crud->addButtonFromModelFunction($stack, $name, $model_function_name, $position); // add a button whose HTML is returned by a method in the CRUD model

        // $this->crud->addButtonFromView($stack, $name, $view, $position); // add a button whose HTML is in a view placed at resources\views\vendor\backpack\crud\buttons

        // $this->crud->removeButton($name);

        // $this->crud->removeButtonFromStack($name, $stack);

        // $this->crud->removeAllButtons();

        // $this->crud->removeAllButtonsFromStack('line');


        // ------ CRUD ACCESS
        $this->crud->allowAccess(['list', 'show']);
        $this->crud->denyAccess(['create', 'update', 'delete', 'importProject']);

        // ------ CRUD REORDER
        // $this->crud->enableReorder('label_name', MAX_TREE_LEVEL);

        // NOTE: you also need to do allow access to the right users: $this->crud->allowAccess('reorder');

        // ------ CRUD DETAILS ROW
        // $this->crud->enableDetailsRow();

        // NOTE: you also need to do allow access to the right users: $this->crud->allowAccess('details_row');
        // NOTE: you also need to do overwrite the showDetailsRow($id) method in your EntityCrudController to show whatever you'd like in the details row OR overwrite the views/backpack/crud/details_row.blade.php

        // ------ REVISIONS
        // You also need to use \Venturecraft\Revisionable\RevisionableTrait;
        // Please check out: https://laravel-backpack.readme.io/docs/crud#revisions
        // $this->crud->allowAccess('revisions');


        // ------ AJAX TABLE VIEW
        // Please note the drawbacks of this though:
        // - 1-n and n-n columns are not searchable
        // - date and datetime columns won't be sortable anymore
        // $this->crud->enableAjaxTable();


        // ------ DATATABLE EXPORT BUTTONS
        // Show export to PDF, CSV, XLS and Print buttons on the table view.
        // Does not work well with AJAX datatables.
        // $this->crud->enableExportButtons();


        // ------ ADVANCED QUERIES
        // $this->crud->addClause('active');

        // $this->crud->addClause('type', 'car');

        // $this->crud->addClause('where', 'name', '==', 'car');

        // $this->crud->addClause('whereName', 'car');

        // $this->crud->addClause('whereHas', 'posts', function($query) {

        //     $query->activePosts();

        // });
        // $this->crud->addClause('withoutGlobalScopes');

        // $this->crud->addClause('withoutGlobalScope', VisibleScope::class);

        // $this->crud->with(); // eager load relationships

        // $this->crud->orderBy();

        // $this->crud->groupBy();

        // $this->crud->limit();

    }

    /**
     * @param UpdateRequest $request
     * @param Project       $project
     *
     * @return RedirectResponse
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    public function createBatch(ImportRequest $request, Project $project)
    {
        $this->policyAuthorize('import', $project, $project->id);
        /* @var Batch $batch */
        if ($this->wizard->dataHas('batch_id')) {
            $batch = Batch::findOrFail($this->wizard->dataGet('batch_id'));
        } else {
            $batch = Batch::make(['project_id' => $project->id]);
            $this->setWizardData('batch_id', $batch->id);
        }

        return $this->processImportProject($request, $project, $batch, $this->wizard->first()->key);
    }

    /**
     * @param Request $request
     * @param Project $project
     * @param Batch   $batch
     * @param null    $step
filter:
    dependency_paths: ["lib/*"]
     *
     * @return \Backpack\CRUD\app\Http\Controllers\Response
filter:
    dependency_paths: ["lib/*"]
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    public function importProject(Request $request, Project $project, Batch $batch, $step = null)
    {
        $this->policyAuthorize('import', $project, $project->id);
        //if we get to here we're authorized to import a project, so we authorize create
        $this->crud->allowAccess(['create', 'edit']);
        try {
            if (null === $step) {
                if (null === $batch->id) {

                    $step = $this->wizard->first();
                    $this->wizard->data([]);
                } else {
                    $step = $this->wizard->firstOrLastProcessed();
                }
            } else {
                $step = $this->wizard->getBySlug($step);
            }
        } catch (StepNotFoundException $e) {
            abort(404);
        }
        //we've jumped into a middle step of the sequence (we should always have worksheets after step 1)
        if ($step->number > 1 && ! $batch->dataHas('googlesheets')) {
            $step = $this->wizard->first();
        }
        if ($this->wizard->data() != $batch->step_data) {
            //we've returned from an incomplete import
            //and have to load the previous step data into the wizard from the database
            $this->wizard->data($batch->step_data);
        }

        $this->setWizardData('batch_id', $batch->id);
        $this->setWizardData('project_id', $project->id);

        if (method_exists($step, 'preProcess')) {
            $step->preProcess($request, $this->wizard);
        }

        $this->crud->setCreateView('frontend.import.project.wizard');
        $this->crud->setRoute(config('backpack.base.route_prefix') . 'projects/' . $project->id);
        $this->crud->addFields($step->fields(), 'create');
        $this->data['step']        = $step;
        $this->data['project']     = $project;
        $this->data['batch']       = $batch;
        $this->data['wizard_data'] = $this->wizard->data();
        if (isset($this->wizard->data()[$step->key])) {
            $data = $this->wizard->data()[$step->key];
            if ($step->key === 'spreadsheet') {
                foreach ($data as $key => $datum) {
                    $this->crud->create_fields[$key]['value'] = $datum;
                }
            }
            if ($step->key === 'worksheets') {
                $this->crud->create_fields['worksheets']['value'] = $data;
            }
            if ($step->key === 'approve') {
                $this->crud->create_fields['approve']['value'] = $data;
            }
        }

        return parent::create();
    }

    /**
     * @param UpdateRequest $request
     * @param Project       $project
     * @param Batch         $batch
     * @param null          $step
     *
     * @return RedirectResponse
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    public function processImportProject(ImportRequest $request, Project $project, Batch $batch, $step = null): RedirectResponse
    {
        $this->policyAuthorize('import', $project, $project->id);
        //if we get to here we're authorized to import a project, so we authorize create
        $this->crud->allowAccess(['create']);
        try {
            $step = $this->wizard->getBySlug($step);
        } catch (StepNotFoundException $e) {
            abort(404);
        }

        //here we validate the input from the step

        if (method_exists($step, 'validate')) {
            $step->validate($request);
        } else {
            $this->validate($request, $step->rules($request));
        }

        //$request->flash();


        //handle the next/last step
        $step->process($request);

        $batch->step_data       = $this->wizard->data();
        $batch->next_step       = $this->wizard->nextSlug();
        $batch->run_description = $batch->run_description ?? $this->wizard->dataGet('title');
        $batch->save();

        //and redirect to the next step if valid
        //$request->session()->save();

        return redirect()->route('frontend.project.import',
            ['project' => $project->id, 'batch' => $batch, 'step' => $this->wizard->nextSlug()]);
    }

    /**
     * @param UpdateRequest $request
     *
     * @return RedirectResponse
     */
    public function store(StoreRequest $request)
    public function store(/** @scrutinizer ignore-unused */ StoreRequest $request)
    {
        // your additional operations before save here
        $redirect_location = parent::storeCrud();
        // your additional operations after save here
        // use $this->data['entry'] or $this->crud->entry

        return $redirect_location;
    }

    /**
     * @param UpdateRequest $request
     *
     * @return RedirectResponse
     */
    public function update(UpdateRequest $request)
    public function update(/** @scrutinizer ignore-unused */ UpdateRequest $request)
    {
        // your additional operations before save here
        $redirect_location = parent::updateCrud();
        // your additional operations after save here
        // use $this->data['entry'] or $this->crud->entry

        return $redirect_location;
    }

    /**
     * @param $step
     *
     * @return array
     */
    private static function getWizardStep($step): array

    {
        $steps = [
            [
                'name'         => 'spreadsheet',
                'step'         => 1,
                'title'        => 'Start with a Spreadsheet URL...',
                'instructions' => 'Some instructions',
            ],
            [
                'name'         => 'worksheets',
                'step'         => 2,
                'title'        => 'Choose the Worksheets...',
                'instructions' => 'Some instructions',
            ],
            [
                'name'         => 'approve',
                'step'         => 3,
                'title'        => 'Approve the changes..',
                'instructions' => 'Some instructions',
            ],
            [
                'name'         => 'import',
                'step'         => 4,
                'title'        => 'Start with a Spreadsheet URL',
                'instructions' => 'Some instructions',
            ],
        ];
        $key   = $step !== null ? array_search($step, array_column($steps, 'name')) : 0;
        if ($key === false) {
            abort(404, 'Invalid Step');
        }
        $steps[$key]['next'] = ($key < count($steps)) ? $steps[$key + 1]['name'] : false;

        return $steps[$key];
    }

    /**
     * @param string $key
     * @param mixed  $value
     */
    private function setWizardData($key, $value): void
    {
        $data         = $this->wizard->data();
        $data[$key]   = $value;
        $this->wizard->data($data);
    }
}

jonphipps / Metadata-Registry

Branch — beta (1b8e35)

ImportCrudController A

Complexity

Size/Duplication

Importance

9 Methods

Duplication Side-by-Side

Filter issues like
