Merge remote-tracking branch 'origin/master' into chore/phpstan-setup

.git-blame-ignore-revs

@@ -0,0 +1,15 @@
+# Git 2.23+ allows ignoring commits from git-blame, useful to not display large automated commits.
+#
+# This file is a list of such commits, that you most probably are not interested in.
+# To make this work for your local setup, you need to run the following command:
+#
+# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
+#
+# A few rules for changing this file:
+# - Commits are in chronological order - oldest on top. Therefore new commits should be added in the end.
+# - The purpose is specifically for large commits - avoid adding commits with a very small impact, even if related
+#   to automated code style formatting.
+# - Each commit should be preceded with a comment detailing the purpose of the commit.
+
+# PHP-CS-Fixer Setup - Apply automated changes
+cc23fdc9376975d209489ae88b22ed945871d9cb

.gitattributes

@@ -7,5 +7,5 @@
 /CONTRIBUTING.md            export-ignore
 /phpunit.dist.xml           export-ignore
 /.php-cs-fixer.dist.php     export-ignore
+/.git-blame-ignore-revs     export-ignore
 /phpstan.dist.neon          export-ignore
-/phpstan-baseline.neon      export-ignore

.php-cs-fixer.dist.php

@@ -6,7 +6,6 @@
 
 return (new PhpCsFixer\Config())
     ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
-    ->setRiskyAllowed(true)
     ->setRules([
         '@PER-CS' => true,
         '@Symfony' => true,
@@ -28,7 +27,8 @@
         'phpdoc_align' => ['align' => 'left'],
         'heredoc_to_nowdoc' => true,
         'heredoc_indentation' => ['indentation' => 'same_as_start'],
-        'phpdoc_array_type' => true,
-        'phpdoc_list_type' => true,
+        'single_line_throw' => false,
+        'ternary_to_null_coalescing' => true,
+        'global_namespace_import' => false,
     ])
     ->setFinder($finder);

composer.json

