Merge pull request #80 from chadicus/master

Add Filter Alias for Arrays::arrayize()

Author: chadicus

README.md

@@ -156,6 +156,13 @@ The following does a strict check for `$value` against the 3 accepted values.
 \TraderInteractive\Filter\Arrays::in($value, ['a', 'b', 'c']);
 ```
 
+#### Arrays::arrayize
+Aliased in the filterer as `arrayize`, this filter returns this original input if it is an array, otherwise returns input wrapped in an array. If the original input is null, an empty array is returned.
+```php
+$value = \TraderInteractive\Filter\Arrays::arrayize('a string value');
+assert($value === ['a string value']);
+```
+
 #### Arrays::filter
 Aliased in the filterer as `array`, this filter verifies that the argument is an array and checks the length of the array against bounds.  The
 default bounds are 1+, so an empty array fails by default.

composer.json

@@ -30,7 +30,7 @@
     "license": "MIT",
     "require": {
         "php": "^7.0",
-        "traderinteractive/filter-arrays": "^3.0",
+        "traderinteractive/filter-arrays": "^3.1",
         "traderinteractive/filter-bools": "^3.0",
         "traderinteractive/filter-dates": "^3.0",
         "traderinteractive/filter-floats": "^3.0",

src/Filterer.php

@@ -15,25 +15,26 @@ final class Filterer
      * @var array
      */
     const DEFAULT_FILTER_ALIASES = [
-        'in' => '\TraderInteractive\Filter\Arrays::in',
-        'array' => '\TraderInteractive\Filter\Arrays::filter',
-        'bool' => '\TraderInteractive\Filter\Booleans::filter',
-        'float' => '\TraderInteractive\Filter\Floats::filter',
-        'int' => '\TraderInteractive\Filter\Ints::filter',
-        'bool-convert' => '\TraderInteractive\Filter\Booleans::convert',
-        'uint' => '\TraderInteractive\Filter\UnsignedInt::filter',
-        'string' => '\TraderInteractive\Filter\Strings::filter',
-        'ofScalars' => '\TraderInteractive\Filterer::ofScalars',
-        'ofArrays' => '\TraderInteractive\Filterer::ofArrays',
-        'ofArray' => '\TraderInteractive\Filterer::ofArray',
-        'url' => '\TraderInteractive\Filter\Url::filter',
-        'email' => '\TraderInteractive\Filter\Email::filter',
-        'explode' => '\TraderInteractive\Filter\Strings::explode',
-        'strip-tags' => '\TraderInteractive\Filter\Strings::stripTags',
-        'flatten' => '\TraderInteractive\Filter\Arrays::flatten',
-        'date' => '\TraderInteractive\Filter\DateTime::filter',
-        'date-format' => '\TraderInteractive\Filter\DateTime::format',
-        'timezone' => '\TraderInteractive\Filter\DateTimeZone::filter',
+        'array' => '\\TraderInteractive\\Filter\\Arrays::filter',
+        'arrayize' => '\\TraderInteractive\\Filter\\Arrays::arrayize',
+        'bool' => '\\TraderInteractive\\Filter\\Booleans::filter',
+        'bool-convert' => '\\TraderInteractive\\Filter\\Booleans::convert',
+        'date' => '\\TraderInteractive\\Filter\\DateTime::filter',
+        'date-format' => '\\TraderInteractive\\Filter\\DateTime::format',
+        'email' => '\\TraderInteractive\\Filter\\Email::filter',
+        'explode' => '\\TraderInteractive\\Filter\\Strings::explode',
+        'flatten' => '\\TraderInteractive\\Filter\\Arrays::flatten',
+        'float' => '\\TraderInteractive\\Filter\\Floats::filter',
+        'in' => '\\TraderInteractive\\Filter\\Arrays::in',
+        'int' => '\\TraderInteractive\\Filter\\Ints::filter',
+        'ofArray' => '\\TraderInteractive\\Filterer::ofArray',
+        'ofArrays' => '\\TraderInteractive\\Filterer::ofArrays',
+        'ofScalars' => '\\TraderInteractive\\Filterer::ofScalars',
+        'string' => '\\TraderInteractive\\Filter\\Strings::filter',
+        'strip-tags' => '\\TraderInteractive\\Filter\\Strings::stripTags',
+        'timezone' => '\\TraderInteractive\\Filter\\DateTimeZone::filter',
+        'uint' => '\\TraderInteractive\\Filter\\UnsignedInt::filter',
+        'url' => '\\TraderInteractive\\Filter\\Url::filter',
     ];
 
     /**

tests/FiltererTest.php

@@ -647,4 +647,16 @@ public function ofArrayUnknown()
             $this->assertSame($expected, $e->getMessage());
         }
     }
+
+    /**
+     * @tests
+     * @covers ::filter
+     */
+    public function arrayizeAliasIsCalledProperly()
+    {
+        $this->assertSame(
+            [true, ['field' => ['a string value']], null, []],
+            Filterer::filter(['field' => [['arrayize']]], ['field' => 'a string value'])
+        );
+    }
 }