IsAranguentModel::newEloquentBuilder() - Code Metrics - Inspection of "id/_key conversion" - LaravelFreelancerNL/laravel-arangodb - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — experiment/id-key-conversion ( cbc737...bb5ee1 )

by Bas

created 2021-11-30 11:32 UTC

IsAranguentModel::newEloquentBuilder() A

↳ Parent: IsAranguentModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php

namespace LaravelFreelancerNL\Aranguent\Eloquent\Concerns;

use Closure;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Str;
use LaravelFreelancerNL\Aranguent\Eloquent\Builder;
use LaravelFreelancerNL\Aranguent\Query\Builder as QueryBuilder;
use LaravelFreelancerNL\FluentAQL\QueryBuilder as ArangoQueryBuilder;

trait IsAranguentModel
{
    use HasAranguentRelationships;

    /**
     * Insert the given attributes and set the ID on the model.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  array  $attributes
     * @return void
     */
    protected function insertAndSetId(\Illuminate\Database\Eloquent\Builder $query, $attributes)
    {
        $id = $query->insertGetId($attributes, $keyName = $this->getKeyName());
        $id = $query->insertGetId($attributes, $keyName = $this->/** @scrutinizer ignore-call */ getKeyName());

        $this->setAttribute($keyName, $id);
               setAttribute($keyName, $id);
        if ($keyName === '_id') {
            $matches = [];
            preg_match('/\/(.*)$/', $id, $matches);
            preg_match('/\/(.*)$/', /** @scrutinizer ignore-type */ $id, $matches);

            $this->setAttribute('_key', $matches[1]);
        }
    }

    /**
     * @override
     * Create a new Eloquent query builder for the model.
     *
     * @param QueryBuilder $query
     *
     * @return Builder
     */
    public function newEloquentBuilder($query)
    {
        return new Builder($query);
    }

    /**
     * Get a new query builder instance for the connection.
     *
     * @return \Illuminate\Database\Query\Builder
     */
    protected function newBaseQueryBuilder()
    {
        return $this->getConnection()->query();
        return $this->/** @scrutinizer ignore-call */ getConnection()->query();
    }

    /**
     * Dynamically set attributes on the model.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return void
     */
    public function __set($key, $value)
    {
        // Laravel's mutators don't differentiate between id and _id, so we catch ArangoDB's _id here.
        if ($key === 'id') {
            $this->attributes['_id'] = $this->getTable() . '/' . $value;
            $this->attributes['_id'] = $this->/** @scrutinizer ignore-call */ getTable() . '/' . $value;
        }

        if ($key === '_id') {
            $this->attributes['id'] = explode('/', $value)[1];
        }

        $this->setAttribute($key, $value);
    }

    /**
     * Map the id attribute commonly used in Laravel to the primary key for third-party compatibility.
     * In ArangoDB '_key' is the equivalent of 'id' in sql databases.
     *
     * @param  string  $value
     * @return void
     */
    public function setKeyAttribute($value)
    {
        $this->attributes['_key'] = $value;


        $this->updateIdWithKey($value);
    }

    /**
     * @param  string  $key
     */
    protected function updateIdWithKey(string $key)
    {
        if (! isset($this->attributes['_id'])) {
            return;
        }

        $id = preg_replace("/[a-zA-Z0-9_-]+\/\K.+/i", $key, $this->attributes['_id']);
        $this->attributes['_id'] = $id;

    }

    /**
     * Qualify the given column name by the model's table.
     *
     * @param string $column
     *
     * @return string
     */
    public function qualifyColumn($column)
    {
        $tableReferer = Str::singular($this->getTable()) . 'Doc';

        if (Str::startsWith($column, $tableReferer . '.')) {
            return $column;
        }

        return $tableReferer . '.' . $column;
    }

    /**
     * Get the default foreign key name for the model.
     *
     * @return string
     */
    public function getForeignKey()
    {
        $keyName = $this->getKeyName();

        if ($keyName[0] != '_') {
            $keyName = '_' . $keyName;
        }

        return Str::snake(class_basename($this)) . $keyName;
    }

    protected function fromAqb(ArangoQueryBuilder|Closure $aqb): Collection
    {
        if ($aqb instanceof Closure) {
            /** @phpstan-ignore-next-line */
            $aqb = $aqb(DB::aqb());
        }
        $connection = $this->getConnection();
        $results = $connection->execute($aqb->get());
        return $this->hydrate($results);
        return $this->/** @scrutinizer ignore-call */ hydrate($results);
    }
}


LaravelFreelancerNL / laravel-arangodb

Push — experiment/id-key-conversion ( cbc737...bb5ee1 )

IsAranguentModel::newEloquentBuilder() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like