Kim.update() API keeps "flag"/"pick" tag consistent with rating tag. (#…

…98)
Ashampoo · May 10, 2024 · 3af7a13 · 3af7a13
1 parent 3733738
commit 3af7a13
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ of Ashampoo Photo Organizer, which, in turn, is driven by user community feedbac
 ## Installation
 
 ```
-implementation("com.ashampoo:kim:0.18.1")
+implementation("com.ashampoo:kim:0.18.2")
 ```
 
 For the targets `wasmJs` & `js` you also need to specify this:

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/xmp/XmpWriter.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/xmp/XmpWriter.kt
@@ -18,6 +18,7 @@ package com.ashampoo.kim.format.xmp
 import com.ashampoo.kim.Kim.underUnitTesting
 import com.ashampoo.kim.common.GpsUtil
 import com.ashampoo.kim.model.MetadataUpdate
+import com.ashampoo.kim.model.PhotoRating
 import com.ashampoo.xmp.XMPException
 import com.ashampoo.xmp.XMPMeta
 import com.ashampoo.xmp.XMPMetaFactory
@@ -77,12 +78,30 @@ public object XmpWriter {
                     deleteGpsCoordinates()
             }
 
-            is MetadataUpdate.Flagged ->
+            is MetadataUpdate.Flagged -> {
+
                 setFlagged(update.flagged)
 
-            is MetadataUpdate.Rating ->
+                /*
+                 * In the case of flagging/picking a photo a rejected
+                 * rating will be reset to UNRATED for logical consistency.
+                 */
+                if (update.flagged && getRating() == PhotoRating.REJECTED.value)
+                    setRating(PhotoRating.UNRATED.value)
+            }
+
+            is MetadataUpdate.Rating -> {
+
                 setRating(update.photoRating.value)
 
+                /*
+                 * In the case of rejecting a photo a flag/pick marker
+                 * will be removed for logical consistency.
+                 */
+                if (update.photoRating == PhotoRating.REJECTED && isFlagged())
+                    setFlagged(false)
+            }
+
             is MetadataUpdate.Keywords ->
                 setKeywords(update.keywords)
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/model/MetadataUpdate.kt b/src/commonMain/kotlin/com/ashampoo/kim/model/MetadataUpdate.kt
@@ -45,6 +45,9 @@ public sealed interface MetadataUpdate {
 
     /**
      * Set a photo as flagged/tagged/picked.
+     *
+     * In the case of flagging/picking a photo a rejected
+     * rating will be reset to UNRATED for logical consistency.
      */
     public data class Flagged(
         val flagged: Boolean
@@ -53,6 +56,9 @@ public sealed interface MetadataUpdate {
     /**
      * Set a new Rating.
      * Can't be NULL and should be UNRATED instead.
+     *
+     * In the case of rejecting a photo a flag/pick marker
+     * will be removed for logical consistency.
      */
     public data class Rating(
         val photoRating: PhotoRating