array to list types

juliangut · Mar 5, 2024 · cac3cc7 · cac3cc7
1 parent 044c5d5
commit cac3cc7
Show file tree

Hide file tree

Showing 17 changed files with 34 additions and 27 deletions.
diff --git a/composer.json b/composer.json
@@ -37,8 +37,8 @@
     "ext-simplexml": "*",
     "doctrine/annotations": "^2.0",
     "infection/infection": "~0.25|~0.27",
-    "juliangut/easy-coding-standard-config": "^1.14",
-    "juliangut/phpstan-config": "^1.1",
+    "juliangut/easy-coding-standard-config": "^1.15",
+    "juliangut/phpstan-config": "^1.2",
     "overtrue/phplint": "^9.0",
     "phpcompatibility/php-compatibility": "^9.3",
     "phpmd/phpmd": "^2.14",

diff --git a/src/Annotation/AbstractAnnotation.php b/src/Annotation/AbstractAnnotation.php
@@ -63,7 +63,7 @@ public function __construct($parameters)
      *
      * @throws AnnotationException
      *
-     * @return array<string>
+     * @return list<string>
      */
     private function getAnnotationProperties(array $parameters, ?string $defaultProperty): array
     {

diff --git a/src/Driver/AbstractClassDriver.php b/src/Driver/AbstractClassDriver.php
@@ -91,8 +91,8 @@ protected function loadClassFromFile(string $mappingFile): ?string
     /**
      * Traverse token stack in search of next token.
      *
-     * @param array<mixed|array{0: int, 1: string, 2: int}> $tokens
-     * @param array<int>                                    $types
+     * @param list<mixed|array{0: int, 1: string, 2: int}> $tokens
+     * @param list<int>                                    $types
      */
     private function findNextToken(array $tokens, array $types, int $start = 0, ?int $escapePreviousType = null): ?int
     {
@@ -122,7 +122,7 @@ private function findNextToken(array $tokens, array $types, int $start = 0, ?int
     }
 
     /**
-     * @return array<int>
+     * @return list<int>
      */
     private function getValidTokenTypes(): array
     {

diff --git a/src/Driver/AbstractDriverFactory.php b/src/Driver/AbstractDriverFactory.php
@@ -35,7 +35,7 @@ public function getDriver(array $mappingSource): DriverInterface
         }
 
         if (\array_key_exists('type', $mappingSource) && \array_key_exists('path', $mappingSource)) {
-            return $this->getDriverImplementation($mappingSource['type'], array_values((array) $mappingSource['path']));
+            return $this->getDriverImplementation($mappingSource['type'], (array) $mappingSource['path']);
         }
 
         throw new DriverException(

diff --git a/src/Driver/AbstractMappingDriver.php b/src/Driver/AbstractMappingDriver.php
@@ -18,7 +18,7 @@ abstract class AbstractMappingDriver extends AbstractDriver
     /**
      * @throws DriverException
      *
-     * @return array<mixed>
+     * @return array<int|string, mixed>
      */
     protected function getMappingData(): array
     {
@@ -39,15 +39,15 @@ protected function getMappingData(): array
     /**
      * @throws DriverException
      *
-     * @return array<mixed>
+     * @return array<int|string, mixed>
      */
     abstract protected function loadMappingFile(string $mappingFile): array;
 
     /**
-     * @param array<mixed> $mappingsA
-     * @param array<mixed> $mappingsB
+     * @param array<int|string, mixed|array<int|string, mixed>> $mappingsA
+     * @param array<int|string, mixed|array<int|string, mixed>> $mappingsB
      *
-     * @return array<mixed>
+     * @return array<int|string, mixed>
      */
     final protected function mergeMappings(array $mappingsA, array $mappingsB): array
     {
@@ -56,7 +56,10 @@ final protected function mergeMappings(array $mappingsA, array $mappingsB): arra
                 if (\is_int($key)) {
                     $mappingsA[] = $value;
                 } elseif (\is_array($value) && \is_array($mappingsA[$key])) {
-                    $mappingsA[$key] = $this->mergeMappings($mappingsA[$key], $value);
+                    /** @var array<int|string, mixed> $valueA */
+                    $valueA = $mappingsA[$key];
+                    /** @var array<int|string, mixed> $value */
+                    $mappingsA[$key] = $this->mergeMappings($valueA, $value);
                 } else {
                     $mappingsA[$key] = $value;
                 }

diff --git a/src/Driver/Locator/FileLocator.php b/src/Driver/Locator/FileLocator.php
@@ -31,7 +31,7 @@ public function __construct(
     ) {}
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getPaths(): array
     {
@@ -41,7 +41,7 @@ public function getPaths(): array
     /**
      * Get supported file extensions.
      *
-     * @return array<string>
+     * @return list<string>
      */
     public function getExtensions(): array
     {
@@ -51,7 +51,7 @@ public function getExtensions(): array
     /**
      * @throws DriverException
      *
-     * @return array<string>
+     * @return list<string>
      */
     public function getMappingFiles(): array
     {
@@ -71,7 +71,7 @@ public function getMappingFiles(): array
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     protected function getFilesFromDirectory(string $mappingDirectory): array
     {
@@ -81,7 +81,7 @@ protected function getFilesFromDirectory(string $mappingDirectory): array
         $recursiveIterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($mappingDirectory));
         $regexIterator = new RegexIterator($recursiveIterator, $filePattern, RecursiveRegexIterator::GET_MATCH);
 
-        /** @var array<string> $mappingFile */
+        /** @var list<string> $mappingFile */
         foreach ($regexIterator as $mappingFile) {
             $mappingPaths[] = $mappingFile[0];
         }

diff --git a/src/Driver/Traits/JsonMappingTrait.php b/src/Driver/Traits/JsonMappingTrait.php
@@ -47,6 +47,7 @@ protected function loadMappingFile(string $mappingFile): array
             throw new DriverException(sprintf('Malformed XML mapping file "%s".', $mappingFile), 0);
         }
 
+        /** @var array<int|string, mixed> $mappings */
         return $mappings;
     }
 }
diff --git a/src/Driver/Traits/PhpMappingTrait.php b/src/Driver/Traits/PhpMappingTrait.php
@@ -28,6 +28,7 @@ protected function loadMappingFile(string $mappingFile): array
             throw new DriverException(sprintf('Malformed XML mapping file "%s".', $mappingFile), 0);
         }
 
+        /** @var array<int|string, mixed> $mappings */
         return $mappings;
     }
 }
diff --git a/src/Driver/Traits/XmlMappingTrait.php b/src/Driver/Traits/XmlMappingTrait.php
@@ -84,6 +84,7 @@ protected function loadMappingFile(string $mappingFile): array
             throw new DriverException(sprintf('Malformed XML mapping file "%s".', $mappingFile), 0);
         }
 
+        /** @var array<int|string, mixed> $mappings */
         return $mappings;
     }
 

