Merge pull request #281 from uuf6429/chore/phpstan-level-3

Update to PHPStan level 3; various fixes

phpstan.dist.neon

@@ -1,5 +1,5 @@
 parameters:
-    level: 1
+    level: 3
     paths:
         - src
         - tests

src/Behat/Gherkin/Loader/AbstractFileLoader.php

@@ -50,7 +50,7 @@ protected function findRelativePath($path)
      *
      * @param string $path Relative path
      *
-     * @return string
+     * @return false|string
      */
     protected function findAbsolutePath($path)
     {
@@ -69,4 +69,17 @@ protected function findAbsolutePath($path)
 
         return false;
     }
+
+    /**
+     * @throws \RuntimeException
+     */
+    final protected function getAbsolutePath(string $path): string
+    {
+        $resolvedPath = $this->findAbsolutePath($path);
+        if ($resolvedPath === false) {
+            throw new \RuntimeException("Unable to locate absolute path of \"$path\"");
+        }
+
+        return $resolvedPath;
+    }
 }

src/Behat/Gherkin/Loader/DirectoryLoader.php

@@ -44,7 +44,8 @@ public function __construct(Gherkin $gherkin)
     public function supports($resource)
     {
         return is_string($resource)
-            && is_dir($this->findAbsolutePath($resource));
+            && ($path = $this->findAbsolutePath($resource)) !== false
+            && is_dir($path);
     }
 
     /**
@@ -56,8 +57,7 @@ public function supports($resource)
      */
     public function load($resource)
     {
-        $path = $this->findAbsolutePath($resource);
-
+        $path = $this->getAbsolutePath($resource);
         $iterator = new RecursiveIteratorIterator(
             new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS)
         );

src/Behat/Gherkin/Loader/GherkinFileLoader.php

