🔀 Merge pull request #410 from vinceglb/platformfile-serialization

✨ Add @serialization support to PlatformFile

Author: vinceglb

filekit-core/build.gradle.kts

@@ -4,6 +4,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 plugins {
     alias(libs.plugins.androidLibrary)
     alias(libs.plugins.kotlinMultiplatform)
+    alias(libs.plugins.kotlinSerialization)
     alias(libs.plugins.vanniktech.mavenPublish)
 }
 
@@ -55,6 +56,9 @@ kotlin {
 
             // Kotlinx IO
             api(libs.kotlinx.io)
+
+            // Kotlinx Serialization
+            implementation(libs.kotlinx.serialization.core)
         }
 
         commonTest.dependencies {
@@ -69,6 +73,9 @@ kotlin {
             }
         }
         val nonWebTest by creating { dependsOn(commonTest.get()) }
+        nonWebTest.dependencies {
+            implementation(libs.kotlinx.serialization.json)
+        }
 
         val jvmAndNativeMain by creating { dependsOn(nonWebMain) }
 
@@ -80,7 +87,12 @@ kotlin {
                 implementation(libs.androidx.exifinterface)
             }
         }
-        androidUnitTest.get().dependsOn(nonWebTest)
+        androidUnitTest {
+            dependsOn(nonWebTest)
+            dependencies {
+                implementation(libs.test.android.robolectric)
+            }
+        }
         jvmMain.get().dependsOn(jvmAndNativeMain)
         jvmTest.get().dependsOn(nonWebTest)
         nativeMain.get().dependsOn(jvmAndNativeMain)

filekit-core/src/androidMain/kotlin/io/github/vinceglb/filekit/PlatformFile.android.kt

@@ -21,12 +21,14 @@ import kotlinx.io.asSink
 import kotlinx.io.asSource
 import kotlinx.io.files.Path
 import kotlinx.io.files.SystemFileSystem
+import kotlinx.serialization.Serializable
 import java.io.File
 import java.nio.file.Files
 import java.nio.file.attribute.BasicFileAttributes
 import kotlin.time.ExperimentalTime
 import kotlin.time.Instant
 
+@Serializable(with = PlatformFileSerializer::class)
 public actual data class PlatformFile(
     val androidFile: AndroidFile
 ) {

filekit-core/src/androidUnitTest/kotlin/io/github/vinceglb/filekit/PlatformFileAndroidSerializationTest.kt

@@ -0,0 +1,29 @@
+package io.github.vinceglb.filekit
+
+import android.net.Uri
+import kotlinx.serialization.json.Json
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import org.robolectric.annotation.Config
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertIs
+
+@RunWith(RobolectricTestRunner::class)
+@Config(sdk = [36])
+class PlatformFileAndroidSerializationTest {
+    private val json = Json { encodeDefaults = true }
+
+    @Test
+    fun serializeAndDeserializeUriBackedPlatformFile() {
+        val uri = Uri.parse("content://example.provider/document/12345")
+        val platformFile = PlatformFile(uri)
+
+        val encoded = json.encodeToString(platformFile)
+        val decoded = json.decodeFromString<PlatformFile>(encoded)
+
+        assertEquals(platformFile.path, decoded.path)
+        assertEquals(uri.toString(), decoded.toString())
+        assertIs<AndroidFile.UriWrapper>(value = decoded.androidFile)
+    }
+}

filekit-core/src/androidUnitTest/kotlin/io/github/vinceglb/filekit/PlatformFileAndroidTest.kt

@@ -0,0 +1,42 @@
+package io.github.vinceglb.filekit
+
+import io.github.vinceglb.filekit.mimeType.MimeType
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import org.robolectric.annotation.Config
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+@RunWith(RobolectricTestRunner::class)
+@Config(sdk = [36])
+class PlatformFileAndroidTest {
+    private val resourceDirectory = FileKit.projectDir / "src/nonWebTest/resources"
+    private val textFile = resourceDirectory / "hello.txt"
+    private val imageFile = resourceDirectory / "compose-logo.png"
+    private val emptyFile = resourceDirectory / "empty-file"
+    private val notExistingFile = resourceDirectory / "not-existing-file.pdf"
+
+    @Test
+    fun testPlatformMimeType() {
+        assertEquals(
+            expected = MimeType.parse("text/plain"),
+            actual = textFile.mimeType()
+        )
+        assertEquals(
+            expected = MimeType.parse("image/png"),
+            actual = imageFile.mimeType()
+        )
+        assertEquals(
+            expected = null,
+            actual = emptyFile.mimeType()
+        )
+        assertEquals(
+            expected = MimeType.parse("application/pdf"),
+            actual = notExistingFile.mimeType()
+        )
+        assertEquals(
+            expected = null,
+            actual = resourceDirectory.mimeType()
+        )
+    }
+}

filekit-core/src/appleMain/kotlin/io/github/vinceglb/filekit/PlatformFile.apple.kt

@@ -23,6 +23,7 @@ import kotlinx.coroutines.IO
 import kotlinx.coroutines.withContext
 import kotlinx.io.files.Path
 import kotlinx.io.files.SystemFileSystem
+import kotlinx.serialization.Serializable
 import platform.CoreFoundation.CFRelease
 import platform.CoreFoundation.CFStringCreateWithCString
 import platform.CoreFoundation.CFStringGetCString
@@ -46,6 +47,7 @@ import platform.UniformTypeIdentifiers.UTType
 import kotlin.time.ExperimentalTime
 import kotlin.time.Instant
 
+@Serializable(with = PlatformFileSerializer::class)
 public actual data class PlatformFile(
     val nsUrl: NSURL,
 ) {
@@ -220,16 +222,6 @@ public actual suspend fun PlatformFile.bookmarkData(): BookmarkData = withContex
     }
 }
 
