Iterated expect DSL

Author: gmazzo

README.md

@@ -181,20 +181,23 @@ const val APP_VERSION: String = "0.0.1"
 
 Similar to Android's `buildConfigField`, you can consume an `expect` BuildConfig class from common code,
 and provide different values for each platform target:
+
 ```kotlin
 buildConfig {
-    buildConfigField("COMMON_VALUE",  "aCommonValue")
-    buildConfigField("IS_MOBILE", expect(false)) // with a default
-    buildConfigField("PLATFORM", expect<String>()) // without a default
-
-    sourceSets.named("androidMain") {
-        buildConfigField("PLATFORM", "android")
-        buildConfigField("IS_MOBILE", true)
-    }
+  buildConfigField("COMMON_VALUE", "aCommonValue")  // any constant value will be automatically 'expect'ed and propagated to the actual classes
+  buildConfigField("IS_MOBILE", expect(false))      // with a default
+  buildConfigField("PLATFORM", expect<String>())    // without a default
+
+  sourceSets.named("androidMain") {
+    buildConfigField("PLATFORM", "android")
+    buildConfigField("IS_MOBILE", true)
+    buildConfigField("ANDROID_VALUE", "anAndroidValue")
+  }
 
-    sourceSets.named("jvmMain") {
-        buildConfigField("PLATFORM", "jvm")
-    }
+  sourceSets.named("jvmMain") {
+    buildConfigField("PLATFORM", "jvm")
+    buildConfigField("JVM_VALUE", "aJVMValue")
+  }
 }
 ```
 It will generate at `commonMain`:
