feat(template): access profiles in tera context

Author: oknozor

Cargo.lock

@@ -16,6 +16,7 @@ config = "0.13.1"
 dirs = "^4"
 toml = "^0"
 serde = { version = "1.0.139", features = ["derive"] }
+serde_json = "1.0.89"
 anyhow = "1.0.58"
 tera = "1.16.0"
 colored = "2.0.0"

Cargo.toml

@@ -22,6 +22,7 @@ impl Dot {
         &self,
         vars: &Variables,
         auto_ignored: Vec<PathBuf>,
+        profiles: &[String],
     ) -> Result<LinkResult> {
         let source = &self.source()?;
         let target = &self.build_copy_path();
@@ -47,7 +48,7 @@ impl Dot {
         vars.resolve_ref();
 
         // Recursively copy dotfile to .dots directory
-        self.traverse_and_copy(source, target, ignored_paths.as_slice(), &vars)
+        self.traverse_and_copy(source, target, ignored_paths.as_slice(), &vars, profiles)
     }
 
     fn load_local_vars(source: &Path) -> Variables {
@@ -74,6 +75,7 @@ impl Dot {
         target: &PathBuf,
         ignored: &[PathBuf],
         vars: &Variables,
+        profiles: &[String],
     ) -> Result<LinkResult> {
         if ignored.contains(source) {
             return Ok(LinkResult::Ignored);
@@ -82,7 +84,7 @@ impl Dot {
         // Single file : inject vars and write to .dots/
         if source.is_file() {
             fs::create_dir_all(target.parent().unwrap())?;
-            match vars.to_dot(source) {
+            match vars.to_dot(source, profiles) {
                 Ok(content) if target.exists() => self.update(source, target, content),
                 Ok(content) => self.create(source, target, content),
                 Err(_) if target.exists() => {
@@ -107,6 +109,7 @@ impl Dot {
                     &target.join(entry_name),
                     ignored,
                     vars,
+                    &[],
                 );
 
                 match result {
@@ -356,6 +359,7 @@ mod tests {
             &PathBuf::from("dotfiles_with_multiple_nested_dir/.dots/dir"),
             &vec![],
             &Variables::default(),
+            &[],
         )?;
 
         run_cmd!(tree -a;)?;
@@ -389,6 +393,7 @@ mod tests {
             &PathBuf::from("dotfiles_non_utf8/.dots/ferris.png"),
             &vec![],
             &Variables::default(),
+            &[],
         )?;
 
         run_cmd!(tree -a;)?;
@@ -428,6 +433,7 @@ mod tests {
                 PathBuf::from("source_dot/file.md"),
             ],
             &Variables::default(),
+            &[],
         )?;
 
         // Assert
@@ -489,7 +495,7 @@ mod tests {
             vars: Dot::default_vars(),
         };
 
-        dot.install(&Variables::default(), vec![])?;
+        dot.install(&Variables::default(), vec![], &[])?;
 
         assert_that!(PathBuf::from(".dots")).exists();
         assert_that!(PathBuf::from(".dots/source_dot")).exists();
@@ -514,7 +520,7 @@ mod tests {
         vars.insert("name", "Tom Bombadil");
 
         // Act
-        dot.install(&vars, vec![])?;
+        dot.install(&vars, vec![], &[])?;
         let dot = PathBuf::from(".dots/dotfiles/dot");
 
         // Assert
@@ -551,7 +557,7 @@ mod tests {
             vars: PathBuf::from("my_vars.toml"),
         };
 
-        dot.install(&Variables::default(), vec![])?;
+        dot.install(&Variables::default(), vec![], &[])?;
 
         let content = fs::read_to_string(".dots/dir/template")?;
         assert_that!(content).is_equal_to(&"Hello Tom\n".to_string());
@@ -582,7 +588,7 @@ mod tests {
         };
 
         // Arrange
-        dot.install(&Variables::default(), vec![])?;
+        dot.install(&Variables::default(), vec![], &[])?;
 
         // Assert
         let content = fs::read_to_string(PathBuf::from(

src/dots.rs

@@ -44,12 +44,21 @@ pub(crate) const BOMBADIL_CONFIG: &str = "bombadil.toml";
 /// dotfile directory and how to install it.
 #[derive(Clone)]
 pub struct Bombadil {
+    // path to self configuration, relative to $HOME
     path: PathBuf,
+    // A list of dotfiles to link for this instance
     dots: HashMap<String, Dot>,
+    // Variables for the tera template context
     vars: Variables,
+    // Pre-hook commands, run before `bombadil-link`
     prehooks: Vec<Hook>,
+    // Post-hook commands, run after `bombadil-link`
     posthooks: Vec<Hook>,
+    // Available profiles
     profiles: HashMap<String, Profile>,
+    // Profiles enabled for this isntance
+    profile_enabled: Vec<String>,
+    // A GPG user id, linking to user encryption/decryption key via gnupg
     gpg: Option<Gpg>,
 }
 
@@ -148,7 +157,11 @@ impl Bombadil {
         // Render current settings and create symlinks
         fs::create_dir_all(dot_copy_dir)?;
         for (key, dot) in self.dots.iter() {
-            match dot.install(&self.vars, self.get_auto_ignored_files(key)) {
+            match dot.install(
+                &self.vars,
+                self.get_auto_ignored_files(key),
+                self.profile_enabled.as_slice(),
+            ) {
                 Err(err) => {
                     eprintln!("{}", err);
                     continue;
@@ -361,6 +374,8 @@ impl Bombadil {
             return Ok(());
         }
 
+        self.profile_enabled = profile_keys.iter().map(ToString::to_string).collect();
+
         let mut profiles: Vec<Profile> = profile_keys
             .iter()
             // unwrap here is safe cause allowed profile keys are checked by clap
@@ -528,6 +543,7 @@ impl Bombadil {
             posthooks,
             profiles,
             gpg,
+            profile_enabled: vec![],
         })
     }
 
@@ -822,4 +838,21 @@ mod tests {
 
         Ok(())
     }
+
+    #[sealed_test(files = ["tests/dotfiles_with_profile_context"], before = setup("dotfiles_with_profile_context"))]
+    fn should_have_profile_context() -> Result<()> {
+        // Arrange
+        let mut bombadil = Bombadil::from_settings(NoGpg)?;
+        bombadil.enable_profiles(vec!["fancy"])?;
+
+        // Act
+        bombadil.install()?;
+        let target = fs::read_link(".config/template.css")?;
+        let content = fs::read_to_string(target)?;
+
+        // Assert
+        assert_that!(content).is_equal_to(".class {color: #de1f1f}\n".to_string());
+
+        Ok(())
+    }
 }

src/lib.rs

@@ -63,7 +63,7 @@ impl Variables {
 
     /// Read file in the given path and return its content
     /// with variable replaced by their values.
-    pub(crate) fn to_dot(&self, path: &Path) -> Result<String> {
+    pub(crate) fn to_dot(&self, path: &Path, profiles: &[String]) -> Result<String> {
         // Read file content
         let file = File::open(path)?;
         let mut buf_reader = BufReader::new(file);
@@ -76,10 +76,19 @@ impl Variables {
             context.insert(name, value);
         }
 
+        let profiles_context = serde_json::to_value(profiles)?;
+
         self.secrets.iter().for_each(|(k, v)| {
-            context.insert(k.to_owned(), v);
+            if k == "profiles" {
+                eprintln!("Cannot insert variable '{k}{v}'");
+                eprintln!("'profiles' is a reserved variable name");
+            } else {
+                context.insert(k.to_owned(), v);
+            }
         });
 
+        context.insert("profiles", &profiles_context);
+
         let mut tera = Tera::default();
         let filename = path.as_os_str().to_str().expect("Non UTF8 filename");
 
@@ -157,7 +166,7 @@ mod test {
             variables,
             secrets: Default::default(),
         }
-        .to_dot(Path::new("tests/dotfiles_simple/template.css"))
+        .to_dot(Path::new("tests/dotfiles_simple/template.css"), &[])
         .unwrap();
 
         assert_eq!(
@@ -181,7 +190,7 @@ mod test {
         secrets.insert("pass".to_string(), "hunter2".to_string());
 
         let dot_content = Variables { variables, secrets }
-            .to_dot(Path::new("tests/dotfiles_with_secret/template"))
+            .to_dot(Path::new("tests/dotfiles_with_secret/template"), &[])
             .unwrap();
 
         assert_that!(dot_content).contains("color: red_value");
@@ -194,7 +203,7 @@ mod test {
             variables: HashMap::new(),
             secrets: Default::default(),
         }
-        .to_dot(Path::new("tests/dotfiles_non_utf8/ferris.png"));
+        .to_dot(Path::new("tests/dotfiles_non_utf8/ferris.png"), &[]);
 
         assert_that!(content).is_err();
     }

src/templating.rs

@@ -0,0 +1,11 @@
+dotfiles_dir = "dotfiles_with_profile_context"
+
+[settings]
+vars = [ "vars.toml" ]
+
+
+
+[settings.dots]
+css = { source = "template.css", target = ".config/template.css" }
+
+[profiles.fancy]

tests/dotfiles_with_profile_context/bombadil.toml

@@ -0,0 +1,7 @@
+.class {
+    {%- if profiles is containing("fancy") -%}
+    color: {{red}}
+    {%- else -%}
+    color: {{black}}
+    {%- endif -%}
+}

tests/dotfiles_with_profile_context/template.css

@@ -0,0 +1,2 @@
+red = "#de1f1f"
+black = "#ffffff"