feat: add support for range types

ci/phpstan/baselines/range-baseline.neon

@@ -0,0 +1,25 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Method MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\:\:empty\(\) should return static\(MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\<R of DateTimeInterface\|float\|int\>\) but returns static\(MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\<DateTimeInterface\|float\|int\>\)\.$#'
+			identifier: return.type
+			count: 1
+			path: ../../../src/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/Range.php
+
+		-
+			message: '#^Method MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\:\:fromString\(\) should return static\(MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\<R of DateTimeInterface\|float\|int\>\) but returns static\(MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\<DateTimeInterface\|float\|int\>\)\.$#'
+			identifier: return.type
+			count: 2
+			path: ../../../src/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/Range.php
+
+		-
+			message: '#^Method MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\:\:infinite\(\) should return static\(MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\<R of DateTimeInterface\|float\|int\>\) but returns static\(MartinGeorgiev\\Doctrine\\DBAL\\Types\\ValueObject\\Range\<DateTimeInterface\|float\|int\>\)\.$#'
+			identifier: return.type
+			count: 1
+			path: ../../../src/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/Range.php
+
+		-
+			message: '#^Unsafe usage of new static\(\)\.$#'
+			identifier: new.static
+			count: 4
+			path: ../../../src/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/Range.php

ci/phpstan/config.neon

@@ -6,6 +6,7 @@ includes:
     - ./baselines/deprecated-methods.neon
     - ./baselines/lexer-variations.neon
     - ./baselines/phpstan-identifiers.neon
+    - ./baselines/range-baseline.neon
     - ./baselines/type-mismatches.neon
 
 parameters:

docs/AVAILABLE-TYPES.md

@@ -19,3 +19,9 @@
 | macaddr[] | _macaddr | `MartinGeorgiev\Doctrine\DBAL\Types\MacaddrArray` |
 | point | point | `MartinGeorgiev\Doctrine\DBAL\Types\Point` |
 | point[] | _point | `MartinGeorgiev\Doctrine\DBAL\Types\PointArray` |
+| daterange | daterange | `MartinGeorgiev\Doctrine\DBAL\Types\DateRange` |
+| int4range | int4range | `MartinGeorgiev\Doctrine\DBAL\Types\Int4Range` |
+| int8range | int8range | `MartinGeorgiev\Doctrine\DBAL\Types\Int8Range` |
+| numrange | numrange | `MartinGeorgiev\Doctrine\DBAL\Types\NumRange` |
+| tsrange | tsrange | `MartinGeorgiev\Doctrine\DBAL\Types\TsRange` |
+| tstzrange | tstzrange | `MartinGeorgiev\Doctrine\DBAL\Types\TstzRange` |

docs/INTEGRATING-WITH-DOCTRINE.md

