refactor: Add native parameter types & return type when possible (#353)

Native parameter types are added for all arguments.

Return types are added only for private methods as adding a returning
type on an method that can be overriden is a BC break.

Author: stof

src/Cache/CacheInterface.php

@@ -27,7 +27,7 @@ interface CacheInterface
      *
      * @return bool
      */
-    public function isFresh($path, $timestamp);
+    public function isFresh(string $path, int $timestamp);
 
     /**
      * Reads feature cache from path.
@@ -36,15 +36,14 @@ public function isFresh($path, $timestamp);
      *
      * @return FeatureNode
      */
-    public function read($path);
+    public function read(string $path);
 
     /**
      * Caches feature node.
      *
      * @param string $path Feature path
-     * @param FeatureNode $feature Feature instance
      *
      * @return void
      */
-    public function write($path, FeatureNode $feature);
+    public function write(string $path, FeatureNode $feature);
 }

src/Cache/FileCache.php

@@ -63,7 +63,7 @@ public function __construct(string $path)
      *
      * @return bool
      */
-    public function isFresh($path, $timestamp)
+    public function isFresh(string $path, int $timestamp)
     {
         $cachePath = $this->getCachePathFor($path);
 
@@ -83,7 +83,7 @@ public function isFresh($path, $timestamp)
      *
      * @throws CacheException
      */
-    public function read($path)
+    public function read(string $path)
     {
         $cachePath = $this->getCachePathFor($path);
         $feature = unserialize(file_get_contents($cachePath));
@@ -99,11 +99,10 @@ public function read($path)
      * Caches feature node.
      *
      * @param string $path Feature path
-     * @param FeatureNode $feature Feature instance
      *
      * @return void
      */
-    public function write($path, FeatureNode $feature)
+    public function write(string $path, FeatureNode $feature)
     {
         file_put_contents($this->getCachePathFor($path), serialize($feature));
     }
@@ -115,7 +114,7 @@ public function write($path, FeatureNode $feature)
      *
      * @return string
      */
-    protected function getCachePathFor($path)
+    protected function getCachePathFor(string $path)
     {
         return $this->path . '/' . md5($path) . '.feature.cache';
     }

src/Cache/MemoryCache.php

@@ -37,7 +37,7 @@ class MemoryCache implements CacheInterface
      *
      * @return bool
      */
-    public function isFresh($path, $timestamp)
+    public function isFresh(string $path, int $timestamp)
     {
         if (!isset($this->features[$path])) {
             return false;
@@ -53,7 +53,7 @@ public function isFresh($path, $timestamp)
      *
      * @return FeatureNode
      */
-    public function read($path)
+    public function read(string $path)
     {
         return $this->features[$path];
     }
@@ -62,11 +62,10 @@ public function read($path)
      * Caches feature node.
      *
      * @param string $path Feature path
-     * @param FeatureNode $feature Feature instance
      *
      * @return void
      */
-    public function write($path, FeatureNode $feature)
+    public function write(string $path, FeatureNode $feature)
     {
         $this->features[$path] = $feature;
         $this->timestamps[$path] = time();

src/Filter/LineFilter.php

@@ -32,7 +32,7 @@ class LineFilter implements FilterInterface
      *
      * @param int|numeric-string $filterLine Line of the scenario to filter on
      */
-    public function __construct($filterLine)
+    public function __construct(int|string $filterLine)
     {
         $this->filterLine = (int) $filterLine;
     }

src/Filter/LineRangeFilter.php

@@ -37,7 +37,7 @@ class LineRangeFilter implements FilterInterface
      * @param int|numeric-string $filterMinLine Minimum line of a scenario to filter on
      * @param int|numeric-string|'*' $filterMaxLine Maximum line of a scenario to filter on
      */
-    public function __construct($filterMinLine, $filterMaxLine)
+    public function __construct(int|string $filterMinLine, int|string $filterMaxLine)
     {
         $this->filterMinLine = (int) $filterMinLine;
         $this->filterMaxLine = $filterMaxLine === '*' ? PHP_INT_MAX : (int) $filterMaxLine;

src/Filter/NameFilter.php

@@ -25,12 +25,7 @@ class NameFilter extends SimpleFilter
      */
     protected $filterString;
 
-    /**
-     * Initializes filter.
-     *
-     * @param string $filterString Name filter string
-     */
-    public function __construct($filterString)
+    public function __construct(string $filterString)
     {
         $this->filterString = trim($filterString);
     }

src/Filter/RoleFilter.php

@@ -30,7 +30,7 @@ class RoleFilter extends SimpleFilter
      *
      * @param string $role Approved role wildcard
      */
-    public function __construct($role)
+    public function __construct(string $role)
     {
         $this->pattern = sprintf(
             '/as an? %s[$\n]/i',

src/Filter/TagFilter.php

@@ -26,12 +26,7 @@ class TagFilter extends ComplexFilter
      */
     protected $filterString;
 
-    /**
-     * Initializes filter.
-     *
-     * @param string $filterString Name filter string
-     */
-    public function __construct($filterString)
+    public function __construct(string $filterString)
     {
         $this->filterString = trim($filterString);
 
@@ -116,7 +111,7 @@ public function isScenarioMatch(FeatureNode $feature, ScenarioInterface $scenari
      *
      * @return bool
      */
-    protected function isTagsMatchCondition($tags)
+    protected function isTagsMatchCondition(array $tags)
     {
         if ($this->filterString === '') {
             return true;

src/Gherkin.php

@@ -84,7 +84,7 @@ public function setFilters(array $filters)
      *
      * @return void
      */
-    public function setBasePath($path)
+    public function setBasePath(string $path)
     {
         foreach ($this->loaders as $loader) {
             if ($loader instanceof FileLoaderInterface) {
@@ -143,7 +143,7 @@ public function load($resource, array $filters = [])
      *
      * @return LoaderInterface|null
      */
-    public function resolveLoader($resource)
+    public function resolveLoader(mixed $resource)
     {
         foreach ($this->loaders as $loader) {
             if ($loader->supports($resource)) {

src/Keywords/ArrayKeywords.php

@@ -65,11 +65,9 @@ public function __construct(
     /**
      * Sets keywords holder language.
      *
-     * @param string $language Language name
-     *
      * @return void
      */
-    public function setLanguage($language)
+    public function setLanguage(string $language)
     {
         if (!isset($this->keywords[$language])) {
             $this->language = 'en';