Merge pull request #525 from HC-224/changed-properties

Track and Provide Access to Changed Properties

Author: vincentlauvlwj

buildSrc/src/main/kotlin/ktorm.publish.gradle.kts

@@ -155,6 +155,11 @@ publishing {
                         id.set("brohacz")
                         name.set("Michal Brosig")
                     }
+                    developer {
+                        id.set("hc224")
+                        name.set("hc224")
+                        email.set("[email protected]")
+                    }
                 }
             }
         }

ktorm-core/src/main/kotlin/org/ktorm/entity/Entity.kt

@@ -143,6 +143,14 @@ public interface Entity<E : Entity<E>> : Serializable {
      */
     public val properties: Map<String, Any?>
 
+    /**
+     * Return the immutable view of the original values for this entity's changed properties.
+     *
+     * Properties are set as changed when constructing an entity with non-default values or when setting a property.
+     * If the property is set to the same value it is still marked as changed.
+     */
+    public val changedProperties: Map<String, Any?>
+
     /**
      * Update the property changes of this entity into the database and return the affected record number.
      *

ktorm-core/src/main/kotlin/org/ktorm/entity/EntityImplementation.kt

@@ -38,7 +38,7 @@ internal class EntityImplementation(
     @Transient var fromDatabase: Database? = fromDatabase
     @Transient var fromTable: Table<*>? = fromTable
     @Transient var parent: EntityImplementation? = parent
-    @Transient var changedProperties = LinkedHashSet<String>()
+    @Transient var changedProperties = LinkedHashMap<String, Any?>()
 
     override fun invoke(proxy: Any, method: Method, args: Array<out Any>?): Any? {
         return when (method.declaringClass.kotlin) {
@@ -54,6 +54,7 @@ internal class EntityImplementation(
                 when (method.name) {
                     "getEntityClass" -> this.entityClass
                     "getProperties" -> Collections.unmodifiableMap(this.values)
+                    "getChangedProperties" -> Collections.unmodifiableMap(this.changedProperties)
                     "flushChanges" -> this.doFlushChanges()
                     "discardChanges" -> this.doDiscardChanges()
                     "delete" -> this.doDelete()
@@ -150,13 +151,15 @@ internal class EntityImplementation(
             throw UnsupportedOperationException(msg)
         }
 
+        // Map#putIfAbsent treats null as absent, but null is a valid entity value
+        if (!changedProperties.containsKey(name))
+            changedProperties[name] = this.values.getOrDefault(name, null)
         values[name] = value
-        changedProperties.add(name)
     }
 
     private fun copy(): Entity<*> {
         val entity = Entity.create(entityClass, parent, fromDatabase, fromTable)
-        entity.implementation.changedProperties.addAll(changedProperties)
+        entity.implementation.changedProperties.putAll(changedProperties)
 
         for ((name, value) in values) {
             if (value is Entity<*>) {
@@ -204,7 +207,7 @@ internal class EntityImplementation(
         val javaClass = Class.forName(input.readUTF(), true, Thread.currentThread().contextClassLoader)
         entityClass = javaClass.kotlin
         values = input.readObject() as LinkedHashMap<String, Any?>
-        changedProperties = LinkedHashSet()
+        changedProperties = LinkedHashMap()
     }
 
     override fun equals(other: Any?): Boolean {

ktorm-core/src/test/kotlin/org/ktorm/entity/EntityTest.kt

@@ -47,6 +47,50 @@ class EntityTest : BaseTest() {
         assert(employee.job == "")
     }
 
+    @Test
+    fun testEntityChangedPropertiesInitializer() {
+        val employee = Employee { name = "walter" }
+        println(employee)
+
+        assert(employee.changedProperties.size == 1)
+        assert(employee.changedProperties.contains("name"))
+        assert(employee.changedProperties["name"] == null)
+    }
+
+    @Test
+    fun testEntityChangedPropertiesSetter() {
+        val employee = Employee { }
+        println(employee)
+
+        val oldChangedPropertiesIsEmpty = employee.changedProperties.isEmpty()
+
+        employee.name = "walter"
+        println(employee)
+
+        assert(oldChangedPropertiesIsEmpty)
+        assert(employee.changedProperties.size == 1)
+        assert(employee.changedProperties.contains("name"))
+        assert(employee.changedProperties["name"] == null)
+    }
+
+    @Test
+    fun testEntityChangedPropertiesMultiple() {
+        val employee = Employee { }.copy()
+        println(employee)
+
+        val oldChangedPropertiesIsEmpty = employee.changedProperties.isEmpty()
+
+        employee.name = "walter"
+        println(employee)
+        employee.name = "vince"
+        println(employee)
+
+        assert(oldChangedPropertiesIsEmpty)
+        assert(employee.changedProperties.size == 1)
+        assert(employee.changedProperties.containsKey("name"))
+        assert(employee.changedProperties["name"] == null)
+    }
+
     @Test
     fun testDefaultMethod() {
         for (method in Employee::class.java.methods) {
@@ -783,4 +827,4 @@ class EntityTest : BaseTest() {
         assert(departmentTransient !== departmentAttached)
         assert(departmentTransient.hashCode() == departmentAttached.hashCode())
     }
-}
+}