LaravelFreelancerNL\Aranguent\Schema\Concerns\Indexes

Complexity

Total Complexity

25

Size/Duplication

Total Lines	243
Duplicated Lines	0 %

Test Coverage

Coverage

76.25%

Importance

Changes	2
Bugs	1	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	ttlIndex()	0	3	1
A	executeIndexCommand()	0	20	4
A	mapIndexAlgorithm()	0	11	2
A	createIndexName()	0	13	1
A	executeDropIndexCommand()	0	12	2
A	index()	0	5	1
A	skiplistIndex()	0	3	1
A	unique()	0	8	1
A	hashIndex()	0	3	1
A	invertedIndex()	0	3	1
A	indexCommand()	0	21	5
A	spatialIndex()	0	3	1
A	fulltextIndex()	0	3	1
A	geoIndex()	0	3	1
A	persistentIndex()	0	3	1
A	dropIndex()	0	9	1

<?php

namespace LaravelFreelancerNL\Aranguent\Schema\Concerns;

use ArangoClient\Exceptions\ArangoException;
use Illuminate\Support\Fluent;

trait Indexes
{
    /**
     * Add a new index command to the blueprint.
     *
     * @param  string|array<string>|null  $columns
     */
    protected function indexCommand(
        string $type = '',
        array|string $columns = null,
        string $name = null,
        array $indexOptions = []
    ): Fluent {
        if ($type == '') {
            $type = $this->mapIndexAlgorithm('persistent');
        }

        if ($columns === null) {
            $columns = end($this->columns);
        }

        if (is_string($columns)) {
            $columns = [$columns];
        }

        $indexOptions['name'] = $name ?: $this->createIndexName($type, $columns, $indexOptions);

        return $this->addCommand('index', compact('type', 'columns', 'indexOptions'));

It seems like addCommand() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Specify an index for the table.
     *
     * @param  string|array  $columns
     * @param  string  $name
     * @param  string|null  $algorithm
     * @return Fluent
     */
    public function index($columns = null, $name = null, $algorithm = null)
    {
        $type = $this->mapIndexAlgorithm($algorithm);

        return $this->indexCommand($type, $columns, $name);
    }

    /**
     * Create a hash index for fast exact matching.
     *
     * @param  null  $columns

Are you sure the doc-type for parameter $columns is correct as it would always require null to be passed?

     * @param  array  $indexOptions
     * @return Fluent
     */
    public function hashIndex($columns = null, $indexOptions = [])
    {
        return $this->indexCommand('hash', $columns, $indexOptions);

$indexOptions of type array is incompatible with the type null|string expected by parameter $name of LaravelFreelancerNL\Aranguent\Schema\Concerns\Indexes::indexCommand().

    }

    /**
     * @param  null|string  $column
     * @param  string  $name
     * @param  array  $indexOptions
     * @return Fluent
     */
    public function fulltextIndex($column = null, $name = null, $indexOptions = [])
    {
        return $this->indexCommand('fulltext', $column, $name, $indexOptions);
    }

    /**
     *  Specify a spatial index for the table.
     *
     * @param  array<mixed>|null  $columns
     * @param  null  $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @param  array  $indexOptions
     * @return Fluent
     */
    public function geoIndex(array $columns = null, $name = null, $indexOptions = [])
    {
        return $this->indexCommand('geo', $columns, $name, $indexOptions);
    }

    /**
     *  Specify a inverted index for the table.
     *
     * @param  array<mixed>|null  $columns
     * @param  null  $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @param  array  $indexOptions
     * @return Fluent
     */
    public function invertedIndex(array $columns = null, $name = null, $indexOptions = [])
    {
        return $this->indexCommand('inverted', $columns, $name, $indexOptions);
    }

    /**
     * Specify a spatial index for the table.
     *
     * @param  string|array  $columns
     * @param  string  $name
     * @return Fluent
     */
    public function spatialIndex($columns, $name = null)
    {
        return $this->geoIndex($columns, $name);

It seems like $name can also be of type string; however, parameter $name of LaravelFreelancerNL\Aranguent\Schema\Concerns\Indexes::geoIndex() does only seem to accept null, maybe add an additional type check?

It seems like $columns can also be of type string; however, parameter $columns of LaravelFreelancerNL\Aranguent\Schema\Concerns\Indexes::geoIndex() does only seem to accept array|null, maybe add an additional type check?

    }

    /**
     * @param array<mixed>|null$columns
     * @param  string|null  $name
     * @param  array  $indexOptions
     * @return Fluent
     */
    public function skiplistIndex(array $columns = null, $name = null, $indexOptions = [])
    {
        return $this->indexCommand('skiplist', $columns, $name, $indexOptions);
    }

    public function persistentIndex(array $columns = null, string $name = null, array $indexOptions = []): Fluent
    {
        return $this->indexCommand('persistent', $columns, $name, $indexOptions);
    }

    /**
     * Create a TTL index for the table.
     *
     * @param  array<string>|null  $columns
     * @param  null  $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @param  array  $indexOptions
     */
    public function ttlIndex(array $columns = null, $name = null, $indexOptions = []): Fluent
    {
        return $this->indexCommand('ttl', $columns, $name, $indexOptions);
    }

    /**
     * Specify a unique index for the table.
     *
     * @param  string|array  $columns
     * @param  string  $name
     * @param  string|null  $algorithm
     */
    public function unique($columns = null, $name = null, $algorithm = null): Fluent
    {
        $type = $this->mapIndexAlgorithm($algorithm);

        $indexOptions = [];
        $indexOptions['unique'] = true;

        return $this->indexCommand($type, $columns, $name, $indexOptions);
    }

    /**
     * @throws ArangoException
     */
    public function executeIndexCommand(Fluent $command)
    {
        if ($this->connection->pretending()) {
            $this->connection->logQuery('/* ' . $command->explanation . " */\n", []);

            return;
        }

        $options = [
            'type' => $command->type,
            'fields' => $command->columns,
            'unique' => $command->unique,
            'options' => $command->indexOptions,
        ];

        if (isset($command->indexOptions) && is_array($command->indexOptions)) {

The condition is_array($command->indexOptions) is always false.

            $options = array_merge($options, $command->indexOptions);
        }

        $this->schemaManager->createIndex($this->table, $options);
    }

    /**
     * Indicate that the given index should be dropped.
     */
    public function dropIndex(string $name): Fluent
    {
        $parameters = [];
        $parameters['name'] = 'dropIndex';
        $parameters['index'] = $name;
        $parameters['explanation'] = "Drop the '" . $name . "' index on the {$this->table} table.";
        $parameters['handler'] = 'collection';

        return $this->addCommand('dropIndex', $parameters);
    }

    /**
     * Drop the index by first getting all the indexes on the table; then selecting the matching one
     * by name.
     */
    public function executeDropIndexCommand(Fluent $command)
    {
        if ($this->connection->pretending()) {
            $this->connection->logQuery('/* ' . $command->explanation . " */\n", []); // @phpstan-ignore-line

            return;
        }
        $indexes = $this->schemaManager->getIndexes($this->table);
        $arrayIndex = array_search($command->index, array_column($indexes, 'name'), true);
        $indexId = $indexes[$arrayIndex]->id;

        $this->schemaManager->deleteIndex($indexId);
    }

    /**
     * @param  string|null  $algorithm
     * @return mixed|string
     */
    protected function mapIndexAlgorithm($algorithm): mixed
    {
        $algorithmConversion = [
            'HASH' => 'hash',
            'BTREE' => 'persistent',
            'RTREE' => 'geo',
            'TTL' => 'ttl',
        ];
        $algorithm = strtoupper($algorithm);

It seems like $algorithm can also be of type null; however, parameter $string of strtoupper() does only seem to accept string, maybe add an additional type check?

        return (isset($algorithmConversion[$algorithm])) ? $algorithmConversion[$algorithm] : 'persistent';
    }

    /**
     * Create a default index name for the table.
     *
     * @param  string  $type
     */
    public function createIndexName($type, array $columns, array $options = []): string
    {
        $nameParts = [];
        $nameParts[] = $this->prefix . $this->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);
    }
}