Create FileSystem.SYSTEM property in shared source set (#1455)

* Create FileSystem.SYSTEM property in shared source set Co-authored-by: Sebastian Sellmair <sebastian.sellmair@jetbrains.com> * Only configure native platforms in samples if kmpNativeEnabled is set * Use FileSystem.SYSTEM in existing tests, remove new multiplatform samples --------- Co-authored-by: Sebastian Sellmair <sebastian.sellmair@jetbrains.com>
square · Mar 12, 2024 · eac869b · eac869b
1 parent fe6ac99
commit eac869b
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 24 deletions.
diff --git a/okio-testing-support/src/jvmMain/kotlin/okio/TestingJvm.kt b/okio-testing-support/src/jvmMain/kotlin/okio/TestingJvm.kt
@@ -15,8 +15,6 @@
  */
 package okio
 
-actual val SYSTEM_FILE_SYSTEM = FileSystem.SYSTEM
-
 actual fun isBrowser() = false
 
 actual fun isWasm() = false

diff --git a/okio-testing-support/src/nativeMain/kotlin/okio/TestingNative.kt b/okio-testing-support/src/nativeMain/kotlin/okio/TestingNative.kt
@@ -19,8 +19,6 @@ import kotlinx.cinterop.ExperimentalForeignApi
 import kotlinx.cinterop.toKString
 import platform.posix.getenv
 
-actual val SYSTEM_FILE_SYSTEM = FileSystem.SYSTEM
-
 actual fun isBrowser() = false
 
 actual fun isWasm() = false

diff --git a/okio-testing-support/src/zlibMain/kotlin/okio/TestingZlib.kt b/okio-testing-support/src/zlibMain/kotlin/okio/TestingZlib.kt
diff --git a/okio/api/okio.api b/okio/api/okio.api
@@ -755,6 +755,10 @@ public abstract interface class okio/Source : java/io/Closeable {
 	public abstract fun timeout ()Lokio/Timeout;
 }
 
+public final class okio/SystemFileSystem {
+	public static final synthetic fun getSYSTEM (Lokio/FileSystem$Companion;)Lokio/FileSystem;
+}
+
 public final class okio/Throttler {
 	public fun <init> ()V
 	public final fun bytesPerSecond (J)V

diff --git a/okio/build.gradle.kts b/okio/build.gradle.kts
@@ -47,6 +47,8 @@ plugins {
  *
  * The `hashFunctions` source set builds on all platforms. It ships as a main source set on non-JVM
  * platforms and as a test source set on the JVM platform.
+ *
+ * The `systemFileSystem` source set is used on jvm and native targets, and provides the FileSystem.SYSTEM property.
  */
 kotlin {
   configureOrCreateOkioPlatforms()
@@ -87,6 +89,10 @@ kotlin {
       dependsOn(commonMain)
     }
 
+    val systemFileSystemMain by creating {
+      dependsOn(commonMain)
+    }
+
     val nonJvmTest by creating {
       dependsOn(commonTest)
     }
@@ -104,6 +110,7 @@ kotlin {
 
     val jvmMain by getting {
       dependsOn(zlibMain)
+      dependsOn(systemFileSystemMain)
     }
     val jvmTest by getting {
       kotlin.srcDir("src/jvmTest/hashFunctions")
@@ -131,6 +138,7 @@ kotlin {
       createSourceSet("nativeMain", parent = nonJvmMain)
         .also { nativeMain ->
           nativeMain.dependsOn(zlibMain)
+          nativeMain.dependsOn(systemFileSystemMain)
           createSourceSet("mingwMain", parent = nativeMain, children = mingwTargets).also { mingwMain ->
             mingwMain.dependsOn(nonAppleMain)
           }

diff --git a/okio/src/jvmMain/kotlin/okio/FileSystem.System.kt b/okio/src/jvmMain/kotlin/okio/FileSystem.System.kt
@@ -0,0 +1,13 @@
+@file:JvmName("SystemFileSystem")
+
+package okio
+
+/*
+ * JVM and native platforms do offer a [SYSTEM] [FileSystem], however we cannot refine an 'expect' companion object.
+ * Therefore an extension property is provided, which on respective platforms (here JVM) will be shadowed by the
+ * original implementation.
+ */
+@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
+actual inline val FileSystem.Companion.SYSTEM: FileSystem
+  @JvmSynthetic
+  get() = SYSTEM
diff --git a/okio/src/nativeMain/kotlin/okio/FileSystem.kt b/okio/src/nativeMain/kotlin/okio/FileSystem.kt
@@ -112,3 +112,12 @@ actual abstract class FileSystem {
     actual val SYSTEM_TEMPORARY_DIRECTORY: Path = PLATFORM_TEMPORARY_DIRECTORY
   }
 }
+
+/*
+ * JVM and native platforms do offer a [SYSTEM] [FileSystem], however we cannot refine an 'expect' companion object.
+ * Therefore an extension property is provided, which on respective platforms (here JVM) will be shadowed by the
+ * original implementation.
+ */
+@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
+actual inline val FileSystem.Companion.SYSTEM: FileSystem
+  get() = SYSTEM
diff --git a/okio/src/systemFileSystemMain/kotlin/okio/FileSystem.System.kt b/okio/src/systemFileSystemMain/kotlin/okio/FileSystem.System.kt
@@ -0,0 +1,7 @@
+package okio
+
+/*
+ * The current process's host file system. Use this instance directly, or dependency inject a
+ * [FileSystem] to make code testable.
+ */
+expect val FileSystem.Companion.SYSTEM: FileSystem
diff --git a/okio/src/zlibTest/kotlin/okio/ZipFileSystemGoTest.kt b/okio/src/zlibTest/kotlin/okio/ZipFileSystemGoTest.kt
@@ -26,7 +26,7 @@ import okio.Path.Companion.toPath
  * https://github.com/golang/go/blob/6f5d77454e31be8af11a7e2bcda36d200fda07c5/src/archive/zip/reader_test.go
  */
 class ZipFileSystemGoTest {
-  private val fileSystem = SYSTEM_FILE_SYSTEM
+  private val fileSystem = FileSystem.SYSTEM
   private var base = okioRoot / "okio-testing-support" /
     "src/commonMain/resources/go/src/archive/zip/testdata"
 

diff --git a/okio/src/zlibTest/kotlin/okio/ZipFileSystemTest.kt b/okio/src/zlibTest/kotlin/okio/ZipFileSystemTest.kt
@@ -33,7 +33,7 @@ import okio.ByteString.Companion.encodeUtf8
 import okio.Path.Companion.toPath
 
 class ZipFileSystemTest {
-  private val fileSystem = SYSTEM_FILE_SYSTEM
+  private val fileSystem = FileSystem.SYSTEM
   private var base = okioRoot / "okio-testing-support/src/commonMain/resources/okio/zipfilesystem"
 
   @Test