Add support for android string resource id in application label. (#146)

Fixes #145 * New android metadata field 'apk_name' used for apk file naming (fall back to artifact name). * Remove useless 'android:name' field from android manifest. * CHANGELOG.md, README.md and formatting fixes. * CHANGELOG.md version and notes fixed. * Rewrite changelog entry and remove date for *unreleased* version
rust-mobile · May 6, 2021 · a8d7129 · a8d7129
1 parent 7936944
commit a8d7129
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 3 deletions.
diff --git a/cargo-apk/CHANGELOG.md b/cargo-apk/CHANGELOG.md
@@ -1,3 +1,8 @@
+# Unreleased
+
+- Added `apk_name` field to android metadata for APK file naming (defaults to Rust library name if unspecified).
+  The application label is now no longer used for this purpose, and can contain a string resource ID from now on.
+
 # 0.6.0 (2021-04-20)
 
 - **Breaking:** uses `ndk-build`'s new (de)serialized `Manifest` struct to properly serialize a toml's `[package.metadata.android]` to an `AndroidManifest.xml`. The `[package.metadata.android]` now closely resembles the structure of [an android manifest file](https://developer.android.com/guide/topics/manifest/manifest-element). See [README](README.md) for an example of the new `[package.metadata.android]` structure and all manifest attributes that are currently supported.

diff --git a/cargo-apk/README.md b/cargo-apk/README.md
@@ -38,6 +38,10 @@ resources = "path/to/resources_folder"
 # If not specified, assets will not be included in the APK.
 assets = "path/to/assets_folder"
 
+# Name for final APK file.
+# Defaults to package name.
+apk_name = "myapp"
+
 # See https://developer.android.com/guide/topics/manifest/uses-sdk-element
 #
 # Defaults to a `min_sdk_version` of 23 and `target_sdk_version` is based on the ndk's default platform.

diff --git a/cargo-apk/src/apk.rs b/cargo-apk/src/apk.rs
@@ -121,10 +121,16 @@ impl<'a> ApkBuilder<'a> {
             )
             .to_owned()
         });
+        let apk_name = self
+            .manifest
+            .apk_name
+            .clone()
+            .unwrap_or_else(|| artifact.name().to_string());
 
         let config = ApkConfig {
             ndk: self.ndk.clone(),
             build_dir: self.build_dir.join(artifact),
+            apk_name,
             assets,
             resources,
             manifest,

diff --git a/cargo-apk/src/manifest.rs b/cargo-apk/src/manifest.rs
@@ -6,6 +6,7 @@ use std::path::Path;
 
 pub struct Manifest {
     pub version: String,
+    pub apk_name: Option<String>,
     pub android_manifest: AndroidManifest,
     pub build_targets: Vec<Target>,
     pub assets: Option<String>,
@@ -24,6 +25,7 @@ impl Manifest {
             .unwrap_or_default();
         Ok(Self {
             version: toml.package.version,
+            apk_name: metadata.apk_name,
             android_manifest: metadata.android_manifest,
             build_targets: metadata.build_targets,
             assets: metadata.assets,
@@ -50,6 +52,7 @@ struct PackageMetadata {
 
 #[derive(Clone, Debug, Default, Deserialize)]
 struct AndroidMetadata {
+    apk_name: Option<String>,
     #[serde(flatten)]
     android_manifest: AndroidManifest,
     #[serde(default)]

diff --git a/ndk-build/CHANGELOG.md b/ndk-build/CHANGELOG.md
@@ -1,3 +1,7 @@
+# Unreleased
+
+- New `ApkConfig` field `apk_name` is now used for APK file naming, instead of the application label.
+
 # 0.2.0 (2021-04-20)
 
 - **Breaking:** refactored `Manifest` into a proper (de)serialization struct. `Manifest` now closely matches [`an android manifest file`](https://developer.android.com/guide/topics/manifest/manifest-element).

diff --git a/ndk-build/src/apk.rs b/ndk-build/src/apk.rs
@@ -8,6 +8,7 @@ use std::process::Command;
 pub struct ApkConfig {
     pub ndk: Ndk,
     pub build_dir: PathBuf,
+    pub apk_name: String,
     pub assets: Option<PathBuf>,
     pub resources: Option<PathBuf>,
     pub manifest: AndroidManifest,
@@ -22,12 +23,11 @@ impl ApkConfig {
 
     fn unaligned_apk(&self) -> PathBuf {
         self.build_dir
-            .join(format!("{}-unaligned.apk", self.manifest.application.label))
+            .join(format!("{}-unaligned.apk", self.apk_name))
     }
 
     fn apk(&self) -> PathBuf {
-        self.build_dir
-            .join(format!("{}.apk", self.manifest.application.label))
+        self.build_dir.join(format!("{}.apk", self.apk_name))
     }
 
     pub fn create_apk(&self) -> Result<UnalignedApk, NdkError> {