Merge pull request #21 from gaillard/master

Add ofArray filter

Author: chadicus

src/DominionEnterprises/Filter/Arrays.php

@@ -144,4 +144,25 @@ public static function ofArrays(array $values, array $spec)
 
         return $results;
     }
+
+    /**
+     * Filter $value by using a Filterer $spec and Filterer's default options.
+     *
+     * @param array $value array to be filtered. Use the Arrays::filter() before this method to ensure counts when you pass into Filterer
+     * @param array $spec spec to apply to $value, specified the same as in @see Filterer::filter.
+     *     Eg ['key' => ['required' => true, ['string', false], ['unit']], 'key2' => ...]
+     *
+     * @return array the filtered $value
+     *
+     * @throws \Exception if $value fails filtering
+     */
+    public static function ofArray(array $value, array $spec)
+    {
+        list($status, $result, $error) = Filterer::filter($spec, $value);
+        if (!$status) {
+            throw new \Exception($error);
+        }
+
+        return $result;
+    }
 }

src/DominionEnterprises/Filterer.php

@@ -20,6 +20,7 @@ final class Filterer
         'string' => '\DominionEnterprises\Filter\String::filter',
         'ofScalars' => '\DominionEnterprises\Filter\Arrays::ofScalars',
         'ofArrays' => '\DominionEnterprises\Filter\Arrays::ofArrays',
+        'ofArray' => '\DominionEnterprises\Filter\Arrays::ofArray',
     );
 
     /**

tests/DominionEnterprises/Filter/ArraysTest.php

@@ -230,4 +230,67 @@ public function ofArrays_fail()
             $this->assertSame($expected, $e->getMessage());
         }
     }
+
+    /**
+     * @test
+     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     */
+    public function ofArray()
+    {
+        $expected = array('key1' => 1, 'key2' => 2);
+        $spec = array('key1' => array(array('uint')), 'key2' => array(array('uint')));
+        $this->assertSame($expected, A::ofArray(array('key1' => '1', 'key2' => '2'), $spec));
+    }
+
+    /**
+     * @test
+     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     */
+    public function ofArray_chained()
+    {
+        $expected = array('key' => 3.3);
+        $spec = array('key' => array(array('trim', 'a'), array('floatval')));
+        $this->assertSame($expected, A::ofArray(array('key' => 'a3.3'), $spec));
+    }
+
+    /**
+     * @test
+     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     */
+    public function ofArray_requiredSuccess()
+    {
+        $expected = array('key2' => 2);
+        $spec = array('key1' => array(array('uint')), 'key2' => array('required' => true, array('uint')));
+        $this->assertSame($expected, A::ofArray(array('key2' => '2'), $spec));
+    }
+
+    /**
+     * @test
+     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     */
+    public function ofArray_requiredFail()
+    {
+        try {
+            A::ofArray(array('key1' => '1'), array('key1' => array(array('uint')), 'key2' => array('required' => true, array('uint'))));
+            $this->fail();
+        } catch (\Exception $e) {
+            $expected = "Field 'key2' was required and not present";
+            $this->assertSame($expected, $e->getMessage());
+        }
+    }
+
+    /**
+     * @test
+     * @covers \DominionEnterprises\Filter\Arrays::ofArray
+     */
+    public function ofArray_unknown()
+    {
+        try {
+            A::ofArray(array('key' => '1'), array('key2' => array(array('uint'))));
+            $this->fail();
+        } catch (\Exception $e) {
+            $expected = "Field 'key' with value '1' is unknown";
+            $this->assertSame($expected, $e->getMessage());
+        }
+    }
 }