Builder::rename() - Code Metrics - Inspection of "Added Schema::hasIndex (#151)" - LaravelFreelancerNL/laravel-arangodb - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 152-support-field-properties-f... ( af2be7 )

by Bas
created 2024-08-04 14:15 UTC
Builder::rename() A

↳ Parent: Builder
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
Metric	Value
eloc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1
<?php

declare(strict_types=1);

namespace LaravelFreelancerNL\Aranguent\Schema;

use ArangoClient\Exceptions\ArangoException;
use ArangoClient\Schema\SchemaManager;
use Closure;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Fluent;
use LaravelFreelancerNL\Aranguent\Connection;
use LaravelFreelancerNL\Aranguent\Exceptions\QueryException;
use LaravelFreelancerNL\Aranguent\Schema\Concerns\HandlesAnalyzers;
use LaravelFreelancerNL\Aranguent\Schema\Concerns\HandlesViews;
use LaravelFreelancerNL\Aranguent\Schema\Concerns\UsesBlueprints;

class Builder extends \Illuminate\Database\Schema\Builder
{
    use HandlesAnalyzers;
    use HandlesViews;

    use UsesBlueprints;

    /**
     * The database connection instance.
     *
     * @var Connection
     */
    protected $connection;

    public SchemaManager $schemaManager;

    /**
     * The schema grammar instance.
     *
     * @var Grammar
     */
    public $grammar;


    /**
     * index prefixes?
     */
    public ?bool $prefixIndexes;

    /**
     * The table prefix.
     */
    public string $prefix;

    /**
     * Create a new database Schema manager.
     *
     * Builder constructor.
     */
    public function __construct(Connection $connection)
    {
        $this->connection = $connection;

        $this->grammar = $connection->getSchemaGrammar();

        $this->schemaManager = $connection->getArangoClient()->schema();

        $this->prefixIndexes = $this->connection->getConfig('prefix_indexes');

        $this->prefix = $this->prefixIndexes
            ? $this->connection->getConfig('prefix')
            : '';

    }

    /**
     * Determine if the given table exists.
     *
     * @param  string  $table
     * @return bool
     */
    public function hasTable($table)
    {
        return $this->handleExceptionsAsQueryExceptions(function () use ($table) {
            return $this->schemaManager->hasCollection($table);
        });
    }

    /**
     * @throws ArangoException
     */
    public function dropIfExists($table): void
    {
        $tableExists = $this->hasTable($table);
        if ($tableExists) {
            $this->drop($table);
        }
    }

    /**
     * Get all the tables for the database; excluding ArangoDB system collections
     *
     * @return array<mixed>
     *
     * @throws ArangoException
     */
    public function getAllTables(): array
    {
        return $this->schemaManager->getCollections(true);
    }

    /**
     * Get the tables that belong to the database.
     *
     * @return array
     * @throws ArangoException
     */
    public function getTables()
    {
        return $this->schemaManager->getCollections(true);
    }

    /**
     * Rename a table (collection).
     *
     * @param  string  $from
     * @param  string  $to
     *
     * @throws ArangoException
     */
    public function rename($from, $to): bool
    {
        return (bool) $this->schemaManager->renameCollection($from, $to);
    }

    /**
     * Drop a table (collection) from the schema.
     *
     * @throws ArangoException
     */
    public function drop($table)
    {
        $this->schemaManager->deleteCollection($table);
    }

    /**
     * Drop all tables (collections) from the schema.
     *
     * @throws ArangoException
     */
    public function dropAllTables(): void
    {
        $collections = $this->getAllTables();

        foreach ($collections as $name) {
            $this->schemaManager->deleteCollection($name->name);
        }
    }

    /**
     * Determine if the given table has a given column.
     *
     * @param  string  $table
     * @param string|string[] $column
     * @return bool
     */
    public function hasColumn($table, $column)
    {
        return $this->hasColumns($table, $column);
    }

    /**
     * Determine if the given table has given columns.
     *
     * @param string $table
     * @param string|string[] $columns
     * @return bool
     */
    public function hasColumns($table, $columns)
    {
        if (is_string($columns)) {
            $columns = [$columns];
        }

        $parameters = [];
        $parameters['name'] = 'hasColumn';
        $parameters['handler'] = 'aql';
        $parameters['columns'] = $columns;

        $command = new Fluent($parameters);

        $compilation = $this->grammar->compileHasColumn($table, $command);
        return $this->connection->select($compilation['aqb'])[0];
    }

    /**
     * Create a default index name for the table.
     *
     * @param  string  $type
     */
    public function createIndexName(string $table, string $type, array $columns, array $options = []): string
    {
        $nameParts = [];
        $nameParts[] = $this->prefix . $table;
        $nameParts = array_merge($nameParts, $columns);
        $nameParts[] = $type;
        $nameParts = array_merge($nameParts, array_keys($options));
        array_filter($nameParts);

        $index = strtolower(implode('_', $nameParts));
        $index = preg_replace("/\[\*+\]+/", '_array', $index);

        return preg_replace('/[^A-Za-z0-9]+/', '_', $index);
    }

    /**
     * Determine if the given table has a given index.
     *
     * @param  string  $table
     * @param  string|array<string>  $index
     * @param  string|null  $type
     * @return bool
     */
    public function hasIndex($table, $index, $type = null, array $options = [])
    public function hasIndex($table, $index, $type = null, /** @scrutinizer ignore-unused */ array $options = [])
    {
        $name = $index;

        if ($type === null) {
            $type = 'persistent';
        }

        if (is_array($index)) {
            $name = $this->createIndexName($table, $type, $index, $options = []);
        }

        return !!$this->schemaManager->getIndexByName($table, $name);
        return !!$this->schemaManager->getIndexByName($table, /** @scrutinizer ignore-type */ $name);
    }

    /**
     * Create a database in the schema.
     *
     * @param  string  $name
     * @return bool
     *
     * @throws ArangoException
     */
    public function createDatabase($name)
    {
        return $this->schemaManager->createDatabase($name);
    }

    /**
     * Drop a database from the schema if the database exists.
     *
     * @param  string  $name
     * @return bool
     *
     * @throws ArangoException
     */
    public function dropDatabaseIfExists($name)
    {
        if ($this->schemaManager->hasDatabase($name)) {
            return $this->schemaManager->deleteDatabase($name);
        }

        return true;
    }

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

    /**
     * @throws QueryException
     */
    protected function handleExceptionsAsQueryExceptions(Closure $callback): mixed
    {
        try {
            return $callback();
        } catch (\Exception $e) {
            throw new QueryException($this->connection->getName(), $e->getMessage(), [], $e);
        }
    }

    /**
     * Disable foreign key constraints during the execution of a callback.
     *
     * ArangoDB doesn't have foreign keys so this is just a dummy to keep things working
     * for functionality that expect this method.
     *
     * @param  \Closure  $callback
     * @return mixed
     */
    public function withoutForeignKeyConstraints(Closure $callback)
    {
        return $callback();
    }

    /**
     * Silently catch the use of unsupported builder methods.
     */
    public function __call($method, $parameters)
    {
        Log::warning("The ArangoDB driver's schema builder doesn't support method '$method'\n");
    }
}

LaravelFreelancerNL / laravel-arangodb

Push — 152-support-field-properties-f... ( af2be7 )

Builder::rename() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
