Merge pull request #7473 from orklah/intrange2

remove TPositiveInt

UPGRADING.md

@@ -1,126 +1,127 @@
 # Upgrading from Psalm 4 to Psalm 5
 ## Changed
- - [BC] The parameter `$php_version` of `Psalm\Type\Atomic::create()` renamed
-   to `$analysis_php_version_id` and changed from `array|null` to `int|null`.
-   Previously it accepted PHP version as `array{major_version, minor_version}`
-   while now it accepts version ID, similar to how [`PHP_VERSION_ID` is
-   calculated](https://www.php.net/manual/en/reserved.constants.php#constant.php-version-id).
+- [BC] TPositiveInt has been removed and replaced by TIntRange
 
- - [BC] The parameter `$php_version` of `Psalm\Type::parseString()` renamed to
-   `$analysis_php_version_id` and changed from `array|null` to `int|null`.
-   Previously it accepted PHP version as `array{major_version, minor_version}`
-   while now it accepts version ID.
+- [BC] The parameter `$php_version` of `Psalm\Type\Atomic::create()` renamed
+  to `$analysis_php_version_id` and changed from `array|null` to `int|null`.
+  Previously it accepted PHP version as `array{major_version, minor_version}`
+  while now it accepts version ID, similar to how [`PHP_VERSION_ID` is
+  calculated](https://www.php.net/manual/en/reserved.constants.php#constant.php-version-id).
 
- - [BC] Parameter 0 of `canBeFullyExpressedInPhp()` of the classes listed below
-   changed name from `php_major_version` to `analysis_php_version_id`.
-   Previously it accepted major PHP version as int (e.g. `7`), while now it
-   accepts version ID. Classes affected:
-    - `Psalm\Type\Atomic`
-    - `Psalm\Type\Atomic\Scalar`
-    - `Psalm\Type\Atomic\TArray`
-    - `Psalm\Type\Atomic\TArrayKey`
-    - `Psalm\Type\Atomic\TCallable`
-    - `Psalm\Type\Atomic\TCallableObject`
-    - `Psalm\Type\Atomic\TCallableString`
-    - `Psalm\Type\Atomic\TClassConstant`
-    - `Psalm\Type\Atomic\TClassString`
-    - `Psalm\Type\Atomic\TClassStringMap`
-    - `Psalm\Type\Atomic\TClosedResource`
-    - `Psalm\Type\Atomic\TClosure`
-    - `Psalm\Type\Atomic\TConditional`
-    - `Psalm\Type\Atomic\TDependentGetClass`
-    - `Psalm\Type\Atomic\TDependentGetDebugType`
-    - `Psalm\Type\Atomic\TDependentGetType`
-    - `Psalm\Type\Atomic\TDependentListKey`
-    - `Psalm\Type\Atomic\TEnumCase`
-    - `Psalm\Type\Atomic\TFalse`
-    - `Psalm\Type\Atomic\TGenericObject`
-    - `Psalm\Type\Atomic\TIntMask`
-    - `Psalm\Type\Atomic\TIntMaskOf`
-    - `Psalm\Type\Atomic\TIntRange`
-    - `Psalm\Type\Atomic\TIterable`
-    - `Psalm\Type\Atomic\TKeyedArray`
-    - `Psalm\Type\Atomic\TKeyOfClassConstant`
-    - `Psalm\Type\Atomic\TList`
-    - `Psalm\Type\Atomic\TLiteralClassString`
-    - `Psalm\Type\Atomic\TLowercaseString`
-    - `Psalm\Type\Atomic\TMixed`
-    - `Psalm\Type\Atomic\TNamedObject`
-    - `Psalm\Type\Atomic\TNever`
-    - `Psalm\Type\Atomic\TNonEmptyLowercaseString`
-    - `Psalm\Type\Atomic\TNonspecificLiteralInt`
-    - `Psalm\Type\Atomic\TNonspecificLiteralString`
-    - `Psalm\Type\Atomic\TNull`
-    - `Psalm\Type\Atomic\TNumeric`
-    - `Psalm\Type\Atomic\TNumericString`
-    - `Psalm\Type\Atomic\TObject`
-    - `Psalm\Type\Atomic\TObjectWithProperties`
-    - `Psalm\Type\Atomic\TPositiveInt`
-    - `Psalm\Type\Atomic\TResource`
-    - `Psalm\Type\Atomic\TScalar`
-    - `Psalm\Type\Atomic\TTemplateIndexedAccess`
-    - `Psalm\Type\Atomic\TTemplateParam`
-    - `Psalm\Type\Atomic\TTraitString`
-    - `Psalm\Type\Atomic\TTrue`
-    - `Psalm\Type\Atomic\TTypeAlias`
-    - `Psalm\Type\Atomic\TValueOfClassConstant`
-    - `Psalm\Type\Atomic\TVoid`
-    - `Psalm\Type\Union`
+- [BC] The parameter `$php_version` of `Psalm\Type::parseString()` renamed to
+  `$analysis_php_version_id` and changed from `array|null` to `int|null`.
+  Previously it accepted PHP version as `array{major_version, minor_version}`
+  while now it accepts version ID.
 
- - [BC] Parameter 3 of `toPhpString()` of methods listed below changed name
-   from `php_major_version` to `analysis_php_version_id`. Previously it
-   accepted major PHP version as int (e.g. `7`), while now it accepts version
-   ID. Classes affected:
-    - `Psalm\Type\Atomic`
-    - `Psalm\Type\Atomic\CallableTrait`
-    - `Psalm\Type\Atomic\TAnonymousClassInstance`
-    - `Psalm\Type\Atomic\TArray`
-    - `Psalm\Type\Atomic\TArrayKey`
-    - `Psalm\Type\Atomic\TBool`
-    - `Psalm\Type\Atomic\TCallable`
-    - `Psalm\Type\Atomic\TCallableObject`
-    - `Psalm\Type\Atomic\TClassConstant`
-    - `Psalm\Type\Atomic\TClassString`
-    - `Psalm\Type\Atomic\TClassStringMap`
-    - `Psalm\Type\Atomic\TClosedResource`
-    - `Psalm\Type\Atomic\TConditional`
-    - `Psalm\Type\Atomic\TEmpty`
-    - `Psalm\Type\Atomic\TEnumCase`
-    - `Psalm\Type\Atomic\TFloat`
-    - `Psalm\Type\Atomic\TGenericObject`
-    - `Psalm\Type\Atomic\TInt`
-    - `Psalm\Type\Atomic\TIterable`
-    - `Psalm\Type\Atomic\TKeyedArray`
-    - `Psalm\Type\Atomic\TKeyOfClassConstant`
-    - `Psalm\Type\Atomic\TList`
-    - `Psalm\Type\Atomic\TLiteralClassString`
-    - `Psalm\Type\Atomic\TMixed`
-    - `Psalm\Type\Atomic\TNamedObject`
-    - `Psalm\Type\Atomic\TNever`
-    - `Psalm\Type\Atomic\TNull`
-    - `Psalm\Type\Atomic\TNumeric`
-    - `Psalm\Type\Atomic\TObject`
-    - `Psalm\Type\Atomic\TObjectWithProperties`
-    - `Psalm\Type\Atomic\TResource`
-    - `Psalm\Type\Atomic\TScalar`
-    - `Psalm\Type\Atomic\TString`
-    - `Psalm\Type\Atomic\TTemplateIndexedAccess`
-    - `Psalm\Type\Atomic\TTemplateParam`
-    - `Psalm\Type\Atomic\TTraitString`
-    - `Psalm\Type\Atomic\TTypeAlias`
-    - `Psalm\Type\Atomic\TValueOfClassConstant`
-    - `Psalm\Type\Atomic\TVoid`
-    - `Psalm\Type\Union`
- - While not a BC break per se, all classes / interfaces / traits / enums under
-   `Psalm\Internal` namespace are now marked `@internal`.
- - [BC] Parameter 1 of `Psalm\Type\Atomic\TNamedObject::__construct()` changed name from `was_static` to `is_static`
- - [BC] Parameter 1 of `Psalm\Type\Atomic\TAnonymousClassInstance::__construct()` changed name from `was_static` to `is_static`
- - [BC] Parameter 5 of `Psalm\Type::getStringFromFQCLN()` changed name from `was_static` to `is_static`
- - [BC] Property `Psalm\Type\Atomic\TNamedObject::$was_static` was renamed to `$is_static`
- - [BC] Method `Psalm\Type\Union::isFormerStaticObject()` was renamed to `isStaticObject()`
- - [BC] Method `Psalm\Type\Union::hasFormerStaticObject()` was renamed to `hasStaticObject()`
- - [BC] Function assertions (from `@psalm-assert Foo $bar`) have been converted from strings to specific `Assertion` objects.
- - [BC] Property `Psalm\Storage\ClassLikeStorage::$invalid_dependencies` changed from `array<string>` to `array<string, true>`.
+- [BC] Parameter 0 of `canBeFullyExpressedInPhp()` of the classes listed below
+  changed name from `php_major_version` to `analysis_php_version_id`.
+  Previously it accepted major PHP version as int (e.g. `7`), while now it
+  accepts version ID. Classes affected:
+   - `Psalm\Type\Atomic`
+   - `Psalm\Type\Atomic\Scalar`
+   - `Psalm\Type\Atomic\TArray`
+   - `Psalm\Type\Atomic\TArrayKey`
+   - `Psalm\Type\Atomic\TCallable`
+   - `Psalm\Type\Atomic\TCallableObject`
+   - `Psalm\Type\Atomic\TCallableString`
+   - `Psalm\Type\Atomic\TClassConstant`
+   - `Psalm\Type\Atomic\TClassString`
+   - `Psalm\Type\Atomic\TClassStringMap`
+   - `Psalm\Type\Atomic\TClosedResource`
+   - `Psalm\Type\Atomic\TClosure`
+   - `Psalm\Type\Atomic\TConditional`
+   - `Psalm\Type\Atomic\TDependentGetClass`
+   - `Psalm\Type\Atomic\TDependentGetDebugType`
+   - `Psalm\Type\Atomic\TDependentGetType`
+   - `Psalm\Type\Atomic\TDependentListKey`
+   - `Psalm\Type\Atomic\TEnumCase`
+   - `Psalm\Type\Atomic\TFalse`
+   - `Psalm\Type\Atomic\TGenericObject`
+   - `Psalm\Type\Atomic\TIntMask`
+   - `Psalm\Type\Atomic\TIntMaskOf`
+   - `Psalm\Type\Atomic\TIntRange`
+   - `Psalm\Type\Atomic\TIterable`
+   - `Psalm\Type\Atomic\TKeyedArray`
+   - `Psalm\Type\Atomic\TKeyOfClassConstant`
+   - `Psalm\Type\Atomic\TList`
+   - `Psalm\Type\Atomic\TLiteralClassString`
+   - `Psalm\Type\Atomic\TLowercaseString`
+   - `Psalm\Type\Atomic\TMixed`
+   - `Psalm\Type\Atomic\TNamedObject`
+   - `Psalm\Type\Atomic\TNever`
+   - `Psalm\Type\Atomic\TNonEmptyLowercaseString`
+   - `Psalm\Type\Atomic\TNonspecificLiteralInt`
+   - `Psalm\Type\Atomic\TNonspecificLiteralString`
+   - `Psalm\Type\Atomic\TNull`
+   - `Psalm\Type\Atomic\TNumeric`
+   - `Psalm\Type\Atomic\TNumericString`
+   - `Psalm\Type\Atomic\TObject`
+   - `Psalm\Type\Atomic\TObjectWithProperties`
+   - `Psalm\Type\Atomic\TResource`
+   - `Psalm\Type\Atomic\TScalar`
+   - `Psalm\Type\Atomic\TTemplateIndexedAccess`
+   - `Psalm\Type\Atomic\TTemplateParam`
+   - `Psalm\Type\Atomic\TTraitString`
+   - `Psalm\Type\Atomic\TTrue`
+   - `Psalm\Type\Atomic\TTypeAlias`
+   - `Psalm\Type\Atomic\TValueOfClassConstant`
+   - `Psalm\Type\Atomic\TVoid`
+   - `Psalm\Type\Union`
+
+- [BC] Parameter 3 of `toPhpString()` of methods listed below changed name
+  from `php_major_version` to `analysis_php_version_id`. Previously it
+  accepted major PHP version as int (e.g. `7`), while now it accepts version
+  ID. Classes affected:
+   - `Psalm\Type\Atomic`
+   - `Psalm\Type\Atomic\CallableTrait`
+   - `Psalm\Type\Atomic\TAnonymousClassInstance`
+   - `Psalm\Type\Atomic\TArray`
+   - `Psalm\Type\Atomic\TArrayKey`
+   - `Psalm\Type\Atomic\TBool`
+   - `Psalm\Type\Atomic\TCallable`
+   - `Psalm\Type\Atomic\TCallableObject`
+   - `Psalm\Type\Atomic\TClassConstant`
+   - `Psalm\Type\Atomic\TClassString`
+   - `Psalm\Type\Atomic\TClassStringMap`
+   - `Psalm\Type\Atomic\TClosedResource`
+   - `Psalm\Type\Atomic\TConditional`
+   - `Psalm\Type\Atomic\TEmpty`
+   - `Psalm\Type\Atomic\TEnumCase`
+   - `Psalm\Type\Atomic\TFloat`
+   - `Psalm\Type\Atomic\TGenericObject`
+   - `Psalm\Type\Atomic\TInt`
+   - `Psalm\Type\Atomic\TIterable`
+   - `Psalm\Type\Atomic\TKeyedArray`
+   - `Psalm\Type\Atomic\TKeyOfClassConstant`
+   - `Psalm\Type\Atomic\TList`
+   - `Psalm\Type\Atomic\TLiteralClassString`
+   - `Psalm\Type\Atomic\TMixed`
+   - `Psalm\Type\Atomic\TNamedObject`
+   - `Psalm\Type\Atomic\TNever`
+   - `Psalm\Type\Atomic\TNull`
+   - `Psalm\Type\Atomic\TNumeric`
+   - `Psalm\Type\Atomic\TObject`
+   - `Psalm\Type\Atomic\TObjectWithProperties`
+   - `Psalm\Type\Atomic\TResource`
+   - `Psalm\Type\Atomic\TScalar`
+   - `Psalm\Type\Atomic\TString`
+   - `Psalm\Type\Atomic\TTemplateIndexedAccess`
+   - `Psalm\Type\Atomic\TTemplateParam`
+   - `Psalm\Type\Atomic\TTraitString`
+   - `Psalm\Type\Atomic\TTypeAlias`
+   - `Psalm\Type\Atomic\TValueOfClassConstant`
+   - `Psalm\Type\Atomic\TVoid`
+   - `Psalm\Type\Union`
+- While not a BC break per se, all classes / interfaces / traits / enums under
+  `Psalm\Internal` namespace are now marked `@internal`.
+- [BC] Parameter 1 of `Psalm\Type\Atomic\TNamedObject::__construct()` changed name from `was_static` to `is_static`
+- [BC] Parameter 1 of `Psalm\Type\Atomic\TAnonymousClassInstance::__construct()` changed name from `was_static` to `is_static`
+- [BC] Parameter 5 of `Psalm\Type::getStringFromFQCLN()` changed name from `was_static` to `is_static`
+- [BC] Property `Psalm\Type\Atomic\TNamedObject::$was_static` was renamed to `$is_static`
+- [BC] Method `Psalm\Type\Union::isFormerStaticObject()` was renamed to `isStaticObject()`
+- [BC] Method `Psalm\Type\Union::hasFormerStaticObject()` was renamed to `hasStaticObject()`
+- [BC] Function assertions (from `@psalm-assert Foo $bar`) have been converted from strings to specific `Assertion` objects.
+- [BC] Property `Psalm\Storage\ClassLikeStorage::$invalid_dependencies` changed from `array<string>` to `array<string, true>`.
 
 ## Removed
  - [BC] Property `Psalm\Codebase::$php_major_version` was removed, use

docs/running_psalm/plugins/plugins_type_system.md

@@ -83,7 +83,7 @@ All scalar types have literal versions e.g. `int` vs `int(5)`.
 
 `TLiteralInt` - is used to represent an integer value where the exact numeric value is known.
 
-`TPositiveInt` - denotes an int that is also positive (strictly > 0)
+`TIntRange` - allows to describe an int with bounded values (ie. `int<1, 5>`).
 
 #### Floats
 

psalm-baseline.xml

@@ -126,12 +126,6 @@
     </PossiblyUndefinedIntArrayOffset>
   </file>
   <file src="src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/ArithmeticOpAnalyzer.php">
-    <DeprecatedClass occurrences="1">
-      <code>new TPositiveInt()</code>
-    </DeprecatedClass>
-    <DeprecatedMethod occurrences="1">
-      <code>Type::getPositiveInt(true)</code>
-    </DeprecatedMethod>
     <PossiblyUndefinedIntArrayOffset occurrences="2">
       <code>$invalid_left_messages[0]</code>
       <code>$invalid_right_messages[0]</code>
@@ -164,13 +158,6 @@
       <code>$stmt-&gt;getArgs()[0]</code>
     </PossiblyUndefinedIntArrayOffset>
   </file>
-  <file src="src/Psalm/Internal/Analyzer/Statements/Expression/Call/FunctionCallReturnTypeFetcher.php">
-    <DeprecatedClass occurrences="3">
-      <code>new TPositiveInt</code>
-      <code>new TPositiveInt</code>
-      <code>new TPositiveInt</code>
-    </DeprecatedClass>
-  </file>
   <file src="src/Psalm/Internal/Analyzer/Statements/Expression/Call/MethodCallAnalyzer.php">
     <PossiblyUndefinedIntArrayOffset occurrences="6">
       <code>$result-&gt;invalid_method_call_types[0]</code>
@@ -328,20 +315,7 @@
       <code>$cs[0]</code>
     </PossiblyUndefinedIntArrayOffset>
   </file>
-  <file src="src/Psalm/Internal/Type/Comparator/IntegerRangeComparator.php">
-    <DeprecatedClass occurrences="1">
-      <code>TPositiveInt::class</code>
-    </DeprecatedClass>
-  </file>
-  <file src="src/Psalm/Internal/Type/Comparator/ScalarTypeComparator.php">
-    <DeprecatedClass occurrences="1">
-      <code>TPositiveInt::class</code>
-    </DeprecatedClass>
-  </file>
   <file src="src/Psalm/Internal/Type/TypeCombiner.php">
-    <DeprecatedClass occurrences="1">
-      <code>new TPositiveInt()</code>
-    </DeprecatedClass>
     <PossiblyUndefinedIntArrayOffset occurrences="6">
       <code>$combination-&gt;array_type_params[1]</code>
       <code>$combination-&gt;array_type_params[1]</code>
@@ -352,9 +326,6 @@
     </PossiblyUndefinedIntArrayOffset>
   </file>
   <file src="src/Psalm/Internal/Type/TypeParser.php">
-    <DeprecatedClass occurrences="1">
-      <code>new TPositiveInt()</code>
-    </DeprecatedClass>
     <PossiblyUndefinedIntArrayOffset occurrences="9">
       <code>$intersection_types[0]</code>
       <code>$parse_tree-&gt;children[0]</code>
@@ -398,11 +369,6 @@
       <code>addFileExtension</code>
     </DeprecatedMethod>
   </file>
-  <file src="src/Psalm/Type.php">
-    <DeprecatedClass occurrences="1">
-      <code>new TPositiveInt()</code>
-    </DeprecatedClass>
-  </file>
   <file src="src/Psalm/Type/Atomic.php">
     <PossiblyUndefinedIntArrayOffset occurrences="1">
       <code>array_keys($template_type_map[$value])[0]</code>

src/Psalm/Internal/Analyzer/Statements/Expression/ArrayAnalyzer.php

@@ -147,7 +147,7 @@ public static function analyze(
                 $array_type = new TList($item_value_type ?? Type::getMixed());
             } else {
                 $array_type = new TNonEmptyList($item_value_type ?? Type::getMixed());
-                /** @psalm-suppress PossiblyInvalidPropertyAssignmentValue */
+                /** @psalm-suppress InvalidPropertyAssignmentValue */
                 $array_type->count = count($array_creation_info->property_types);
             }
 
@@ -235,7 +235,7 @@ public static function analyze(
             $item_value_type ?? Type::getMixed(),
         ]);
 
-        /** @psalm-suppress PossiblyInvalidPropertyAssignmentValue */
+        /** @psalm-suppress InvalidPropertyAssignmentValue */
         $array_type->count = count($array_creation_info->property_types);
 
         $stmt_type = new Union([

src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/ArithmeticOpAnalyzer.php

@@ -40,7 +40,6 @@
 use Psalm\Type\Atomic\TNull;
 use Psalm\Type\Atomic\TNumeric;
 use Psalm\Type\Atomic\TNumericString;
-use Psalm\Type\Atomic\TPositiveInt;
 use Psalm\Type\Atomic\TString;
 use Psalm\Type\Atomic\TTemplateParam;
 use Psalm\Type\Union;
@@ -728,11 +727,11 @@ private static function analyzeOperands(
                 if ($parent instanceof PhpParser\Node\Expr\BinaryOp\Div) {
                     $result_type = new Union([new TInt(), new TFloat()]);
                 } else {
-                    $left_is_positive = $left_type_part instanceof TPositiveInt
-                        || ($left_type_part instanceof TLiteralInt && $left_type_part->value > 0);
+                    $left_is_positive = ($left_type_part instanceof TLiteralInt && $left_type_part->value > 0)
+                        || ($left_type_part instanceof TIntRange && $left_type_part->isPositive());
 
-                    $right_is_positive = $right_type_part instanceof TPositiveInt
-                        || ($right_type_part instanceof TLiteralInt && $right_type_part->value > 0);
+                    $right_is_positive = ($right_type_part instanceof TLiteralInt && $right_type_part->value > 0)
+                        || ($right_type_part instanceof TIntRange && $right_type_part->isPositive());
 
                     if ($parent instanceof PhpParser\Node\Expr\BinaryOp\Minus) {
                         $always_positive = false;
@@ -772,17 +771,14 @@ private static function analyzeOperands(
                             }
                         } else {
                             if ($always_positive) {
-                                $result_type = new Union([
-                                    new TPositiveInt(),
-                                    new TLiteralInt(0)
-                                ]);
+                                $result_type = new Union([new TIntRange(0, null)]);
                             } else {
                                 $result_type = Type::getInt();
                             }
                         }
                     } else {
                         $result_type = Type::combineUnionTypes(
-                            $always_positive ? Type::getPositiveInt(true) : Type::getInt(true),
+                            $always_positive ? new Union([new TIntRange(1, null)]) : Type::getInt(true),
                             $result_type
                         );
                     }