Add return types for methods of classes implementing native PHP ones (e.g Iterator)

Includes some smaller modernizations of code

Author: DiegoPino

src/DataStreams/BaseDataStream.php

@@ -30,5 +30,5 @@ abstract public function save($filename);
      *
      * @throws \frictionlessdata\datapackage\Exceptions\DataStreamValidationException
      */
-    abstract public function current();
+    abstract public function current():mixed;
 }

src/DataStreams/DefaultDataStream.php

@@ -33,7 +33,10 @@ public function __destruct()
         fclose($this->fopenResource);
     }
 
-    public function rewind()
+  /**
+   * @throws \Exception
+   */
+    public function rewind():void
     {
         if ($this->currentLineNumber == 0) {
             // starting iterations
@@ -50,22 +53,22 @@ public function save($filename)
         fclose($target);
     }
 
-    public function current()
+    public function current():mixed
     {
         return fgets($this->fopenResource);
     }
 
-    public function key()
+    public function key():mixed
     {
         return $this->currentLineNumber;
     }
 
-    public function next()
+    public function next():void
     {
         ++$this->currentLineNumber;
     }
 
-    public function valid()
+    public function valid():bool
     {
         return !feof($this->fopenResource);
     }

src/DataStreams/TabularDataStream.php

@@ -15,6 +15,10 @@ class TabularDataStream extends BaseDataStream
     public $table;
     public $schema;
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DataStreamOpenException
+   * @throws \Exception
+   */
     public function __construct($dataSource, $dataSourceOptions = null)
     {
         parent::__construct($dataSource, $dataSourceOptions);
@@ -38,7 +42,7 @@ protected function getDataSourceObject()
         return new CsvDataSource($this->dataSource);
     }
 
-    public function rewind()
+    public function rewind():void
     {
         $this->table->rewind();
     }
@@ -53,28 +57,26 @@ public function save($filename)
      *
      * @throws DataStreamValidationException
      */
-    public function current()
+    public function current():mixed
     {
         try {
             return $this->table->current();
-        } catch (DataSourceException $e) {
-            throw new DataStreamValidationException($e->getMessage());
-        } catch (FieldValidationException $e) {
+        } catch (DataSourceException|FieldValidationException $e) {
             throw new DataStreamValidationException($e->getMessage());
         }
     }
 
-    public function key()
+    public function key():mixed
     {
         return $this->table->key();
     }
 
-    public function next()
+    public function next():void
     {
         $this->table->next();
     }
 
-    public function valid()
+    public function valid(): bool
     {
         return $this->table->valid();
     }

src/Datapackages/BaseDatapackage.php

@@ -2,16 +2,18 @@
 
 namespace frictionlessdata\datapackage\Datapackages;
 
+use Exception;
 use frictionlessdata\datapackage\Factory;
 use frictionlessdata\datapackage\Package;
 use frictionlessdata\datapackage\Registry;
 use frictionlessdata\datapackage\Utils;
 use frictionlessdata\datapackage\Validators\DatapackageValidator;
 use frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException;
 use frictionlessdata\datapackage\Exceptions\DatapackageInvalidSourceException;
+use Iterator;
 use ZipArchive;
 
-abstract class BaseDatapackage implements \Iterator
+abstract class BaseDatapackage implements Iterator
 {
 
     /**
@@ -34,6 +36,9 @@ public function __construct($descriptor, $basePath = null, $skipValidations = fa
         }
     }
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException
+   */
     public static function create($name, $resources, $basePath = null)
     {
         $datapackage = new static((object) [
@@ -47,6 +52,9 @@ public static function create($name, $resources, $basePath = null)
         return $datapackage;
     }
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException
+   */
     public function revalidate()
     {
         $this->rewind();
@@ -81,16 +89,23 @@ public function resources()
         return $resources;
     }
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
+   * @throws \Exception
+   */
     public function getResource($name)
     {
         foreach ($this->descriptor->resources as $resourceDescriptor) {
             if ($resourceDescriptor->name == $name) {
                 return $this->initResource($resourceDescriptor);
             }
         }
-        throw new \Exception("couldn't find matching resource with name =  '{$name}'");
+        throw new Exception("couldn't find matching resource with name =  '{$name}'");
     }
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException
+   */
     public function addResource($name, $resource)
     {
         if (is_a($resource, 'frictionlessdata\\datapackage\\Resources\\BaseResource')) {
@@ -119,6 +134,10 @@ public function addResource($name, $resource)
     }
 
     // TODO: remove this function and use the getResource / addResource directly (will need to modify a lot of tests code)
+
+  /**
+   * @throws \Exception
+   */
     public function resource($name, $resource = null)
     {
         if ($resource) {
@@ -128,6 +147,9 @@ public function resource($name, $resource = null)
         }
     }
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException
+   */
     public function removeResource($name)
     {
         $resourceDescriptors = [];
@@ -148,27 +170,30 @@ public function saveDescriptor($filename)
     }
 
     // standard iterator functions - to iterate over the resources
-    public function rewind()
+    public function rewind():void
     {
         $this->currentResourcePosition = 0;
     }
 
-    public function current()
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
+   */
+    public function current():mixed
     {
         return $this->initResource($this->descriptor()->resources[$this->currentResourcePosition]);
     }
 
-    public function key()
+    public function key():mixed
     {
         return $this->currentResourcePosition;
     }
 
-    public function next()
+    public function next():void
     {
         ++$this->currentResourcePosition;
     }
 
-    public function valid()
+    public function valid():bool
     {
         return isset($this->descriptor()->resources[$this->currentResourcePosition]);
     }
@@ -242,7 +267,6 @@ protected function copy()
      * @param object $descriptor
      *
      * @return \frictionlessdata\datapackage\Resources\BaseResource
-     * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
      */
     protected function initResource($descriptor)
     {

src/Resources/BaseResource.php

@@ -8,6 +8,7 @@
 use frictionlessdata\datapackage\Validators\ResourceValidator;
 use frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException;
 use frictionlessdata\datapackage\Utils;
+use frictionlessdata\tableschema\SchemaValidationError;
 
 abstract class BaseResource implements \Iterator
 {
@@ -146,11 +147,11 @@ public function isRemote()
 
     public function data()
     {
-        return isset($this->descriptor()->data) ? $this->descriptor()->data : null;
+        return $this->descriptor()->data ?? null;
     }
 
     // standard iterator functions - to iterate over the data sources
-    public function rewind()
+    public function rewind():void
     {
         $this->dataStreams = null;
         $this->currentDataStream = 0;
@@ -159,22 +160,25 @@ public function rewind()
         }
     }
 
-    public function current()
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DataStreamValidationException
+   */
+    public function current():mixed
     {
         return $this->dataStreams()[$this->currentDataStream]->current();
     }
 
-    public function key()
+    public function key():mixed
     {
         return $this->dataStreams()[$this->currentDataStream]->key();
     }
 
-    public function next()
+    public function next():void
     {
-        return $this->dataStreams()[$this->currentDataStream]->next();
+        $this->dataStreams()[$this->currentDataStream]->next();
     }
 
-    public function valid()
+    public function valid():bool
     {
         $dataStreams = $this->dataStreams();
         if ($dataStreams[$this->currentDataStream]->valid()) {
@@ -223,7 +227,7 @@ public static function validateDataSource($dataSource, $basePath = null)
         $dataSource = static::normalizeDataSource($dataSource, $basePath);
         if (!Utils::isHttpSource($dataSource) && !file_exists($dataSource)) {
             $errors[] = new ResourceValidationError(
-                ResourceValidationError::SCHEMA_VIOLATION,
+                SchemaValidationError::SCHEMA_VIOLATION,
                 "data source file does not exist or is not readable: {$dataSource}"
             );
         }

src/Resources/TabularResource.php

@@ -31,17 +31,20 @@ protected function getDataStream($dataSource, $dataSourceOptions = null)
     {
         $dataSourceOptions = array_merge([
             'schema' => $this->schema(),
-            'dialect' => isset($this->descriptor()->dialect) ? $this->descriptor()->dialect : null,
+            'dialect' => $this->descriptor()->dialect ?? null,
         ], (array) $dataSourceOptions);
 
         return new TabularDataStream($this->normalizeDataSource($dataSource, $this->basePath), $dataSourceOptions);
     }
 
+  /**
+   * @throws \frictionlessdata\datapackage\Exceptions\DataStreamOpenException
+   */
     protected function getInlineDataStream($data)
     {
         return new TabularInlineDataStream($data, [
             'schema' => $this->schema(),
-            'dialect' => isset($this->descriptor()->dialect) ? $this->descriptor()->dialect : null,
+            'dialect' => $this->descriptor()->dialect ?? null,
         ]);
     }
 

src/Validators/BaseValidator.php

@@ -44,6 +44,9 @@ protected function getValidationProfile()
         return $this->descriptor->profile;
     }
 
+  /**
+   * @throws \Exception
+   */
     protected function convertValidationSchemaFilenameToUrl($filename)
     {
         $filename = realpath($filename);
@@ -116,9 +119,12 @@ protected function getValidationErrorMessage(array $error)
         return sprintf('[%s] %s', $error['property'], $error['message']);
     }
 
-    /**
-     * Does the validation, adds errors to the validator object using _addError method.
-     */
+  /**
+   * Does the validation, adds errors to the validator object using _addError
+   * method.
+   *
+   * @throws \Exception
+   */
     protected function validateSchema()
     {
         $this->validateSchemaUrl($this->getValidationSchemaUrl());