chore: rework dependency resolution and add integration guide to the README

Author: gyulavoros

README.md

@@ -7,6 +7,25 @@ The Kotlin Composable Architecture is a companion library for the amazing [Swift
 
 ⚠️ **Please note that this repository is a work in progress; there is no stable release available.**
 
+## Getting started
+
+Until there is no stable release available, the easiest way to integrate the library into your project is to use [Gradle's `includeBuild()` feature](https://publicobject.com/2021/03/11/includebuild/).
+
+```kotlin
+// in build.gradle.kts
+implementation("composable-architecture:composable-architecture:0.1.0")
+```
+
+```kotlin
+// in settings.gradle.kts
+includeBuild("<PATH TO kotlin-composable-architecture>") {
+    dependencySubstitution {
+        substitute(module("composable-architecture:composable-architecture"))
+            .with(project(":composable-architecture"))
+    }
+}
+```
+
 ## What is the Composable Architecture?
 
 This library provides a few core tools that can be used to build applications of varying purpose and complexity. It provides compelling stories that you can follow to solve many problems you encounter day-to-day when building applications, such as:

build.gradle.kts

@@ -26,6 +26,8 @@ allprojects {
 
         kotlinOptions.jvmTarget = "1.8"
     }
+
+    project.version = "0.1.0"
 }
 
 tasks.register<Delete>("clean") {

buildSrc/build.gradle.kts

@@ -12,7 +12,8 @@ repositories {
     jcenter()
 }
 
-private val properties = Properties().apply { File("gradle.properties").inputStream().use { load(it) } }
+private val properties = Properties()
+    .apply { File(rootDir.parentFile, "gradle.properties").inputStream().use { load(it) } }
 
 val androidToolsBuildVersion = properties.getProperty("androidToolsBuildVersion")
 val kotlinVersion = properties.getProperty("kotlinVersion")

buildSrc/gradle.properties

@@ -1,31 +1,31 @@
-@file:Suppress("HasPlatformType")
-
+import org.gradle.api.Project
 import java.io.File
 import java.util.Properties
 
-private val properties = Properties().apply { File("gradle.properties").inputStream().use { load(it) } }
-
 // Versions
-val androidToolsBuildVersion = properties.getProperty("androidToolsBuildVersion")
-val androidxActivityVersion = properties.getProperty("androidxActivityVersion")
-val androidxAppcompatVersion = properties.getProperty("androidxAppcompatVersion")
-val androidxConstraintLayoutVersion = properties.getProperty("androidxConstraintLayoutVersion")
-val androidxCoreVersion = properties.getProperty("androidxCoreVersion")
-val androidxDynamicAnimationVersion = properties.getProperty("androidxDynamicAnimationVersion")
-val androidxEspressoVersion = properties.getProperty("androidxEspressoVersion")
-val androidxJunitVersion = properties.getProperty("androidxJunitVersion")
-val androidxLifecycleVersion = properties.getProperty("androidxLifecycleVersion")
-val androidxRecyclerviewVersion = properties.getProperty("androidxRecyclerviewVersion")
-val arrowVersion = properties.getProperty("arrowVersion")
-val coroutinesVersion = properties.getProperty("coroutinesVersion")
-val junitVersion = properties.getProperty("junitVersion")
-val kotlinComposeVersion = properties.getProperty("kotlinComposeVersion")
-val kotlinVersion = properties.getProperty("kotlinVersion")
-val moshiVersion = properties.getProperty("moshiVersion")
-val okhttpVersion = properties.getProperty("okhttpVersion")
-val retrofitVersion = properties.getProperty("retrofitVersion")
+val Project.androidToolsBuildVersion: String get() = props.getProperty("androidToolsBuildVersion")
+val Project.androidxActivityVersion: String get() = props.getProperty("androidxActivityVersion")
+val Project.androidxAppcompatVersion: String get() = props.getProperty("androidxAppcompatVersion")
+val Project.androidxConstraintLayoutVersion: String get() = props.getProperty("androidxConstraintLayoutVersion")
+val Project.androidxCoreVersion: String get() = props.getProperty("androidxCoreVersion")
+val Project.androidxDynamicAnimationVersion: String get() = props.getProperty("androidxDynamicAnimationVersion")
+val Project.androidxEspressoVersion: String get() = props.getProperty("androidxEspressoVersion")
+val Project.androidxJunitVersion: String get() = props.getProperty("androidxJunitVersion")
+val Project.androidxLifecycleVersion: String get() = props.getProperty("androidxLifecycleVersion")
+val Project.androidxRecyclerviewVersion: String get() = props.getProperty("androidxRecyclerviewVersion")
+val Project.arrowVersion: String get() = props.getProperty("arrowVersion")
+val Project.coroutinesVersion: String get() = props.getProperty("coroutinesVersion")
+val Project.junitVersion: String get() = props.getProperty("junitVersion")
+val Project.kotlinComposeVersion: String get() = props.getProperty("kotlinComposeVersion")
+val Project.kotlinVersion: String get() = props.getProperty("kotlinVersion")
+val Project.moshiVersion: String get() = props.getProperty("moshiVersion")
+val Project.okhttpVersion: String get() = props.getProperty("okhttpVersion")
+val Project.retrofitVersion: String get() = props.getProperty("retrofitVersion")
 
 // Android
-val androidCompileSdkVersion = properties.getProperty("androidCompileSdkVersion").toInt()
-val androidMinSdkVersion = properties.getProperty("androidMinSdkVersion").toInt()
-val androidTargetSdkVersion = properties.getProperty("androidTargetSdkVersion").toInt()
+val Project.androidCompileSdkVersion: Int get() = props.getProperty("androidCompileSdkVersion").toInt()
+val Project.androidMinSdkVersion: Int get() = props.getProperty("androidMinSdkVersion").toInt()
+val Project.androidTargetSdkVersion: Int get() = props.getProperty("androidTargetSdkVersion").toInt()
+
+private val Project.props: Properties
+    get() = Properties().apply { File(rootDir, "gradle.properties").inputStream().use { load(it) } }

buildSrc/src/main/kotlin/Version.kt

@@ -8,7 +8,7 @@ kotlin.code.style=official
 android.useAndroidX=true
 
 # Versions
-androidToolsBuildVersion=7.0.0-alpha05
+androidToolsBuildVersion=4.1.3
 androidxActivityVersion=1.1.0
 androidxAppcompatVersion=1.2.0
 androidxConstraintLayoutVersion=2.0.4

gradle.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.jar

@@ -130,7 +130,7 @@ fi
 if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    
+
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath

gradle/wrapper/gradle-wrapper.properties

@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -54,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -64,29 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell