ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\MatchesJsonSchema

Complexity

Total Complexity

13

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	toString()	0	3	1
A	__construct()	0	4	2
A	additionalFailureDescription()	0	14	3
A	matches()	0	12	2
A	canonicalizeJson()	0	14	5

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint;

use ApiPlatform\Core\JsonSchema\Schema;
use JsonSchema\Validator;
use PHPUnit\Framework\Constraint\Constraint;

/**
 * Asserts that a JSON document matches a given JSON Schema.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 *
 * @experimental
 */
final class MatchesJsonSchema extends Constraint
{
    private $schema;
    private $checkMode;

    /**
     * @param array|string $schema
     */
    public function __construct($schema, ?int $checkMode = null)
    {
        $this->schema = \is_array($schema) ? (object) $schema : json_decode($schema);
        $this->checkMode = $checkMode;
    }

    /**
     * {@inheritdoc}
     */
    public function toString(): string
    {
        return 'matches the provided JSON Schema';
    }

    /**
     * @param array|object $other
     */
    protected function matches($other): bool
    {
        if (!class_exists(Validator::class)) {
            throw new \RuntimeException('The "justinrainbow/json-schema" library must be installed to use "assertMatchesJsonSchema()". Try running "composer require --dev justinrainbow/json-schema".');
        }

        $other = $this->canonicalizeJson($other);

        $validator = new Validator();
        $validator->validate($other, $this->schema, $this->checkMode);

        return $validator->isValid();
    }

    /**
     * @param array|object $other
     */
    protected function additionalFailureDescription($other): string
    {
        $other = $this->canonicalizeJson($other);

        $validator = new Validator();
        $validator->check($other, $this->schema);

        $errors = [];
        foreach ($validator->getErrors() as $error) {
            $property = $error['property'] ? $error['property'].': ' : '';
            $errors[] = $property.$error['message'];
        }

        return implode("\n", $errors);
    }

    /**
     * @param array|object $data A representation of a JSON array or JSON object
     *
     * @return array|object An array if data is a JSON array, or an object if data is a JSON object
     */
    private function canonicalizeJson($data)
    {
        if (!(\is_array($data) || \is_object($data))) {
            throw new \InvalidArgumentException('Data must be array or object.');
        }

        $data = (string) json_encode($data);
        $data = json_decode($data);

        if (!(\is_array($data) || \is_object($data))) {
            throw new \UnexpectedValueException('JSON encoding / decoding failed.');
        }

        return $data;
    }
}