Merge pull request #19 from IngotGG/feat/auto-deserialize-bool-from-int

Automatically Convert Int to Boolean Where Applicable

build.gradle.kts

@@ -6,7 +6,7 @@ plugins {
 }
 
 group = "gg.ingot"
-version = "1.3.3"
+version = "1.3.4"
 
 repositories {
     mavenCentral()

src/main/kotlin/gg/ingot/iron/representation/EntityField.kt

@@ -21,6 +21,7 @@ data class EntityField(
     val columnName: String,
     val nullable: Boolean,
     val isJson: Boolean,
+    val isBoolean: Boolean,
     val serializer: ColumnSerializer<*, *>?,
     val deserializer: ColumnDeserializer<*, *>?,
 ) {

src/main/kotlin/gg/ingot/iron/transformer/ModelTransformer.kt

@@ -60,6 +60,7 @@ internal class ModelTransformer(
                     columnName = retrieveName(field, annotation),
                     nullable = field.returnType.isMarkedNullable,
                     isJson = annotation?.json ?: false,
+                    isBoolean = field.returnType.classifier == Boolean::class,
                     serializer = retrieveSerializer(field, annotation),
                     deserializer = retrieveDeserializer(field, annotation)
                 ))

src/main/kotlin/gg/ingot/iron/transformer/ResultTransformer.kt

@@ -1,14 +1,9 @@
 package gg.ingot.iron.transformer
 
 import gg.ingot.iron.Iron
-import gg.ingot.iron.IronSettings
 import gg.ingot.iron.annotations.Model
-import gg.ingot.iron.representation.EntityField
-import gg.ingot.iron.strategies.NamingStrategy
-import org.slf4j.LoggerFactory
 import java.sql.ResultSet
 import kotlin.reflect.KClass
-import kotlin.reflect.full.declaredMemberProperties
 import kotlin.reflect.full.primaryConstructor
 import kotlin.reflect.jvm.isAccessible
 
@@ -114,8 +109,20 @@ internal class ResultTransformer(
         }
 
         try {
-            return if(columnLabel != null) result.getObject(columnLabel) as? T
+            val obj = if(columnLabel != null) result.getObject(columnLabel) as? T
             else result.getObject(1) as? T
+
+            // Automatically convert Ints to Booleans for DBMS
+            // that don't give us back a boolean type.
+            @Suppress("KotlinConstantConditions")
+            if(obj != null && clazz == Boolean::class && obj is Int) {
+                if(obj != 0 && obj != 1) {
+                    error("Could not convert the column to a boolean, the value was not 0 or 1.")
+                }
+                return (obj == 1) as? T
+            }
+
+            return obj
         } catch(ex: ClassCastException) {
             error("Could not cast the column to the desired type, if you're attempted to map to a model try annotating with @Model, if not try passing a custom deserializer.")
         }

src/main/kotlin/gg/ingot/iron/transformer/ValueTransformer.kt

@@ -3,6 +3,7 @@ package gg.ingot.iron.transformer
 import gg.ingot.iron.representation.EntityField
 import gg.ingot.iron.serialization.*
 import gg.ingot.iron.strategies.NamingStrategy
+import org.slf4j.LoggerFactory
 import java.sql.ResultSet
 import kotlin.reflect.KClass
 
@@ -93,6 +94,15 @@ internal class ValueTransformer(
             return java.lang.Enum.valueOf(field.javaField.type as Class<out Enum<*>>, value as String)
         }
 
+        // Automatically convert Ints to Booleans for DBMS
+        // that don't give us back a boolean type.
+        if(value != null && value is Int && field.isBoolean) {
+            if(value != 0 && value != 1) {
+                error("Expected a boolean value, but found an integer value of $value for field: ${field.field.name}")
+            }
+            return value == 1
+        }
+
         return value
     }
 

src/test/kotlin/DatabaseTest.kt

@@ -381,9 +381,9 @@ class DatabaseTest {
     fun `test transformer`() = runTest {
         val value = connection.transaction {
             execute("CREATE TABLE uuids(uuid TEXT PRIMARY KEY)")
-            prepare("INSERT INTO uuids VALUES (?)", UUID.randomUUID())
-            prepare("INSERT INTO uuids VALUES (?)", UUID.randomUUID())
-            prepare("INSERT INTO uuids VALUES (?)", UUID.randomUUID())
+            repeat(3) {
+                prepare("INSERT INTO uuids VALUES (?)", UUID.randomUUID())
+            }
             prepare("INSERT INTO uuids VALUES (?) RETURNING *", UUID.randomUUID())
                 .single<UUID>(UUIDTransformer)
         }

src/test/kotlin/DeserializationTest.kt

@@ -179,4 +179,26 @@ class DeserializationTest {
         assertEquals("hello", mapped.json.example)
     }
 
+    @Test
+    fun `deserialize ints as bools`() = runTest {
+        @Model
+        data class TestMapping(val bool: Boolean)
+
+        val connection = Iron("jdbc:sqlite::memory:")
+            .connect()
+
+        connection.execute("CREATE TABLE test(id INTEGER PRIMARY KEY, bool BOOLEAN NOT NULL)")
+        connection.execute("INSERT INTO test(bool) VALUES (true)")
+        connection.execute("INSERT INTO test(bool) VALUES (false)")
+
+        val booleans = connection.query("SELECT bool FROM test")
+            .all<Boolean>()
+
+        val modeledBooleans = connection.query("SELECT bool FROM test")
+            .all<TestMapping>()
+            .map { it.bool }
+
+        assertEquals(listOf(true, false), booleans)
+        assertEquals(listOf(true, false), modeledBooleans)
+    }
 }