Builder::addColumns() - Code Metrics - Inspection of "WIP" - LaravelFreelancerNL/laravel-arangodb - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Push — refactor/improve-static-analys... ( a7b39f...bdf823 )

by Bas
created 2022-05-12 14:52 UTC
Builder::addColumns() A

↳ Parent: Builder
Complexity

Conditions	6
Paths	5
Size

Total Lines	20
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	7
CRAP Score	6
Importance

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

namespace LaravelFreelancerNL\Aranguent\Query;

use Closure;
use Illuminate\Database\Query\Builder as IlluminateQueryBuilder;
use Illuminate\Database\Query\Expression;
use Illuminate\Support\Arr;
use InvalidArgumentException;
use LaravelFreelancerNL\Aranguent\Connection;
use LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsJoinClauses;
use LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsSubqueries;
use LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsWhereClauses;
use LaravelFreelancerNL\FluentAQL\Exceptions\BindException;
use LaravelFreelancerNL\FluentAQL\Expressions\ExpressionInterface as ExpressionInterface;
use LaravelFreelancerNL\FluentAQL\Expressions\FunctionExpression;
use LaravelFreelancerNL\FluentAQL\QueryBuilder;

class Builder extends IlluminateQueryBuilder
{
    use BuildsJoinClauses;
    use BuildsSubqueries;
    use BuildsWhereClauses;

    /**
     * @var QueryBuilder|FunctionExpression
     */
    public QueryBuilder|FunctionExpression $aqb;

    /**
     * @var Connection
     */
    public $connection;

    /**
     * @var Grammar
     */
    public $grammar;

    /**
     * The current query value bindings.
     *
     * @var null|array{predicates: array<mixed>, options: array<string, string>}
     */
    public ?array $search = null;

    /**
     * The query variables that should be set.
     *
     * @var array<mixed>
     */
    public $variables = [];

    /**
     * ID of the query
     * Used as prefix for automatically generated bindings.
     *
     * @var int
     */
    protected $queryId = 1;

    /**
     * @override
     * Create a new query builder instance.
     */
    public function __construct(
        Connection $connection,
        Grammar $grammar = null,
        Processor $processor = null,
        QueryBuilder $aqb = null
    ) {
        $this->connection = $connection;
        $this->grammar = $grammar ?: $connection->getQueryGrammar();
        $this->processor = $processor ?: $connection->getPostProcessor();
        if (!$aqb instanceof QueryBuilder) {
            $aqb = new QueryBuilder();
        }
        $this->aqb = $aqb;

        $this->queryId = spl_object_id($this);
    }

    protected function bindValue($value, string $type = 'where')
    {
        if (! $value instanceof Expression) {
            $this->addBinding($this->flattenValue($value), 'where');
            $value = $this->replaceValueWithBindVariable($type);
        }
        return $value;
    }

    protected function generateBindVariable(string $type = 'where'): string
    {
        return $this->queryId . '_' . $type . '_' . (count($this->bindings[$type]) + 1);
    }

    /**
     * Add a binding to the query.
     *
     * @param  mixed  $value
     * @param  string  $type
     * @return IlluminateQueryBuilder
     *
     * @throws \InvalidArgumentException
     */
    public function addBinding($value, $type = 'where')
    {
        if (! array_key_exists($type, $this->bindings)) {
            throw new InvalidArgumentException("Invalid binding type: {$type}.");
        }

        $bindVariable = $this->generateBindVariable($type);

        if (is_array($value)) {
            $this->bindings[$type] = array_map(
                [$this, 'castBinding'],
                array_merge($this->bindings[$type], $value),
            );
        } else {
            $this->bindings[$type][$bindVariable] = $this->castBinding($value);
        }

        return $this;
    }

    protected function getLastBindVariable(string $type = 'where')
    {
        return array_key_last($this->bindings[$type]);
    }

    protected function replaceValueWithBindVariable(string $type = 'where')
    {
        return '@' . $this->getLastBindVariable($type);
    }

    public function getQueryId()
    {
        return $this->queryId;
    }

