Gorynych\Testing\Constraint\MatchesJsonSchema

Complexity

Total Complexity

11

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getSchemaValidator()	0	6	1
A	normalizeJson()	0	18	5
A	matches()	0	8	1
A	additionalFailureDescription()	0	15	2
A	toString()	0	3	1

<?php
/**
 * Copyright (c) 2020.
 * @author Paweł Antosiak <contact@pawelantosiak.com>
 */

declare(strict_types=1);

namespace Gorynych\Testing\Constraint;

use JsonSchema\Constraints\Factory;
use JsonSchema\SchemaStorage;
use JsonSchema\Validator;
use PHPUnit\Framework\Constraint\Constraint;

final class MatchesJsonSchema extends Constraint
{
    private object $schema;
    private ?int $checkMode;

    public function __construct(object $schema, ?int $checkMode = null)
    {
        $this->schema = $schema;
        $this->checkMode = $checkMode;
    }

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

    /**
     * {@inheritdoc}
     */
    protected function matches($other): bool
    {
        $other = $this->normalizeJson($other);

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

        return $validator->isValid();
    }

    /**
     * {@inheritdoc}
     */
    protected function additionalFailureDescription($other): string
    {
        $other = $this->normalizeJson($other);

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

        $errors = array_map(
            static function (array $error): string {
                return ($error['property'] ? $error['property'] . ': ' : '') . $error['message'];
            },
            $validator->getErrors()
        );

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

    /**
     * Normalizes a JSON document
     *
     * Specifically, we should ensure that:
     * 1. a JSON object is represented as a PHP object, not as an associative array
     *
     * @param mixed $document
     * @return object|mixed[]|mixed
     * @throws \InvalidArgumentException
     * @throws \UnexpectedValueException
     */
    private function normalizeJson($document)
    {
        if (true === is_scalar($document) || true === is_object($document)) {
            return $document;
        }

        if (false === is_array($document)) {
            throw new \InvalidArgumentException('Document must be scalar, array or object.');
        }

        try {
            $document = json_encode($document, JSON_THROW_ON_ERROR);
            $document = json_decode($document, false, 512, JSON_THROW_ON_ERROR);
        } catch (\JsonException $e) {
            throw new \UnexpectedValueException($e->getMessage());
        }

        return $document;
    }

    private function getSchemaValidator(): Validator
    {
        $schemaStorage = new SchemaStorage();
        $schemaStorage->addSchema('file://schemas', $this->schema);

        return new Validator(new Factory($schemaStorage));
    }
}