Narrow types

krchiper · Aug 7, 2023 · e47e419 · e47e419
1 parent b20ce11
commit e47e419
Show file tree

Hide file tree

Showing 45 changed files with 431 additions and 9 deletions.
diff --git a/.psalm/baseline.xml b/.psalm/baseline.xml
@@ -421,9 +421,6 @@
     </RedundantCondition>
   </file>
   <file src="src/Metadata/Api/DataProvider.php">
-    <ArgumentTypeCoercion>
-      <code><![CDATA[$_dataProvider->methodName()]]></code>
-    </ArgumentTypeCoercion>
     <PossiblyInvalidArgument>
       <code><![CDATA[$e->getCode()]]></code>
     </PossiblyInvalidArgument>
@@ -460,12 +457,6 @@
       <code>assert($metadata instanceof RequiresSetting)</code>
     </RedundantCondition>
   </file>
-  <file src="src/Metadata/Metadata.php">
-    <ArgumentTypeCoercion>
-      <code>$className</code>
-      <code>$className</code>
-    </ArgumentTypeCoercion>
-  </file>
   <file src="src/Metadata/MetadataCollection.php">
     <PropertyTypeCoercion>
       <code>$metadata</code>
@@ -512,10 +503,26 @@
       <code>$className</code>
       <code>$className</code>
       <code>$className</code>
+      <code>$className</code>
+      <code>$className</code>
+      <code>$className</code>
+      <code>$function</code>
+      <code>$function</code>
+      <code>$methodName</code>
       <code>$pieces[0]</code>
       <code>$pieces[0]</code>
+      <code>$pieces[1]</code>
+      <code>$pieces[1]</code>
+      <code>$value</code>
+      <code>$value</code>
+      <code>$value</code>
+      <code>$value</code>
+      <code>$value</code>
+      <code>$value</code>
+      <code><![CDATA[explode('::', $value)]]></code>
       <code><![CDATA[explode('::', $value)]]></code>
       <code>trim($tmp[0])</code>
+      <code>trim($tmp[1])</code>
     </ArgumentTypeCoercion>
   </file>
   <file src="src/Metadata/Version/Requirement.php">

