Merge pull request #72 from chadicus/fea/string-filter

Allow String::Filter to accept scalars and objects with __tostring

Author: chadicus

src/Filter/Strings.php

@@ -45,6 +45,14 @@ public static function filter($value, $allowNull = false, $minLength = 1, $maxLe
             return null;
         }
 
+        if (is_scalar($value)) {
+            $value = "{$value}";
+        }
+
+        if (is_object($value) && method_exists($value, '__toString')) {
+            $value = (string)$value;
+        }
+
         if (!is_string($value)) {
             throw new \Exception("Value '" . var_export($value, true) . "' is not a string");
         }

tests/Filter/ArraysTest.php

@@ -172,11 +172,17 @@ public function ofScalarsWithMeaninglessKeys()
     public function ofScalarsFail()
     {
         try {
-            Arrays::ofScalars(['1', 2, 3], [['string']]);
+            Arrays::ofScalars(['1', [], new \StdClass], [['string']]);
             $this->fail();
         } catch (\Exception $e) {
-            $expected = "Field '1' with value '2' failed filtering, message 'Value '2' is not a string'\n";
-            $expected .= "Field '2' with value '3' failed filtering, message 'Value '3' is not a string'";
+            $expected = <<<TXT
+Field '1' with value 'array (
+)' failed filtering, message 'Value 'array (
+)' is not a string'
+Field '2' with value 'stdClass::__set_state(array(
+))' failed filtering, message 'Value 'stdClass::__set_state(array(
+))' is not a string'
+TXT;
             $this->assertSame($expected, $e->getMessage());
         }
     }
@@ -224,12 +230,22 @@ public function ofArraysRequiredAndUnknown()
     public function ofArraysFail()
     {
         try {
-            Arrays::ofArrays([['key' => '1'], ['key' => 2], ['key' => 3], 'key'], ['key' => [['string']]]);
+            Arrays::ofArrays(
+                [['key' => new \StdClass], ['key' => []], ['key' => null], 'key'],
+                ['key' => [['string']]]
+            );
             $this->fail();
         } catch (\Exception $e) {
-            $expected = "Field 'key' with value '2' failed filtering, message 'Value '2' is not a string'\n";
-            $expected .= "Field 'key' with value '3' failed filtering, message 'Value '3' is not a string'\n";
-            $expected .= "Value at position '3' was not an array";
+            $expected = <<<TXT
+Field 'key' with value 'stdClass::__set_state(array(
+))' failed filtering, message 'Value 'stdClass::__set_state(array(
+))' is not a string'
+Field 'key' with value 'array (
+)' failed filtering, message 'Value 'array (
+)' is not a string'
+Field 'key' with value 'NULL' failed filtering, message 'Value 'NULL' is not a string'
+Value at position '3' was not an array
+TXT;
             $this->assertSame($expected, $e->getMessage());
         }
     }

tests/Filter/StringsTest.php

@@ -7,14 +7,33 @@
 final class StringsTest extends \PHPUnit_Framework_TestCase
 {
     /**
+     * Verify basic use of filter
+     *
      * @test
-     * @expectedException Exception
-     * @expectedExceptionMessage Value '1' is not a string
      * @covers ::filter
+     * @dataProvider filterData
+     *
+     * @return void
+     */
+    public function filter($input, $expected)
+    {
+        $this->assertSame($expected, Strings::filter($input));
+    }
+
+    /**
+     * Data provider for basic filter tests
+     *
+     * @return array
      */
-    public function filterNotString()
+    public function filterData()
     {
-        Strings::filter(1);
+        return [
+            'string' => ['abc', 'abc'],
+            'int' => [1, '1'],
+            'float' => [1.1, '1.1'],
+            'bool' => [true, '1'],
+            'object' => [new \SplFileInfo(__FILE__), __FILE__],
+        ];
     }
 
     /**