@@ -31,6 +31,13 @@ Type::addType('macaddr[]', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\MacaddrArray"
 
 Type::addType('point', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Point");
 Type::addType('point[]', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\PointArray");
+
+Type::addType('daterange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\DateRange");
+Type::addType('int4range', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Int4Range");
+Type::addType('int8range', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Int8Range");
+Type::addType('numrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\NumRange");
+Type::addType('tsrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TsRange");
+Type::addType('tstzrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TstzRange");
 ```
 
 
@@ -237,6 +244,13 @@ $platform->registerDoctrineTypeMapping('_macaddr','macaddr[]');
 $platform->registerDoctrineTypeMapping('point','point');
 $platform->registerDoctrineTypeMapping('point[]','point[]');
 $platform->registerDoctrineTypeMapping('_point','point[]');
+
+$platform->registerDoctrineTypeMapping('daterange','daterange');
+$platform->registerDoctrineTypeMapping('int4range','int4range');
+$platform->registerDoctrineTypeMapping('int8range','int8range');
+$platform->registerDoctrineTypeMapping('numrange','numrange');
+$platform->registerDoctrineTypeMapping('tsrange','tsrange');
+$platform->registerDoctrineTypeMapping('tstzrange','tstzrange');
 ...
 
 ```

src/MartinGeorgiev/Doctrine/DBAL/Types/BaseRangeType.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidRangeForDatabaseException;
+use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidRangeForPHPException;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+
+/**
+ * Base class for PostgreSQL range types.
+ *
+ * @template R of Range
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+abstract class BaseRangeType extends BaseType
+{
+    /**
+     * @param R|null $value
+     */
+    public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (!$value instanceof Range) {
+            throw InvalidRangeForDatabaseException::forInvalidType($value);
+        }
+
+        return (string) $value;
+    }
+
+    /**
+     * @param string|null $value
+     *
+     * @return R|null
+     */
+    public function convertToPHPValue($value, AbstractPlatform $platform): ?Range
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (!\is_string($value)) {
+            throw InvalidRangeForPHPException::forInvalidType($value);
+        }
+
+        if ($value === '') {
+            return null;
+        }
+
+        try {
+            return $this->createFromString($value);
+        } catch (\InvalidArgumentException) {
+            throw InvalidRangeForPHPException::forInvalidFormat($value);
+        }
+    }
+
+    /**
+     * @return R
+     */
+    abstract protected function createFromString(string $value): Range;
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/DateRange.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\DateRange as DateRangeValueObject;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+
+/**
+ * Implementation of PostgreSQL DATERANGE type.
+ *
+ * @extends BaseRangeType<DateRangeValueObject>
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class DateRange extends BaseRangeType
+{
+    protected const TYPE_NAME = 'daterange';
+
+    protected function createFromString(string $value): Range
+    {
+        return DateRangeValueObject::fromString($value);
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/Exceptions/InvalidRangeForDatabaseException.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types\Exceptions;
+
+/**
+ * Exception thrown when an invalid range value is provided for database conversion.
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+final class InvalidRangeForDatabaseException extends \InvalidArgumentException
+{
+    public static function forInvalidType(mixed $value): self
+    {
+        return new self(
+            \sprintf(
+                'Invalid type for range. Expected Range object or string, got %s',
+                \get_debug_type($value)
+            )
+        );
+    }
+
+    public static function forInvalidFormat(string $value): self
+    {
+        return new self(
+            \sprintf('Invalid range format: %s', $value)
+        );
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/Exceptions/InvalidRangeForPHPException.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types\Exceptions;
+
+use Doctrine\DBAL\Types\ConversionException;
+
+/**
+ * Exception thrown when an invalid PHP value is provided for range creation.
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class InvalidRangeForPHPException extends ConversionException
+{
+    private static function create(string $message, mixed $value): self
+    {
+        return new self(\sprintf($message, \var_export($value, true)));
+    }
+
+    public static function forInvalidNumericBound(mixed $value): self
+    {
+        return self::create('Range bound must be numeric, %s given', $value);
+    }
+
+    public static function forInvalidIntegerBound(mixed $value): self
+    {
+        return self::create('Range bound must be an integer, %s given', $value);
+    }
+
+    public static function forInvalidDateTimeBound(mixed $value): self
+    {
+        return self::create('Range bound must be a DateTimeInterface instance, %s given', $value);
+    }
+
+    public static function forInvalidType(mixed $value): self
+    {
+        return self::create('Invalid database value type for range conversion. Expected string, %s given', $value);
+    }
+
+    public static function forInvalidFormat(string $value): self
+    {
+        return new self(\sprintf('Invalid range format from database: %s', $value));
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/Int4Range.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Int4Range as Int4RangeValueObject;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+
+/**
+ * Implementation of PostgreSQL INT4RANGE type.
+ *
+ * @extends BaseRangeType<Int4RangeValueObject>
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class Int4Range extends BaseRangeType
+{
+    protected const TYPE_NAME = 'int4range';
+
+    protected function createFromString(string $value): Range
+    {
+        return Int4RangeValueObject::fromString($value);
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/Int8Range.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Int8Range as Int8RangeValueObject;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+
+/**
+ * Implementation of PostgreSQL INT8RANGE type.
+ *
+ * @extends BaseRangeType<Int8RangeValueObject>
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class Int8Range extends BaseRangeType
+{
+    protected const TYPE_NAME = 'int8range';
+
+    protected function createFromString(string $value): Range
+    {
+        return Int8RangeValueObject::fromString($value);
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/NumRange.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\NumericRange;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+
+/**
+ * Implementation of PostgreSQL NUMRANGE type.
+ *
+ * @extends BaseRangeType<NumericRange>
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class NumRange extends BaseRangeType
+{
+    protected const TYPE_NAME = 'numrange';
+
+    protected function createFromString(string $value): Range
+    {
+        return NumericRange::fromString($value);
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/TsRange.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\TsRange as TsRangeValueObject;
+
+/**
+ * Implementation of PostgreSQL TSRANGE type.
+ *
+ * @extends BaseRangeType<TsRangeValueObject>
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class TsRange extends BaseRangeType
+{
+    protected const TYPE_NAME = 'tsrange';
+
+    protected function createFromString(string $value): Range
+    {
+        return TsRangeValueObject::fromString($value);
+    }
+}

src/MartinGeorgiev/Doctrine/DBAL/Types/TstzRange.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\DBAL\Types;
+
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Range;
+use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\TstzRange as TstzRangeValueObject;
+
+/**
+ * Implementation of PostgreSQL TSTZRANGE type.
+ *
+ * @extends BaseRangeType<TstzRangeValueObject>
+ *
+ * @since 3.3
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class TstzRange extends BaseRangeType
+{
+    protected const TYPE_NAME = 'tstzrange';
+
+    protected function createFromString(string $value): Range
+    {
+        return TstzRangeValueObject::fromString($value);
+    }
+}