diff --git a/src/Driver/Traits/YamlMappingTrait.php b/src/Driver/Traits/YamlMappingTrait.php
@@ -51,6 +51,7 @@ protected function loadMappingFile(string $mappingFile): array
             throw new DriverException(sprintf('Malformed YAML mapping file "%s".', $mappingFile), 0);
         }
 
+        /** @var array<int|string, mixed> $mappings */
         return $mappings;
     }
 }
diff --git a/src/Metadata/MetadataResolver.php b/src/Metadata/MetadataResolver.php
@@ -104,7 +104,7 @@ static function (string $key, array $mappingSource): string {
      */
     protected function normalizeMappingSources(array $mappingSources): array
     {
-        return array_values(array_map(
+        return array_map(
             static function ($mappingSource): array {
                 if (\is_array($mappingSource) && \array_key_exists('driver', $mappingSource)) {
                     return ['driver' => $mappingSource['driver']];
@@ -120,6 +120,6 @@ static function ($mappingSource): array {
                 return $mappingSource;
             },
             $mappingSources,
-        ));
+        );
     }
 }
diff --git a/tests/Mapping/Stubs/AbstractAnnotationDriverStub.php b/tests/Mapping/Stubs/AbstractAnnotationDriverStub.php
@@ -20,7 +20,7 @@
 class AbstractAnnotationDriverStub extends AbstractAnnotationDriver
 {
     /**
-     * @return array<ReflectionClass<object>>
+     * @return list<ReflectionClass<object>>
      */
     public function extractMappingClasses(): array
     {
@@ -33,7 +33,7 @@ public function getMetadata(): array
     }
 
     /**
-     * @return array<mixed>
+     * @return list<mixed>
      */
     public function getAnnotations(): array
     {

diff --git a/tests/Mapping/Stubs/AbstractAttributeDriverStub.php b/tests/Mapping/Stubs/AbstractAttributeDriverStub.php
@@ -20,7 +20,7 @@
 class AbstractAttributeDriverStub extends AbstractClassDriver
 {
     /**
-     * @return array<ReflectionClass<object>>
+     * @return list<ReflectionClass<object>>
      */
     public function extractMappingClasses(): array
     {

diff --git a/tests/Mapping/Stubs/AbstractClassDriverStub.php b/tests/Mapping/Stubs/AbstractClassDriverStub.php
@@ -22,7 +22,7 @@ class AbstractClassDriverStub extends AbstractClassDriver
     /**
      * Get mapped metadata.
      *
-     * @return array<MetadataInterface>
+     * @return list<MetadataInterface>
      */
     public function getMetadata(): array
     {

diff --git a/tests/Mapping/Stubs/AbstractMappingDriverStub.php b/tests/Mapping/Stubs/AbstractMappingDriverStub.php
@@ -23,7 +23,7 @@ class AbstractMappingDriverStub extends AbstractMappingDriver
     use PhpMappingTrait;
 
     /**
-     * @return array<ReflectionClass<object>>
+     * @return list<ReflectionClass<object>>
      */
     public function extractMappingData(): array
     {

diff --git a/tests/Mapping/Stubs/JsonMappingDriverStub.php b/tests/Mapping/Stubs/JsonMappingDriverStub.php
@@ -27,7 +27,7 @@ class JsonMappingDriverStub implements DriverInterface
     /**
      * Get supported mapping file extensions.
      *
-     * @return array<string>
+     * @return list<string>
      */
     public function getExtensions(): array
     {

diff --git a/tests/Mapping/Stubs/YamlMappingDriverStub.php b/tests/Mapping/Stubs/YamlMappingDriverStub.php
@@ -27,7 +27,7 @@ class YamlMappingDriverStub implements DriverInterface
     /**
      * Get supported mapping file extensions.
      *
-     * @return array<string>
+     * @return list<string>
      */
     public function getExtensions(): array
     {
-Original file line number
+Diff line change
@@ Expand Up @@
                 throw new DriverException(sprintf('Malformed XML mapping file "%s".', $mappingFile), 0);
             }
+            /** @var array<int|string, mixed> $mappings */
             return $mappings;
         }
@@ Expand Down @@