Add getSelectorFullPath to KspoonDecoder

burnoo · Sep 4, 2024 · 3337d15 · 3337d15
1 parent 09e229c
commit 3337d15
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/kspoon/src/commonMain/kotlin/decoder/HtmlTreeDecoder.kt b/kspoon/src/commonMain/kotlin/decoder/HtmlTreeDecoder.kt
@@ -212,4 +212,6 @@ internal class HtmlTreeDecoder(
 
     override fun decodeDocument() = elements.firstOrNull() as? Document
         ?: kspoonError("Current Element is not a Document. Document type works only on root")
+
+    override fun getSelectorFullPath(): String = getSelectorFullPath(tag = currentTagOrNull)
 }
diff --git a/kspoon/src/commonMain/kotlin/decoder/KspoonDecoder.kt b/kspoon/src/commonMain/kotlin/decoder/KspoonDecoder.kt
@@ -13,4 +13,6 @@ interface KspoonDecoder {
     fun decodeElements(): Elements
 
     fun decodeDocument(): Document
+
+    fun getSelectorFullPath(): String
 }
diff --git a/kspoon/src/commonMain/kotlin/exception/KspoonParseException.kt b/kspoon/src/commonMain/kotlin/exception/KspoonParseException.kt
@@ -2,7 +2,7 @@ package dev.burnoo.ksoup.exception
 
 class KspoonParseException(
     override val message: String?,
-    override val cause: Throwable?,
+    override val cause: Throwable? = null,
 ) : IllegalStateException()
 
 internal fun kspoonError(message: String?, cause: Throwable? = null): Nothing {

diff --git a/kspoon/src/commonTest/kotlin/KspoonSerializersTest.kt b/kspoon/src/commonTest/kotlin/KspoonSerializersTest.kt
@@ -2,6 +2,8 @@ package dev.burnoo.ksoup
 
 import dev.burnoo.ksoup.annotation.Selector
 import dev.burnoo.ksoup.decoder.KspoonDecoder
+import dev.burnoo.ksoup.exception.KspoonParseException
+import io.kotest.assertions.throwables.shouldThrowWithMessage
 import io.kotest.matchers.shouldBe
 import kotlinx.serialization.Contextual
 import kotlinx.serialization.KSerializer
@@ -36,8 +38,10 @@ object TagSerializer : KSerializer<String> {
         PrimitiveSerialDescriptor("dev.burnoo.ksoup.type.CustomString", PrimitiveKind.STRING)
 
     override fun deserialize(decoder: Decoder): String {
-        val element = (decoder as KspoonDecoder).decodeElement()
-        val tag = element?.tag()?.name ?: "tag not found"
+        val kspoonDecoder = decoder as KspoonDecoder
+        val element = decoder.decodeElement()
+        val tag = element?.tag()?.name
+            ?: throw KspoonParseException("Could not get tag name for selector: ${kspoonDecoder.getSelectorFullPath()}")
         return tag
     }
 
@@ -80,4 +84,18 @@ class SerializersModuleTest {
 
         model shouldBe Model("p")
     }
+
+    @Test
+    fun shouldThrowWithFullPathTagMessage() {
+        @Serializable
+        data class Model(
+            @Selector(".class1")
+            @Serializable(TagSerializer::class)
+            val tag: String,
+        )
+
+        shouldThrowWithMessage<KspoonParseException>(message = "Could not get tag name for selector: ['.class1']") {
+            Kspoon.parse<Model>("")
+        }
+    }
 }