Improve abs() return type

julienfalque · web-flow · commit a079c4544bff · 2024-07-27T08:21:35.000+02:00
diff --git a/conf/config.neon b/conf/config.neon
@@ -1108,6 +1108,11 @@ services:
 	-
 		class: PHPStan\Type\BitwiseFlagHelper
 
+	-
+		class: PHPStan\Type\Php\AbsFunctionDynamicReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicFunctionReturnTypeExtension
+
 	-
 		class: PHPStan\Type\Php\ArgumentBasedFunctionReturnTypeExtension
 		tags:
diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -408,6 +408,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return TypeCombinator::union(
diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -171,6 +171,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();
diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -177,6 +177,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();
diff --git a/src/Type/Accessory/AccessoryNonFalsyStringType.php b/src/Type/Accessory/AccessoryNonFalsyStringType.php
@@ -173,6 +173,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();
diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -179,6 +179,11 @@ public function toNumber(): Type
 		]);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();
diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -328,6 +328,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -374,6 +374,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -389,6 +389,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ConstantIntegerType(1);
diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -385,6 +385,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ConstantIntegerType(1);
diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -588,6 +588,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -56,6 +56,11 @@ public function toNumber(): Type
 		return $this->toInteger();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toString(): Type
 	{
 		return TypeCombinator::union(
diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -299,6 +299,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -422,6 +422,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/Constant/ConstantBooleanType.php b/src/Type/Constant/ConstantBooleanType.php
@@ -82,6 +82,11 @@ public function toNumber(): Type
 		return new ConstantIntegerType((int) $this->value);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toString(): Type
 	{
 		return new ConstantStringType((string) $this->value);
diff --git a/src/Type/Constant/ConstantFloatType.php b/src/Type/Constant/ConstantFloatType.php
@@ -12,6 +12,7 @@
 use PHPStan\Type\Traits\ConstantScalarTypeTrait;
 use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
+use function abs;
 use function ini_get;
 use function ini_set;
 use function is_finite;
@@ -76,6 +77,11 @@ public function toInteger(): Type
 		return new ConstantIntegerType((int) $this->value);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new self(abs($this->value));
+	}
+
 	public function toArrayKey(): Type
 	{
 		return new ConstantIntegerType((int) $this->value);
diff --git a/src/Type/Constant/ConstantIntegerType.php b/src/Type/Constant/ConstantIntegerType.php
@@ -15,6 +15,7 @@
 use PHPStan\Type\Traits\ConstantScalarTypeTrait;
 use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
+use function abs;
 use function sprintf;
 
 /** @api */
@@ -76,6 +77,11 @@ public function toFloat(): Type
 		return new ConstantFloatType($this->value);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new self(abs($this->value));
+	}
+
 	public function toString(): Type
 	{
 		return new ConstantStringType((string) $this->value);
diff --git a/src/Type/Constant/ConstantStringType.php b/src/Type/Constant/ConstantStringType.php
@@ -292,6 +292,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ConstantIntegerType((int) $this->value);
diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -110,6 +110,11 @@ public function toNumber(): Type
 		return $this;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this;
+	}
+
 	public function toFloat(): Type
 	{
 		return $this;
diff --git a/src/Type/IntegerRangeType.php b/src/Type/IntegerRangeType.php
@@ -447,6 +447,21 @@ public function toBoolean(): BooleanType
 		return new ConstantBooleanType(false);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		if ($this->min !== null && $this->min >= 0) {
+			return $this;
+		}
+
+		if ($this->max === null || $this->max >= 0) {
+			$inversedMin = $this->min !== null ? $this->min * -1 : null;
+
+			return self::fromInterval(0, $inversedMin !== null && $this->max !== null ? max($inversedMin, $this->max) : null);
+		}
+
+		return self::fromInterval($this->max * -1, $this->min !== null ? $this->min * -1 : null);
+	}
+
 	public function toString(): Type
 	{
 		$isZero = (new ConstantIntegerType(0))->isSuperTypeOf($this);
diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -62,6 +62,11 @@ public function toNumber(): Type
 		return $this;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return IntegerRangeType::createAllGreaterThanOrEqualTo(0);
+	}
+
 	public function toFloat(): Type
 	{
 		return new FloatType();
diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -914,6 +914,13 @@ public function toNumber(): Type
 		return $type;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		$type = $this->intersectTypes(static fn (Type $type): Type => $type->toAbsoluteNumber());
+
+		return $type;
+	}
+
 	public function toString(): Type
 	{
 		$type = $this->intersectTypes(static fn (Type $type): Type => $type->toString());
diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -217,6 +217,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -468,6 +468,11 @@ public function toNumber(): Type
 		]);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();
diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -351,6 +351,11 @@ public function toNumber(): Type
 		return $this;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this;
+	}
+
 	public function toString(): Type
 	{
 		return $this;
diff --git a/src/Type/NonexistentParentClassType.php b/src/Type/NonexistentParentClassType.php
@@ -127,6 +127,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();
diff --git a/src/Type/NullType.php b/src/Type/NullType.php
@@ -144,6 +144,11 @@ public function toNumber(): Type
 		return new ConstantIntegerType(0);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toString(): Type
 	{
 		return new ConstantStringType('');
diff --git a/src/Type/ObjectType.php b/src/Type/ObjectType.php
@@ -563,6 +563,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		if ($this->isInstanceOf('SimpleXMLElement')->yes()) {
diff --git a/src/Type/Php/AbsFunctionDynamicReturnTypeExtension.php b/src/Type/Php/AbsFunctionDynamicReturnTypeExtension.php
diff --git a/src/Type/ResourceType.php b/src/Type/ResourceType.php
diff --git a/src/Type/StaticType.php b/src/Type/StaticType.php
diff --git a/src/Type/StrictMixedType.php b/src/Type/StrictMixedType.php
diff --git a/src/Type/StringType.php b/src/Type/StringType.php
diff --git a/src/Type/Traits/LateResolvableTypeTrait.php b/src/Type/Traits/LateResolvableTypeTrait.php
diff --git a/src/Type/Traits/ObjectTypeTrait.php b/src/Type/Traits/ObjectTypeTrait.php
diff --git a/src/Type/Type.php b/src/Type/Type.php
diff --git a/src/Type/UnionType.php b/src/Type/UnionType.php
diff --git a/src/Type/VoidType.php b/src/Type/VoidType.php
diff --git a/tests/PHPStan/Analyser/nsrt/abs.php b/tests/PHPStan/Analyser/nsrt/abs.php
diff --git a/tests/PHPStan/Rules/Api/ApiClassImplementsRuleTest.php b/tests/PHPStan/Rules/Api/ApiClassImplementsRuleTest.php
diff --git a/tests/PHPStan/Rules/Api/data/class-implements-out-of-phpstan.php b/tests/PHPStan/Rules/Api/data/class-implements-out-of-phpstan.php

Original file line number	Diff line number	Diff line change
`@@ -1108,6 +1108,11 @@ services:`
`1108`	`1108`	`-`
`1109`	`1109`	`class: PHPStan\Type\BitwiseFlagHelper`
`1110`	`1110`
	`1111`	`+ -`
	`1112`	`+ class: PHPStan\Type\Php\AbsFunctionDynamicReturnTypeExtension`
	`1113`	`+ tags:`
	`1114`	`+ - phpstan.broker.dynamicFunctionReturnTypeExtension`
	`1115`	`+`
`1111`	`1116`	`-`
`1112`	`1117`	`class: PHPStan\Type\Php\ArgumentBasedFunctionReturnTypeExtension`
`1113`	`1118`	`tags:`
Original file line number	Diff line number	Diff line change
`@@ -408,6 +408,11 @@ public function toNumber(): Type`
`408`	`408`	`return new ErrorType();`
`409`	`409`	`}`
`410`	`410`
	`411`	`+ public function toAbsoluteNumber(): Type`
	`412`	`+ {`
	`413`	`+ return new ErrorType();`
	`414`	`+ }`
	`415`	`+`
`411`	`416`	`public function toInteger(): Type`
`412`	`417`	`{`
`413`	`418`	`return TypeCombinator::union(`
Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,11 @@ public function toNumber(): Type`
`171`	`171`	`return new ErrorType();`
`172`	`172`	`}`
`173`	`173`
	`174`	`+ public function toAbsoluteNumber(): Type`
	`175`	`+ {`
	`176`	`+ return new ErrorType();`
	`177`	`+ }`
	`178`	`+`
`174`	`179`	`public function toInteger(): Type`
`175`	`180`	`{`
`176`	`181`	`return new IntegerType();`
Original file line number	Diff line number	Diff line change
`@@ -177,6 +177,11 @@ public function toNumber(): Type`
`177`	`177`	`return new ErrorType();`
`178`	`178`	`}`
`179`	`179`
	`180`	`+ public function toAbsoluteNumber(): Type`
	`181`	`+ {`
	`182`	`+ return new ErrorType();`
	`183`	`+ }`
	`184`	`+`
`180`	`185`	`public function toInteger(): Type`
`181`	`186`	`{`
`182`	`187`	`return new IntegerType();`
Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,11 @@ public function toNumber(): Type`
`173`	`173`	`return new ErrorType();`
`174`	`174`	`}`
`175`	`175`
	`176`	`+ public function toAbsoluteNumber(): Type`
	`177`	`+ {`
	`178`	`+ return new ErrorType();`
	`179`	`+ }`
	`180`	`+`
`176`	`181`	`public function toInteger(): Type`
`177`	`182`	`{`
`178`	`183`	`return new IntegerType();`
Original file line number	Diff line number	Diff line change
`@@ -179,6 +179,11 @@ public function toNumber(): Type`
`179`	`179`	`]);`
`180`	`180`	`}`
`181`	`181`
	`182`	`+ public function toAbsoluteNumber(): Type`
	`183`	`+ {`
	`184`	`+ return $this->toNumber()->toAbsoluteNumber();`
	`185`	`+ }`
	`186`	`+`
`182`	`187`	`public function toInteger(): Type`
`183`	`188`	`{`
`184`	`189`	`return new IntegerType();`
Original file line number	Diff line number	Diff line change
`@@ -328,6 +328,11 @@ public function toNumber(): Type`
`328`	`328`	`return new ErrorType();`
`329`	`329`	`}`
`330`	`330`
	`331`	`+ public function toAbsoluteNumber(): Type`
	`332`	`+ {`
	`333`	`+ return new ErrorType();`
	`334`	`+ }`
	`335`	`+`
`331`	`336`	`public function toInteger(): Type`
`332`	`337`	`{`
`333`	`338`	`return new ErrorType();`
Original file line number	Diff line number	Diff line change
`@@ -374,6 +374,11 @@ public function toNumber(): Type`
`374`	`374`	`return new ErrorType();`
`375`	`375`	`}`
`376`	`376`
	`377`	`+ public function toAbsoluteNumber(): Type`
	`378`	`+ {`
	`379`	`+ return new ErrorType();`
	`380`	`+ }`
	`381`	`+`
`377`	`382`	`public function toInteger(): Type`
`378`	`383`	`{`
`379`	`384`	`return new ErrorType();`
Original file line number	Diff line number	Diff line change
`@@ -389,6 +389,11 @@ public function toNumber(): Type`
`389`	`389`	`return new ErrorType();`
`390`	`390`	`}`
`391`	`391`
	`392`	`+ public function toAbsoluteNumber(): Type`
	`393`	`+ {`
	`394`	`+ return new ErrorType();`
	`395`	`+ }`
	`396`	`+`
`392`	`397`	`public function toInteger(): Type`
`393`	`398`	`{`
`394`	`399`	`return new ConstantIntegerType(1);`
Original file line number	Diff line number	Diff line change
`@@ -385,6 +385,11 @@ public function toNumber(): Type`
`385`	`385`	`return new ErrorType();`
`386`	`386`	`}`
`387`	`387`
	`388`	`+ public function toAbsoluteNumber(): Type`
	`389`	`+ {`
	`390`	`+ return new ErrorType();`
	`391`	`+ }`
	`392`	`+`
`388`	`393`	`public function toInteger(): Type`
`389`	`394`	`{`
`390`	`395`	`return new ConstantIntegerType(1);`