introduce notion of provider error

Oleg · Oleg · commit d09d044d6c76 · 2019-08-08T15:40:15.000+03:00
diff --git a/composer.json b/composer.json
@@ -11,7 +11,8 @@
     "require": {
         "php": "^7.1",
         "doctrine/dbal": "^2.5",
-        "ext-json": "*"
+        "ext-json": "*",
+        "ext-pdo": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.0",
diff --git a/src/Plumber.php b/src/Plumber.php
@@ -4,6 +4,7 @@
 namespace SlayerBirden\DataFlow;
 
 use SlayerBirden\DataFlow\Exception\FlowTerminationException;
+use SlayerBirden\DataFlow\Provider\Exception\ProviderExceptionInterface;
 
 class Plumber
 {
@@ -33,17 +34,21 @@ public function __construct(ProviderInterface $source, PipeLineInterface $pipeLi
     public function pour(): void
     {
         $provider = $this->source->getCask();
-        foreach ($provider as $dataBag) {
-            try {
-                $this->pipeLine->rewind();
-                while ($this->pipeLine->valid()) {
-                    $handler = $this->pipeLine->current();
-                    $dataBag = $handler->pass($dataBag);
-                    $this->pipeLine->next();
+        try {
+            foreach ($provider as $dataBag) {
+                try {
+                    $this->pipeLine->rewind();
+                    while ($this->pipeLine->valid()) {
+                        $handler = $this->pipeLine->current();
+                        $dataBag = $handler->pass($dataBag);
+                        $this->pipeLine->next();
+                    }
+                } catch (FlowTerminationException $exception) {
+                    $this->emitter->emit('valve_closed', $exception->getIdentifier(), $dataBag);
                 }
-            } catch (FlowTerminationException $exception) {
-                $this->emitter->emit('valve_closed', $exception->getIdentifier(), $dataBag);
             }
+        } catch (ProviderExceptionInterface $exception) {
+            $this->emitter->emit('provider_error', $exception->getMessage());
         }
         $this->emitter->emit('empty_cask');
     }
diff --git a/src/Provider/ArrayProvider.php b/src/Provider/ArrayProvider.php
@@ -38,7 +38,7 @@ private function validate(array $data)
             $localKeys = array_keys($row);
             sort($localKeys);
             if (isset($keys)) {
-                if ($keys != $localKeys) {
+                if ($keys !== $localKeys) {
                     throw new InvalidDataException(
                         sprintf('Row #(%s) has different structure than the 1st element.', $key)
                     );
diff --git a/src/Provider/Csv.php b/src/Provider/Csv.php
@@ -6,7 +6,7 @@
 use SlayerBirden\DataFlow\Data\SimpleBag;
 use SlayerBirden\DataFlow\IdentificationTrait;
 use SlayerBirden\DataFlow\Provider\Exception\FileDoesNotExist;
-use SlayerBirden\DataFlow\Provider\Exception\HeaderInvalid;
+use SlayerBirden\DataFlow\Provider\Exception\RowInvalid;
 use SlayerBirden\DataFlow\Provider\Exception\HeaderMissing;
 use SlayerBirden\DataFlow\ProviderInterface;
 
@@ -59,7 +59,7 @@ public function __construct(string $id, string $fileName, bool $headerRow = true
 
     /**
      * @inheritdoc
-     * @throws HeaderInvalid
+     * @throws RowInvalid
      */
     public function getCask(): \Generator
     {
@@ -75,11 +75,11 @@ public function getCask(): \Generator
         while ($this->file->valid()) {
             $row = $this->file->current();
             if (count($row) !== count($this->header)) {
-                throw new HeaderInvalid(
+                throw new RowInvalid(
                     sprintf(
-                        'Invalid header %s for row %s. Column count mismatch.',
-                        json_encode($this->header),
-                        json_encode($row)
+                        'Invalid row %s for header %s. Column count mismatch.',
+                        json_encode($row),
+                        json_encode($this->header)
                     )
                 );
             }
@@ -99,7 +99,11 @@ public function getEstimatedSize(): int
         // attempt to reach max (will reach last line);
         $prevPos = $this->file->key();
         $this->file->seek(PHP_INT_MAX);
-        $numberOfLines = $this->file->key() + 1;
+        $numberOfLines = $this->file->key();
+        if ($this->file->valid()) {
+            // this line is not eof
+            $numberOfLines += 1;
+        }
         if ($this->headerRow) {
             // subtract header row if it's present in the file
             --$numberOfLines;
diff --git a/src/Provider/Dbal.php b/src/Provider/Dbal.php
@@ -4,9 +4,11 @@
 namespace SlayerBirden\DataFlow\Provider;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\DBALException;
 use SlayerBirden\DataFlow\Data\SimpleBag;
 use SlayerBirden\DataFlow\DataBagInterface;
 use SlayerBirden\DataFlow\IdentificationTrait;
+use SlayerBirden\DataFlow\Provider\Exception\ProviderException;
 use SlayerBirden\DataFlow\ProviderInterface;
 
 class Dbal implements ProviderInterface
@@ -36,7 +38,6 @@ public function __construct(string $id, Connection $connection, string $table)
 
     /**
      * @return \Generator|DataBagInterface[]
-     * @throws \Doctrine\DBAL\DBALException
      */
     public function getCask(): \Generator
     {
@@ -47,7 +48,11 @@ public function getCask(): \Generator
                 ->from($this->table)
                 ->setFirstResult($offset)
                 ->setMaxResults(self::LIMIT);
-            $stmt = $this->connection->query($qb->getSQL());
+            try {
+                $stmt = $this->connection->query($qb->getSQL());
+            } catch (DBALException $e) {
+                throw new ProviderException($e->getMessage(), $e->getCode(), $e);
+            }
             $result = $stmt->fetchAll(\PDO::FETCH_ASSOC);
             $count = count($result);
             if ($count) {
@@ -61,6 +66,7 @@ public function getCask(): \Generator
 
     /**
      * @inheritdoc
+     * @throws \Doctrine\DBAL\DBALException
      */
     public function getEstimatedSize(): int
     {
diff --git a/src/Provider/Exception/FileDoesNotExist.php b/src/Provider/Exception/FileDoesNotExist.php
@@ -3,8 +3,6 @@
 
 namespace SlayerBirden\DataFlow\Provider\Exception;
 
-use SlayerBirden\DataFlow\Exception\DomainExceptionInterface;
-
-class FileDoesNotExist extends \InvalidArgumentException implements DomainExceptionInterface
+class FileDoesNotExist extends \InvalidArgumentException implements ProviderExceptionInterface
 {
 }
diff --git a/src/Provider/Exception/HeaderMissing.php b/src/Provider/Exception/HeaderMissing.php
@@ -3,8 +3,6 @@
 
 namespace SlayerBirden\DataFlow\Provider\Exception;
 
-use SlayerBirden\DataFlow\Exception\DomainExceptionInterface;
-
-class HeaderMissing extends \LogicException implements DomainExceptionInterface
+class HeaderMissing extends \RuntimeException implements ProviderExceptionInterface
 {
 }
diff --git a/src/Provider/Exception/ProviderException.php b/src/Provider/Exception/ProviderException.php
@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace SlayerBirden\DataFlow\Provider\Exception;
+
+class ProviderException extends \LogicException implements ProviderExceptionInterface
+{
+}
diff --git a/src/Provider/Exception/ProviderExceptionInterface.php b/src/Provider/Exception/ProviderExceptionInterface.php
@@ -1,10 +1,9 @@
 <?php
-declare(strict_types=1);
 
 namespace SlayerBirden\DataFlow\Provider\Exception;
 
 use SlayerBirden\DataFlow\Exception\DomainExceptionInterface;
 
-class HeaderInvalid extends \LogicException implements DomainExceptionInterface
+interface ProviderExceptionInterface extends DomainExceptionInterface
 {
 }
diff --git a/src/Provider/Exception/RowInvalid.php b/src/Provider/Exception/RowInvalid.php
@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace SlayerBirden\DataFlow\Provider\Exception;
+
+class RowInvalid extends \RuntimeException implements ProviderExceptionInterface
+{
+}
diff --git a/tests/unit/Provider/CsvTest.php b/tests/unit/Provider/CsvTest.php
@@ -82,7 +82,7 @@ public function testGetCask()
     }
 
     /**
-     * @expectedException \SlayerBirden\DataFlow\Provider\Exception\HeaderInvalid
+     * @expectedException \SlayerBirden\DataFlow\Provider\Exception\RowInvalid
      */
     public function testInvalidHeader()
     {

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,6 @@`
`3`	`3`
`4`	`4`	`namespace SlayerBirden\DataFlow\Provider\Exception;`
`5`	`5`
`6`		`-use SlayerBirden\DataFlow\Exception\DomainExceptionInterface;`
`7`		`-`
`8`		`-class FileDoesNotExist extends \InvalidArgumentException implements DomainExceptionInterface`
	`6`	`+class FileDoesNotExist extends \InvalidArgumentException implements ProviderExceptionInterface`
`9`	`7`	`{`
`10`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,9 @@`
`1`	`1`	`<?php`
`2`		`-declare(strict_types=1);`
`3`	`2`
`4`	`3`	`namespace SlayerBirden\DataFlow\Provider\Exception;`
`5`	`4`
`6`	`5`	`use SlayerBirden\DataFlow\Exception\DomainExceptionInterface;`
`7`	`6`
`8`		`-class HeaderInvalid extends \LogicException implements DomainExceptionInterface`
	`7`	`+interface ProviderExceptionInterface extends DomainExceptionInterface`
`9`	`8`	`{`
`10`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ public function testGetCask()`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`/**`
`85`		`- * @expectedException \SlayerBirden\DataFlow\Provider\Exception\HeaderInvalid`
	`85`	`+ * @expectedException \SlayerBirden\DataFlow\Provider\Exception\RowInvalid`
`86`	`86`	`*/`
`87`	`87`	`public function testInvalidHeader()`
`88`	`88`	`{`