Merge pull request #22 from valadaptive/bundle-id

Make macOS bundle ID match the `directories` crate
lunacookies · Feb 27, 2025 · 6cc955a · 6cc955a
2 parents c65b9c4 + dbb18c5
commit 6cc955a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Etcetera has 2 modes of operation: `BaseStrategy` & `AppStrategy`:
   For eg. if you provide the following details: `{ top_level_domain: "org", author: "Acme Corp", app_name: "Frobnicator Plus" }`, you'll get:
   - XDG: `~/.config/frobnicator-plus`
   - Unix: `~/.frobnicator-plus`
-  - Apple: `~/Library/Preferences/org.acmecorp.FrobnicatorPlus`
+  - Apple: `~/Library/Preferences/org.acme-corp.Frobnicator-Plus`
   - Windows: `~\AppData\Roaming\Acme Corp\Frobnicator Plus`
 
 Note: the location of the home (~) is determined by the [`home`](https://docs.rs/home/0.5.4/home/fn.home_dir.html) crate.

diff --git a/src/app_strategy.rs b/src/app_strategy.rs
@@ -29,15 +29,18 @@ impl AppStrategyArgs {
     ///     app_name: "Frobnicator Plus".to_string(),
     /// };
     ///
-    /// assert_eq!(strategy_args.bundle_id().replace(' ', ""), "org.acmecorp.FrobnicatorPlus".to_string());
+    /// assert_eq!(strategy_args.bundle_id(), "org.acme-corp.Frobnicator-Plus".to_string());
     /// ```
     pub fn bundle_id(&self) -> String {
-        format!(
-            "{}.{}.{}",
-            self.top_level_domain,
-            self.author.to_lowercase(),
-            self.app_name
-        )
+        let author = self.author.to_lowercase().replace(' ', "-");
+        let app_name = self.app_name.replace(' ', "-");
+        let mut parts = vec![
+            self.top_level_domain.as_str(),
+            author.as_str(),
+            app_name.as_str(),
+        ];
+        parts.retain(|part| !part.is_empty());
+        parts.join(".")
     }
 
     /// Returns a ‘unixy’ version of the application’s name, akin to what would usually be used as a binary name.

diff --git a/src/app_strategy/apple.rs b/src/app_strategy/apple.rs
@@ -24,15 +24,15 @@ use std::path::{Path, PathBuf};
 /// );
 /// assert_eq!(
 ///     app_strategy.config_dir().strip_prefix(&home_dir),
-///     Ok(Path::new("Library/Preferences/org.acmecorp.FrobnicatorPlus/"))
+///     Ok(Path::new("Library/Preferences/org.acme-corp.Frobnicator-Plus/"))
 /// );
 /// assert_eq!(
 ///     app_strategy.data_dir().strip_prefix(&home_dir),
-///     Ok(Path::new("Library/Application Support/org.acmecorp.FrobnicatorPlus/"))
+///     Ok(Path::new("Library/Application Support/org.acme-corp.Frobnicator-Plus/"))
 /// );
 /// assert_eq!(
 ///     app_strategy.cache_dir().strip_prefix(&home_dir),
-///     Ok(Path::new("Library/Caches/org.acmecorp.FrobnicatorPlus/"))
+///     Ok(Path::new("Library/Caches/org.acme-corp.Frobnicator-Plus/"))
 /// );
 /// assert_eq!(
 ///     app_strategy.state_dir(),
@@ -54,7 +54,7 @@ impl Apple {
     pub fn new(args: super::AppStrategyArgs) -> Result<Self, HomeDirError> {
         Ok(Self {
             base_strategy: base_strategy::Apple::new()?,
-            bundle_id: args.bundle_id().replace(' ', ""),
+            bundle_id: args.bundle_id(),
         })
     }
 }

diff --git a/src/lib.rs b/src/lib.rs
@@ -33,7 +33,7 @@
 //! Let’s take an application created by `Acme Corp` with the name `Frobnicator Plus` and the top-level domain of `jrg` as an example.
 //! - XDG strategy would place these in `~/.config/frobnicator-plus`.
 //! - Unix strategy would place these in `~/.frobnicator-plus`.
-//! - Apple strategy would place these in `~/Library/Preferences/org.acmecorp.FrobnicatorPlus`.
+//! - Apple strategy would place these in `~/Library/Preferences/org.acme-corp.Frobnicator-Plus`.
 //! - Windows strategy would place these in `~\AppData\Roaming\Acme Corp\Frobnicator Plus`.
 //!
 //! ```