Add comments for model classes. Simplify array interface

Author: OptimumCode

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/factories/array/AdditionalItemsAssertion.kt

@@ -7,6 +7,7 @@ import io.github.optimumcode.json.schema.internal.AssertionContext
 import io.github.optimumcode.json.schema.internal.JsonSchemaAssertion
 import io.github.optimumcode.json.schema.model.AbstractElement
 import io.github.optimumcode.json.schema.model.ArrayElement
+import io.github.optimumcode.json.schema.model.lastIndex
 
 internal class AdditionalItemsAssertion(
   private val location: JsonPointer,

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/factories/array/AllItemsAssertion.kt

@@ -7,6 +7,7 @@ import io.github.optimumcode.json.schema.internal.AssertionContext
 import io.github.optimumcode.json.schema.internal.JsonSchemaAssertion
 import io.github.optimumcode.json.schema.model.AbstractElement
 import io.github.optimumcode.json.schema.model.ArrayElement
+import io.github.optimumcode.json.schema.model.lastIndex
 
 internal class AllItemsAssertion(
   private val location: JsonPointer,

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/factories/array/UnevaluatedItemsAssertion.kt

@@ -8,6 +8,7 @@ import io.github.optimumcode.json.schema.internal.AssertionContext
 import io.github.optimumcode.json.schema.internal.JsonSchemaAssertion
 import io.github.optimumcode.json.schema.model.AbstractElement
 import io.github.optimumcode.json.schema.model.ArrayElement
+import io.github.optimumcode.json.schema.model.lastIndex
 
 internal class UnevaluatedItemsAssertion(
   private val location: JsonPointer,

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/util/ElementEqualityUtil.kt

@@ -45,6 +45,7 @@ internal fun areEqualPrimitives(
   } else {
     when {
       first.isNull || second.isNull -> false
+      // probably content should be compared ignoring the case - YAML allows different values for boolean
       first.isBoolean || second.isBoolean -> first.content == second.content
       else -> compareAsNumbers(first, second)
     }

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/util/NumberParts.kt

@@ -1,7 +1,6 @@
 package io.github.optimumcode.json.schema.internal.util
 
 import io.github.optimumcode.json.schema.model.PrimitiveElement
-import kotlinx.serialization.json.double
 import kotlin.math.absoluteValue
 
 internal data class NumberParts(
@@ -28,7 +27,8 @@ private const val TEN: Double = 10.0
 internal fun numberParts(element: PrimitiveElement): NumberParts {
   if (element.content.run { contains(E_SMALL_CHAR) || contains(E_BIG_CHAR) }) {
     // FIXME: if we add support for YAML then we should handle +Inf and -Inf values correctly
-    return element.double.run {
+    val number = requireNotNull(element.number) { "element '${element.content}' is not a number" }
+    return number.toDouble().run {
       var precision = 0
       var fractionalPart = rem(1.0).absoluteValue
       while (fractionalPart % 1.0 > 0) {

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/wrapper/JsonWrappers.kt

@@ -10,7 +10,6 @@ import kotlinx.serialization.json.JsonNull
 import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.json.JsonPrimitive
 import kotlinx.serialization.json.booleanOrNull
-import kotlinx.serialization.json.double
 import kotlinx.serialization.json.doubleOrNull
 import kotlinx.serialization.json.longOrNull
 import kotlin.jvm.JvmInline
@@ -70,8 +69,6 @@ internal value class JsonPrimitiveWrapper(
       primitive.run {
         !isString && (longOrNull ?: doubleOrNull) != null
       }
-  override val double: Double
-    get() = primitive.double
   override val content: String
     get() = primitive.content
 
@@ -99,8 +96,6 @@ internal value class StringWrapper(
     get() = false
   override val isNumber: Boolean
     get() = false
-  override val double: Double
-    get() = value.toDouble()
   override val content: String
     get() = value
 

json-schema-validator/src/commonMain/kotlin/io/github/optimumcode/json/schema/model/Model.kt

@@ -1,38 +1,96 @@
 package io.github.optimumcode.json.schema.model
 
+/**
+ * [AbstractElement] represents one of 3 elements that can be consumed and validated:
+ * * [ObjectElement] - corresponds to a JSON/YAML object or [Map]
+ * * [ArrayElement] - corresponds to a collection of [AbstractElement]s
+ * * [PrimitiveElement] - corresponds to a scalar value (string, number, boolean)
+ */
 public sealed interface AbstractElement {
+  /**
+   * Implement [toString] method to provide a useful view that can be used in error message
+   */
   override fun toString(): String
 }
 
 public interface PrimitiveElement : AbstractElement {
+  /**
+   * Returns `true` if the element is `null`.
+   * Otherwise, returns `false`
+   */
   public val isNull: Boolean
+
+  /**
+   * Returns `true` if the element can be interpreted as string.
+   * Otherwise, returns `false`
+   */
   public val isString: Boolean
-  public val number: Number?
+
+  /**
+   * Returns `true` if the element can be interpreted as a boolean.
+   * Otherwise, returns `false`
+   */
   public val isBoolean: Boolean
+
+  /**
+   * Returns `true` if the element can be interpreted as a number.
+   * Otherwise, returns `false`
+   */
   public val isNumber: Boolean
-  public val double: Double
+
+  /**
+   * Tries to parse the element as a [Number].
+   * Must return either [Long] or [Double].
+   * If the element cannot be interpreted as a number, returns `null`.
+   */
+  public val number: Number?
+
+  /**
+   * Returns the content of the element as plain string
+   */
   public val content: String
 }
 
 internal val PrimitiveElement.contentOrNull: String?
   get() = if (isNull) null else content
 
 public interface ObjectElement : AbstractElement, Sequence<Pair<String, AbstractElement>> {
+  /**
+   * Returns the set of keys defined in the [ObjectElement]
+   */
   public val keys: Set<String>
 
+  /**
+   * Returns an [AbstractElement] associated with the [key].
+   * If the [key] does not exist returns `null`
+   */
   public operator fun get(key: String): AbstractElement?
 
+  /**
+   * Returns `true` if the [key] exists in the [ObjectElement].
+   * Otherwise, returns `false`
+   */
   public operator fun contains(key: String): Boolean
 
+  /**
+   * Returns number of keys in the [ObjectElement]
+   */
   public val size: Int
 }
 
 internal fun ObjectElement.isEmpty(): Boolean = size == 0
 
 public interface ArrayElement : AbstractElement, Sequence<AbstractElement> {
+  /**
+   * Returns the [AbstractElement] associated with the [index].
+   */
   public operator fun get(index: Int): AbstractElement
 
+  /**
+   * Returns the number of [AbstractElement]s in the collection
+   */
   public val size: Int
-  public val lastIndex: Int
-    get() = size - 1
-}
+}
+
+internal val ArrayElement.lastIndex: Int
+  get() = size - 1