feat: add support for range types (#396)

Author: martin-georgiev

README.md

@@ -13,6 +13,7 @@ Enhances Doctrine with PostgreSQL-specific features and functions. Supports Post
 // Register types with Doctrine
 Type::addType('jsonb', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Jsonb");
 Type::addType('text[]', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TextArray");
+Type::addType('numrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\NumRange");
 
 // Use in your Doctrine entities
 #[ORM\Column(type: 'jsonb')]
@@ -21,6 +22,9 @@ private array $data;
 #[ORM\Column(type: 'text[]')]
 private array $tags;
 
+#[ORM\Column(type: 'numrange')]
+private NumericRange $priceRange;
+
 // Use in DQL
 $query = $em->createQuery('
     SELECT e
@@ -51,6 +55,9 @@ This package provides comprehensive Doctrine support for PostgreSQL features:
   - MAC addresses (`macaddr`, `macaddr[]`)
 - **Geometric Types**
   - Point (`point`, `point[]`)
+- **Range Types**
+  - Date and time ranges (`daterange`, `tsrange`, `tstzrange`)
+  - Numeric ranges (`numrange`, `int4range`, `int8range`)
 
 ### PostgreSQL Operators
 - **Array Operations**
@@ -62,6 +69,9 @@ This package provides comprehensive Doctrine support for PostgreSQL features:
   - Field access (`->`, `->>`)
   - Path operations (`#>`, `#>>`)
   - JSON containment and existence operators
+- **Range Operations**
+  - Containment checks (in PHP value objects and for DQL queries with `@>` and `<@`)
+  - Overlaps (`&&`)
 
 ### Functions
 - **Text Search**
@@ -85,6 +95,7 @@ This package provides comprehensive Doctrine support for PostgreSQL features:
 
 Full documentation:
 - [Available Types](docs/AVAILABLE-TYPES.md)
+- [Value Objects for Range Types](docs/RANGE-TYPES.md)
 - [Available Functions and Operators](docs/AVAILABLE-FUNCTIONS-AND-OPERATORS.md)
 - [Common Use Cases and Examples](docs/USE-CASES-AND-EXAMPLES.md)
 

ci/phpstan/baselines/range-baseline.neon

@@ -0,0 +1,47 @@
+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
+
+		# Temporary suppression for PHPStan's lack of covariant generics support
+		# Remove when PHPStan supports covariance (https://github.com/phpstan/phpstan/issues/7427)
+		-
+			message: '#.*Template type R on class.*Range is not covariant#'
+			path: ../../../tests/Unit/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/
+
+		-
+			message: '#.*should return.*Range<DateTimeInterface\|float\|int>.*but returns.*Range#'
+			path: ../../../tests/Unit/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/
+
+		-
+			message: '#.*Generator expects value type.*Range<DateTimeInterface\|float\|int>.*given#'
+			path: ../../../tests/Unit/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/
+
+		-
+			message: '#.*extends generic class.*but does not specify its types#'
+			path: ../../../tests/Unit/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/
+
+		-
+			message: '#.*should be compatible with return type#'
+			path: ../../../tests/Unit/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/

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');
 ...
 
 ```