net.pwall.json.schema.subschema.AdditionalPropertiesSchema.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-kotlin-schema Show documentation
The newest version!
/*
 * @(#) AdditionalPropertiesSchema.kt
 *
 * json-kotlin-schema Kotlin implementation of JSON Schema
 * Copyright (c) 2020 Peter Wall
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package net.pwall.json.schema.subschema

import java.net.URI

import io.kjson.JSONObject
import io.kjson.JSONValue
import io.kjson.pointer.JSONPointer
import io.kjson.pointer.get

import net.pwall.json.schema.JSONSchema
import net.pwall.json.schema.output.BasicErrorEntry
import net.pwall.json.schema.output.BasicOutput
import net.pwall.json.schema.output.DetailedOutput

class AdditionalPropertiesSchema(private val parent: General, uri: URI?, location: JSONPointer,
        val schema: JSONSchema) : JSONSchema.SubSchema(uri, location) {

    override fun childLocation(pointer: JSONPointer): JSONPointer = pointer.child("additionalProperties")

    override fun validate(json: JSONValue?, instanceLocation: JSONPointer): Boolean {
        val instance = json[instanceLocation]
        if (instance !is JSONObject)
            return true
        val propertiesSchema = parent.children.filterIsInstance().firstOrNull()
        val patternPropertiesSchema = parent.children.filterIsInstance().firstOrNull()
        instance.keys.forEach { key ->
            if (!anyMatchingProperty(key, propertiesSchema, patternPropertiesSchema)) {
                if (!schema.validate(json, instanceLocation.child(key)))
                    return false
            }
        }
        return true
    }

    override fun validateBasic(relativeLocation: JSONPointer, json: JSONValue?, instanceLocation: JSONPointer):
            BasicOutput {
        val instance = json[instanceLocation]
        if (instance !is JSONObject)
            return BasicOutput.trueOutput
        val errors = mutableListOf()
        val propertiesSchema = parent.children.filterIsInstance().firstOrNull()
        val patternPropertiesSchema = parent.children.filterIsInstance().firstOrNull()
        instance.keys.forEach { key ->
            if (!anyMatchingProperty(key, propertiesSchema, patternPropertiesSchema)) {
                schema.validateBasic(relativeLocation, json, instanceLocation.child(key)).let {
                    if (!it.valid) {
                        errors.add(createBasicErrorEntry(relativeLocation, instanceLocation.child(key),
                                "Additional property '$key' found but was invalid"))
                        errors.addAllFromNullable(it.errors)
                    }
                }
            }
        }
        if (errors.isEmpty())
            return BasicOutput.trueOutput
        return BasicOutput(false, errors)
    }

    override fun validateDetailed(relativeLocation: JSONPointer, json: JSONValue?, instanceLocation: JSONPointer):
            DetailedOutput {
        val instance = json[instanceLocation]
        if (instance !is JSONObject)
            return createAnnotation(relativeLocation, instanceLocation, "Value is not an object")
        val errors = mutableListOf()
        val propertiesSchema = parent.children.filterIsInstance().firstOrNull()
        val patternPropertiesSchema = parent.children.filterIsInstance().firstOrNull()
        instance.keys.forEach { key ->
            if (!anyMatchingProperty(key, propertiesSchema, patternPropertiesSchema)) {
                schema.validateDetailed(relativeLocation, json, instanceLocation.child(key)).let {
                    if (!it.valid)
                        errors.add(createError(relativeLocation, instanceLocation.child(key),
                                "Additional property '$key' found but was invalid", errors = listOf(it)))
                }
            }
        }
        return when (errors.size) {
            0 -> createAnnotation(relativeLocation, instanceLocation, "properties are valid")
            1 -> errors[0]
            else -> createError(relativeLocation, instanceLocation, "Errors in properties", errors = errors)
        }
    }

    private fun anyMatchingProperty(propertyName: String, propertiesSchema: PropertiesSchema?,
            patternPropertiesSchema: PatternPropertiesSchema?): Boolean {
        if (propertiesSchema != null && propertiesSchema.properties.any { it.first == propertyName })
            return true
        if (patternPropertiesSchema != null &&
                patternPropertiesSchema.properties.any { it.first.containsMatchIn(propertyName) })
            return true
        return false
    }

    /**
     * Compare two `AdditionalPropertiesSchema` objects for equality.
     *
     * This will report two objects as equal even if the `parent` is different, because including the parent in the
     * comparison leads to infinite recursion.  This should be a reasonable approach, since the function will mostly be
     * called as a nested equality comparison on the parent object.
     *
     * @param   other       the other object
     * @return              `true` if the two objects are equal, subject to the above note.
     */
    override fun equals(other: Any?): Boolean = this === other || other is AdditionalPropertiesSchema &&
            super.equals(other) && schema == other.schema

    override fun hashCode(): Int = super.hashCode() xor schema.hashCode()

}