RangeParser::isAllowedType() - Code Metrics - Inspection of "Range parser fixes" - yiisoft/db-pgsql - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#94)

unknown
created 2021-12-11 09:02 UTC
RangeParser::isAllowedType() A

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

declare(strict_types=1);

namespace Yiisoft\Db\Pgsql;

use DateInterval;
use DateTime;
use InvalidArgumentException;
use function preg_match;

final class RangeParser
{
    private const RANGES = [
        Schema::TYPE_INT_4_RANGE,
        Schema::TYPE_INT_8_RANGE,
        Schema::TYPE_NUM_RANGE,
        Schema::TYPE_TS_RANGE,
        Schema::TYPE_TS_TZ_RANGE,
        Schema::TYPE_DATE_RANGE,
    ];

    private ?string $type = null;

    public function __construct(?string $type = null)
    {
        if ($type !== null) {
            if (self::isAllowedType($type)) {
                $this->type = $type;
            } else {
                throw new InvalidArgumentException('Unsupported range type "' . $type . '"');
            }
        }
    }

    public function withType(string $type): self
    {
        if (!self::isAllowedType($type)) {
            throw new InvalidArgumentException('Unsupported range type "' . $type . '"');
        }

        $new = clone $this;
        $new->type = $type;

        return $new;
    }

    public function asInt(): self
    {
        return $this->withType(Schema::TYPE_INT_4_RANGE);
    }

    public function asBigInt(): self
    {
        return $this->withType(Schema::TYPE_INT_8_RANGE);
    }

    public function asNumeric(): self
    {
        return $this->withType(Schema::TYPE_NUM_RANGE);
    }

    public function asDate(): self
    {
        return $this->withType(Schema::TYPE_DATE_RANGE);
    }

    public function asTimestamp(): self
    {
        return $this->withType(Schema::TYPE_TS_RANGE);
    }

    public function asTimestampTz(): self
    {
        return $this->withType(Schema::TYPE_TS_TZ_RANGE);
    }

    public function parse(?string $value): ?array
    {
        if ($value === null || $value === 'empty') {
            return null;
        }

        if (!preg_match('/^(?P<open>\[|\()(?P<lower>[^,]*),(?P<upper>[^\)\]]*)(?P<close>\)|\])$/', $value, $matches)) {
            throw new InvalidArgumentException();
        }

        $lower = $matches['lower'] ? trim($matches['lower'], '"') : null;
        $upper = $matches['upper'] ? trim($matches['upper'], '"') : null;
        $includeLower = $matches['open'] === '[';
        $includeUpper = $matches['close'] === ']';

        if ($lower === null && $upper === null) {
            return [null, null];
        }

        $type = $this->type ?? self::parseType($lower, $upper);

        switch ($type) {
            case Schema::TYPE_INT_4_RANGE:
                return self::parseIntRange($lower, $upper, $includeLower, $includeUpper);
            case Schema::TYPE_INT_8_RANGE:
                return self::parseBigIntRange($lower, $upper, $includeLower, $includeUpper);
            case Schema::TYPE_NUM_RANGE:
                return self::parseNumRange($lower, $upper);
            case Schema::TYPE_DATE_RANGE:
                return self::parseDateRange($lower, $upper, $includeLower, $includeUpper);
            case Schema::TYPE_TS_RANGE:
                return self::parseTsRange($lower, $upper);
            case Schema::TYPE_TS_TZ_RANGE:
                return self::parseTsTzRange($lower, $upper);
            default:
                return null;
        }
    }

    private static function parseIntRange(?string $lower, ?string $upper, bool $includeLower, bool $includeUpper): array
    {
        $min = $lower === null ? null : (int) $lower;
        $max = $upper === null ? null : (int) $upper;

        if ($min !== null && $includeLower === false) {
            $min += 1;
        }

        if ($max !== null && $includeUpper === false) {
            $max -= 1;
        }

        return [$min, $max];
    }

    private static function parseBigIntRange(?string $lower, ?string $upper, bool $includeLower, bool $includeUpper): array
    {
        if (PHP_INT_SIZE === 8) {
            return self::parseIntRange($lower, $upper, $includeLower, $includeUpper);
        }

        [$min, $max] = self::parseNumRange($lower, $upper, $includeLower, $includeUpper);
        [$min, $max] = self::parseNumRange($lower, $upper, $includeLower, $includeUpper);

        if ($min !== null && $includeLower === false) {
            $min += 1;
        }

        if ($max !== null && $includeUpper === false) {
            $max -= 1;
        }

        return [$min, $max];
    }

    private static function parseNumRange(?string $lower, ?string $upper): array
    {
        $min = $lower === null ? null : (float) $lower;
        $max = $upper === null ? null : (float) $upper;

        return [$min, $max];
    }

    private static function parseDateRange(?string $lower, ?string $upper, bool $includeLower, bool $includeUpper): array
    {
        $interval = new DateInterval('P1D');
        $min = $lower ? DateTime::createFromFormat('Y-m-d', $lower) : null;
        $max = $upper ? DateTime::createFromFormat('Y-m-d', $upper) : null;

        if ($min && $includeLower === false) {
            $min->add($interval);
        }

        if ($max && $includeUpper === false) {
            $max->sub($interval);
        }

        return [$min, $max];
    }

    private static function parseTsRange(?string $lower, ?string $upper): array
    {
        $min = $lower ? DateTime::createFromFormat('Y-m-d H:i:s', $lower) : null;
        $max = $upper ? DateTime::createFromFormat('Y-m-d H:i:s', $upper) : null;

        return [$min, $max];
    }

    private static function parseTsTzRange(?string $lower, ?string $upper): array
    {
        $min = $lower ? DateTime::createFromFormat('Y-m-d H:i:sP', $lower) : null;
        $max = $upper ? DateTime::createFromFormat('Y-m-d H:i:sP', $upper) : null;

        return [$min, $max];
    }

    public static function isAllowedType(string $type): bool
    {
        return in_array($type, self::RANGES, true);
    }

    /**
     * Find range type from value format
     *
     * @param string $lower
     * @param string $upper
     *
     * @return string|null
     */
    private static function parseType(?string $lower, ?string $upper): ?string
    {
        if ($lower !== null && $upper !== null) {
            if (filter_var($lower, FILTER_VALIDATE_INT) !== false && filter_var($upper, FILTER_VALIDATE_INT) !== false) {
                return Schema::TYPE_INT_4_RANGE;
            }

            if (filter_var($lower, FILTER_VALIDATE_FLOAT) !== false && filter_var($upper, FILTER_VALIDATE_FLOAT) !== false) {
                return Schema::TYPE_NUM_RANGE;
            }
        }

        $value = $lower ?? $upper;

        if (filter_var($value, FILTER_VALIDATE_INT) !== false) {
            return Schema::TYPE_INT_4_RANGE;
        }


        if (filter_var($value, FILTER_VALIDATE_FLOAT) !== false) {
            return Schema::TYPE_NUM_RANGE;
        }

        if (DateTime::createFromFormat('Y-m-d', $value)) {
            return Schema::TYPE_DATE_RANGE;
        }

        if (DateTime::createFromFormat('Y-m-d H:i:s', $value)) {
            return Schema::TYPE_TS_RANGE;
        }

        if (DateTime::createFromFormat('Y-m-d H:i:sP', $value)) {
            return Schema::TYPE_TS_TZ_RANGE;
        }

        return null;
    }
}

yiisoft / db-pgsql

Pull Request — master (#94)

RangeParser::isAllowedType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