@@ -14,10 +14,12 @@
     ],
 
     "require": {
-        "php": "8.1.* || 8.2.* || 8.3.* || 8.4.*"
+        "php": "8.1.* || 8.2.* || 8.3.* || 8.4.*",
+        "composer-runtime-api": "^2.2"
     },
 
     "require-dev": {
+        "symfony/filesystem": "^5.4 || ^6.4 || ^7.0",
         "symfony/yaml": "^5.4 || ^6.4 || ^7.0",
         "phpunit/phpunit": "^10.5",
         "cucumber/cucumber": "dev-gherkin-24.1.0",
@@ -73,7 +75,7 @@
         "lint": [
             "Composer\\Config::disableProcessTimeout",
             "vendor/bin/phpstan analyse --no-progress --memory-limit 512M",
-            "vendor/bin/php-cs-fixer fix --dry-run --diff --show-progress=dots"
+            "vendor/bin/php-cs-fixer check --diff --show-progress=dots --verbose"
         ],
         "test": [
             "Composer\\Config::disableProcessTimeout",

src/Behat/Gherkin/Cache/FileCache.php

@@ -11,8 +11,8 @@
 namespace Behat\Gherkin\Cache;
 
 use Behat\Gherkin\Exception\CacheException;
-use Behat\Gherkin\Gherkin;
 use Behat\Gherkin\Node\FeatureNode;
+use Composer\InstalledVersions;
 
 /**
  * File cache.
@@ -24,6 +24,17 @@ class FileCache implements CacheInterface
 {
     private $path;
 
+    /**
+     * Used as part of the cache directory path to invalidate cache if the installed package version changes.
+     */
+    private static function getGherkinVersionHash(): string
+    {
+        $version = InstalledVersions::getVersion('behat/gherkin');
+
+        // Composer version strings can contain arbitrary content so hash for filesystem safety
+        return md5($version);
+    }
+
     /**
      * Initializes file cache.
      *
@@ -33,7 +44,7 @@ class FileCache implements CacheInterface
      */
     public function __construct($path)
     {
-        $this->path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . 'v' . Gherkin::VERSION;
+        $this->path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . self::getGherkinVersionHash();
 
         if (!is_dir($this->path)) {
             @mkdir($this->path, 0777, true);

src/Behat/Gherkin/Filter/LineRangeFilter.php

@@ -33,11 +33,11 @@ class LineRangeFilter implements FilterInterface
      */
     public function __construct($filterMinLine, $filterMaxLine)
     {
-        $this->filterMinLine = intval($filterMinLine);
-        if ($filterMaxLine == '*') {
+        $this->filterMinLine = (int) $filterMinLine;
+        if ($filterMaxLine === '*') {
             $this->filterMaxLine = PHP_INT_MAX;
         } else {
-            $this->filterMaxLine = intval($filterMaxLine);
+            $this->filterMaxLine = (int) $filterMaxLine;
         }
     }
 

src/Behat/Gherkin/Filter/NameFilter.php

@@ -46,10 +46,10 @@ public function isFeatureMatch(FeatureNode $feature)
         }
 
         if ($this->filterString[0] === '/') {
-            return preg_match($this->filterString, $feature->getTitle()) === 1;
+            return (bool) preg_match($this->filterString, $feature->getTitle());
         }
 
-        return mb_strpos($feature->getTitle(), $this->filterString, 0, 'utf8') !== false;
+        return str_contains($feature->getTitle(), $this->filterString);
     }
 
     /**
@@ -65,9 +65,11 @@ public function isScenarioMatch(ScenarioInterface $scenario)
             return false;
         }
 
-        if ($this->filterString[0] === '/' && preg_match($this->filterString, $scenario->getTitle()) === 1) {
+        if ($this->filterString[0] === '/' && preg_match($this->filterString, $scenario->getTitle())) {
             return true;
-        } elseif (mb_strpos($scenario->getTitle(), $this->filterString, 0, 'utf8') !== false) {
+        }
+
+        if (str_contains($scenario->getTitle(), $this->filterString)) {
             return true;
         }
 

src/Behat/Gherkin/Filter/NarrativeFilter.php

@@ -44,7 +44,7 @@ public function __construct($regex)
      */
     public function isFeatureMatch(FeatureNode $feature)
     {
-        return preg_match($this->regex, $feature->getDescription() ?? '') === 1;
+        return (bool) preg_match($this->regex, $feature->getDescription() ?? '');
     }
 
     /**

src/Behat/Gherkin/Filter/RoleFilter.php

@@ -29,12 +29,18 @@ class RoleFilter extends SimpleFilter
      */
     public function __construct($role)
     {
-        $this->pattern = '/as an? ' . strtr(preg_quote($role, '/'), [
-            '\*' => '.*',
-            '\?' => '.',
-            '\[' => '[',
-            '\]' => ']',
-        ]) . '[$\n]/i';
+        $this->pattern = sprintf(
+            '/as an? %s[$\n]/i',
+            strtr(
+                preg_quote($role, '/'),
+                [
+                    '\*' => '.*',
+                    '\?' => '.',
+                    '\[' => '[',
+                    '\]' => ']',
+                ]
+            )
+        );
     }
 
     /**
@@ -46,7 +52,7 @@ public function __construct($role)
      */
     public function isFeatureMatch(FeatureNode $feature)
     {
-        return preg_match($this->pattern, $feature->getDescription() ?? '') === 1;
+        return (bool) preg_match($this->pattern, $feature->getDescription() ?? '');
     }
 
     /**

src/Behat/Gherkin/Filter/TagFilter.php

@@ -14,6 +14,8 @@
 use Behat\Gherkin\Node\OutlineNode;
 use Behat\Gherkin\Node\ScenarioInterface;
 
+use function strlen;
+
 /**
  * Filters scenarios by feature/scenario tag.
  *
@@ -134,7 +136,7 @@ protected function isTagsMatchCondition($tags)
     {
         $satisfies = true;
 
-        if (\strlen($this->filterString) === 0) {
+        if (strlen($this->filterString) === 0) {
             return $satisfies;
         }
 

src/Behat/Gherkin/Gherkin.php

@@ -23,6 +23,11 @@
  */
 class Gherkin
 {
+    /**
+     * @deprecated this constant will not be updated for releases after 4.8.0 and will be removed in the next major.
+     * You can use composer's runtime API to get the behat version if you need it. Note that composer's versions will
+     * not always be simple numeric values.
+     */
     public const VERSION = '4.8.0';
 
     /**

src/Behat/Gherkin/Keywords/CucumberKeywords.php

@@ -112,7 +112,7 @@ public function getButKeywords()
      */
     private function prepareStepString($keywordsString)
     {
-        if (mb_strpos($keywordsString, '*|', 0, 'UTF-8') === 0) {
+        if (str_starts_with($keywordsString, '*|')) {
             $keywordsString = mb_substr($keywordsString, 2, mb_strlen($keywordsString, 'utf8') - 2, 'utf8');
         }
 

src/Behat/Gherkin/Keywords/KeywordsDumper.php

@@ -54,7 +54,9 @@ public function setKeywordsDumperFunction($mapper)
     public function dumpKeywords(array $keywords, $isShort)
     {
         if ($isShort) {
-            return count($keywords) > 1 ? '(' . implode('|', $keywords) . ')' : $keywords[0];
+            return count($keywords) > 1
+                ? '(' . implode('|', $keywords) . ')'
+                : $keywords[0];
         }
 
         return $keywords[0];
@@ -348,7 +350,7 @@ function ($keyword) {
                 }
 
                 $indent = ' ';
-                if (mb_strpos($keyword, '<', 0, 'utf8') !== false) {
+                if (str_contains($keyword, '<')) {
                     $keyword = mb_substr($keyword, 0, -1, 'utf8');
                     $indent = '';
                 }

src/Behat/Gherkin/Lexer.php

@@ -128,11 +128,7 @@ public function deferToken(array $token)
      */
     public function predictToken()
     {
-        if ($this->stashedToken === null) {
-            $this->stashedToken = $this->getNextToken();
-        }
-
-        return $this->stashedToken;
+        return $this->stashedToken ??= $this->getNextToken();
     }
 
     /**
@@ -196,7 +192,7 @@ protected function consumeLineUntil(int $trimmedOffset)
      */
     protected function getTrimmedLine()
     {
-        return $this->trimmedLine !== null ? $this->trimmedLine : $this->trimmedLine = trim($this->line);
+        return $this->trimmedLine ??= trim($this->line);
     }
 
     /**
@@ -343,7 +339,7 @@ protected function getKeywords($type)
             if ($type === 'Step') {
                 $padded = [];
                 foreach (explode('|', $keywords) as $keyword) {
-                    $padded[] = mb_strpos($keyword, '<', 0, 'utf8') !== false
+                    $padded[] = str_contains($keyword, '<')
                         ? preg_quote(mb_substr($keyword, 0, -1, 'utf8'), '/') . '\s*'
                         : preg_quote($keyword, '/') . '\s+';
                 }
@@ -499,7 +495,7 @@ protected function scanTableRow()
         }
 
         $line = $this->getTrimmedLine();
-        if (!isset($line[0]) || $line[0] !== '|' || substr($line, -1) !== '|') {
+        if ($line === '' || !str_starts_with($line, '|') || !str_ends_with($line, '|')) {
             return null;
         }
 
@@ -524,7 +520,7 @@ protected function scanTags()
     {
         $line = $this->getTrimmedLine();
 
-        if (!isset($line[0]) || $line[0] !== '@') {
+        if ($line === '' || !str_starts_with($line, '@')) {
             return null;
         }
 
@@ -558,11 +554,11 @@ protected function scanLanguage()
             return null;
         }
 
-        if (mb_strpos(ltrim($this->line), '#', 0, 'utf8') !== 0) {
+        if (!str_starts_with(ltrim($this->line), '#')) {
             return null;
         }
 
-        return $this->scanInput('/^\s*\#\s*language:\s*([\w_\-]+)\s*$/', 'Language');
+        return $this->scanInput('/^\s*#\s*language:\s*([\w_\-]+)\s*$/', 'Language');
     }
 
     /**
@@ -577,7 +573,7 @@ protected function scanComment()
         }
 
         $line = $this->getTrimmedLine();
-        if (mb_strpos($line, '#', 0, 'utf8') !== 0) {
+        if (!str_starts_with($line, '#')) {
             return null;
         }
 
@@ -642,7 +638,7 @@ private function getStepKeywordType($native)
         }
 
         foreach ($this->stepKeywordTypesCache as $type => $keywords) {
-            if (in_array($native, $keywords) || in_array($native . '<', $keywords)) {
+            if (in_array($native, $keywords, true) || in_array($native . '<', $keywords, true)) {
                 return $type;
             }
         }