Adjust oneofstrings validator to improve formatting

mattupstate · Apr 12, 2024 · 302f7fb · 302f7fb
1 parent 4f514e9
commit 302f7fb
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 8 deletions.
diff --git a/acme-lib/acme-lib-validation/build.gradle.kts b/acme-lib/acme-lib-validation/build.gradle.kts
@@ -6,5 +6,6 @@ dependencies {
   implementation(libs.com.googlecode.libphonenumber)
   api(libs.jakarta.validation.jakarta.validation.api)
   testImplementation(libs.io.kotest.kotest.runner.junit5)
+  testImplementation(libs.org.hibernate.validator.hibernate.validator)
   testRuntimeOnly(libs.org.glassfish.jakarta.el)
 }
diff --git a/acme-lib/acme-lib-validation/src/main/kotlin/com/acme/validation/OneOfStrings.kt b/acme-lib/acme-lib-validation/src/main/kotlin/com/acme/validation/OneOfStrings.kt
@@ -9,7 +9,8 @@ import kotlin.reflect.KClass
 @MustBeDocumented
 @Constraint(validatedBy = [OneOfStringsValidator::class])
 annotation class OneOfStrings(
-  val values: Array<String> = [],
+  val values: String = "",
+  val delimiter: String = ", ",
   val message: String = "{com.acme.validation.OneOfStrings.message}",
   val groups: Array<KClass<*>> = [],
   val payload: Array<KClass<out Payload>> = []

diff --git a/acme-lib/acme-lib-validation/src/main/kotlin/com/acme/validation/OneOfStringsValidator.kt b/acme-lib/acme-lib-validation/src/main/kotlin/com/acme/validation/OneOfStringsValidator.kt
@@ -12,5 +12,5 @@ class OneOfStringsValidator : ConstraintValidator<OneOfStrings, String> {
   }
 
   override fun isValid(value: String?, context: ConstraintValidatorContext?): Boolean =
-    annotation!!.values.contains(value)
+    annotation!!.values.split(annotation!!.delimiter).contains(value)
 }
diff --git a/acme-lib/acme-lib-validation/src/test/kotlin/com/acme/validation/OneOfStringsTest.kt b/acme-lib/acme-lib-validation/src/test/kotlin/com/acme/validation/OneOfStringsTest.kt
@@ -0,0 +1,19 @@
+package com.acme.validation
+
+import io.kotest.core.spec.style.ShouldSpec
+import io.kotest.matchers.collections.shouldHaveSize
+import jakarta.validation.Validation
+import jakarta.validation.ValidatorFactory
+
+class OneOfStringsTest: ShouldSpec({
+  data class FakeBean(
+    @field:OneOfStrings(values = "Doctor, Nurse, Pediatrician")
+    val title: String?
+  )
+
+  should("result in errors for invalid value") {
+    val validator = Validation.buildDefaultValidatorFactory().validator
+    val results = validator.validate(FakeBean("Doc"))
+    results shouldHaveSize 1
+  }
+})
diff --git a/acme-lib/acme-lib-validation/src/test/resources/ValidationMessages.properties b/acme-lib/acme-lib-validation/src/test/resources/ValidationMessages.properties
@@ -0,0 +1,2 @@
+com.acme.validation.PhoneNumber.message=invalid phone number
+com.acme.validation.OneOfStrings.message=must be one of: {values}
diff --git a/...src/test/kotlin/com/acme/web/api/test/scheduling/api/SchedulingClientCollectionApiSpec.kt b/...src/test/kotlin/com/acme/web/api/test/scheduling/api/SchedulingClientCollectionApiSpec.kt
@@ -275,7 +275,7 @@ class SchedulingClientCollectionApiSpec : ShouldSpec({
                   "path": "/emailAddresses"
                 },
                 {
-                  "message": "must be one of [MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN]",
+                  "message": "must be one of MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN",
                   "path": "/gender"
                 },
                 {

diff --git a/acme-web/acme-web-api/src/main/kotlin/com/acme/web/api/scheduling/json.kt b/acme-web/acme-web-api/src/main/kotlin/com/acme/web/api/scheduling/json.kt
@@ -58,7 +58,7 @@ data class CreateAppointmentCommandRequest(
   val practiceId: String? = null,
 
   @field:NotNull
-  @field:OneOfStrings(["SCHEDULED", "UNATTENDED", "ATTENDED", "CANCELED"])
+  @field:OneOfStrings(values = "SCHEDULED, UNATTENDED, ATTENDED, CANCELED")
   val state: String?,
 
   @field:NotNull
@@ -77,7 +77,7 @@ data class CreateClientCommandRequest(
   val name: HumanName? = null,
 
   @field:NotNull
-  @field:OneOfStrings(["MALE", "FEMALE", "TRANSGENDER", "NON_BINARY", "OTHER", "UNKNOWN"])
+  @field:OneOfStrings(values = "MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN")
   val gender: String? = null,
 
   @field:NotNull
@@ -111,7 +111,7 @@ data class CreatePractitionerCommandRequest(
   val name: HumanName? = null,
 
   @field:NotNull
-  @field:OneOfStrings(["MALE", "FEMALE", "TRANSGENDER", "NON_BINARY", "OTHER", "UNKNOWN"])
+  @field:OneOfStrings(values = "MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN")
   val gender: String? = null,
 
   @field:NotNull

diff --git a/...cme-web-api/src/test/kotlin/com/acme/web/api/scheduling/CreateClientCommandRequestTest.kt b/...cme-web-api/src/test/kotlin/com/acme/web/api/scheduling/CreateClientCommandRequestTest.kt
@@ -36,7 +36,7 @@ class CreateClientCommandRequestTest : ShouldSpec({
           "/gender" to setOf(
             "" +
               "must not be null",
-            "must be one of [MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN]"
+            "must be one of MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN"
           ),
           "/phoneNumbers" to setOf("must not be null"),
           "/emailAddresses" to setOf("must not be null"),

diff --git a/...b-api/src/test/kotlin/com/acme/web/api/scheduling/CreatePractitionerCommandRequestTest.kt b/...b-api/src/test/kotlin/com/acme/web/api/scheduling/CreatePractitionerCommandRequestTest.kt
@@ -37,7 +37,7 @@ class CreatePractitionerCommandRequestTest : ShouldSpec({
           "/gender" to setOf("must not be null"),
           "/gender" to setOf(
             "must not be null",
-            "must be one of [MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN]"
+            "must be one of MALE, FEMALE, TRANSGENDER, NON_BINARY, OTHER, UNKNOWN"
           ),
           "/phoneNumbers" to setOf("must not be null"),
           "/emailAddresses" to setOf("must not be null"),