Merge pull request #51 from aPureBase/file-path-mapping

Add std libmappings, Path, File, ...

Author: AndreasVolkmann

arkenv/src/main/kotlin/com/apurebase/arkenv/ArkenvMapper.kt

@@ -1,6 +1,11 @@
 package com.apurebase.arkenv
 
 import com.apurebase.arkenv.util.split
+import java.io.File
+import java.net.URI
+import java.net.URL
+import java.nio.file.Path
+import java.nio.file.Paths
 import kotlin.reflect.KClass
 
 /**
@@ -35,6 +40,13 @@ internal object ArkenvMapper {
  DoubleArray::class -> split().map(String::toDouble).toDoubleArray()
  BooleanArray::class -> split().map(String::toBoolean).toBooleanArray()
  ByteArray::class -> split().map(String::toByte).toByteArray()
+ Path::class -> Paths.get(this)
+ File::class -> File(this)
+ URL::class -> URL(this)
+ URI::class -> URI(this)
+ IntRange::class -> split("..").let { IntRange(it[0].toInt(), it[1].toInt()) }
+ LongRange::class -> split("..").let { LongRange(it[0].toLong(), it[1].toLong()) }
+ CharRange::class -> CharRange(this[0], this[3])
  else -> throw UnsupportedMappingException(key, clazz)
  }
 }

arkenv/src/test/kotlin/com/apurebase/arkenv/MappingTests.kt

@@ -3,9 +3,15 @@ package com.apurebase.arkenv
 import com.apurebase.arkenv.test.expectThat
 import com.apurebase.arkenv.test.parse
 import com.apurebase.arkenv.util.argument
+import com.apurebase.arkenv.util.parse
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.TestInstance
+import strikt.api.expectThat
 import strikt.assertions.isEqualTo
+import java.io.File
+import java.net.URI
+import java.net.URL
+import java.nio.file.Path
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 internal class MappingTests {
@@ -17,8 +23,8 @@ internal class MappingTests {
  val list: List<String> by argument()
  val collection: Collection<String> by argument()
  }.parse("LIST", input, "COLLECTION", input).expectThat {
- get { list }.isEqualTo(output)
- get { collection }.isEqualTo(output)
+ get { list } isEqualTo output
+ get { collection } isEqualTo output
  }
  }
 
@@ -94,6 +100,83 @@ internal class MappingTests {
  }
  }
 
+ @Test fun `Path should map`() {
+ val expectedPath = "C:\\"
+ val configuration = object {
+ val path: Path by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--path", expectedPath))
+
+ expectThat(configuration).get { path.toString() } isEqualTo expectedPath
+ }
+
+ @Test fun `File should map`() {
+ val expectedPath = "C:\\"
+ val configuration = object {
+ val file: File by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--file", expectedPath))
+
+ expectThat(configuration).get { file.toString() } isEqualTo expectedPath
+ }
+
+ @Test fun url() {
+ val expectedUrl = "https://arkenv.io/features/mapping/"
+ val configuration = object {
+ val url: URL by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--url", expectedUrl))
+
+ expectThat(configuration).get { url.toString() } isEqualTo expectedUrl
+ }
+
+ @Test fun uri() {
+ val expectedUri = "arkenv.io/features/mapping"
+ val configuration = object {
+ val uri: URI by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--uri", expectedUri))
+
+ expectThat(configuration).get { uri.toString() } isEqualTo expectedUri
+ }
+
+ @Test fun intRange() {
+ val expectedRange = -5..101
+ val configuration = object {
+ val range: IntRange by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--range", "-5..101"))
+
+ expectThat(configuration).get { range } isEqualTo expectedRange
+ }
+
+ @Test fun longRange() {
+ val expectedRange = -5L..101
+ val configuration = object {
+ val range: LongRange by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--range", "-5..101"))
+
+ expectThat(configuration).get { range } isEqualTo expectedRange
+ }
+
+ @Test fun charRange() {
+ val expectedRange = CharRange('z', 'a')
+ val configuration = object {
+ val range: CharRange by argument()
+ }
+
+ Arkenv.parse(configuration, arrayOf("--range", "z..a"))
+
+ expectThat(configuration).get { range } isEqualTo expectedRange
+ }
+
  private val floatingPointInput = "1.1,29.92,-387.9999"
  private val floatingPointOutput = listOf(1.1, 29.92, -387.9999)
  private val numericInput = "1,-29,387"

docs/features/mapping.md

@@ -10,11 +10,13 @@ nav_order: 13
 The following mappings are supported by default:
 
 ```kotlin
-object Ark : Arkenv() {
+object Configuration {
  val int: Int by argument()
  val long: Long by argument()
  val string: String by argument()
  val char: Char by argument()
+ 
+ // arrays
  val intArray: IntArray by argument()
  val shortArray: ShortArray by argument()
  val charArray: CharArray by argument()
@@ -25,7 +27,18 @@ object Ark : Arkenv() {
  val byteArray: ByteArray by argument()
 
  val stringList: List<String> by argument()
- val stringCollection: Collection<String> by argument() 
+ val stringCollection: Collection<String> by argument()
+ 
+ // IO
+ val file: File by argument()
+ val path: Path by argument()
+ val url: URL by argument()
+ val uri: URI by argument()
+
+ // ranges
+ val intRange: IntRange by argument() // -5..5
+ val longRange: LongRange by argument() // -5..5
+ val charRange: CharRange by argument() // a..z
 }
 ```