Add CHECK_MODE_EARLY_COERCE

If set, falls back to the old behavior of coercing to the first
compatible type, regardless of whether another already-valid type might
be available.

Author: erayd

README.md

@@ -186,12 +186,17 @@ third argument to `Validator::validate()`, or can be provided as the third argum
 | `Constraint::CHECK_MODE_NORMAL` | Validate in 'normal' mode - this is the default |
 | `Constraint::CHECK_MODE_TYPE_CAST` | Enable fuzzy type checking for associative arrays and objects |
 | `Constraint::CHECK_MODE_COERCE_TYPES` | Convert data types to match the schema where possible |
+| `Constraint::CHECK_MODE_EARLY_COERCE` | Apply type coercion as soon as possible |
 | `Constraint::CHECK_MODE_APPLY_DEFAULTS` | Apply default values from the schema if not set |
 | `Constraint::CHECK_MODE_EXCEPTIONS` | Throw an exception immediately if validation fails |
 | `Constraint::CHECK_MODE_DISABLE_FORMAT` | Do not validate "format" constraints |
 
-Please note that using `Constraint::CHECK_MODE_COERCE_TYPES` or `Constraint::CHECK_MODE_APPLY_DEFAULTS`
-will modify your original data.
+Please note that using `CHECK_MODE_COERCE_TYPES` or `CHECK_MODE_APPLY_DEFAULTS` will modify your
+original data.
+
+`CHECK_MODE_EARLY_COERCE` has no effect unless used in combination with `CHECK_MODE_COERCE_TYPES`. If
+enabled, type coercion will occur as soon as possible, even if the value may already be of another valid
+type.
 
 ## Running the tests
 

src/JsonSchema/Constraints/Constraint.php

@@ -31,6 +31,7 @@ abstract class Constraint extends BaseConstraint implements ConstraintInterface
     const CHECK_MODE_APPLY_DEFAULTS =   0x00000008;
     const CHECK_MODE_EXCEPTIONS =       0x00000010;
     const CHECK_MODE_DISABLE_FORMAT =   0x00000020;
+    const CHECK_MODE_EARLY_COERCE =     0x00000040;
 
     /**
      * Bubble down the path

src/JsonSchema/Constraints/TypeConstraint.php

@@ -45,20 +45,21 @@ public function check(&$value = null, $schema = null, JsonPointer $path = null,
         $type = isset($schema->type) ? $schema->type : null;
         $isValid = false;
         $coerce = $this->factory->getConfig(self::CHECK_MODE_COERCE_TYPES);
+        $earlyCoerce = $this->factory->getConfig(self::CHECK_MODE_EARLY_COERCE);
         $wording = array();
 
         if (is_array($type)) {
-            $this->validateTypesArray($value, $type, $wording, $isValid, $path, false);
-            if (!$isValid && $coerce) {
+            $this->validateTypesArray($value, $type, $wording, $isValid, $path, $coerce && $earlyCoerce);
+            if (!$isValid && $coerce && !$earlyCoerce) {
                 $this->validateTypesArray($value, $type, $wording, $isValid, $path, true);
             }
         } elseif (is_object($type)) {
             $this->checkUndefined($value, $type, $path);
 
             return;
         } else {
-            $isValid = $this->validateType($value, $type, false);
-            if (!$isValid && $coerce) {
+            $isValid = $this->validateType($value, $type, $coerce && $earlyCoerce);
+            if (!$isValid && $coerce && !$earlyCoerce) {
                 $isValid = $this->validateType($value, $type, true);
             }
         }

tests/Constraints/CoerciveTest.php

@@ -136,12 +136,22 @@ public function dataCoerceCases()
             'array', 'array', array(42, '42'), true
         );
 
+        // #44 check early coercion
+        $tests[] = array(
+            '{"properties":{"propertyOne":{"type":["object", "number", "string"]}}}',
+            '{"propertyOne":"42"}',
+            'string', 'integer', 42, true, true
+        );
+
         return $tests;
     }
 
     /** @dataProvider dataCoerceCases **/
-    public function testCoerceCases($schema, $data, $startType, $endType, $endValue, $valid, $assoc = false)
+    public function testCoerceCases($schema, $data, $startType, $endType, $endValue, $valid, $early = false, $assoc = false)
     {
+        if ($early) {
+            $this->factory->addConfig(Constraint::CHECK_MODE_EARLY_COERCE);
+        }
         $validator = new Validator($this->factory);
 
         $schema = json_decode($schema);
@@ -181,11 +191,13 @@ public function testCoerceCases($schema, $data, $startType, $endType, $endValue,
             $this->assertFalse($validator->isValid(), 'Validation succeeded, but should have failed');
             $this->assertEquals(1, count($validator->getErrors()));
         }
+
+        $this->factory->removeConfig(Constraint::CHECK_MODE_EARLY_COERCE);
     }
 
     /** @dataProvider dataCoerceCases **/
-    public function testCoerceCasesUsingAssoc($schema, $data, $startType, $endType, $endValue, $valid)
+    public function testCoerceCasesUsingAssoc($schema, $data, $startType, $endType, $endValue, $valid, $early = false)
     {
-        $this->testCoerceCases($schema, $data, $startType, $endType, $endValue, $valid, true);
+        $this->testCoerceCases($schema, $data, $startType, $endType, $endValue, $valid, $early, true);
     }
 }