Behat · uuf6429 · Dec 26, 2024 · Dec 26, 2024 · Dec 26, 2024
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -6,6 +6,7 @@
 
 return (new PhpCsFixer\Config())
     ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+    ->setRiskyAllowed(true)
     ->setRules([
         '@PER-CS' => true,
         '@Symfony' => true,
@@ -30,5 +31,7 @@
         'single_line_throw' => false,
         'ternary_to_null_coalescing' => true,
         'global_namespace_import' => false,
+        'phpdoc_array_type' => true,
+        'phpdoc_list_type' => true,
     ])
     ->setFinder($finder);
diff --git a/src/Behat/Gherkin/Filter/PathsFilter.php b/src/Behat/Gherkin/Filter/PathsFilter.php
@@ -25,19 +25,17 @@ class PathsFilter extends SimpleFilter
     /**
      * Initializes filter.
      *
-     * @param string[] $paths List of approved paths
+     * @param array<array-key, string> $paths List of approved paths
      */
     public function __construct(array $paths)
     {
-        $this->filterPaths = array_map(
-            function ($realpath) {
-                return rtrim($realpath, DIRECTORY_SEPARATOR) .
-                    (is_dir($realpath) ? DIRECTORY_SEPARATOR : '');
-            },
-            array_filter(
-                array_map('realpath', $paths)
-            )
-        );
+        foreach ($paths as $path) {
+            if (($realpath = realpath($path)) === false) {
+                continue;
+            }
+            $this->filterPaths[] = rtrim($realpath, DIRECTORY_SEPARATOR)
+                . (is_dir($realpath) ? DIRECTORY_SEPARATOR : '');
+        }
     }
 
     /**

diff --git a/src/Behat/Gherkin/Filter/TagFilter.php b/src/Behat/Gherkin/Filter/TagFilter.php
@@ -128,7 +128,7 @@ public function isScenarioMatch(FeatureNode $feature, ScenarioInterface $scenari
     /**
      * Checks that node matches condition.
      *
-     * @param string[] $tags
+     * @param array<array-key, string> $tags
      *
      * @return bool
      */

diff --git a/src/Behat/Gherkin/Gherkin.php b/src/Behat/Gherkin/Gherkin.php
@@ -31,11 +31,11 @@ class Gherkin
     public const VERSION = '4.8.0';
 
     /**
-     * @var LoaderInterface[]
+     * @var list<LoaderInterface>
      */
     protected $loaders = [];
     /**
-     * @var FeatureFilterInterface[]
+     * @var list<FeatureFilterInterface>
      */
     protected $filters = [];
 
@@ -62,12 +62,12 @@ public function addFilter(FeatureFilterInterface $filter)
     /**
      * Sets filters to the parser.
      *
-     * @param FeatureFilterInterface[] $filters
+     * @param array<array-key, FeatureFilterInterface> $filters
      */
     public function setFilters(array $filters)
     {
         $this->filters = [];
-        array_map([$this, 'addFilter'], $filters);
+        array_map($this->addFilter(...), $filters);
     }
 
     /**
@@ -88,7 +88,7 @@ public function setBasePath($path)
      * Loads & filters resource with added loaders.
      *
      * @param mixed $resource Resource to load
-     * @param FeatureFilterInterface[] $filters Additional filters
+     * @param array<array-key, FeatureFilterInterface> $filters Additional filters
      *
      * @return array
      */
@@ -97,10 +97,10 @@ public function load($resource, array $filters = [])
         $filters = array_merge($this->filters, $filters);
 
         $matches = [];
