Delegate most of TypeCombinator::remove() to Type::tryRemove()

phpstan · Feb 4, 2022 · 44866d8 · 44866d8
1 parent 9512513
commit 44866d8
Show file tree

Hide file tree

Showing 35 changed files with 263 additions and 94 deletions.
diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -17,6 +17,7 @@
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonIterableTypeTrait;
 use PHPStan\Type\Traits\NonObjectTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
 use PHPStan\Type\UnionType;
@@ -30,6 +31,7 @@ class AccessoryLiteralStringType implements CompoundType, AccessoryType
 	use NonIterableTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 	use NonGenericTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct()

diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -15,6 +15,7 @@
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonIterableTypeTrait;
 use PHPStan\Type\Traits\NonObjectTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\TruthyBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
@@ -30,6 +31,7 @@ class AccessoryNonEmptyStringType implements CompoundType, AccessoryType
 	use TruthyBooleanTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 	use NonGenericTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct()

diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -15,6 +15,7 @@
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonIterableTypeTrait;
 use PHPStan\Type\Traits\NonObjectTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\UndecidedBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
@@ -30,6 +31,7 @@ class AccessoryNumericStringType implements CompoundType, AccessoryType
 	use UndecidedBooleanTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
 	use NonGenericTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct()

diff --git a/src/Type/Accessory/HasMethodType.php b/src/Type/Accessory/HasMethodType.php
@@ -12,6 +12,7 @@
 use PHPStan\Type\CompoundType;
 use PHPStan\Type\IntersectionType;
 use PHPStan\Type\Traits\NonGenericTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\ObjectTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
@@ -26,6 +27,7 @@ class HasMethodType implements AccessoryType, CompoundType
 	use ObjectTypeTrait;
 	use NonGenericTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct(private string $methodName)

diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -12,6 +12,7 @@
 use PHPStan\Type\Traits\MaybeIterableTypeTrait;
 use PHPStan\Type\Traits\MaybeObjectTypeTrait;
 use PHPStan\Type\Traits\NonGenericTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\TruthyBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
@@ -28,6 +29,7 @@ class HasOffsetType implements CompoundType, AccessoryType
 	use TruthyBooleanTypeTrait;
 	use NonGenericTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct(private Type $offsetType)

diff --git a/src/Type/Accessory/HasPropertyType.php b/src/Type/Accessory/HasPropertyType.php
@@ -8,6 +8,7 @@
 use PHPStan\Type\CompoundType;
 use PHPStan\Type\IntersectionType;
 use PHPStan\Type\Traits\NonGenericTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\ObjectTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
@@ -21,6 +22,7 @@ class HasPropertyType implements AccessoryType, CompoundType
 	use ObjectTypeTrait;
 	use NonGenericTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct(private string $propertyName)

diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -12,6 +12,7 @@
 use PHPStan\Type\Traits\MaybeCallableTypeTrait;
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonObjectTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\TruthyBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use PHPStan\Type\Type;
@@ -26,6 +27,7 @@ class NonEmptyArrayType implements CompoundType, AccessoryType
 	use TruthyBooleanTypeTrait;
 	use NonGenericTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct()

diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -7,6 +7,7 @@
 use PHPStan\Reflection\TrivialParametersAcceptor;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
+use PHPStan\Type\Accessory\HasOffsetType;
 use PHPStan\Type\Accessory\NonEmptyArrayType;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantFloatType;
@@ -420,6 +421,23 @@ public function traverse(callable $cb): Type
 		return $this;
 	}
 
