[BTD-292] Added keyword search

src/main/kotlin/uk/gov/justice/digital/hmpps/learnerrecordsapi/config/Synonyms.kt

@@ -0,0 +1,17 @@
+package uk.gov.justice.digital.hmpps.learnerrecordsapi.config
+
+object Synonyms {
+
+  private val synonyms = mapOf(
+    "maths" to "mathematics",
+  )
+
+  fun getSynonyms(keywords: List<String>): List<String> {
+    val list = mutableListOf<String>()
+    synonyms.forEach { (key, value) ->
+      if (keywords.contains(key)) list.add(value)
+      if (keywords.contains(value)) list.add(key)
+    }
+    return list + keywords
+  }
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/learnerrecordsapi/models/lrsapi/response/LearningEvent.kt

@@ -79,6 +79,8 @@ data class LearningEvent(
     } else if (keywords.isEmpty()) {
       return true
     }
-    return keywords.any { keyword -> subject.contains(keyword, ignoreCase = true) }
+    return keywords.any { keyword -> subject.containsWholeWord(keyword) }
   }
 }
+
+fun String.containsWholeWord(word: String): Boolean = (" $this ").contains(" $word ", ignoreCase = true)

src/main/kotlin/uk/gov/justice/digital/hmpps/learnerrecordsapi/service/LearnerEventsService.kt

@@ -5,6 +5,7 @@ import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.stereotype.Service
 import uk.gov.justice.digital.hmpps.learnerrecordsapi.config.HttpClientConfiguration
 import uk.gov.justice.digital.hmpps.learnerrecordsapi.config.LRSConfiguration
+import uk.gov.justice.digital.hmpps.learnerrecordsapi.config.Synonyms.getSynonyms
 import uk.gov.justice.digital.hmpps.learnerrecordsapi.logging.LoggerUtil
 import uk.gov.justice.digital.hmpps.learnerrecordsapi.logging.LoggerUtil.debugLog
 import uk.gov.justice.digital.hmpps.learnerrecordsapi.models.lrsapi.response.LearningEventsResponse
@@ -50,7 +51,7 @@ class LearnerEventsService(
       incomingUln = learningEventsResult.incomingUln,
       foundUln = learningEventsResult.foundUln,
       learnerRecord = learningEventsResult.learnerRecord.filter {
-        it.isSubjectOneOf(request.keywords)
+        it.isSubjectOneOf(getSynonyms(request.keywords))
       },
     )
   }

src/test/kotlin/uk/gov/justice/digital/hmpps/learnerrecordsapi/service/LearnerEventsServiceTest.kt

@@ -131,7 +131,7 @@ class LearnerEventsServiceTest {
           learningEventsResult = LearningEventsResult(
             learnerRecord = listOf(
               LearningEvent(
-                subject = "GSCE in Mathematics",
+                subject = "GCSE in Mathematics",
               ),
             ),
           ),
@@ -184,4 +184,19 @@ class LearnerEventsServiceTest {
   fun `should return learner event as no keyword specified`() {
     checkLearnerEvents(null, true)
   }
+
+  @Test
+  fun `should return learner event as keyword synonym match`() {
+    checkLearnerEvents("maths", true)
+  }
+
+  @Test
+  fun `should return learner event as keyword at start`() {
+    checkLearnerEvents("gcse", true)
+  }
+
+  @Test
+  fun `should return no learner events as keyword not whole word`() {
+    checkLearnerEvents("gc", false)
+  }
 }