-        if (preg_match('/^(.*)\:(\d+)-(\d+|\*)$/', $resource, $matches)) {
+        if (preg_match('/^(.*):(\d+)-(\d+|\*)$/', $resource, $matches)) {
             $resource = $matches[1];
             $filters[] = new LineRangeFilter($matches[2], $matches[3]);
-        } elseif (preg_match('/^(.*)\:(\d+)$/', $resource, $matches)) {
+        } elseif (preg_match('/^(.*):(\d+)$/', $resource, $matches)) {
             $resource = $matches[1];
             $filters[] = new LineFilter($matches[2]);
         }

diff --git a/src/Behat/Gherkin/Loader/ArrayLoader.php b/src/Behat/Gherkin/Loader/ArrayLoader.php
@@ -43,7 +43,7 @@ public function supports($resource)
      *
      * @param mixed $resource Resource to load
      *
-     * @return FeatureNode[]
+     * @return list<FeatureNode>
      */
     public function load($resource)
     {
@@ -195,7 +195,7 @@ protected function loadOutlineHash(array $hash, $line = 0)
     /**
      * Loads steps from provided hash.
      *
-     * @return StepNode[]
+     * @return list<StepNode>
      */
     private function loadStepsHash(array $hash)
     {

diff --git a/src/Behat/Gherkin/Loader/CucumberNDJsonAstLoader.php b/src/Behat/Gherkin/Loader/CucumberNDJsonAstLoader.php
@@ -65,18 +65,18 @@ private static function getFeature(array $json, $filePath)
     }
 
     /**
-     * @return string[]
+     * @return list<string>
      */
     private static function getTags(array $json)
     {
         return array_map(
-            static function (array $tag) { return preg_replace('/^@/', '', $tag['name']); },
-            $json['tags'] ?? []
+            static fn (array $tag) => preg_replace('/^@/', '', $tag['name']),
+            array_values($json['tags'] ?? [])
         );
     }
 
     /**
-     * @return ScenarioInterface[]
+     * @return list<ScenarioInterface>
      */
     private static function getScenarios(array $json)
     {
@@ -92,15 +92,15 @@ static function ($child) {
                             $child['scenario']['keyword'],
                             $child['scenario']['location']['line']
                         );
-                    } else {
-                        return new ScenarioNode(
-                            $child['scenario']['name'],
-                            self::getTags($child['scenario']),
-                            self::getSteps($child['scenario']['steps'] ?? []),
-                            $child['scenario']['keyword'],
-                            $child['scenario']['location']['line']
-                        );
                     }
+
+                    return new ScenarioNode(
+                        $child['scenario']['name'],
+                        self::getTags($child['scenario']),
+                        self::getSteps($child['scenario']['steps'] ?? []),
+                        $child['scenario']['keyword'],
+                        $child['scenario']['location']['line']
+                    );
                 },
                 array_filter(
                     $json['children'] ?? [],
@@ -112,75 +112,56 @@ static function ($child) {
         );
     }
 
-    /**
-     * @return BackgroundNode|null
-     */
-    private static function getBackground(array $json)
+    private static function getBackground(array $json): ?BackgroundNode
     {
         $backgrounds = array_values(
             array_map(
-                static function ($child) {
-                    return new BackgroundNode(
-                        $child['background']['name'],
-                        self::getSteps($child['background']['steps'] ?? []),
-                        $child['background']['keyword'],
-                        $child['background']['location']['line']
-                    );
-                },
+                static fn ($child) => new BackgroundNode(
+                    $child['background']['name'],
+                    self::getSteps($child['background']['steps'] ?? []),
+                    $child['background']['keyword'],
+                    $child['background']['location']['line']
+                ),
                 array_filter(
                     $json['children'] ?? [],
-                    static function ($child) {
-                        return isset($child['background']);
-                    }
+                    static fn ($child) => isset($child['background']),
                 )
             )
         );
 
-        return count($backgrounds) == 1 ? $backgrounds[0] : null;
+        return count($backgrounds) === 1 ? $backgrounds[0] : null;
     }
 
     /**
-     * @return StepNode[]
+     * @return list<StepNode>
      */
-    private static function getSteps(array $json)
+    private static function getSteps(array $items): array
     {
         return array_map(
-            static function (array $json) {
-                return new StepNode(
-                    trim($json['keyword']),
-                    $json['text'],
-                    [],
-                    $json['location']['line'],
-                    trim($json['keyword'])
-                );
-            },
-            $json
+            static fn (array $item) => new StepNode(
+                trim($item['keyword']),
+                $item['text'],
+                [],
+                $item['location']['line'],
+                trim($item['keyword'])
+            ),
+            array_values($items)
         );
     }
 
     /**
-     * @return ExampleTableNode[]
+     * @return list<ExampleTableNode>
      */
-    private static function getTables(array $json)
+    private static function getTables(array $items): array
     {
         return array_map(
             static function ($tableJson) {
                 $table = [];
 
-                $table[$tableJson['tableHeader']['location']['line']] = array_map(
-                    static function ($cell) {
-                        return $cell['value'];
-                    },
-                    $tableJson['tableHeader']['cells']
-                );
+                $table[$tableJson['tableHeader']['location']['line']] = array_column($tableJson['tableHeader']['cells'], 'value');
 
                 foreach ($tableJson['tableBody'] as $bodyRow) {
-                    $table[$bodyRow['location']['line']] = array_map(
-                        static function ($cell) {
-                            return $cell['value'];
-                        },
-                        $bodyRow['cells']
-                    );
+                    $table[$bodyRow['location']['line']] = array_column($bodyRow['cells'], 'value');
                 }
 
                 return new ExampleTableNode(
@@ -189,7 +170,7 @@ static function ($cell) {
                     self::getTags($tableJson)
                 );
             },
-            $json
+            array_values($items)
         );
     }
 }
diff --git a/src/Behat/Gherkin/Loader/DirectoryLoader.php b/src/Behat/Gherkin/Loader/DirectoryLoader.php
@@ -37,32 +37,32 @@ public function __construct(Gherkin $gherkin)
     /**
      * Checks if current loader supports provided resource.
      *
-     * @param mixed $path Resource to load
+     * @param mixed $resource Resource to load
      *
      * @return bool
      */
-    public function supports($path)
+    public function supports($resource)
     {
-        return is_string($path)
-        && is_dir($this->findAbsolutePath($path));
+        return is_string($resource)
+            && is_dir($this->findAbsolutePath($resource));
     }
 
     /**
      * Loads features from provided resource.
      *
-     * @param string $path Resource to load
+     * @param string $resource Resource to load
      *
-     * @return FeatureNode[]
+     * @return list<FeatureNode>
      */
-    public function load($path)
+    public function load($resource)
     {
-        $path = $this->findAbsolutePath($path);
+        $path = $this->findAbsolutePath($resource);
 
         $iterator = new RecursiveIteratorIterator(
             new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS)
         );
-        $paths = array_map('strval', iterator_to_array($iterator));
-        uasort($paths, 'strnatcasecmp');
+        $paths = array_map(strval(...), iterator_to_array($iterator));
+        uasort($paths, strnatcasecmp(...));
 
         $features = [];
 
@@ -71,7 +71,7 @@ public function load($path)
             $loader = $this->gherkin->resolveLoader($path);
 
             if ($loader !== null) {
-                $features = array_merge($features, $loader->load($path));
+                array_push($features, ...$loader->load($path));
             }
         }
 

