Accept errors as a known PHPStan limitation rather than worked around with complex annotations that don't provide real value

Author: martin-georgiev

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:

src/MartinGeorgiev/Doctrine/DBAL/Types/ValueObject/Range.php

@@ -7,7 +7,7 @@
 /**
  * Abstract base class for PostgreSQL range types.
  *
- * @template T of int|float|\DateTimeInterface
+ * @template R of int|float|\DateTimeInterface
  *
  * @since 3.3
  *

tests/Integration/MartinGeorgiev/Doctrine/DBAL/Types/DBALTypesTest.php

@@ -23,6 +23,9 @@ public function test_scalar_type(string $typeName, string $columnType, mixed $te
         $this->runTypeTest($typeName, $columnType, $testValue);
     }
 
+    /**
+     * @return array<string, array{string, string, string}>
+     */
     public static function provideScalarTypeTestCases(): array
     {
         return [
@@ -35,12 +38,18 @@ public static function provideScalarTypeTestCases(): array
         ];
     }
 
+    /**
+     * @param array<mixed> $testValue
+     */
     #[DataProvider('provideArrayTypeTestCases')]
     public function test_array_type(string $typeName, string $columnType, array $testValue): void
     {
         $this->runTypeTest($typeName, $columnType, $testValue);
     }
 
+    /**
+     * @return array<string, array{string, string, array<mixed>}>
+     */
     public static function provideArrayTypeTestCases(): array
     {
         return [
@@ -63,12 +72,18 @@ public static function provideArrayTypeTestCases(): array
         ];
     }
 
+    /**
+     * @param array<mixed> $testValue
+     */
     #[DataProvider('provideJsonTypeTestCases')]
     public function test_json_type(string $typeName, string $columnType, array $testValue): void
     {
         $this->runTypeTest($typeName, $columnType, $testValue);
     }
 
+    /**
+     * @return array<string, array{string, string, array<mixed>}>
+     */
     public static function provideJsonTypeTestCases(): array
     {
         return [
@@ -94,6 +109,9 @@ public function test_point_type(string $typeName, string $columnType, PointValue
         $this->runTypeTest($typeName, $columnType, $pointValueObject);
     }
 
+    /**
+     * @return array<string, array{string, string, PointValueObject}>
+     */
     public static function providePointTypeTestCases(): array
     {
         return [
@@ -104,12 +122,18 @@ public static function providePointTypeTestCases(): array
         ];
     }
 
+    /**
+     * @param DateRangeValueObject|Int4RangeValueObject|Int8RangeValueObject|NumRangeValueObject|TsRangeValueObject|TstzRangeValueObject $rangeValueObject
+     */
     #[DataProvider('provideRangeTypeTestCases')]
     public function test_range_type(string $typeName, string $columnType, RangeValueObject $rangeValueObject): void
     {
         $this->runTypeTest($typeName, $columnType, $rangeValueObject);
     }
 
+    /**
+     * @return array<string, array{string, string, DateRangeValueObject|Int4RangeValueObject|Int8RangeValueObject|NumRangeValueObject|TsRangeValueObject|TstzRangeValueObject}>
+     */
     public static function provideRangeTypeTestCases(): array
     {
         return [
@@ -183,6 +207,9 @@ private function assertPointEquals(PointValueObject $pointValueObject, mixed $ac
         $this->assertEquals($pointValueObject->getY(), $actual->getY(), 'Failed asserting that Y coordinates are equal for type '.$typeName);
     }
 
+    /**
+     * @param RangeValueObject<\DateTimeInterface|float|int> $rangeValueObject
+     */
     private function assertRangeEquals(RangeValueObject $rangeValueObject, mixed $actual, string $typeName): void
     {
         $this->assertInstanceOf(RangeValueObject::class, $actual, 'Failed asserting that value is a Range object for type '.$typeName);