Add File.children, resourceOrNull and resource functions

Author: JavierSegoviaCordoba

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Added
 
+- `resource(name: String): File` function
+- `resourceOrNull(name: String): File?` function
+- `File.children: Sequence<File>`
 - `String.transformstring` function
 - `String.TRANSFORMSTRING` function
 - `String.transformString` function

kotlin-stdlib/android/main/AndroidManifest.xml

@@ -159,6 +159,12 @@ public final class com/javiersc/kotlin/stdlib/CollectionsKt {
 	public static final fun thirdOrNull (Ljava/lang/Iterable;)Ljava/lang/Object;
 }
 
+public final class com/javiersc/kotlin/stdlib/FilesKt {
+	public static final fun getChildren (Ljava/io/File;)Lkotlin/sequences/Sequence;
+	public static final fun resource (Ljava/lang/String;)Ljava/io/File;
+	public static final fun resourceOrNull (Ljava/lang/String;)Ljava/io/File;
+}
+
 public final class com/javiersc/kotlin/stdlib/StringsKt {
 	public static final fun endWithNewLine (Ljava/lang/String;)Ljava/lang/String;
 	public static final fun getEmpty (Lkotlin/jvm/internal/StringCompanionObject;)Ljava/lang/String;

kotlin-stdlib/api/jvm/kotlin-stdlib.api

@@ -0,0 +1,11 @@
+package com.javiersc.kotlin.stdlib
+
+import java.io.File
+
+public fun resource(name: String): File = resourceOrNull(name) ?: error("File not found")
+
+public fun resourceOrNull(name: String): File? =
+    Thread.currentThread().contextClassLoader?.getResource(name)?.file?.let(::File)
+
+public val File.children: Sequence<File>
+    get() = walkTopDown().maxDepth(1) - this

kotlin-stdlib/common/test/resources/children-test/A.txt

@@ -0,0 +1,40 @@
+package com.javiersc.kotlin.stdlib
+
+import java.io.File
+import kotlin.test.Test
+import kotlin.test.assertFailsWith
+import kotlin.test.assertNotNull
+import kotlin.test.assertNull
+import kotlin.test.assertTrue
+
+internal class FilesTest {
+
+    @Test
+    fun `given a directory when it exists then resource is not null`() {
+        val childrenTestDir = resourceOrNull("children-test")
+        assertNotNull(childrenTestDir)
+        assertTrue { childrenTestDir.exists() }
+        assertTrue { resource("children-test").exists() }
+    }
+
+    @Test
+    fun `given a directory when it does not exist then resource is null`() {
+        assertFailsWith<IllegalStateException> { resource("children-test-foo") }
+        assertNull(resourceOrNull("children-test-foo"))
+    }
+
+    @Test
+    fun `given a directory when it has children a sub-children then children does not use sub children`() {
+        val childrenTestDir = resource("children-test")
+
+        val children: Sequence<File> = childrenTestDir.children
+        val actualChildren: List<String> = children.toList().map { it.name }.sorted()
+        val expectChildren: List<String> = listOf("A.txt", "B.txt", "sub-children").sorted()
+        assertTrue { actualChildren == expectChildren }
+
+        val subChildren = children.first { it.isDirectory }.children
+        val actualSubChildren: List<String> = subChildren.toList().map { it.name }.sorted()
+        val expectSubChildren: List<String> = listOf("C.txt", "D.txt").sorted()
+        assertTrue { actualSubChildren == expectSubChildren }
+    }
+}

kotlin-stdlib/common/test/resources/children-test/B.txt

@@ -0,0 +1,72 @@
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreAndroidNativeArm32 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreAndroidNativeArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreAndroidNativeX64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreAndroidNativeX86 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreCommon : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreIosArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreIosSimulatorArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreIosX64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreJs : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreJvm : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreLinuxArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreLinuxX64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreMacosArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreMacosX64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreMingwX64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreTvosArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreTvosSimulatorArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreTvosX64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreWasm : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreWatchosArm32 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreWatchosArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreWatchosDeviceArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreWatchosSimulatorArm64 : java/lang/annotation/Annotation {
+}
+
+public abstract interface annotation class com/javiersc/kotlin/test/IgnoreWatchosX64 : java/lang/annotation/Annotation {
+}
+