diff --git a/src/Behat/Gherkin/Loader/GherkinFileLoader.php b/src/Behat/Gherkin/Loader/GherkinFileLoader.php
@@ -49,27 +49,27 @@ public function setCache(CacheInterface $cache)
     /**
      * Checks if current loader supports provided resource.
      *
-     * @param mixed $path Resource to load
+     * @param mixed $resource Resource to load
      *
      * @return bool
      */
-    public function supports($path)
+    public function supports($resource)
     {
-        return is_string($path)
-        && is_file($absolute = $this->findAbsolutePath($path))
-        && pathinfo($absolute, PATHINFO_EXTENSION) === 'feature';
+        return is_string($resource)
+            && is_file($absolute = $this->findAbsolutePath($resource))
+            && pathinfo($absolute, PATHINFO_EXTENSION) === 'feature';
     }
 
     /**
      * Loads features from provided resource.
      *
-     * @param string $path Resource to load
+     * @param string $resource Resource to load
      *
-     * @return FeatureNode[]
+     * @return list<FeatureNode>
      */
-    public function load($path)
+    public function load($resource)
     {
-        $path = $this->findAbsolutePath($path);
+        $path = $this->findAbsolutePath($resource);
 
         if ($this->cache) {
             if ($this->cache->isFresh($path, filemtime($path))) {
@@ -94,8 +94,7 @@ public function load($path)
     protected function parseFeature($path)
     {
         $content = file_get_contents($path);
-        $feature = $this->parser->parse($content, $path);
 
-        return $feature;
+        return $this->parser->parse($content, $path);
     }
 }
diff --git a/src/Behat/Gherkin/Loader/LoaderInterface.php b/src/Behat/Gherkin/Loader/LoaderInterface.php
@@ -33,7 +33,7 @@ public function supports($resource);
      *
      * @param mixed $resource Resource to load
      *
-     * @return FeatureNode[]
+     * @return list<FeatureNode>
      */
     public function load($resource);
 }