AbstractManager::withoutPagination() - Code Metrics - Inspection of "Add: sorting index for larger sets" - thinktomorrow/chief - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed
Push — master ( e22c69...3f50b7 )

by Ben
created 2021-01-11 10:04 UTC
AbstractManager::withoutPagination() A

↳ Parent: AbstractManager
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
eloc	2
c	0
b	0
f	0
dl	0
loc	5
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1
<?php

declare(strict_types=1);

namespace Thinktomorrow\Chief\Management;

use Illuminate\Support\Facades\Schema;
use Illuminate\Contracts\Pagination\Paginator;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Thinktomorrow\Chief\Fields\Types\NumberField;
use Thinktomorrow\Chief\Concerns\Translatable\TranslatableCommand;
use Thinktomorrow\Chief\Fields\FieldReference;
use Thinktomorrow\Chief\Fields\Fields;
use Thinktomorrow\Chief\Fields\SavingFields;
use Thinktomorrow\Chief\Fields\Types\Field;
use Thinktomorrow\Chief\Filters\Filters;
use Thinktomorrow\Chief\Fragments\ManagesFragments;
use Thinktomorrow\Chief\Management\Assistants\ManagesAssistants;
use Thinktomorrow\Chief\Management\Details\HasDetails;
use Thinktomorrow\Chief\Management\Details\HasDetailSections;
use Thinktomorrow\Chief\Management\Exceptions\NonExistingRecord;
use Thinktomorrow\Chief\Management\Exceptions\NotAllowedManagerRoute;
use Thinktomorrow\Chief\Relations\ActsAsChild;
use Thinktomorrow\Chief\Relations\ActsAsParent;

abstract class AbstractManager
{
    use SavingFields;
    use HasDetails;

    use HasDetailSections;
    use ManagesMedia;
    use ManagesPagebuilder;

    use TranslatableCommand;
    use ManagesAssistants;
    use ManagesFragments;

    protected $translation_columns = [];

    protected $model;

    /** @var Register */
    protected $registration;

    protected $pageCount = 20;
    protected $paginated = true;
    protected static $bootedTraitMethods = [];

    final public function __construct(Registration $registration)
    {
        $this->registration = $registration;


        // Upon instantiation, a general model is set that doesn't point to a persisted record.
        $this->manage(app($this->registration->model()));

        // Check if key and model are present since the model should be set by the manager itself
        $this->validateConstraints();

        static::bootTraitMethods();
    }

    public function managerKey(): string
    {
        return $this->registration->key();
        return $this->registration->/** @scrutinizer ignore-call */ key();
    }

    public function manage($model): Manager
    {
        $this->model = $model;

        return $this;

    }

    public function isManualSortable(): bool
    {
        return (isset($this->useManualSorting) && $this->useManualSorting && method_exists($this->modelInstance(), 'scopeSortedManually'));
    }

    public function saveCreateFields(Request $request): void
    {
        if($this->isManualSortable() && !$request->has('order')) {
            $this->model->order = $this->modelInstance()::orderBy('order', 'desc')->first()->order + 1;
            $this->model->order = $this->modelInstance()::/** @scrutinizer ignore-call */ orderBy('order', 'desc')->first()->order + 1;
        }

        $this->saveFields($request, $this->createFields());
    }

    public function findManaged($id): Manager
    {
        $modelInstance = $this->modelInstance()::where('id', $id)->withoutGlobalScopes()->first();
        $modelInstance = $this->modelInstance()::/** @scrutinizer ignore-call */ where('id', $id)->withoutGlobalScopes()->first();

        return (new static($this->registration))->manage($modelInstance);
        return (new static(/** @scrutinizer ignore-type */ $this->registration))->manage($modelInstance);
    }

    public function indexCollection()
    {
        $builder = ($this->modelInstance())->query();
        $builder = ($this->modelInstance())->/** @scrutinizer ignore-call */ query();

        $this->filters()->apply($builder);

        $builder = $this->indexBuilder($builder);

        $builder = $this->indexSorting($builder);

        if ($this->paginated) {
            return $this->indexPagination($builder);
        }

        return $builder->get()->map(function ($model) {
            return (new static($this->registration))->manage($model);
            return (new static(/** @scrutinizer ignore-type */ $this->registration))->manage($model);
        });
    }

    public function withoutPagination(): Manager
    {
        $this->paginated = false;

        return $this;

    }

    protected function indexBuilder(Builder $builder): Builder
    {
        return $builder;
    }

