Merge pull request #1 from onix-labs/feature-validate-on-the-fly

Implementation to validate on the fly.

Author: MrMatthewLayton

CHANGELOG.md

@@ -4,6 +4,16 @@
 
 This document serves as the change log for the ONIXLabs Kotlin Validation API.
 
+## Version 2.0.0
+
+#### ValidationGraphException (class)
+
+Represents an exception that will be thrown when validation mode is set to DEFAULT.
+
+#### Validator.validate (function)
+
+Builds and validates a subject on-the-fly.
+
 ## Version 1.0.0
 
 #### MemberAssertion (class)

build.gradle

@@ -13,7 +13,7 @@ buildscript {
         jackson_datatype_version = "2.9.8"
 
         onixlabs_group = "io.onixlabs"
-        onixlabs_kotlin_core_version = "1.0.0"
+        onixlabs_kotlin_core_version = "2.0.0"
     }
 
     repositories {
@@ -28,7 +28,7 @@ buildscript {
 }
 
 group 'io.onixlabs'
-version '1.0.0'
+version '2.0.0'
 
 allprojects {
     repositories {

src/main/kotlin/io/onixlabs/kotlin/validation/MemberAssertionContextStringExtensions.kt

@@ -143,7 +143,7 @@ fun MemberAssertionContext<out String?>.mustNotBeBlank(
         override val id: String = id.toUpperSnakeCase()
 
         override fun isValid(): Boolean {
-            return subject?.isNotBlank() ?: false
+            return subject?.isNotBlank() ?: true
         }
     }
 
@@ -187,7 +187,7 @@ fun MemberAssertionContext<out String?>.mustNotBeEmpty(
         override val id: String = id.toUpperSnakeCase()
 
         override fun isValid(): Boolean {
-            return subject?.isNotEmpty() ?: false
+            return subject?.isNotEmpty() ?: true
         }
     }
 

src/main/kotlin/io/onixlabs/kotlin/validation/ValidationException.kt

@@ -22,4 +22,4 @@ package io.onixlabs.kotlin.validation
  * @param message A message detailing the validation exception. Typically this should be the assertion message.
  * @param cause An underlying cause of the validation exception.
  */
-class ValidationException(message: String, cause: Throwable? = null) : Exception(message, cause)
+open class ValidationException(message: String, cause: Throwable? = null) : Exception(message, cause)

src/main/kotlin/io/onixlabs/kotlin/validation/ValidationGraphException.kt

@@ -0,0 +1,14 @@
+package io.onixlabs.kotlin.validation
+
+/**
+ * Represents an exception that will be thrown when validation mode is set to DEFAULT.
+ *
+ * @param message A message detailing the validation exception. Typically this should be the assertion message.
+ * @param failures The failures that occurred during validation.
+ * @param cause An underlying cause of the validation exception.
+ */
+class ValidationGraphException(
+    message: String,
+    val failures: List<String>,
+    override val cause: Throwable? = null
+) : ValidationException(message, cause)

src/main/kotlin/io/onixlabs/kotlin/validation/ValidationResult.kt

@@ -16,7 +16,7 @@
 
 package io.onixlabs.kotlin.validation
 
-import io.onixlabs.kotlin.core.reflection.fullName
+import io.onixlabs.kotlin.core.reflection.formattedQualifiedName
 import kotlin.reflect.KCallable
 import kotlin.reflect.KClass
 import kotlin.reflect.KFunction
@@ -72,7 +72,7 @@ open class ValidationResult internal constructor(val name: String, protected val
     internal fun createMember(callable: KCallable<*>): MemberResult {
         return MemberResult(
             name = callable.name,
-            type = callable.returnType.fullName,
+            type = callable.returnType.formattedQualifiedName,
             declaration = when (callable) {
                 is KProperty -> "Property"
                 is KFunction -> "Function"

src/main/kotlin/io/onixlabs/kotlin/validation/Validator.kt

@@ -38,11 +38,28 @@ abstract class Validator<T> {
          * @param action The action that will be executed by the validation builder.
          * @return Returns a custom validator implementation.
          */
-        inline fun <reified T : Any> validatorFor(
-            crossinline action: ValidationBuilder<T>.() -> Unit
-        ) = object : Validator<T>() {
-            override val genericKotlinClass: KClass<*> get() = T::class
-            override fun validate(builder: ValidationBuilder<T>) = action(builder)
+        inline fun <reified T : Any> validatorFor(crossinline action: ValidationBuilder<T>.() -> Unit): Validator<T> {
+            return object : Validator<T>() {
+                override val genericKotlinClass: KClass<*> get() = T::class
+                override fun validate(builder: ValidationBuilder<T>) = action(builder)
+            }
+        }
+
+        /**
+         * Builds and validates a subject on-the-fly.
+         *
+         * @param T The underlying subject class of the validator.
+         * @param subject The subject to be validated.
+         * @param action he action that will be executed by the validation builder.
+         * @throws ValidationGraphException if the validator fails.
+         */
+        inline fun <reified T : Any> validate(subject: T, crossinline action: ValidationBuilder<T>.() -> Unit) {
+            val validator = validatorFor(action)
+            val result = validator.validate(subject)
+            if (result.members.isNotEmpty()) {
+                val message = "Validation of the specified object type failed: ${result.name}."
+                throw ValidationGraphException(message, result.toList())
+            }
         }
     }
 

src/test/kotlin/io/onixlabs/kotlin/validation/MemberAssertionContextStringExtensionTests.kt

@@ -23,8 +23,7 @@ import org.junit.jupiter.api.assertThrows
 
 class MemberAssertionContextStringExtensionTests {
 
-    private val member =
-        "Property 'StringExtensionTestSubject.property' of type 'kotlin.String?'"
+    private val member = "Property 'StringExtensionTestSubject.property' of type 'kotlin.String?'"
 
     @Test
     fun `MemberAssertionContext_mustBeNullOrBlank should assert correctly on validation failure`() {