-internal actual suspend fun PlatformFile.prepareDestinationForWrite(
-    source: PlatformFile
-): PlatformFile = withScopedAccess {
-    if (isDirectory()) {
-        PlatformFile(toKotlinxIoPath() / source.name)
-    } else {
-        this
-    }
-}
-
 public actual fun PlatformFile.releaseBookmark() {}
 
 @OptIn(ExperimentalForeignApi::class, BetaInteropApi::class)

filekit-core/src/commonMain/kotlin/io/github/vinceglb/filekit/PlatformFile.kt

@@ -1,7 +1,9 @@
 package io.github.vinceglb.filekit
 
 import io.github.vinceglb.filekit.mimeType.MimeType
+import kotlinx.serialization.Serializable
 
+@Serializable(with = PlatformFileSerializer::class)
 public expect class PlatformFile {
     override fun toString(): String
     public companion object

filekit-core/src/commonMain/kotlin/io/github/vinceglb/filekit/PlatformFileSerializer.kt

@@ -0,0 +1,12 @@
+package io.github.vinceglb.filekit
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+public expect object PlatformFileSerializer : KSerializer<PlatformFile> {
+    override val descriptor: SerialDescriptor
+    override fun serialize(encoder: Encoder, value: PlatformFile)
+    override fun deserialize(decoder: Decoder): PlatformFile
+}

filekit-core/src/jsMain/kotlin/io/github/vinceglb/filekit/PlatformFile.js.kt

@@ -4,6 +4,7 @@ import io.github.vinceglb.filekit.exceptions.FileKitException
 import io.github.vinceglb.filekit.mimeType.MimeType
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
+import kotlinx.serialization.Serializable
 import org.khronos.webgl.ArrayBuffer
 import org.khronos.webgl.Uint8Array
 import org.khronos.webgl.get
@@ -13,6 +14,7 @@ import kotlin.coroutines.resume
 import kotlin.coroutines.resumeWithException
 import kotlin.coroutines.suspendCoroutine
 
+@Serializable(with = PlatformFileSerializer::class)
 public actual data class PlatformFile(
     val file: File,
 ) {
@@ -70,4 +72,3 @@ public actual suspend fun PlatformFile.readBytes(): ByteArray = withContext(Disp
 public actual fun PlatformFile.mimeType(): MimeType? =
     takeIf { file.type.isNotBlank() }
         ?.let { MimeType.parse(file.type) }
-

filekit-core/src/jsMain/kotlin/io/github/vinceglb/filekit/PlatformFileSerializer.js.kt

@@ -0,0 +1,25 @@
+package io.github.vinceglb.filekit
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+private const val unsupportedMessage = "PlatformFile serialization is not supported on JS targets"
+
+public actual object PlatformFileSerializer : KSerializer<PlatformFile> {
+    actual override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor(
+        serialName = "io.github.vinceglb.filekit.PlatformFile",
+        kind = PrimitiveKind.STRING
+    )
+
+    actual override fun deserialize(decoder: Decoder): PlatformFile {
+        error(unsupportedMessage)
+    }
+
+    actual override fun serialize(encoder: Encoder, value: PlatformFile) {
+        error(unsupportedMessage)
+    }
+}

filekit-core/src/jsTest/kotlin/io/github/vinceglb/filekit/utils/CreateTestFile.js.kt

@@ -2,6 +2,7 @@ package io.github.vinceglb.filekit.utils
 
 import io.github.vinceglb.filekit.PlatformFile
 import org.w3c.files.File
+import org.w3c.files.FilePropertyBag
 
 actual fun createTestFile(
     name: String,
@@ -11,6 +12,7 @@ actual fun createTestFile(
     val file = File(
         fileBits = bytes.toBitsArray(),
         fileName = name,
+        options = FilePropertyBag(type = "text/plain"),
     )
     return PlatformFile(file)
 }