    protected function indexSorting(Builder $builder): Builder
    {
        if($this->isManualSortable()) {
            $builder->sortedManually();
        }

        if ($this->isAssistedBy('publish') && Schema::hasColumn($this->modelInstance()->getTable(), 'published_at')) {
        if ($this->isAssistedBy('publish') && Schema::hasColumn($this->modelInstance()->/** @scrutinizer ignore-call */ getTable(), 'published_at')) {
            $builder->orderBy('published_at', 'DESC');
        }

        // if model has no timestamps, updated_at doesn't exist
        if ($this->modelInstance()->timestamps) {

            $builder->orderBy('updated_at', 'DESC');
        }

        return $builder;
    }

    protected function indexPagination($builder): Paginator
    {
        $paginator = $builder->paginate($this->pageCount);

        $modifiedCollection = $builder->paginate($this->pageCount)->getCollection()->transform(function ($model) {
            return (new static($this->registration))->manage($model);
            return (new static(/** @scrutinizer ignore-type */ $this->registration))->manage($model);
        });

        return $paginator->setCollection($modifiedCollection);
    }

    public function indexView(): string
    {
        return 'chief::back.managers._partials._rowitems';
    }

    public function indexViewData(): array
    {
        return [];
    }

    public function modelInstance(): ManagedModel
    {
        $class = $this->registration->model();
        $class = $this->registration->model();

        return new $class();
    }

    public function existingModel(): ManagedModel
    {
        if (!$this->hasExistingModel()) {
            throw new NonExistingRecord('Model does not exist yet but is expected.');
        }

        return $this->model;

    }

    public function hasExistingModel(): bool
    {
        return ($this->model && $this->model->exists);
    }

    /**
     * Determine which actions should be available for this
     * manager and their respective routed urls.
     *
     * @param $verb
     * @return null|string
     * @throws NonExistingRecord
     */
    public function route($verb): ?string
    {
        $routes = [
            'index'      => route('chief.back.managers.index', [$this->registration->key()]),
            'create'     => route('chief.back.managers.create', [$this->registration->key()]),
            'store'      => route('chief.back.managers.store', [$this->registration->key()]),
            'sort-index' => route('chief.back.managers.sort-index', [$this->registration->key()]),
        ];

        if (array_key_exists($verb, $routes)) {
            return $routes[$verb] ?? null;
        }

        //These routes expect the model to be persisted in the database
        $modelRoutes = [
            'edit'   => route('chief.back.managers.edit', [$this->registration->key(), $this->existingModel()->id]),

            'update' => route('chief.back.managers.update', [$this->registration->key(), $this->existingModel()->id]),
            'delete' => route('chief.back.managers.delete', [$this->registration->key(), $this->existingModel()->id]),
            'upload' => route('chief.back.managers.media.upload', [
                $this->registration->key(),
                $this->existingModel()->id,
            ]),
        ];

        return $modelRoutes[$verb] ?? null;
    }

    public function can($verb): bool
    {
        foreach (static::$bootedTraitMethods['can'] as $method) {
            if (!method_exists($this, $method)) {
                continue;
            }
            $this->$method($verb);
        }

        return !is_null($this->route($verb));
    }

    public function guard($verb): Manager
    {
        if (!$this->can($verb)) {
            NotAllowedManagerRoute::notAllowedVerb($verb, $this);
        }

        return $this;

    }

    public function fields(): Fields
    {
        return new Fields();
    }

    /**
     * Enrich the manager fields with any of the assistant specified fields
     *
     * @return Fields
     * @throws \Exception
     */
    public function fieldsWithAssistantFields(): Fields
    {
        $fields = $this->fields();

        foreach ($this->assistantsAsClassNames() as $assistantClass) {
            if (!method_exists($assistantClass, 'fields')) {
                continue;
            }

            $fields = $fields->merge($this->assistant($assistantClass)->fields());
            $fields = $fields->merge($this->assistant($assistantClass)->/** @scrutinizer ignore-call */ fields());
        }

        return $fields;
    }

    public function createFields(): Fields
    {
        $fields = $this->fieldsWithAssistantFields();

        if($this->isManualSortable() && !$fields->offsetExists('order')) {
            $fields = $fields->add(NumberField::make('order'));
        }

        return $fields;
    }

    public function editFields(): Fields
    {
        return $this->fieldsWithAssistantFields()->map(function (Field $field) {
            return $field->model($this->model);
            return $field->/** @scrutinizer ignore-call */ model($this->model);
        });
    }

    public function createView(): string
    {
        return 'chief::back.managers._partials._form';
    }

    public function createViewData(): array
    {
        return [];
    }

    public function editView(): string
    {
        return 'chief::back.managers._partials._form';
    }

    public function editViewData(): array
    {
        return [];
    }

    public function delete()
    {
        $this->guard('delete');

        if ($this->model instanceof ActsAsChild) {
            $this->model->detachAllParentRelations();
        }

        if ($this->model instanceof ActsAsParent) {
            $this->model->detachAllChildRelations();
        }

        $this->model->delete();
                      delete();
    }

    public static function filters(): Filters
    {
        return new Filters();
    }

    /**
     * This method can be used to manipulate the store request payload
     * before being passed to the storing / updating the models.
     *
     * @param Request $request
     * @return Request
     */
    public function storeRequest(Request $request): Request
    {
        return $request;
    }

    /**
     * This method can be used to manipulate the update request payload
     * before being passed to the storing / updating the models.
     *
     * @param Request $request
     * @return Request
     */
    public function updateRequest(Request $request): Request
    {
        return $request;
    }

    protected function requestContainsTranslations(Request $request): bool
    {
        return $request->has('trans');
    }

    protected function validateConstraints()
    {
        if (!$this->model) {
            throw new \DomainException('Model class should be set for this manager. Please set the model property default via the constructor or by extending the setupDefaults method.');
        }
    }

    public static function bootTraitMethods()
    {
        $class = static::class;

        $methods = [
            'can',
        ];

        foreach ($methods as $baseMethod) {
            static::$bootedTraitMethods[$baseMethod] = [];

            foreach (class_uses_recursive($class) as $trait) {
                $method = class_basename($trait) . ucfirst($baseMethod);

                if (method_exists($class, $method) && !in_array($method, static::$bootedTraitMethods[$baseMethod])) {
                    static::$bootedTraitMethods[$baseMethod][] = lcfirst($method);
                }
            }
        }
    }
}

thinktomorrow / chief

Push — master ( e22c69...3f50b7 )

AbstractManager::withoutPagination() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
