Merge pull request #476 from localheinz/fix/deprecate

Fix: Mark check() and coerce() as deprecated
jsonrainbow · Dec 31, 2017 · 7d7f43a · 7d7f43a
2 parents 92ddcea + 284f3e5
commit 7d7f43a
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 13 deletions.
diff --git a/bin/validate-json b/bin/validate-json
@@ -217,7 +217,7 @@ if (isset($arOptions['--dump-schema'])) {
 
 try {
     $validator = new JsonSchema\Validator();
-    $validator->check($data, $schema);
+    $validator->validate($data, $schema);
 
     if ($validator->isValid()) {
         if(isset($arOptions['--verbose'])) {

diff --git a/demo/demo.php b/demo/demo.php
@@ -6,7 +6,7 @@
 
 // Validate
 $validator = new JsonSchema\Validator();
-$validator->check($data, (object) array('$ref' => 'file://' . realpath('schema.json')));
+$validator->validate($data, (object) array('$ref' => 'file://' . realpath('schema.json')));
 
 if ($validator->isValid()) {
     echo "The supplied JSON validates against the schema.\n";

diff --git a/src/JsonSchema/Validator.php b/src/JsonSchema/Validator.php
@@ -72,6 +72,8 @@ public function validate(&$value, $schema = null, $checkMode = null)
 
     /**
      * Alias to validate(), to maintain backwards-compatibility with the previous API
+     *
+     * @deprecated
      */
     public function check($value, $schema)
     {
@@ -80,6 +82,8 @@ public function check($value, $schema)
 
     /**
      * Alias to validate(), to maintain backwards-compatibility with the previous API
+     *
+     * @deprecated
      */
     public function coerce(&$value, $schema)
     {

diff --git a/tests/Constraints/LongArraysTest.php b/tests/Constraints/LongArraysTest.php
@@ -41,7 +41,7 @@ public function testLongStringArray()
 
         $validator = new Validator(new Factory($schemaStorage));
         $checkValue = json_decode($input);
-        $validator->check($checkValue, $schema);
+        $validator->validate($checkValue, $schema);
         $this->assertTrue($validator->isValid(), print_r($validator->getErrors(), true));
     }
 
@@ -69,7 +69,7 @@ public function testLongNumberArray()
 
         $validator = new Validator(new Factory($schemaStorage));
         $checkValue = json_decode($input);
-        $validator->check($checkValue, $schema);
+        $validator->validate($checkValue, $schema);
         $this->assertTrue($validator->isValid(), print_r($validator->getErrors(), true));
     }
 
@@ -97,7 +97,7 @@ public function testLongIntegerArray()
 
         $validator = new Validator(new Factory($schemaStorage));
         $checkValue = json_decode($input);
-        $validator->check($checkValue, $schema);
+        $validator->validate($checkValue, $schema);
         $this->assertTrue($validator->isValid(), print_r($validator->getErrors(), true));
     }
 }
diff --git a/tests/Constraints/PointerTest.php b/tests/Constraints/PointerTest.php
@@ -83,7 +83,7 @@ public function testVariousPointers()
 
         $validator = new Validator();
         $checkValue = json_decode(json_encode($value));
-        $validator->check($checkValue, json_decode(json_encode($schema)));
+        $validator->validate($checkValue, json_decode(json_encode($schema)));
 
         $this->assertEquals(
             array(

diff --git a/tests/Constraints/SelfDefinedSchemaTest.php b/tests/Constraints/SelfDefinedSchemaTest.php
@@ -69,8 +69,13 @@ public function getValidTests()
 
     public function testInvalidArgumentException()
     {
+        $value = json_decode('{}');
+        $schema = json_decode('');
+
         $v = new Validator();
+
         $this->setExpectedException('\JsonSchema\Exception\InvalidArgumentException');
-        $v->check(json_decode('{}'), json_decode(''));
+
+        $v->validate($value, $schema);
     }
 }
diff --git a/tests/Uri/UriRetrieverTest.php b/tests/Uri/UriRetrieverTest.php
@@ -55,7 +55,7 @@ public function testChildExtendsParentValidTest($childSchema, $parentSchema)
         $decodedJson = json_decode($json);
         $decodedJsonSchema = json_decode($childSchema);
 
-        $this->validator->check($decodedJson, $decodedJsonSchema);
+        $this->validator->validate($decodedJson, $decodedJsonSchema);
         $this->assertTrue($this->validator->isValid());
     }
 
@@ -70,7 +70,7 @@ public function testChildExtendsParentInvalidChildTest($childSchema, $parentSche
         $decodedJson = json_decode($json);
         $decodedJsonSchema = json_decode($childSchema);
 
-        $this->validator->check($decodedJson, $decodedJsonSchema);
+        $this->validator->validate($decodedJson, $decodedJsonSchema);
         $this->assertFalse($this->validator->isValid());
     }
 
@@ -85,7 +85,7 @@ public function testChildExtendsParentInvalidParentTest($childSchema, $parentSch
         $decodedJson = json_decode($json);
         $decodedJsonSchema = json_decode($childSchema);
 
-        $this->validator->check($decodedJson, $decodedJsonSchema);
+        $this->validator->validate($decodedJson, $decodedJsonSchema);
         $this->assertFalse($this->validator->isValid());
     }
 
@@ -101,7 +101,7 @@ public function testResolveRelativeUri($childSchema, $parentSchema)
         $decodedJson = json_decode($json);
         $decodedJsonSchema = json_decode($childSchema);
 
-        $this->validator->check($decodedJson, $decodedJsonSchema);
+        $this->validator->validate($decodedJson, $decodedJsonSchema);
         $this->assertTrue($this->validator->isValid());
     }
 

diff --git a/tests/ValidatorTest.php b/tests/ValidatorTest.php
@@ -35,7 +35,7 @@ public function testBadAssocSchemaInput()
         $validator->validate($data, $schema);
     }
 
-    public function testCheck()
+    public function testDeprecatedCheckDelegatesToValidate()
     {
         $schema = json_decode('{"type":"string"}');
         $data = json_decode('42');
@@ -46,7 +46,7 @@ public function testCheck()
         $this->assertFalse($validator->isValid(), 'Validation succeeded, but should have failed.');
     }
 
-    public function testCoerce()
+    public function testDeprecatedCoerceDelegatesToValidate()
     {
         $schema = json_decode('{"type":"integer"}');
         $data = json_decode('"42"');