Define ConfigDirectory#default_profile().

Author: artob

lib/asimov-directory/README.md

@@ -92,8 +92,8 @@ use asimov_directory::{ModuleNameIterator, fs::StateDirectory};
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let modules_dir = StateDirectory::home()?.modules()?;
-    let mut module_names = modules_dir.iter_installed().await?;
+    let modules = StateDirectory::home()?.modules()?;
+    let mut module_names = modules.iter_installed().await?;
     while let Some(module_name) = module_names.next().await {
         println!("{}", module_name);
     }

lib/asimov-directory/examples/list_configs.rs

@@ -4,7 +4,7 @@ use asimov_directory::fs::StateDirectory;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let _configs_dir = StateDirectory::home()?.configs()?;
+    let _configs = StateDirectory::home()?.configs()?;
     // TODO
     Ok(())
 }

lib/asimov-directory/examples/list_modules.rs

@@ -4,8 +4,8 @@ use asimov_directory::{ModuleNameIterator, fs::StateDirectory};
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let modules_dir = StateDirectory::home()?.modules()?;
-    let mut module_names = modules_dir.iter_installed().await?;
+    let modules = StateDirectory::home()?.modules()?;
+    let mut module_names = modules.iter_installed().await?;
     while let Some(module_name) = module_names.next().await {
         println!("{}", module_name);
     }

lib/asimov-directory/examples/list_programs.rs

@@ -4,7 +4,7 @@ use asimov_directory::fs::StateDirectory;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let _programs_dir = StateDirectory::home()?.programs()?;
+    let _programs = StateDirectory::home()?.programs()?;
     // TODO
     Ok(())
 }

lib/asimov-directory/examples/show_config.rs

@@ -0,0 +1,10 @@
+// cargo run --package asimov-directory --example show_config
+
+use asimov_directory::fs::StateDirectory;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let configs = StateDirectory::home()?.configs()?;
+    let profile = configs.default_profile()?;
+    println!("{:?}", profile); // TODO
+    Ok(())
+}

lib/asimov-directory/src/config_profile.rs

@@ -0,0 +1,12 @@
+// This is free and unencumbered software released into the public domain.
+
+use alloc::string::String;
+use asimov_core::Named;
+
+/// A configuration profile.
+pub trait ConfigProfile: Named {
+    /// Returns the system prompt, if any, for the configuration profile.
+    fn prompt(&self) -> Option<String> {
+        None
+    }
+}

lib/asimov-directory/src/fs/config_directory.rs

@@ -1,6 +1,6 @@
 // This is free and unencumbered software released into the public domain.
 
-use super::StateDirectory;
+use super::{ConfigProfile, StateDirectory};
 use alloc::format;
 use camino::Utf8PathBuf;
 use derive_more::Display;
@@ -39,6 +39,12 @@ impl ConfigDirectory {
         Ok(ConfigDirectory { path })
     }
 
+    /// Returns the default configuration profile (e.g., at
+    /// `$HOME/.asimov/configs/default/`).
+    pub fn default_profile(&self) -> Result<ConfigProfile> {
+        ConfigProfile::open(self.path.join("default"))
+    }
+
     pub fn as_str(&self) -> &str {
         self.path.as_str()
     }

lib/asimov-directory/src/fs/config_profile.rs

@@ -0,0 +1,81 @@
+// This is free and unencumbered software released into the public domain.
+
+use alloc::{borrow::Cow, format, string::String};
+use asimov_core::Named;
+use camino::Utf8PathBuf;
+use derive_more::Display;
+use std::{
+    io::{Error, ErrorKind, Result},
+    path::Path,
+};
+
+/// A configuration profile stored on a file system (e.g., `$HOME/.asimov/configs/default/`).
+#[derive(Debug, Display)]
+#[display("ConfigProfile({:?})", path)]
+pub struct ConfigProfile {
+    path: Utf8PathBuf,
+}
+
+impl ConfigProfile {
+    /// Opens a configuration profile from a file system path.
+    pub fn open(path: impl AsRef<Path>) -> Result<Self> {
+        let path = path.as_ref();
+        if !path.exists() {
+            std::fs::create_dir_all(path)?;
+        }
+        let path = Utf8PathBuf::from_path_buf(path.to_path_buf()).map_err(|e| {
+            Error::new(
+                ErrorKind::InvalidFilename,
+                format!("failed to open non-UTF-8 path: {}", e.display()),
+            )
+        })?;
+        Ok(ConfigProfile { path })
+    }
+
+    /// The name of the configuration profile (e.g., "default").
+    fn name(&self) -> Cow<'_, str> {
+        if let Some(name) = self.path.file_name() {
+            return Cow::Borrowed(name);
+        }
+        self.path
+            .canonicalize_utf8()
+            .ok()
+            .and_then(|p| p.file_name().map(String::from))
+            .map_or(Cow::default(), Cow::Owned)
+    }
+
+    pub fn as_str(&self) -> &str {
+        self.path.as_str()
+    }
+}
+
+impl AsRef<str> for ConfigProfile {
+    fn as_ref(&self) -> &str {
+        self.path.as_str()
+    }
+}
+
+impl AsRef<Path> for ConfigProfile {
+    fn as_ref(&self) -> &Path {
+        self.path.as_std_path()
+    }
+}
+
+#[cfg(feature = "camino")]
+impl AsRef<Utf8Path> for ConfigProfile {
+    fn as_ref(&self) -> &Utf8Path {
+        self.path.as_path()
+    }
+}
+
+impl Named for ConfigProfile {
+    fn name(&self) -> Cow<'_, str> {
+        self.name()
+    }
+}
+
+impl crate::ConfigProfile for ConfigProfile {
+    fn prompt(&self) -> Option<String> {
+        None // TODO
+    }
+}

lib/asimov-directory/src/fs/mod.rs

@@ -3,6 +3,9 @@
 mod config_directory;
 pub use config_directory::*;
 
+mod config_profile;
+pub use config_profile::*;
+
 mod module_directory;
 pub use module_directory::*;
 

lib/asimov-directory/src/lib.rs

@@ -14,6 +14,9 @@ pub mod fs;
 mod config_directory;
 pub use config_directory::*;
 
+mod config_profile;
+pub use config_profile::*;
+
 mod module_directory;
 pub use module_directory::*;