Merge pull request #92 from chadicus/fea/throw-on-error

Add FilterOptions::THROW_ON_ERROR
traderinteractive · Jul 7, 2020 · 047bc08 · 047bc08
2 parents 408c7c9 + e2e492f
commit 047bc08
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 1 deletion.
diff --git a/composer.json b/composer.json
@@ -41,7 +41,8 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.0",
         "phpunit/phpunit": "^6.0",
-        "squizlabs/php_codesniffer": "^3.2"
+        "squizlabs/php_codesniffer": "^3.2",
+        "symfony/yaml": "^3.4"
     },
     "autoload": {
         "psr-4": { "TraderInteractive\\": "src/" }

diff --git a/src/FilterOptions.php b/src/FilterOptions.php
@@ -28,4 +28,9 @@ final class FilterOptions
      * @var string
      */
     const USES = 'uses';
+
+    /**
+     * @var string
+     */
+    const THROW_ON_ERROR = 'throwOnError';
 }
diff --git a/src/Filterer.php b/src/Filterer.php
@@ -61,6 +61,13 @@ final class Filterer implements FiltererInterface
      */
     const RESPONSE_TYPE_FILTER = FilterResponse::class;
 
+    /**
+     * @var string
+     */
+    const INVALID_THROW_ON_ERROR_VALUE_ERROR_FORMAT = (
+        FilterOptions::THROW_ON_ERROR . " for field '%s' was not a boolean value"
+    );
+
     /**
      * @var array
      */
@@ -139,6 +146,7 @@ public function execute(array $input) : FilterResponse
             $filters = $this->specification[$field];
             self::assertFiltersIsAnArray($filters, $field);
             $customError = self::validateCustomError($filters, $field);
+            $throwOnError = self::validateThrowOnError($filters, $field);
             unset($filters[FilterOptions::IS_REQUIRED]);//doesn't matter if required since we have this one
             unset($filters[FilterOptions::DEFAULT_VALUE]);//doesn't matter if there is a default since we have a value
             $conflicts = self::extractConflicts($filters, $field, $conflicts);
@@ -162,6 +170,10 @@ public function execute(array $input) : FilterResponse
                     $this->addUsedInputToFilter($uses, $filteredInput, $field, $filter);
                     $input = call_user_func_array($function, $filter);
                 } catch (Exception $exception) {
+                    if ($throwOnError) {
+                        throw $exception;
+                    }
+
                     $errors = self::handleCustomError($field, $input, $exception, $errors, $customError);
                     continue 2;//next field
                 }
@@ -602,6 +614,24 @@ private static function assertFilterIsArray($filter, string $field)
         }
     }
 
+    private static function validateThrowOnError(array &$filters, string $field) : bool
+    {
+        if (!array_key_exists(FilterOptions::THROW_ON_ERROR, $filters)) {
+            return false;
+        }
+
+        $throwOnError = $filters[FilterOptions::THROW_ON_ERROR];
+        if ($throwOnError !== true && $throwOnError !== false) {
+            throw new InvalidArgumentException(
+                sprintf(self::INVALID_THROW_ON_ERROR_VALUE_ERROR_FORMAT, $field)
+            );
+        }
+
+        unset($filters[FilterOptions::THROW_ON_ERROR]);
+
+        return $throwOnError;
+    }
+
     private static function validateCustomError(array &$filters, string $field)
     {
         $customError = null;

diff --git a/tests/FiltererTest.php b/tests/FiltererTest.php
@@ -5,6 +5,7 @@
 use Exception;
 use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
+use RuntimeException;
 use stdClass;
 use Throwable;
 use TraderInteractive\Exceptions\FilterException;
@@ -380,6 +381,47 @@ function (int $input, int $fieldOneValue) : int {
         ];
     }
 
+    /**
+     * @test
+     * @covers ::execute
+     */
+    public function executeThrowsOnError()
+    {
+        $exception = new RuntimeException('the error');
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage($exception->getMessage());
+        $filter = function () use ($exception) {
+            throw $exception;
+        };
+
+        $specification = [
+            'id' => [
+                FilterOptions::THROW_ON_ERROR => true,
+                [$filter],
+            ],
+        ];
+        $filterer = new Filterer($specification);
+        $filterer->execute(['id' => 1]);
+    }
+
+    /**
+     * @test
+     * @covers ::execute
+     */
+    public function executeValidatesThrowsOnError()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage(sprintf(Filterer::INVALID_THROW_ON_ERROR_VALUE_ERROR_FORMAT, 'id'));
+        $specification = [
+            'id' => [
+                FilterOptions::THROW_ON_ERROR => 'abc',
+                ['uint'],
+            ],
+        ];
+        $filterer = new Filterer($specification);
+        $filterer->execute(['id' => 1]);
+    }
+
     /**
      * @test
      * @covers ::filter