+	public function tryRemove(Type $typeToRemove): ?Type
+	{
+		if ($typeToRemove instanceof ConstantArrayType && $typeToRemove->isIterableAtLeastOnce()->no()) {
+			return TypeCombinator::intersect($this, new NonEmptyArrayType());
+		}
+
+		if ($typeToRemove instanceof NonEmptyArrayType) {
+			return new ConstantArrayType([], []);
+		}
+
+		if ($this instanceof ConstantArrayType && $typeToRemove instanceof HasOffsetType) {
+			return $this->unsetOffset($typeToRemove->getOffsetType());
+		}
+
+		return null;
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -3,6 +3,7 @@
 namespace PHPStan\Type;
 
 use PHPStan\Type\Constant\ConstantArrayType;
+use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\Constant\ConstantFloatType;
 use PHPStan\Type\Constant\ConstantIntegerType;
 use PHPStan\Type\Constant\ConstantStringType;
@@ -75,6 +76,15 @@ public function toArray(): Type
 		);
 	}
 
+	public function tryRemove(Type $typeToRemove): ?Type
+	{
+		if ($typeToRemove instanceof ConstantBooleanType) {
+			return new ConstantBooleanType(!$typeToRemove->getValue());
+		}
+
+		return null;
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -16,6 +16,7 @@
 use PHPStan\Type\Traits\MaybeIterableTypeTrait;
 use PHPStan\Type\Traits\MaybeObjectTypeTrait;
 use PHPStan\Type\Traits\MaybeOffsetAccessibleTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\TruthyBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 use function array_map;
@@ -32,6 +33,7 @@ class CallableType implements CompoundType, ParametersAcceptor
 	use MaybeOffsetAccessibleTypeTrait;
 	use TruthyBooleanTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @var array<int, ParameterReflection> */
 	private array $parameters;

diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -24,6 +24,7 @@
 use PHPStan\Type\Generic\TemplateTypeMap;
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonOffsetAccessibleTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonTypeTrait;
 use function array_map;
 use function array_merge;
@@ -37,6 +38,7 @@ class ClosureType implements TypeWithClassName, ParametersAcceptor
 	use NonGenericTypeTrait;
 	use UndecidedComparisonTypeTrait;
 	use NonOffsetAccessibleTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	private ObjectType $objectType;
 

diff --git a/src/Type/Enum/EnumCaseObjectType.php b/src/Type/Enum/EnumCaseObjectType.php
@@ -91,6 +91,15 @@ public function getSubtractedType(): ?Type
 		return null;
 	}
 
+	public function tryRemove(Type $typeToRemove): ?Type
+	{
+		if ($this->isSuperTypeOf($typeToRemove)->yes()) {
+			return $this->subtract($typeToRemove);
+		}
+
+		return null;
+	}
+
 	public function getProperty(string $propertyName, ClassMemberAccessAnswerer $scope): PropertyReflection
 	{
 		$classReflection = $this->getClassReflection();

diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -11,6 +11,7 @@
 use PHPStan\Type\Traits\NonIterableTypeTrait;
 use PHPStan\Type\Traits\NonObjectTypeTrait;
 use PHPStan\Type\Traits\NonOffsetAccessibleTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\UndecidedBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonTypeTrait;
 use function get_class;
@@ -26,6 +27,7 @@ class FloatType implements Type
 	use UndecidedComparisonTypeTrait;
 	use NonGenericTypeTrait;
 	use NonOffsetAccessibleTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct()

diff --git a/src/Type/Generic/TemplateTypeTrait.php b/src/Type/Generic/TemplateTypeTrait.php
@@ -5,6 +5,7 @@
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\IntersectionType;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Type;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
@@ -16,6 +17,8 @@
 trait TemplateTypeTrait
 {
 
+	use NonRemoveableTypeTrait;
+
 	private string $name;
 
 	private TemplateTypeScope $scope;

diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -76,4 +76,25 @@ public function toArray(): Type
 		);
 	}
 
+	public function tryRemove(Type $typeToRemove): ?Type
+	{
+		if ($typeToRemove instanceof IntegerRangeType || $typeToRemove instanceof ConstantIntegerType) {
+			if ($typeToRemove instanceof IntegerRangeType) {
+				$removeValueMin = $typeToRemove->getMin();
+				$removeValueMax = $typeToRemove->getMax();
+			} else {
+				$removeValueMin = $typeToRemove->getValue();
+				$removeValueMax = $typeToRemove->getValue();
+			}
+			$lowerPart = $removeValueMin !== null ? IntegerRangeType::fromInterval(null, $removeValueMin, -1) : null;
+			$upperPart = $removeValueMax !== null ? IntegerRangeType::fromInterval($removeValueMax, null, +1) : null;
+			if ($lowerPart !== null && $upperPart !== null) {
+				return new UnionType([$lowerPart, $upperPart]);
+			}
+			return $lowerPart ?? $upperPart ?? new NeverType();
+		}
+
+		return null;
+	}
+
 }
diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -22,6 +22,7 @@
 use PHPStan\Type\Generic\TemplateType;
 use PHPStan\Type\Generic\TemplateTypeMap;
 use PHPStan\Type\Generic\TemplateTypeVariance;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use function array_map;
 use function count;
 use function implode;
@@ -34,6 +35,8 @@
 class IntersectionType implements CompoundType
 {
 
+	use NonRemoveableTypeTrait;
+
 	/** @var Type[] */
 	private array $types;
 

diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -4,6 +4,7 @@
 
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Constant\ConstantArrayType;
+use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\Generic\TemplateMixedType;
 use PHPStan\Type\Generic\TemplateType;
 use PHPStan\Type\Generic\TemplateTypeMap;
@@ -278,6 +279,24 @@ public function traverse(callable $cb): Type
 		return $this;
 	}
 
+	public function tryRemove(Type $typeToRemove): ?Type
+	{
+		$arrayType = new ArrayType(new MixedType(), new MixedType());
+		if ($typeToRemove->isSuperTypeOf($arrayType)->yes()) {
+			return new GenericObjectType(Traversable::class, [
+				$this->getIterableKeyType(),
+				$this->getIterableValueType(),
+			]);
+		}
+
+		$traversableType = new ObjectType(Traversable::class);
+		if ($typeToRemove->isSuperTypeOf($traversableType)->yes()) {
+			return new ArrayType($this->getIterableKeyType(), $this->getIterableValueType());
+		}
+
+		return null;
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -420,6 +420,15 @@ public function isLiteralString(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function tryRemove(Type $typeToRemove): ?Type
+	{
+		if ($this->isSuperTypeOf($typeToRemove)->yes()) {
+			return $this->subtract($typeToRemove);
+		}
+
+		return null;
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -13,6 +13,7 @@
 use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Traits\NonGenericTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\UndecidedBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
 
@@ -23,6 +24,7 @@ class NeverType implements CompoundType
 	use UndecidedBooleanTypeTrait;
 	use NonGenericTypeTrait;
 	use UndecidedComparisonCompoundTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct(private bool $isExplicit = false)

diff --git a/src/Type/NonexistentParentClassType.php b/src/Type/NonexistentParentClassType.php
@@ -14,6 +14,7 @@
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonIterableTypeTrait;
 use PHPStan\Type\Traits\NonOffsetAccessibleTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 use PHPStan\Type\Traits\TruthyBooleanTypeTrait;
 use PHPStan\Type\Traits\UndecidedComparisonTypeTrait;
 
@@ -27,6 +28,7 @@ class NonexistentParentClassType implements Type
 	use TruthyBooleanTypeTrait;
 	use NonGenericTypeTrait;
 	use UndecidedComparisonTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	public function describe(VerbosityLevel $level): string
 	{

diff --git a/src/Type/NullType.php b/src/Type/NullType.php
@@ -13,6 +13,7 @@
 use PHPStan\Type\Traits\NonGenericTypeTrait;
 use PHPStan\Type\Traits\NonIterableTypeTrait;
 use PHPStan\Type\Traits\NonObjectTypeTrait;
+use PHPStan\Type\Traits\NonRemoveableTypeTrait;
 
 /** @api */
 class NullType implements ConstantScalarType
@@ -23,6 +24,7 @@ class NullType implements ConstantScalarType
 	use NonObjectTypeTrait;
 	use FalseyBooleanTypeTrait;
 	use NonGenericTypeTrait;
+	use NonRemoveableTypeTrait;
 
 	/** @api */
 	public function __construct()