    /**
     * Get the current query value bindings in a flattened array.
     *
     * @return array
     */
    public function getBindings()
    {
        $extractedBindings = [];
        foreach ($this->bindings as $typeBinds) {
            foreach ($typeBinds as $key => $value) {
                $extractedBindings[$key] = $value;
            }
        }
        return $extractedBindings;
    }

    /**
     * Delete a record from the database.
     *
     * @param mixed $id
     *
     * @return int
     */
    public function delete($id = null)
    {
        $this->aqb = new QueryBuilder();
        $this->grammar->compileDelete($this, $id)->setAql();
        return $this->connection->delete($this->aqb);
    }

    /**
     * Set the table which the query is targeting.
     *
     * @param  \Closure|IlluminateQueryBuilder|string  $table
     * @param  string|null  $as
     * @return IlluminateQueryBuilder
     */
    public function from($table, $as = null)
    {
        if ($this->isQueryable($table)) {
            return $this->fromSub($table, $as);
        }
        $this->grammar->registerTableAlias($table, $as);
        $this->grammar->registerTableAlias(/** @scrutinizer ignore-type */ $table, $as);

        $this->from = $table;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

    /**
     * Run a pagination count query.
     *
     * @param array<mixed> $columns
     *
     * @return array<mixed>
     */
    protected function runPaginationCountQuery($columns = ['*'])
    {
        $without = $this->unions ? ['orders', 'limit', 'offset'] : ['columns', 'orders', 'limit', 'offset'];

        $closeResults = $this->cloneWithout($without)
            ->cloneWithoutBindings($this->unions ? ['order'] : ['select', 'order'])
            ->setAggregate('count', $this->withoutSelectAliases($columns))
            ->get()->all();

        return $closeResults;
    }

    /**
     * Set the columns to be selected.
     *
     * @param  array<mixed>|mixed  $columns
     */
    public function select($columns = ['*']): IlluminateQueryBuilder
    {
        $this->columns = [];
        $this->bindings['select'] = [];

        $columns = is_array($columns) ? $columns : func_get_args();
        foreach ($columns as $as => $column) {
            if (is_string($as) && $this->isQueryable($column)) {
                $this->selectSub($column, $as);
            } else {
                $this->addColumns($columns);
            }
        }

        return $this;
    }

    /**
     * Add a new select column to the query.
     *
     * @param  array|mixed  $column
     * @return $this
     */
    public function addSelect($column)
    {
        $columns = is_array($column) ? $column : func_get_args();

        $this->addColumns($columns);

        return $this;
    }

    /**
     * @param array<mixed> $columns
     */
    protected function addColumns(array $columns): void
    {
        foreach ($columns as $as => $column) {
            if (is_string($as) && $this->isQueryable($column)) {
                if (is_null($this->columns)) {
                    $this->select($this->from . '.*');
                }

                $this->selectSub($column, $as);

                continue;
            }

            if (is_string($as)) {
                $this->columns[$as] = $column;

                continue;
            }

            $this->columns[] = $column;
        }
    }

    /**
     * Insert a new record into the database.
     *
     * @param array<mixed> $values
     *
     * @throws BindException
     *
     * @return bool
     */
    public function insert(array $values): bool
    {
        $this->grammar->compileInsert($this, $values)->setAql();
        $results = $this->getConnection()->insert($this->aqb);
        $results = $this->getConnection()->insert(/** @scrutinizer ignore-type */ $this->aqb);
        $this->aqb = new QueryBuilder();
        return $results;
    }

    /**
     * Insert a new record and get the value of the primary key.
     *
     * @param array<mixed> $values
     */
    public function insertGetId(array $values, $sequence = null)
    {
        $this->grammar->compileInsertGetId($this, $values, $sequence)->setAql();
        $response = $this->getConnection()->execute($this->aqb);
        $response = $this->getConnection()->execute(/** @scrutinizer ignore-type */ $this->aqb);
        $this->aqb = new QueryBuilder();

        return (is_array($response)) ? end($response) : $response;
    }

    /**
     * Insert a new record into the database.
     *
     * @param array<mixed> $values
     *
     * @throws BindException
     *
     * @return bool
     */
    public function insertOrIgnore(array $values): bool
    {
        $this->grammar->compileInsertOrIgnore($this, $values)->setAql();
        $results = $this->getConnection()->insert($this->aqb);
        $results = $this->getConnection()->insert(/** @scrutinizer ignore-type */ $this->aqb);
        $this->aqb = new QueryBuilder();

        return $results;
    }

    protected function setAql()
    {
        $this->aqb = $this->aqb->get();
        $this->aqb = $this->aqb->get();

        return $this;
    }

    /**
     * Update a record in the database.
     *
     * @param array<mixed> $values
     *
     * @return int
     */
    public function update(array $values)
    {
        $this->aqb = new QueryBuilder();

        $this->grammar->compileUpdate($this, $values)->setAql();
        $results = $this->connection->update($this->aqb);
        $this->aqb = new QueryBuilder();
        return $results;
    }

    /**
     * Execute an aggregate function on the database.
     *
     * @param string $function
     * @param array<mixed>  $columns
     *
     * @return mixed
     */
    public function aggregate($function, $columns = ['*'])
    {
        $results = $this->cloneWithout($this->unions ? [] : ['columns'])
            ->setAggregate($function, $columns)
            ->get($columns);

        $this->aqb = new QueryBuilder();

        if (!$results->isEmpty()) {
            return array_change_key_case((array) $results[0])['aggregate'];
        }

        return false;
    }


    /**
     * Determine if the given operator is supported.
     *
     * @param string $operator
     *
     * @return bool
     */
    protected function invalidOperator($operator)
    {
        return !in_array(strtolower($operator), $this->operators, true) &&
            !isset($this->grammar->getOperators()[strtoupper($operator)]);
    }


    /**
     * Add an "order by" clause to the query.
     *
     * @param Closure|IlluminateQueryBuilder|string $column
     * @param string                                $direction
     *
     * @throws InvalidArgumentException
     *
     * @return $this
     */
    public function orderBy($column, $direction = 'asc')
    {
        if ($this->isQueryable($column)) {
            [$query, $bindings] = $this->createSub($column);

            //fixme: Remove binding when implementing subqueries
            $bindings = null;


            $column = new Expression('(' . $query . ')');
        }

        $this->{$this->unions ? 'unionOrders' : 'orders'}[] = [
            'column'    => $column,
            'direction' => $direction,
        ];

        return $this;
    }

    /**
     * Add a raw "order by" clause to the query.
     *
     * @param string|ExpressionInterface $aql
     * @param array<mixed>                      $bindings
     *
     * @return $this
     */
    public function orderByRaw($aql, $bindings = [])
    {
        $bindings = [];


        $type = 'Raw';
        $column = $aql;
        $this->{$this->unions ? 'unionOrders' : 'orders'}[] = compact('type', 'column');

        return $this;
    }


    /**
     * Put the query's results in random order.
     *
     * @param string $seed
     *
     * @return $this
     */
    public function inRandomOrder($seed = '')
    {
        // ArangoDB's random function doesn't accept a seed.
        $seed = null;


        return $this->orderByRaw($this->grammar->compileRandom($this));
        return $this->orderByRaw($this->grammar->compileRandom(/** @scrutinizer ignore-type */ $this));
    }

    /**
     * Search an ArangoSearch view.
     *
     * @param mixed $predicates
     * @param array|null $options
     * @return Builder
     */
    public function search(mixed $predicates, array $options = null): Builder
    {
        if ($predicates instanceof Closure) {
            $predicates = $predicates($this->aqb);
        }

        if (! is_array($predicates)) {
            $predicates = [$predicates];
        }

        $this->search = [
            'predicates' => $predicates,
            'options' => $options
        ];

        return $this;
    }

    /**
     * Create a new query instance for a sub-query.
     *
     * @return $this
     */
    protected function forSubQuery()
    {
        return $this->newQuery();
    }

    /**
     * Get the database connection instance.
     *
     * @return Connection
     */
    public function getConnection()
    {
        return $this->connection;
    }
}

LaravelFreelancerNL / laravel-arangodb

Push — refactor/improve-static-analys... ( a7b39f...bdf823 )

Builder::addColumns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
