Merge pull request #7 from Archinamon/imply_createTempFile

Imply additional helpful functions

Author: Archinamon

build.gradle.kts

@@ -1,12 +1,12 @@
 plugins {
-    kotlin("multiplatform") version "1.5.10"
+    kotlin("multiplatform") version "1.7.10"
     id("org.jetbrains.dokka") version "1.4.32"
     id("maven-publish")
     id("signing")
 }
 
 group = "me.archinamon"
-version = "1.3.5"
+version = "1.3.6"
 
 val isRunningInIde: Boolean = System.getProperty("idea.active")
     ?.toBoolean() == true

src/commonMain/kotlin/File.common.kt

@@ -14,6 +14,7 @@ expect class File(pathname: String) {
     fun isDirectory(): Boolean
 
     fun getAbsolutePath(): String
+    fun length(): Long
 
     fun exists(): Boolean
     fun canRead(): Boolean
@@ -43,6 +44,8 @@ expect fun File.readText(): String
 
 expect fun File.appendText(text: String)
 
+expect fun File.appendBytes(bytes: ByteArray)
+
 expect fun File.writeText(text: String)
 
 fun File.deleteRecursively(): Boolean = walkBottomUp()

src/commonMain/kotlin/Files.kt

@@ -0,0 +1,34 @@
+package me.archinamon.fileio
+
+object Files {
+    private const val tempDirectory = "/tmp"
+    private const val tempFileType = ".tmp"
+
+    fun createTempFile(prefix: String, suffix: String? = null): File {
+        return createTempFile(prefix, suffix, File(tempDirectory))
+    }
+
+    fun createTempFile(prefix: String, suffix: String? = null, dir: File): File {
+        if (platform() == Platform.Windows) {
+            throw UnsupportedOperationException("Do not supported on mingw yet, create tmp files/dirs manually!")
+        }
+
+        val parent = dir.getAbsolutePath()
+        if (!dir.exists()) {
+            dir.mkdirs()
+        }
+
+        if (!dir.canWrite()) {
+            throw IllegalFileAccess(parent, "Can't create file in the directory")
+        }
+
+        if (prefix.length < 3) {
+            throw IllegalArgumentException("prefix should be at least 3 chars long, now — ${prefix.length}")
+        }
+
+        val end = suffix ?: tempFileType
+        return File("$parent/$prefix$end").apply {
+            createNewFile()
+        }
+    }
+}

src/commonMain/kotlin/platform.kt

@@ -0,0 +1,7 @@
+package me.archinamon.fileio
+
+enum class Platform {
+    Linux, Macos, Windows, JVM, JS
+}
+
+expect fun platform(): Platform

src/commonTest/kotlin/FileTests.kt

@@ -131,4 +131,71 @@ class FileTests {
         assertTrue(testDestFile.delete(), "failed to cleanup test file")
         assertTrue(testDestFolder.delete(), "failed to cleanup directory")
     }
+
+    @Test
+    fun testCreateTempFileAndDelete() {
+        if (platform() == Platform.Windows) {
+            return
+        }
+
+        val testFile = Files.createTempFile("test")
+
+        assertContains(
+            testFile.getAbsolutePath(),
+            "/tmp/test.tmp".replace('/', filePathSeparator),
+            message = "different path: ${testFile.getAbsolutePath()}"
+        )
+        assertTrue(testFile.exists(), "file should exist")
+        assertTrue(testFile.canRead(), "file should be readable")
+        assertTrue(testFile.canWrite(), "file should be writable")
+        assertTrue(testFile.isFile(), "file should be considered a file")
+        assertFalse(testFile.isDirectory(), "file should not be considered a directory")
+        assertTrue(testFile.delete(), "delete file failed")
+    }
+
+    @Test
+    fun testCreateTempFileWithinCustomDirAndDelete() {
+        if (platform() == Platform.Windows) {
+            return
+        }
+
+        val testDir = File("/tmp/testdir").apply { mkdirs() }
+        val testFile = Files.createTempFile(prefix = "test", suffix = "all.t", dir = testDir)
+
+        assertContains(
+            testFile.getAbsolutePath(),
+            "/tmp/testdir/testall.t".replace('/', filePathSeparator),
+            message = "different path: ${testFile.getAbsolutePath()}"
+        )
+        assertTrue(testFile.exists(), "file should exist")
+        assertTrue(testFile.canRead(), "file should be readable")
+        assertTrue(testFile.canWrite(), "file should be writable")
+        assertTrue(testFile.isFile(), "file should be considered a file")
+        assertFalse(testFile.isDirectory(), "file should not be considered a directory")
+        assertTrue(testFile.delete(), "delete file failed")
+
+        assertTrue(testDir.deleteRecursively(), "error while deleting all files in dir")
+    }
+
+    @Test
+    fun testFileLengthAndAppendings() {
+        if (platform() == Platform.Windows) {
+            return
+        }
+
+        val testFile = Files.createTempFile("test")
+        val data = "testData"
+        testFile.writeText(data)
+
+        assertTrue(testFile.exists(), "file should exists")
+        assertEquals(data, testFile.readText())
+
+        val appendedData = "\nNew Text!"
+        testFile.appendBytes(appendedData.encodeToByteArray())
+
+        assertEquals(data + appendedData, testFile.readText())
+        assertEquals((data + appendedData).length.toLong(), testFile.length())
+
+        assertTrue(testFile.delete(), "delete file failed")
+    }
 }

