Merge pull request #32 from gaillard/master

Default support and coversDefaultClass

Author: chadicus

README.md

@@ -17,6 +17,7 @@ A filtering implementation for verifying correct data and performing typical mod
   * Class function
   * Built-in function
  * Optional/Required support, field and global level
+ * Default support
  * Chaining filters
  * Optionally returns unknown fields
  * Filter alias support
@@ -39,6 +40,7 @@ list($status, $result, $error, $unknowns) = DominionEnterprises\Filterer::filter
         'field one' => [[$trimFunc], ['substr', 0, 3], [[$appendFilter, 'filter'], 'boo']],
         'field two' => ['required' => true, ['floatval']],
         'field three' => ['required' => false, ['float']],
+        'field four' => ['required' => true, 'default' => 1, ['uint']],
     ],
     ['field one' => ' abcd', 'field two' => '3.14']
 );
@@ -52,11 +54,13 @@ prints
 
 ```php
 bool(true)
-array(2) {
+array(3) {
   'field one' =>
   string(6) "abcboo"
   'field two' =>
   double(3.14)
+  'field four' =>
+  int(1)
 }
 NULL
 array(0) {

src/Filterer.php

@@ -44,6 +44,7 @@ final class Filterer
      *         'field one' => [[$trimFunc], ['substr', 0, 3], [[$appendFilter, 'filter'], 'boo']],
      *         'field two' => ['required' => true, ['floatval']],
      *         'field three' => ['required' => false, ['float']],
+     *         'field four' => ['required' => true, 'default' => 1, ['uint']],
      *     ],
      *     ['field one' => ' abcd', 'field two' => '3.14']
      * );
@@ -56,11 +57,13 @@ final class Filterer
      * prints:
      * <pre>
      * bool(true)
-     * array(2) {
+     * array(3) {
      *   'field one' =>
      *   string(6) "abcboo"
      *   'field two' =>
      *   double(3.14)
+     *   'field four' =>
+     *   int(1)
      * }
      * NULL
      * array(0) {
@@ -72,7 +75,8 @@ final class Filterer
      *     value to filter as its first argument. Two examples would be the string 'trim' or an object function specified like [$obj, 'filter'],
      *     see is_callable() documentation. The rest of the members are extra arguments to the callable. The result of one filter will be the
      *     first argument to the next filter. In addition to the filters, the specification values may contain a 'required' key (default false)
-     *     that controls the same behavior as the 'defaultRequired' option below but on a per field basis.
+     *     that controls the same behavior as the 'defaultRequired' option below but on a per field basis. A 'default' specification value
+     *     may be used to substitute in a default to the $input when the key is not present (whether 'required' is specified or not).
      * @param array $input the input the apply the $spec on.
      * @param array $options 'allowUnknowns' (default false) true to allow unknowns or false to treat as error, 'defaultRequired'
      *     (default false) true to make fields required by default and treat as error on absence and false to allow their absence by default
@@ -115,6 +119,7 @@ public static function filter(array $spec, array $input, array $options = array(
             }
 
             unset($filters['required']);//doesnt matter if required since we have this one
+            unset($filters['default']);//doesnt matter if there is a default since we have a value
             foreach ($filters as $filter) {
                 if (!is_array($filter)) {
                     throw new \InvalidArgumentException("filter for field '{$field}' was not a array");
@@ -152,12 +157,17 @@ public static function filter(array $spec, array $input, array $options = array(
                 throw new \InvalidArgumentException("filters for field '{$field}' was not a array");
             }
 
-            $required = array_key_exists('required', $filters) ? $filters['required'] : $defaultRequired;
+            $required = isset($filters['required']) ? $filters['required'] : $defaultRequired;
 
             if ($required !== false && $required !== true) {
                 throw new \InvalidArgumentException("'required' for field '{$field}' was not a bool");
             }
 
+            if (array_key_exists('default', $filters)) {
+                $inputToFilter[$field] = $filters['default'];
+                continue;
+            }
+
             if ($required) {
                 $errors[] = "Field '{$field}' was required and not present";
             }

tests/Filter/ArraysTest.php

@@ -2,11 +2,14 @@
 namespace DominionEnterprises\Filter;
 use DominionEnterprises\Filter\Arrays as A;
 
+/**
+ * @coversDefaultClass \DominionEnterprises\Filter\Arrays
+ */
 final class ArraysTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      */
     public function filter_basicPass()
     {
@@ -15,7 +18,7 @@ public function filter_basicPass()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      * @expectedException \Exception
      * @expectedExceptionMessage Value '1' is not an array
      */
@@ -26,7 +29,7 @@ public function filter_failNotArray()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      * @expectedException \Exception
      * @expectedExceptionMessage $value count of 0 is less than 1
      */
@@ -37,7 +40,7 @@ public function filter_failEmpty()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      * @expectedException \Exception
      * @expectedExceptionMessage $value count of 1 is less than 2
      */
@@ -48,7 +51,7 @@ public function filter_countLessThanMin()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      * @expectedException \Exception
      * @expectedExceptionMessage $value count of 2 is greater than 1
      */
@@ -59,7 +62,7 @@ public function filter_countGreaterThanMax()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      * @expectedException \InvalidArgumentException
      * @expectedExceptionMessage $minCount was not an int
      */
@@ -70,7 +73,7 @@ public function filter_minCountNotInt()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::filter
+     * @covers ::filter
      * @expectedException \InvalidArgumentException
      * @expectedExceptionMessage $maxCount was not an int
      */
@@ -81,7 +84,7 @@ public function filter_maxCountNotInt()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::in
+     * @covers ::in
      */
     public function in_passStrict()
     {
@@ -90,7 +93,7 @@ public function in_passStrict()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::in
+     * @covers ::in
      */
     public function in_failStrict()
     {
@@ -104,7 +107,7 @@ public function in_failStrict()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::in
+     * @covers ::in
      */
     public function in_failNotStrict()
     {
@@ -118,7 +121,7 @@ public function in_failNotStrict()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::in
+     * @covers ::in
      */
     public function in_passNotStrict()
     {
@@ -127,7 +130,7 @@ public function in_passNotStrict()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::in
+     * @covers ::in
      * @expectedException \InvalidArgumentException
      * @expectedExceptionMessage $strict was not a bool
      */
@@ -138,7 +141,7 @@ public function in_strictNotBool()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofScalars
+     * @covers ::ofScalars
      */
     public function ofScalars()
     {
@@ -147,7 +150,7 @@ public function ofScalars()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofScalars
+     * @covers ::ofScalars
      */
     public function ofScalars_chained()
     {
@@ -156,7 +159,7 @@ public function ofScalars_chained()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofScalars
+     * @covers ::ofScalars
      */
     public function ofScalars_withMeaninglessKeys()
     {
@@ -165,7 +168,7 @@ public function ofScalars_withMeaninglessKeys()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofScalars
+     * @covers ::ofScalars
      */
     public function ofScalars_fail()
     {
@@ -181,7 +184,7 @@ public function ofScalars_fail()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArrays
+     * @covers ::ofArrays
      */
     public function ofArrays()
     {
@@ -191,7 +194,7 @@ public function ofArrays()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArrays
+     * @covers ::ofArrays
      */
     public function ofArrays_chained()
     {
@@ -202,7 +205,7 @@ public function ofArrays_chained()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArrays
+     * @covers ::ofArrays
      */
     public function ofArrays_requiredAndUnknown()
     {
@@ -217,7 +220,7 @@ public function ofArrays_requiredAndUnknown()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArrays
+     * @covers ::ofArrays
      */
     public function ofArrays_fail()
     {
@@ -233,7 +236,7 @@ public function ofArrays_fail()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     * @covers ::ofArray
      */
     public function ofArray()
     {
@@ -244,7 +247,7 @@ public function ofArray()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     * @covers ::ofArray
      */
     public function ofArray_chained()
     {
@@ -255,7 +258,7 @@ public function ofArray_chained()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     * @covers ::ofArray
      */
     public function ofArray_requiredSuccess()
     {
@@ -266,7 +269,7 @@ public function ofArray_requiredSuccess()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     * @covers ::ofArray
      */
     public function ofArray_requiredFail()
     {
@@ -281,7 +284,7 @@ public function ofArray_requiredFail()
 
     /**
      * @test
-     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     * @covers ::ofArray
      */
     public function ofArray_unknown()
     {