Narrow types

sebastianbergmann · sebastianbergmann · commit 921ca7c95d44 · 2024-10-30T07:07:47.000+01:00
diff --git a/src/Framework/Constraint/Type/IsType.php b/src/Framework/Constraint/Type/IsType.php
@@ -28,75 +28,24 @@
  */
 final class IsType extends Constraint
 {
-    /**
-     * @var string
-     */
-    public const TYPE_ARRAY = 'array';
-
-    /**
-     * @var string
-     */
-    public const TYPE_BOOL = 'bool';
-
-    /**
-     * @var string
-     */
-    public const TYPE_FLOAT = 'float';
-
-    /**
-     * @var string
-     */
-    public const TYPE_INT = 'int';
-
-    /**
-     * @var string
-     */
-    public const TYPE_NULL = 'null';
-
-    /**
-     * @var string
-     */
-    public const TYPE_NUMERIC = 'numeric';
-
-    /**
-     * @var string
-     */
-    public const TYPE_OBJECT = 'object';
-
-    /**
-     * @var string
-     */
-    public const TYPE_RESOURCE = 'resource';
-
-    /**
-     * @var string
-     */
-    public const TYPE_CLOSED_RESOURCE = 'resource (closed)';
-
-    /**
-     * @var string
-     */
-    public const TYPE_STRING = 'string';
-
-    /**
-     * @var string
-     */
-    public const TYPE_SCALAR = 'scalar';
-
-    /**
-     * @var string
-     */
-    public const TYPE_CALLABLE = 'callable';
-
-    /**
-     * @var string
-     */
-    public const TYPE_ITERABLE = 'iterable';
-
-    /**
-     * @var array<string,bool>
-     */
-    private const KNOWN_TYPES = [
+    public const string TYPE_ARRAY           = 'array';
+    public const string TYPE_BOOL            = 'bool';
+    public const string TYPE_FLOAT           = 'float';
+    public const string TYPE_INT             = 'int';
+    public const string TYPE_NULL            = 'null';
+    public const string TYPE_NUMERIC         = 'numeric';
+    public const string TYPE_OBJECT          = 'object';
+    public const string TYPE_RESOURCE        = 'resource';
+    public const string TYPE_CLOSED_RESOURCE = 'resource (closed)';
+    public const string TYPE_STRING          = 'string';
+    public const string TYPE_SCALAR          = 'scalar';
+    public const string TYPE_CALLABLE        = 'callable';
+    public const string TYPE_ITERABLE        = 'iterable';
+
+    /**
+     * @var non-empty-array<non-empty-string, bool>
+     */
+    private const array KNOWN_TYPES = [
         'array'             => true,
         'boolean'           => true,
         'bool'              => true,
diff --git a/src/Framework/MockObject/Generator/Generator.php b/src/Framework/MockObject/Generator/Generator.php
@@ -64,9 +64,9 @@ final class Generator
     use TemplateLoader;
 
     /**
-     * @var array<non-empty-string, true>
+     * @var non-empty-array<non-empty-string, true>
      */
-    private const EXCLUDED_METHOD_NAMES = [
+    private const array EXCLUDED_METHOD_NAMES = [
         '__CLASS__'       => true,
         '__DIR__'         => true,
         '__FILE__'        => true,
diff --git a/src/Logging/TestDox/HtmlRenderer.php b/src/Logging/TestDox/HtmlRenderer.php
@@ -18,10 +18,7 @@
  */
 final readonly class HtmlRenderer
 {
-    /**
-     * @var string
-     */
-    private const PAGE_HEADER = <<<'EOT'
+    private const string PAGE_HEADER = <<<'EOT'
 <!doctype html>
 <html lang="en">
     <head>
@@ -76,28 +73,16 @@
     </head>
     <body>
 EOT;
-
-    /**
-     * @var string
-     */
-    private const CLASS_HEADER = <<<'EOT'
+    private const string CLASS_HEADER = <<<'EOT'
 
         <h2>%s</h2>
         <ul>
 
 EOT;
-
-    /**
-     * @var string
-     */
-    private const CLASS_FOOTER = <<<'EOT'
+    private const string CLASS_FOOTER = <<<'EOT'
         </ul>
 EOT;
-
-    /**
-     * @var string
-     */
-    private const PAGE_FOOTER = <<<'EOT'
+    private const string PAGE_FOOTER = <<<'EOT'
 
     </body>
 </html>
diff --git a/src/Runner/Baseline/Baseline.php b/src/Runner/Baseline/Baseline.php
@@ -16,7 +16,7 @@
  */
 final class Baseline
 {
-    public const VERSION = 1;
+    public const int VERSION = 1;
 
     /**
      * @var array<non-empty-string, array<positive-int, list<Issue>>>
diff --git a/src/Runner/ResultCache/DefaultResultCache.php b/src/Runner/ResultCache/DefaultResultCache.php
@@ -33,15 +33,8 @@
  */
 final class DefaultResultCache implements ResultCache
 {
-    /**
-     * @var int
-     */
-    private const VERSION = 1;
-
-    /**
-     * @var string
-     */
-    private const DEFAULT_RESULT_CACHE_FILENAME = '.phpunit.result.cache';
+    private const int VERSION                          = 1;
+    private const string DEFAULT_RESULT_CACHE_FILENAME = '.phpunit.result.cache';
     private readonly string $cacheFilename;
 
     /**
diff --git a/src/Runner/TestSuiteSorter.php b/src/Runner/TestSuiteSorter.php
@@ -33,37 +33,17 @@
  */
 final class TestSuiteSorter
 {
-    /**
-     * @var int
-     */
-    public const ORDER_DEFAULT = 0;
-
-    /**
-     * @var int
-     */
-    public const ORDER_RANDOMIZED = 1;
-
-    /**
-     * @var int
-     */
-    public const ORDER_REVERSED = 2;
+    public const int ORDER_DEFAULT       = 0;
+    public const int ORDER_RANDOMIZED    = 1;
+    public const int ORDER_REVERSED      = 2;
+    public const int ORDER_DEFECTS_FIRST = 3;
+    public const int ORDER_DURATION      = 4;
+    public const int ORDER_SIZE          = 5;
 
     /**
-     * @var int
+     * @var non-empty-array<non-empty-string, positive-int>
      */
-    public const ORDER_DEFECTS_FIRST = 3;
-
-    /**
-     * @var int
-     */
-    public const ORDER_DURATION = 4;
-
-    /**
-     * @var int
-     */
-    public const ORDER_SIZE = 5;
-
-    private const SIZE_SORT_WEIGHT = [
+    private const array SIZE_SORT_WEIGHT = [
         'small'   => 1,
         'medium'  => 2,
         'large'   => 3,
diff --git a/src/TextUI/Command/Result.php b/src/TextUI/Command/Result.php
@@ -18,10 +18,10 @@
  */
 final readonly class Result
 {
-    public const SUCCESS   = 0;
-    public const FAILURE   = 1;
-    public const EXCEPTION = 2;
-    public const CRASH     = 255;
+    public const int SUCCESS   = 0;
+    public const int FAILURE   = 1;
+    public const int EXCEPTION = 2;
+    public const int CRASH     = 255;
     private string $output;
     private int $shellExitCode;
 
diff --git a/src/TextUI/Configuration/Cli/Builder.php b/src/TextUI/Configuration/Cli/Builder.php
@@ -31,7 +31,10 @@
  */
 final class Builder
 {
-    private const LONG_OPTIONS = [
+    /**
+     * @var non-empty-list<non-empty-string>
+     */
+    private const array LONG_OPTIONS = [
         'atleast-version=',
         'bootstrap=',
         'cache-result',
@@ -137,7 +140,8 @@ final class Builder
         'debug',
         'extension=',
     ];
-    private const SHORT_OPTIONS = 'd:c:h';
+
+    private const string SHORT_OPTIONS = 'd:c:h';
 
     /**
      * @var array<string, non-negative-int>
diff --git a/src/TextUI/Configuration/Configuration.php b/src/TextUI/Configuration/Configuration.php
@@ -16,10 +16,10 @@
  */
 final readonly class Configuration
 {
-    public const COLOR_NEVER   = 'never';
-    public const COLOR_AUTO    = 'auto';
-    public const COLOR_ALWAYS  = 'always';
-    public const COLOR_DEFAULT = self::COLOR_NEVER;
+    public const string COLOR_NEVER   = 'never';
+    public const string COLOR_AUTO    = 'auto';
+    public const string COLOR_ALWAYS  = 'always';
+    public const string COLOR_DEFAULT = self::COLOR_NEVER;
 
     /**
      * @var list<non-empty-string>
diff --git a/src/TextUI/Configuration/Xml/Generator.php b/src/TextUI/Configuration/Xml/Generator.php
@@ -21,7 +21,7 @@
     /**
      * @var string
      */
-    private const TEMPLATE = <<<'EOT'
+    private const string TEMPLATE = <<<'EOT'
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="{schema_location}"
diff --git a/src/TextUI/Configuration/Xml/Migration/MigrationBuilder.php b/src/TextUI/Configuration/Xml/Migration/MigrationBuilder.php
@@ -18,7 +18,10 @@
  */
 final readonly class MigrationBuilder
 {
-    private const AVAILABLE_MIGRATIONS = [
+    /**
+     * @var non-empty-array<non-empty-string, non-empty-list<class-string>>
+     */
+    private const array AVAILABLE_MIGRATIONS = [
         '8.5' => [
             RemoveLogTypes::class,
         ],
diff --git a/src/TextUI/Configuration/Xml/Migration/Migrations/UpdateSchemaLocation.php b/src/TextUI/Configuration/Xml/Migration/Migrations/UpdateSchemaLocation.php
@@ -22,8 +22,8 @@
  */
 final readonly class UpdateSchemaLocation implements Migration
 {
-    private const NAMESPACE_URI              = 'http://www.w3.org/2001/XMLSchema-instance';
-    private const LOCAL_NAME_SCHEMA_LOCATION = 'noNamespaceSchemaLocation';
+    private const string NAMESPACE_URI              = 'http://www.w3.org/2001/XMLSchema-instance';
+    private const string LOCAL_NAME_SCHEMA_LOCATION = 'noNamespaceSchemaLocation';
 
     public function migrate(DOMDocument $document): void
     {
diff --git a/src/TextUI/Help.php b/src/TextUI/Help.php
@@ -29,7 +29,7 @@
  */
 final class Help
 {
-    private const LEFT_MARGIN              = '  ';
+    private const string LEFT_MARGIN       = '  ';
     private int $lengthOfLongestOptionName = 0;
     private readonly int $columnsAvailableForDescription;
     private ?bool $hasColor;
diff --git a/src/TextUI/ShellExitCodeCalculator.php b/src/TextUI/ShellExitCodeCalculator.php
@@ -18,9 +18,9 @@
  */
 final readonly class ShellExitCodeCalculator
 {
-    private const SUCCESS_EXIT   = 0;
-    private const FAILURE_EXIT   = 1;
-    private const EXCEPTION_EXIT = 2;
+    private const int SUCCESS_EXIT   = 0;
+    private const int FAILURE_EXIT   = 1;
+    private const int EXCEPTION_EXIT = 2;
 
     public function calculate(bool $failOnDeprecation, bool $failOnPhpunitDeprecation, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, TestResult $result): int
     {
diff --git a/src/Util/Color.php b/src/Util/Color.php
@@ -34,27 +34,27 @@
 final class Color
 {
     /**
-     * @var array<string,string>
+     * @var non-empty-array<non-empty-string, non-empty-string>
      */
-    private const WHITESPACE_MAP = [
+    private const array WHITESPACE_MAP = [
         ' '  => '·',
         "\t" => '⇥',
     ];
 
     /**
-     * @var array<string,string>
+     * @var non-empty-array<non-empty-string, non-empty-string>
      */
-    private const WHITESPACE_EOL_MAP = [
+    private const array WHITESPACE_EOL_MAP = [
         ' '  => '·',
         "\t" => '⇥',
         "\n" => '↵',
         "\r" => '⟵',
     ];
 
     /**
-     * @var array<string,string>
+     * @var non-empty-array<non-empty-string, non-empty-string>
      */
-    private static array $ansiCodes = [
+    private const array ANSI_CODES = [
         'reset'      => '0',
         'bold'       => '1',
         'dim'        => '2',
@@ -90,8 +90,8 @@ public static function colorize(string $color, string $buffer): string
         $styles = [];
 
         foreach ($codes as $code) {
-            if (isset(self::$ansiCodes[$code])) {
-                $styles[] = self::$ansiCodes[$code];
+            if (isset(self::ANSI_CODES[$code])) {
+                $styles[] = self::ANSI_CODES[$code];
             }
         }
 
diff --git a/src/Util/ExcludeList.php b/src/Util/ExcludeList.php
@@ -53,9 +53,9 @@
 final class ExcludeList
 {
     /**
-     * @var array<string,int>
+     * @var non-empty-array<class-string, positive-int>
      */
-    private const EXCLUDED_CLASS_NAMES = [
+    private const array EXCLUDED_CLASS_NAMES = [
         // composer
         ClassLoader::class => 1,
 
diff --git a/src/Util/GlobalState.php b/src/Util/GlobalState.php
diff --git a/tests/end-to-end/regression/2724/SeparateClassRunMethodInNewProcessTest.php b/tests/end-to-end/regression/2724/SeparateClassRunMethodInNewProcessTest.php
diff --git a/tests/end-to-end/regression/5287/C/MyClassTest.php b/tests/end-to-end/regression/5287/C/MyClassTest.php
diff --git a/tests/unit/Runner/TestSuiteSorterTest.php b/tests/unit/Runner/TestSuiteSorterTest.php

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*/`
`17`	`17`	`final class Baseline`
`18`	`18`	`{`
`19`		`- public const VERSION = 1;`
	`19`	`+ public const int VERSION = 1;`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* @var array<non-empty-string, array<positive-int, list<Issue>>>`