Add new json Validator

zairigimad · zairigimad · commit d59691b901b5 · 2018-09-19T20:23:18.000+02:00
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -10,7 +10,8 @@ CHANGELOG
  * made `ValidatorBuilder` final
  * marked `format` the default option in `DateTime` constraint
  * deprecated validating instances of `\DateTimeInterface` in `DateTimeValidator`, `DateValidator` and `TimeValidator`.
-
+ * added `Json` constraint
+ 
 4.1.0
 -----
 
diff --git a/src/Symfony/Component/Validator/Constraints/Json.php b/src/Symfony/Component/Validator/Constraints/Json.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
+ *
+ * @author Imad ZAIRIG <imadzairig@gmail.com>
+ */
+class Json extends Constraint
+{
+    const NOT_JSON_ERROR = '0789c8ad-2d2b-49a4-8356-e2ce63998504';
+
+    protected static $errorNames = array(
+        self::NOT_JSON_ERROR => 'NOT_JSON_ERROR',
+    );
+
+    public $message = 'This value should be valid json.';
+}
diff --git a/src/Symfony/Component/Validator/Constraints/JsonValidator.php b/src/Symfony/Component/Validator/Constraints/JsonValidator.php
@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+
+/**
+ * @author Imad ZAIRIG <imadzairig@gmail.com>
+ */
+class JsonValidator extends ConstraintValidator
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function validate($value, Constraint $constraint)
+    {
+        if (!$constraint instanceof Json) {
+            throw new UnexpectedTypeException($constraint, Json::class);
+        }
+
+        if (null === $value || '' === $value) {
+            return;
+        }
+
+        if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
+            throw new UnexpectedTypeException($value, 'string');
+        }
+
+        $value = (string) $value;
+
+        if (!$this->isJson($value)) {
+            $this->context->buildViolation($constraint->message)
+                ->setParameter('{{ value }}', $this->formatValue($value))
+                ->setCode(Json::NOT_JSON_ERROR)
+                ->addViolation();
+        }
+    }
+
+    protected function isJson(string $string): bool
+    {
+        json_decode($string);
+
+        return JSON_ERROR_NONE === json_last_error();
+    }
+}
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/JsonValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/JsonValidatorTest.php
@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Constraints;
+
+use Symfony\Component\Validator\Constraints\Json;
+use Symfony\Component\Validator\Constraints\JsonValidator;
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+class JsonValidatorTest extends ConstraintValidatorTestCase
+{
+    protected function createValidator()
+    {
+        return new JsonValidator();
+    }
+
+    /**
+     * @dataProvider getValidValues
+     */
+    public function testJsonIsValid($value)
+    {
+        $this->validator->validate($value, new Json());
+
+        $this->assertNoViolation();
+    }
+
+    /**
+     * @dataProvider getInvalidValues
+     */
+    public function testInvalidValues($value)
+    {
+        $constraint = new Json(array(
+            'message' => 'myMessageTest',
+        ));
+
+        $this->validator->validate($value, $constraint);
+
+        $this->buildViolation('myMessageTest')
+            ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setCode(Json::NOT_JSON_ERROR)
+            ->assertRaised();
+    }
+
+    public function getValidValues()
+    {
+        return array(
+            array('{"planet":"earth", "country": "Morocco","city": "Rabat" ,"postcode" : 10160, "is_great": true,
+			  "img" : null, "area": 118.5, "foo": 15 }'),
+            array(null),
+            array(''),
+            array('"null"'),
+            array('null'),
+            array('"string"'),
+            array('1'),
+            array('true'),
+            array(1),
+        );
+    }
+
+    public function getInvalidValues()
+    {
+        return array(
+            array('{"foo": 3 "bar": 4}'),
+            array('{"foo": 3 ,"bar": 4'),
+            array('{foo": 3, "bar": 4}'),
+            array('foo'),
+        );
+    }
+}
