chore: updated documentation and code cleanup

Author: MatrixDev

example/app/build.gradle.kts

@@ -49,7 +49,7 @@ androidRust {
             runTests = true
         }
     }
-    minimumSupportedRustVersion = "1.62.1"
+    minimumSupportedRustVersion = "1.91.1"
 }
 
 dependencies {

example/app/src/main/AndroidManifest.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:tools="http://schemas.android.com/tools"
-    package="dev.matrix.rust">
+    xmlns:tools="http://schemas.android.com/tools">
 
     <application
         android:allowBackup="true"

example/app/src/rust_library/src/lib.rs

@@ -3,7 +3,7 @@ use jni::objects::JObject;
 use jni::sys::jstring;
 
 #[no_mangle]
-extern fn Java_dev_matrix_rust_MainActivity_callRustCode(env: JNIEnv, _: JObject) -> jstring {
+extern "C" fn Java_dev_matrix_rust_MainActivity_callRustCode(env: JNIEnv, _: JObject) -> jstring {
     env.new_string("Hello from rust!").unwrap().into_inner()
 }
 

src/main/kotlin/dev/matrix/agp/rust/AndroidRustExtension.kt

@@ -8,19 +8,26 @@ annotation class AndroidRustDslMarker
 @AndroidRustDslMarker
 @Suppress("unused")
 open class AndroidRustExtension : AndroidRustConfiguration() {
+    /**
+     * Specify minimum supported rust version.
+     *
+     * Plugin will automatically use `rustup update` command to
+     * update rust version in case installed versions is not high enough.
+     */
     var minimumSupportedRustVersion = ""
-    var modules = mutableMapOf<String, AndroidRustModule>()
 
     /**
-     * Disable IDE ABI injection optimization.
-     * When true, all requested ABIs will be built regardless of IDE deployment target.
-     * When false (default), only the IDE target ABI will be built to speed up development builds.
+     * Configuration map of all rust libraries to build.
      *
-     * Set to true if you experience "library not found" errors when running from Android Studio.
-     * See: https://github.com/MatrixDev/GradleAndroidRustPlugin/issues/3
+     * Keys of this map are rust crates names.
      */
-    var disableAbiOptimization = false
+    var modules = mutableMapOf<String, AndroidRustModule>()
 
+    /**
+     * Configure rust module/library to build.
+     *
+     * @param name Rust crate name.
+     */
     fun module(name: String, configure: AndroidRustModule.() -> Unit) {
         modules.getOrPut(name, ::AndroidRustModule).configure()
     }
@@ -29,17 +36,33 @@ open class AndroidRustExtension : AndroidRustConfiguration() {
 @AndroidRustDslMarker
 @Suppress("unused")
 class AndroidRustModule : AndroidRustConfiguration() {
+    /**
+     * Path to the rust project folder.
+     *
+     * This is the folder containing `Cargo.toml` file.
+     */
     lateinit var path: File
 
+    /**
+     * All supported build type configurations.
+     *
+     * Keys of this map should correspond to this project's build variants.
+     */
     var buildTypes = hashMapOf(
         "debug" to AndroidRustBuildType().also {
             it.profile = "dev"
         },
         "release" to AndroidRustBuildType().also {
             it.profile = "release"
+            it.disableAbiOptimization = true
         },
     )
 
+    /**
+     * Configure rust build options.
+     *
+     * @param name this project's build variant.
+     */
     fun buildType(name: String, configure: AndroidRustBuildType.() -> Unit) {
         buildTypes.getOrPut(name, ::AndroidRustBuildType).configure()
     }
@@ -52,7 +75,32 @@ class AndroidRustBuildType : AndroidRustConfiguration()
 @AndroidRustDslMarker
 @Suppress("unused")
 open class AndroidRustConfiguration {
+    /**
+     * Rust profile (dev, release, etc.).
+     *
+     * See: https://doc.rust-lang.org/cargo/reference/profiles.html
+     */
     var profile = ""
+
+    /**
+     * List of ABIs to build.
+     */
     var targets = listOf<String>()
+
+    /**
+     * Run tests after the build.
+     *
+     * This will run `cargo test` command and check its result.
+     */
     var runTests: Boolean? = null
+
+    /**
+     * Disable IDE ABI injection optimization.
+     * - When `true`, all requested ABIs will be built regardless of IDE deployment target.
+     * - When `false` (default), only the IDE target ABI will be built to speed up development builds.
+     *
+     * Set to `true` if you experience "library not found" errors when running from Android Studio.
+     * See: https://github.com/MatrixDev/GradleAndroidRustPlugin/issues/3
+     */
+    var disableAbiOptimization: Boolean? = null
 }

src/main/kotlin/dev/matrix/agp/rust/AndroidRustPlugin.kt

@@ -20,7 +20,7 @@ import javax.inject.Inject
 //
 @Suppress("unused")
 abstract class AndroidRustPlugin @Inject constructor(
-    private val execOperations: ExecOperations
+    private val execOperations: ExecOperations,
 ) : Plugin<Project> {
     override fun apply(project: Project) {
         val rustBinaries = RustBinaries(project)
@@ -65,7 +65,7 @@ abstract class AndroidRustPlugin @Inject constructor(
                         else -> null
                     }
 
-                    val rustAbiSet = resolveAbiList(project, rustConfiguration.targets, extension)
+                    val rustAbiSet = resolveAbiList(project, rustConfiguration)
                     allRustAbiSet.addAll(rustAbiSet)
 
                     for (rustAbi in rustAbiSet) {
@@ -90,7 +90,12 @@ abstract class AndroidRustPlugin @Inject constructor(
             }
 
             val minimumSupportedRustVersion = SemanticVersion(extension.minimumSupportedRustVersion)
-            installRustComponentsIfNeeded(project, execOperations, minimumSupportedRustVersion, allRustAbiSet, rustBinaries)
+            installRustComponentsIfNeeded(
+                execOperations,
+                minimumSupportedRustVersion,
+                allRustAbiSet,
+                rustBinaries
+            )
         }
 
         androidComponents.onVariants { variant ->
@@ -106,11 +111,11 @@ abstract class AndroidRustPlugin @Inject constructor(
         }
     }
 
-    private fun resolveAbiList(project: Project, requested: Collection<String>, extension: AndroidRustExtension): Collection<Abi> {
-        val requestedAbi = Abi.fromRustNames(requested)
+    private fun resolveAbiList(project: Project, config: AndroidRustConfiguration): Collection<Abi> {
+        val requestedAbi = Abi.fromRustNames(config.targets)
 
         // If optimization is disabled, build all requested ABIs
-        if (extension.disableAbiOptimization) {
+        if (config.disableAbiOptimization == true) {
             return requestedAbi
         }
 
@@ -122,19 +127,23 @@ abstract class AndroidRustPlugin @Inject constructor(
 
         val intersectionAbi = requestedAbi.intersect(injectedAbi)
         check(intersectionAbi.isNotEmpty()) {
-            "ABIs requested by IDE ($injectedAbi) are not supported by the build config ($requested)"
+            "ABIs requested by IDE ($injectedAbi) are not supported by the build config (${config.targets})"
         }
 
         // Return all intersecting ABIs, not just one
         // The original logic only returned a single ABI which caused deployment issues
         return intersectionAbi.toList()
     }
 
+    /**
+     * Merge configurations with the first one having the highest priority
+     */
     private fun mergeRustConfigurations(vararg configurations: AndroidRustConfiguration?): AndroidRustConfiguration {
         val defaultConfiguration = AndroidRustConfiguration().also {
             it.profile = "release"
             it.targets = Abi.values().mapTo(ArrayList(), Abi::rustName)
             it.runTests = null
+            it.disableAbiOptimization = null
         }
 
         return configurations.asSequence()
@@ -150,6 +159,9 @@ abstract class AndroidRustPlugin @Inject constructor(
                 if (result.runTests == null) {
                     result.runTests = base.runTests
                 }
+                if (result.disableAbiOptimization == null) {
+                    result.disableAbiOptimization = base.disableAbiOptimization
+                }
                 result
             }
     }

src/main/kotlin/dev/matrix/agp/rust/RustInstaller.kt

@@ -6,12 +6,10 @@ import dev.matrix.agp.rust.utils.Os
 import dev.matrix.agp.rust.utils.RustBinaries
 import dev.matrix.agp.rust.utils.SemanticVersion
 import dev.matrix.agp.rust.utils.log
-import org.gradle.api.Project
 import org.gradle.process.ExecOperations
 import java.io.ByteArrayOutputStream
 
 internal fun installRustComponentsIfNeeded(
-    project: Project,
     execOperations: ExecOperations,
     minimalVersion: SemanticVersion?,
     abiSet: Collection<Abi>,
@@ -54,7 +52,7 @@ private fun installRustUp(execOperations: ExecOperations, rustBinaries: RustBina
         if (result.exitValue == 0) {
             return
         }
-    } catch (ignored: Exception) {
+    } catch (_: Exception) {
     }
 
     log("installing rustup")