Umbrellio\Postgres\Helpers\IndexAssertions

Complexity

Total Complexity

11

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	existConstraintOnTable()	0	11	2
A	assertSameIndex()	0	6	1
A	seeIndex()	0	3	1
A	notSeeIndex()	0	3	1
A	seeConstraint()	0	3	1
A	dontSeeConstraint()	0	3	1
A	assertRegExpIndex()	0	6	2
A	getIndexListing()	0	5	2

<?php

declare(strict_types=1);

namespace Umbrellio\Postgres\Helpers;

use Illuminate\Support\Facades\DB;

/**
 * @codeCoverageIgnore
 */
trait IndexAssertions
{
    abstract public static function assertNotNull($actual, string $message = ''): void;

    abstract public static function assertSame($expected, $actual, string $message = ''): void;

    abstract public static function assertNull($actual, string $message = ''): void;

    abstract public static function assertMatchesRegularExpression(
        string $pattern,
        string $string,
        string $message = ''
    ): void;

    abstract public static function assertTrue($condition, string $message = ''): void;

    abstract public static function assertFalse($condition, string $message = ''): void;

    protected function seeIndex(string $index): void
    {
        $this->assertNotNull($this->getIndexListing($index));
    }

    protected function notSeeIndex(string $index): void
    {
        $this->assertNull($this->getIndexListing($index));
    }

    protected function assertSameIndex(string $index, string $expectedDef): void
    {
        $definition = $this->getIndexListing($index);

        $this->seeIndex($index);
        $this->assertSame($expectedDef, $definition);
    }

    protected function assertRegExpIndex(string $index, string $expectedDef): void
    {
        $definition = $this->getIndexListing($index);

        $this->seeIndex($index);
        $this->assertMatchesRegularExpression($expectedDef, $definition ?: '');
    }

    protected function dontSeeConstraint(string $table, string $index): void
    {
        $this->assertFalse($this->existConstraintOnTable($table, $index));
    }

    protected function seeConstraint(string $table, string $index): void
    {
        $this->assertTrue($this->existConstraintOnTable($table, $index));
    }

    private function getIndexListing($index): ?string
    {
        $definition = DB::selectOne('SELECT * FROM pg_indexes WHERE indexname = ?', [$index]);

        return $definition ? $definition->indexdef : null;
    }

    private function existConstraintOnTable(string $table, string $index): bool
    {
        $expression = '
            SELECT c.conname
            FROM pg_constraint c
            LEFT JOIN pg_class t ON c.conrelid  = t.oid
            LEFT JOIN pg_class t2 ON c.confrelid = t2.oid
            WHERE t.relname = ? AND c.conname = ?;
        ';
        $definition = DB::selectOne($expression, [$table, $index]);
        return $definition ? true : false;
    }
}