diff --git a/src/Metadata/After.php b/src/Metadata/After.php
@@ -16,6 +16,9 @@
  */
 final class After extends Metadata
 {
+    /**
+     * @psalm-assert-if-true After $this
+     */
     public function isAfter(): bool
     {
         return true;

diff --git a/src/Metadata/AfterClass.php b/src/Metadata/AfterClass.php
@@ -16,6 +16,9 @@
  */
 final class AfterClass extends Metadata
 {
+    /**
+     * @psalm-assert-if-true AfterClass $this
+     */
     public function isAfterClass(): bool
     {
         return true;

diff --git a/src/Metadata/BackupGlobals.php b/src/Metadata/BackupGlobals.php
@@ -18,13 +18,19 @@ final class BackupGlobals extends Metadata
 {
     private readonly bool $enabled;
 
+    /**
+     * @psalm-param 0|1 $level
+     */
     protected function __construct(int $level, bool $enabled)
     {
         parent::__construct($level);
 
         $this->enabled = $enabled;
     }
 
+    /**
+     * @psalm-assert-if-true BackupGlobals $this
+     */
     public function isBackupGlobals(): bool
     {
         return true;

diff --git a/src/Metadata/BackupStaticProperties.php b/src/Metadata/BackupStaticProperties.php
@@ -18,13 +18,19 @@ final class BackupStaticProperties extends Metadata
 {
     private readonly bool $enabled;
 
+    /**
+     * @psalm-param 0|1 $level
+     */
     protected function __construct(int $level, bool $enabled)
     {
         parent::__construct($level);
 
         $this->enabled = $enabled;
     }
 
+    /**
+     * @psalm-assert-if-true BackupStaticProperties $this
+     */
     public function isBackupStaticProperties(): bool
     {
         return true;

diff --git a/src/Metadata/Before.php b/src/Metadata/Before.php
@@ -16,6 +16,9 @@
  */
 final class Before extends Metadata
 {
+    /**
+     * @psalm-assert-if-true Before $this
+     */
     public function isBefore(): bool
     {
         return true;

diff --git a/src/Metadata/BeforeClass.php b/src/Metadata/BeforeClass.php
@@ -16,6 +16,9 @@
  */
 final class BeforeClass extends Metadata
 {
+    /**
+     * @psalm-assert-if-true BeforeClass $this
+     */
     public function isBeforeClass(): bool
     {
         return true;

diff --git a/src/Metadata/Covers.php b/src/Metadata/Covers.php
@@ -16,20 +16,33 @@
  */
 final class Covers extends Metadata
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $target;
 
+    /**
+     * @psalm-param 0|1 $level
+     * @psalm-param non-empty-string $target
+     */
     protected function __construct(int $level, string $target)
     {
         parent::__construct($level);
 
         $this->target = $target;
     }
 
+    /**
+     * @psalm-assert-if-true Covers $this
+     */
     public function isCovers(): bool
     {
         return true;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function target(): string
     {
         return $this->target;

diff --git a/src/Metadata/CoversClass.php b/src/Metadata/CoversClass.php
@@ -22,6 +22,7 @@ final class CoversClass extends Metadata
     private readonly string $className;
 
     /**
+     * @psalm-param 0|1 $level
      * @psalm-param class-string $className
      */
     protected function __construct(int $level, string $className)
@@ -31,6 +32,9 @@ protected function __construct(int $level, string $className)
         $this->className = $className;
     }
 
+    /**
+     * @psalm-assert-if-true CoversClass $this
+     */
     public function isCoversClass(): bool
     {
         return true;

diff --git a/src/Metadata/CoversDefaultClass.php b/src/Metadata/CoversDefaultClass.php
@@ -22,6 +22,7 @@ final class CoversDefaultClass extends Metadata
     private readonly string $className;
 
     /**
+     * @psalm-param 0|1 $level
      * @psalm-param class-string $className
      */
     protected function __construct(int $level, string $className)
@@ -31,6 +32,9 @@ protected function __construct(int $level, string $className)
         $this->className = $className;
     }
 
+    /**
+     * @psalm-assert-if-true CoversDefaultClass $this
+     */
     public function isCoversDefaultClass(): bool
     {
         return true;

diff --git a/src/Metadata/CoversFunction.php b/src/Metadata/CoversFunction.php
@@ -16,20 +16,33 @@
  */
 final class CoversFunction extends Metadata
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $functionName;
 
+    /**
+     * @psalm-param 0|1 $level
+     * @psalm-param non-empty-string $functionName
+     */
     protected function __construct(int $level, string $functionName)
     {
         parent::__construct($level);
 
         $this->functionName = $functionName;
     }
 
+    /**
+     * @psalm-assert-if-true CoversFunction $this
+     */
     public function isCoversFunction(): bool
     {
         return true;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function functionName(): string
     {
         return $this->functionName;

diff --git a/src/Metadata/CoversNothing.php b/src/Metadata/CoversNothing.php
@@ -16,6 +16,9 @@
  */
 final class CoversNothing extends Metadata
 {
+    /**
+     * @psalm-assert-if-true CoversNothing $this
+     */
     public function isCoversNothing(): bool
     {
         return true;

diff --git a/src/Metadata/DataProvider.php b/src/Metadata/DataProvider.php
@@ -20,10 +20,16 @@ final class DataProvider extends Metadata
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
     /**
+     * @psalm-param 0|1 $level
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     protected function __construct(int $level, string $className, string $methodName)
     {
@@ -33,6 +39,9 @@ protected function __construct(int $level, string $className, string $methodName
         $this->methodName = $methodName;
     }
 
+    /**
+     * @psalm-assert-if-true DataProvider $this
+     */
     public function isDataProvider(): bool
     {
         return true;
@@ -46,6 +55,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Metadata/DependsOnClass.php b/src/Metadata/DependsOnClass.php
@@ -24,6 +24,7 @@ final class DependsOnClass extends Metadata
     private readonly bool $shallowClone;
 
     /**
+     * @psalm-param 0|1 $level
      * @psalm-param class-string $className
      */
     protected function __construct(int $level, string $className, bool $deepClone, bool $shallowClone)
@@ -35,6 +36,9 @@ protected function __construct(int $level, string $className, bool $deepClone, b
         $this->shallowClone = $shallowClone;
     }
 
+    /**
+     * @psalm-assert-if-true DependsOnClass $this
+     */
     public function isDependsOnClass(): bool
     {
         return true;

diff --git a/src/Metadata/DependsOnMethod.php b/src/Metadata/DependsOnMethod.php
@@ -20,12 +20,18 @@ final class DependsOnMethod extends Metadata
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
     private readonly bool $deepClone;
     private readonly bool $shallowClone;
 
     /**
+     * @psalm-param 0|1 $level
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     protected function __construct(int $level, string $className, string $methodName, bool $deepClone, bool $shallowClone)
     {
@@ -37,6 +43,9 @@ protected function __construct(int $level, string $className, string $methodName
         $this->shallowClone = $shallowClone;
     }
 
+    /**
+     * @psalm-assert-if-true DependsOnMethod $this
+     */
     public function isDependsOnMethod(): bool
     {
         return true;
@@ -50,6 +59,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Metadata/DoesNotPerformAssertions.php b/src/Metadata/DoesNotPerformAssertions.php
@@ -16,6 +16,9 @@
  */
 final class DoesNotPerformAssertions extends Metadata
 {
+    /**
+     * @psalm-assert-if-true DoesNotPerformAssertions $this
+     */
     public function isDoesNotPerformAssertions(): bool
     {
         return true;

diff --git a/src/Metadata/ExcludeGlobalVariableFromBackup.php b/src/Metadata/ExcludeGlobalVariableFromBackup.php
@@ -16,20 +16,33 @@
  */
 final class ExcludeGlobalVariableFromBackup extends Metadata
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $globalVariableName;
 
+    /**
+     * @psalm-param 0|1 $level
+     * @psalm-param non-empty-string $globalVariableName
+     */
     protected function __construct(int $level, string $globalVariableName)
     {
         parent::__construct($level);
 
         $this->globalVariableName = $globalVariableName;
     }
 
+    /**
+     * @psalm-assert-if-true ExcludeGlobalVariableFromBackup $this
+     */
     public function isExcludeGlobalVariableFromBackup(): bool
     {
         return true;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function globalVariableName(): string
     {
         return $this->globalVariableName;