@@ -56,8 +56,9 @@ public function setCache(CacheInterface $cache)
     public function supports($resource)
     {
         return is_string($resource)
-            && is_file($absolute = $this->findAbsolutePath($resource))
-            && pathinfo($absolute, PATHINFO_EXTENSION) === 'feature';
+            && ($path = $this->findAbsolutePath($resource)) !== false
+            && is_file($path)
+            && pathinfo($path, PATHINFO_EXTENSION) === 'feature';
     }
 
     /**
@@ -69,8 +70,7 @@ public function supports($resource)
      */
     public function load($resource)
     {
-        $path = $this->findAbsolutePath($resource);
-
+        $path = $this->getAbsolutePath($resource);
         if ($this->cache) {
             if ($this->cache->isFresh($path, filemtime($path))) {
                 $feature = $this->cache->read($path);

src/Behat/Gherkin/Loader/YamlFileLoader.php

@@ -37,8 +37,9 @@ public function __construct()
     public function supports($resource)
     {
         return is_string($resource)
-            && is_file($absolute = $this->findAbsolutePath($resource))
-            && pathinfo($absolute, PATHINFO_EXTENSION) === 'yml';
+            && ($path = $this->findAbsolutePath($resource)) !== false
+            && is_file($path)
+            && pathinfo($path, PATHINFO_EXTENSION) === 'yml';
     }
 
     /**
@@ -50,7 +51,7 @@ public function supports($resource)
      */
     public function load($resource)
     {
-        $path = $this->findAbsolutePath($resource);
+        $path = $this->getAbsolutePath($resource);
         $hash = Yaml::parse(file_get_contents($path));
 
         $features = $this->loader->load($hash);

src/Behat/Gherkin/Node/OutlineNode.php

@@ -30,7 +30,7 @@ class OutlineNode implements ScenarioInterface
      */
     private $steps;
     /**
-     * @var ExampleTableNode|ExampleTableNode[]
+     * @var array<array-key, ExampleTableNode>
      */
     private $tables;
     /**
@@ -52,7 +52,7 @@ class OutlineNode implements ScenarioInterface
      * @param string|null $title
      * @param string[] $tags
      * @param StepNode[] $steps
-     * @param ExampleTableNode|ExampleTableNode[] $tables
+     * @param ExampleTableNode|array<array-key, ExampleTableNode> $tables
      * @param string $keyword
      * @param int $line
      */
@@ -69,11 +69,7 @@ public function __construct(
         $this->steps = $steps;
         $this->keyword = $keyword;
         $this->line = $line;
-        if (!is_array($tables)) {
-            $this->tables = [$tables];
-        } else {
-            $this->tables = $tables;
-        }
+        $this->tables = is_array($tables) ? $tables : [$tables];
     }
 
     /**
@@ -197,7 +193,7 @@ public function getExamples()
     /**
      * Returns examples tables array for the outline.
      *
-     * @return ExampleTableNode[]
+     * @return array<array-key, ExampleTableNode>
      */
     public function getExampleTables()
     {

src/Behat/Gherkin/Node/TableNode.php

@@ -23,14 +23,12 @@
  */
 class TableNode implements ArgumentInterface, IteratorAggregate
 {
+    private array $table;
+
     /**
-     * @var array
-     */
-    private $table;
-    /**
-     * @var int
+     * @var array<array-key, int>
      */
-    private $maxLineLength = [];
+    private array $maxLineLength = [];
 
     /**
      * Initializes table.

tests/Behat/Gherkin/Filter/LineFilterTest.php

@@ -18,7 +18,7 @@
 
 class LineFilterTest extends FilterTestCase
 {
-    public function testIsFeatureMatchFilter()
+    public function testIsFeatureMatchFilter(): void
     {
         $feature = new FeatureNode(null, null, [], null, [], null, null, null, 1);
 
@@ -32,7 +32,7 @@ public function testIsFeatureMatchFilter()
         $this->assertFalse($filter->isFeatureMatch($feature));
     }
 
-    public function testIsScenarioMatchFilter()
+    public function testIsScenarioMatchFilter(): void
     {
         $scenario = new ScenarioNode(null, [], [], null, 2);
 
@@ -54,7 +54,7 @@ public function testIsScenarioMatchFilter()
         $this->assertTrue($filter->isScenarioMatch($outline));
     }
 
-    public function testFilterFeatureScenario()
+    public function testFilterFeatureScenario(): void
     {
         $filter = new LineFilter(2);
         $feature = $filter->filterFeature($this->getParsedFeature());
@@ -71,19 +71,20 @@ public function testFilterFeatureScenario()
         $this->assertCount(0, $scenarios = $feature->getScenarios());
     }
 
-    public function testFilterFeatureOutline()
+    public function testFilterFeatureOutline(): void
     {
         $filter = new LineFilter(13);
         $feature = $filter->filterFeature($this->getParsedFeature());
-        /* @var OutlineNode[] $scenarios */
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $this->assertCount(4, $scenarios[0]->getExampleTable()->getRows());
 
         $filter = new LineFilter(20);
         $feature = $filter->filterFeature($this->getParsedFeature());
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $exampleTableNodes = $scenarios[0]->getExampleTables();
         $this->assertCount(1, $exampleTableNodes);
         $this->assertCount(2, $exampleTableNodes[0]->getRows());
@@ -97,6 +98,7 @@ public function testFilterFeatureOutline()
         $feature = $filter->filterFeature($this->getParsedFeature());
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $exampleTableNodes = $scenarios[0]->getExampleTables();
         $this->assertCount(1, $exampleTableNodes);
         $this->assertCount(2, $exampleTableNodes[0]->getRows());
@@ -110,6 +112,7 @@ public function testFilterFeatureOutline()
         $feature = $filter->filterFeature($this->getParsedFeature());
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $this->assertCount(1, $scenarios[0]->getExampleTable()->getRows());
         $this->assertSame([['action', 'outcome']], $scenarios[0]->getExampleTable()->getRows());
     }

tests/Behat/Gherkin/Filter/LineRangeFilterTest.php

@@ -15,10 +15,11 @@
 use Behat\Gherkin\Node\FeatureNode;
 use Behat\Gherkin\Node\OutlineNode;
 use Behat\Gherkin\Node\ScenarioNode;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class LineRangeFilterTest extends FilterTestCase
 {
-    public function featureLineRangeProvider()
+    public static function featureLineRangeProvider(): iterable
     {
         return [
             ['1', '1', true],
@@ -29,18 +30,16 @@ public function featureLineRangeProvider()
         ];
     }
 
-    /**
-     * @dataProvider featureLineRangeProvider
-     */
-    public function testIsFeatureMatchFilter($filterMinLine, $filterMaxLine, $expected)
+    #[DataProvider('featureLineRangeProvider')]
+    public function testIsFeatureMatchFilter(string $filterMinLine, string $filterMaxLine, bool $expected): void
     {
         $feature = new FeatureNode(null, null, [], null, [], null, null, null, 1);
 
         $filter = new LineRangeFilter($filterMinLine, $filterMaxLine);
         $this->assertSame($expected, $filter->isFeatureMatch($feature));
     }
 
-    public function scenarioLineRangeProvider()
+    public static function scenarioLineRangeProvider(): iterable
     {
         return [
             ['1', '2', 1],
@@ -55,22 +54,20 @@ public function scenarioLineRangeProvider()
         ];
     }
 
-    /**
-     * @dataProvider scenarioLineRangeProvider
-     */
-    public function testIsScenarioMatchFilter($filterMinLine, $filterMaxLine, $expectedNumberOfMatches)
+    #[DataProvider('scenarioLineRangeProvider')]
+    public function testIsScenarioMatchFilter(string $filterMinLine, string $filterMaxLine, int $expectedNumberOfMatches): void
     {
         $scenario = new ScenarioNode(null, [], [], null, 2);
         $outline = new OutlineNode(null, [], [], [new ExampleTableNode([], null)], null, 3);
 
         $filter = new LineRangeFilter($filterMinLine, $filterMaxLine);
         $this->assertEquals(
             $expectedNumberOfMatches,
-            intval($filter->isScenarioMatch($scenario)) + intval($filter->isScenarioMatch($outline))
+            (int) $filter->isScenarioMatch($scenario) + (int) $filter->isScenarioMatch($outline)
         );
     }
 
-    public function testFilterFeatureScenario()
+    public function testFilterFeatureScenario(): void
     {
         $filter = new LineRangeFilter(1, 3);
         $feature = $filter->filterFeature($this->getParsedFeature());
@@ -87,19 +84,20 @@ public function testFilterFeatureScenario()
         $this->assertCount(0, $scenarios = $feature->getScenarios());
     }
 
-    public function testFilterFeatureOutline()
+    public function testFilterFeatureOutline(): void
     {
         $filter = new LineRangeFilter(12, 14);
         $feature = $filter->filterFeature($this->getParsedFeature());
-        /* @var OutlineNode[] $scenarios */
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $this->assertFalse($scenarios[0]->hasExamples());
 
         $filter = new LineRangeFilter(16, 21);
         $feature = $filter->filterFeature($this->getParsedFeature());
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $exampleTableNodes = $scenarios[0]->getExampleTables();
         $this->assertCount(1, $exampleTableNodes);
         $this->assertCount(3, $exampleTableNodes[0]->getRows());
@@ -114,6 +112,7 @@ public function testFilterFeatureOutline()
         $feature = $filter->filterFeature($this->getParsedFeature());
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $exampleTableNodes = $scenarios[0]->getExampleTables();
         $this->assertCount(2, $exampleTableNodes);
 
@@ -137,6 +136,7 @@ public function testFilterFeatureOutline()
         $feature = $filter->filterFeature($this->getParsedFeature());
         $this->assertCount(1, $scenarios = $feature->getScenarios());
         $this->assertSame('Scenario#3', $scenarios[0]->getTitle());
+        $this->assertInstanceOf(OutlineNode::class, $scenarios[0]);
         $exampleTableNodes = $scenarios[0]->getExampleTables();
         $this->assertCount(1, $exampleTableNodes);
         $this->assertCount(2, $exampleTableNodes[0]->getRows());