src/jsMain/kotlin/File.kt

@@ -54,6 +54,10 @@ actual class File constructor(jsfile: JsFile) {
         return innerFile.name
     }
 
+    actual fun length(): Long {
+        return innerFile.size.toLong()
+    }
+
     actual fun exists(): Boolean {
         return !virtual
     }
@@ -97,6 +101,11 @@ actual fun File.appendText(text: String) {
     writeText(newData)
 }
 
+actual fun File.appendBytes(bytes: ByteArray) {
+    val newData = readBytes() + bytes
+    writeBytes(newData)
+}
+
 actual fun File.writeText(text: String) {
     innerFile = JsFile(text.encodeToByteArray().toTypedArray(), innerFile.name)
 }

src/jsMain/kotlin/platform.kt

@@ -0,0 +1,3 @@
+package me.archinamon.fileio
+
+actual fun platform(): Platform = Platform.JS

src/jvmMain/kotlin/File.kt

@@ -1,12 +1,14 @@
 @file:Suppress("PackageDirectoryMismatch")
 package me.archinamon.fileio
 
+import java.io.File as jvmFile
 import java.net.URLConnection
 import java.nio.charset.Charset
+import kotlin.io.appendBytes as kAppendBytes
 import kotlin.io.readBytes as kReadBytes
 import kotlin.io.writeBytes as kWriteBytes
 
-actual typealias File = java.io.File
+actual typealias File = jvmFile
 
 actual val filePathSeparator by lazy { File.separatorChar }
 
@@ -19,6 +21,8 @@ actual fun File.readText() = readText(Charset.defaultCharset())
 
 actual fun File.writeBytes(bytes: ByteArray) = kWriteBytes(bytes)
 
+actual fun File.appendBytes(bytes: ByteArray) = kAppendBytes(bytes)
+
 actual fun File.appendText(text: String) = appendText(text, Charset.defaultCharset())
 
-actual fun File.writeText(text: String) = writeText(text, Charset.defaultCharset())
+actual fun File.writeText(text: String) = writeText(text, Charset.defaultCharset())

src/jvmMain/kotlin/platform.kt

@@ -0,0 +1,3 @@
+package me.archinamon.fileio
+
+actual fun platform(): Platform = Platform.JVM

src/linuxX64Main/kotlin/platform.kt

@@ -0,0 +1,3 @@
+package me.archinamon.fileio
+
+actual fun platform(): Platform = Platform.Linux