@@ -221,7 +224,7 @@ actual object BuildConfig {
     actual const val COMMON_VALUE: String = "aCommonValue"
     actual const val PLATFORM: String = "jvm"
     actual const val IS_MOBILE: Boolean = false
-    const val ANDROID_VALUE: String = "anAndroidValue"
+    const val JVM_VALUE: String = "aJVMValue"
 }
 ```
 

demo-project/kts-multiplatform/build.gradle.kts

@@ -44,26 +44,30 @@ dependencies {
 }
 
 buildConfig {
-    buildConfigField("COMMON_VALUE",  "aCommonValue")
-    buildConfigField("IS_MOBILE", expect(false)) // with a default
-    buildConfigField("PLATFORM", expect<String>()) // without a default
-    buildConfigField("DEBUG", expect(false)) // to be changed by an Android variant
-    buildConfigField("com.eygraber.uri.Uri", "ENDPOINT", expect(expression("Uri.parse(\"https://api.example.com\")")))
+    buildConfigField("COMMON_VALUE",  "aCommonValue")       // a constant for all platforms
+    buildConfigField("PLATFORM", expect<String>())          // expect a platform specific value
+    buildConfigField("DEBUG", expect(false))    // expect with a default
+    buildConfigField("com.eygraber.uri.Uri", "ENDPOINT",
+        expect(expression("Uri.parse(\"https://api.example.com\")")))
     buildConfigField("PRODUCT_VALUE", expect<String?>(null))
 
     forClass("i18n") {
         useKotlinOutput { topLevelConstants = true }
 
         buildConfigField("i18n_hello", "Hello")
-        buildConfigField("i18n_greetings", expect("Greetings"))
         buildConfigField("i18n_kind", expect<String>())
     }
 
+    forClass("Single") {
+        buildConfigField("IS_MOBILE", expect(false))
+    }
+
     sourceSets.named("androidMain") {
         buildConfigField("PLATFORM", "android")
-        buildConfigField("IS_MOBILE", true)
         buildConfigField("ANDROID_VALUE", "anAndroidValue")
+        buildConfigField("DEBUG", false)
         forClass("i18n").buildConfigField("i18n_kind", "android")
+        forClass("Single").buildConfigField("IS_MOBILE", true)
     }
 
     sourceSets.named("androidDebug") {
@@ -86,13 +90,14 @@ buildConfig {
         buildConfigField("PLATFORM", "jvm")
         buildConfigField("JVM_VALUE", "aJvmValue")
         forClass("i18n").buildConfigField("i18n_kind", "jvm")
+        forClass("Single").buildConfigField("IS_MOBILE", false)
     }
 
     sourceSets.named("iosMain") {
         buildConfigField("PLATFORM", "ios")
-        buildConfigField("IS_MOBILE", true)
         buildConfigField("IOS_VALUE", "anIOSValue")
         forClass("i18n").buildConfigField("i18n_kind", "ios")
+        forClass("Single").buildConfigField("IS_MOBILE", true)
     }
 
     sourceSets.named("webMain") {
@@ -107,17 +112,10 @@ buildConfig {
                 .build()
         }
 
+        buildConfigField("PLATFORM", "web")
+        buildConfigField("WEB_VALUE", "aWebValue")
         forClass("i18n").buildConfigField("i18n_kind", "web")
-    }
-
-    sourceSets.named("jsMain") {
-        buildConfigField("PLATFORM", "js")
-        buildConfigField("JS_VALUE", "aJsValue")
-    }
-
-    sourceSets.named("wasmJsMain") {
-        buildConfigField("PLATFORM", "wasmJs")
-        buildConfigField("WASM_JS_VALUE", "aWebAssemblyJsValue")
+        forClass("Single").buildConfigField("IS_MOBILE", false)
     }
 }
 

demo-project/kts-multiplatform/src/androidUnitTest/kotlin/com/github/gmazzo/buildconfig/demos/kts_multiplatform/AndroidBuildConfigTest.kt

@@ -0,0 +1,21 @@
+package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+
+import com.eygraber.uri.Uri
+import com.github.gmazzo.buildconfig.demos.android.BuildConfig as AndroidBuildConfig
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class AndroidBuildConfigTest : CommonBuildConfigTest(
+    expectedPlatform = "android",
+    expectedMobile = true,
+    expectedDebug = AndroidBuildConfig.DEBUG,
+    expectedProduct = "${AndroidBuildConfig.FLAVOR_brand}Value",
+    expectedUri = Uri.parse("https://${ if (AndroidBuildConfig.FLAVOR_env == "stage") "stage." else "" }api.example.com"),
+) {
+
+    @Test
+    fun testAndroidOnlyValues() {
+        assertEquals("anAndroidValue", BuildConfig.ANDROID_VALUE)
+    }
+
+}

demo-project/kts-multiplatform/src/androidUnitTest/kotlin/com/github/gmazzo/buildconfig/demos/kts_multiplatform/BuildConfigTest.kt

@@ -1,20 +1,35 @@
 package com.github.gmazzo.buildconfig.demos.kts_multiplatform
 
+import com.eygraber.uri.Uri
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
-class CommonBuildConfigTest {
+abstract class CommonBuildConfigTest(
+    private val expectedPlatform: String,
+    private val expectedMobile: Boolean = false,
+    private val expectedDebug: Boolean = false,
+    private val expectedUri: Uri = Uri.parse("https://api.example.com"),
+    private val expectedProduct: String? = null,
+) {
 
     @Test
     fun testBuildConfigProperties() {
         assertEquals("aCommonValue", BuildConfig.COMMON_VALUE)
+        assertEquals(expectedPlatform, BuildConfig.PLATFORM)
+        assertEquals(expectedDebug, BuildConfig.DEBUG)
+        assertEquals(expectedUri, BuildConfig.ENDPOINT)
+        assertEquals(expectedProduct, BuildConfig.PRODUCT_VALUE)
     }
 
     @Test
     fun testI18nProperties() {
         assertEquals("Hello", i18n_hello)
-        assertEquals("Greetings", i18n_greetings)
-        assertEquals(expected_i18n_kind, i18n_kind)
+        assertEquals(expectedPlatform, i18n_kind)
+    }
+
+    @Test
+    fun testSingleProperties() {
+        assertEquals(expectedMobile, Single.IS_MOBILE)
     }
 
 }

demo-project/kts-multiplatform/src/androidUnitTest/kotlin/com/github/gmazzo/buildconfig/demos/kts_multiplatform/TestActuals.kt

@@ -0,0 +1,16 @@
+package com.github.gmazzo.buildconfig.demos.kts_multiplatform
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class iOSBuildConfigTest : CommonBuildConfigTest(
+    expectedPlatform = "ios",
+    expectedMobile = true,
+) {
+
+    @Test
+    fun testIOSOnlyValues() {
+        assertEquals("anIOSValue", BuildConfig.IOS_VALUE)
+    }
+
+}