feat: add config::Snapshot::trusted_program(). (#1178)

Byron · Byron · commit 3f842134d0e2 · 2023-12-12T14:51:53.000+01:00
That way it's possible to obtain an executable, program or script
from a key in the configuration that is in a trusted section of the
configuration.

This goes along with a new `command` feature that brings in the `command`
module at the top level to be able to execute such commands.
diff --git a/gix/Cargo.toml b/gix/Cargo.toml
@@ -61,6 +61,9 @@ comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human
 #! A component is a distinct feature which may be comprised of one or more methods around a particular topic.
 #! Providers of libraries should only activate the components they need.
 
+## Provide a top-level `command` module that helps with spawning commands similarly to `git`.
+command = ["dep:gix-command"]
+
 ## Obtain information similar to `git status`.
 status = ["gix-status"]
 
@@ -81,7 +84,7 @@ worktree-mutation = ["attributes", "dep:gix-worktree-state"]
 excludes = ["dep:gix-ignore", "dep:gix-worktree", "index"]
 
 ## Query attributes and excludes. Enables access to pathspecs, worktree checkouts, filter-pipelines and submodules.
-attributes = ["excludes", "dep:gix-filter", "dep:gix-pathspec", "dep:gix-attributes", "dep:gix-submodule", "gix-worktree?/attributes", "dep:gix-command"]
+attributes = ["excludes", "dep:gix-filter", "dep:gix-pathspec", "dep:gix-attributes", "dep:gix-submodule", "gix-worktree?/attributes", "command"]
 
 ## Add support for mailmaps, as way of determining the final name of commmiters and authors.
 mailmap = ["dep:gix-mailmap", "revision"]
diff --git a/gix/src/config/snapshot/access.rs b/gix/src/config/snapshot/access.rs
@@ -1,5 +1,6 @@
 #![allow(clippy::result_large_err)]
 use std::borrow::Cow;
+use std::ffi::OsStr;
 
 use gix_features::threading::OwnShared;
 use gix_macros::momo;
@@ -68,6 +69,21 @@ impl<'repo> Snapshot<'repo> {
             .config
             .trusted_file_path(key.section_name, key.subsection_name, key.value_name)
     }
+
+    /// Return the trusted string at `key` for launching using [command::prepare()](gix_command::prepare()),
+    /// or `None` if there is no such value or if no value was found in a trusted file.
+    #[momo]
+    pub fn trusted_program<'a>(&self, key: impl Into<&'a BStr>) -> Option<Cow<'repo, OsStr>> {
+        let value = self
+            .repo
+            .config
+            .resolved
+            .string_filter_by_key(key, &mut self.repo.config.filter_config_section.clone())?;
+        Some(match gix_path::from_bstr(value) {
+            Cow::Borrowed(v) => Cow::Borrowed(v.as_os_str()),
+            Cow::Owned(v) => Cow::Owned(v.into_os_string()),
+        })
+    }
 }
 
 /// Utilities and additional access
diff --git a/gix/src/config/tree/keys.rs b/gix/src/config/tree/keys.rs
@@ -165,9 +165,19 @@ pub type RemoteName = Any<validate::RemoteName>;
 pub type Boolean = Any<validate::Boolean>;
 
 /// A key that represents an executable program, shell script or shell commands.
+///
+/// Once obtained with [trusted_program()](crate::config::Snapshot::trusted_program())
+/// one can run it with [command::prepare()](gix_command::prepare), possibly after
+/// [obtaining](crate::Repository::command_context) and [setting](gix_command::Prepare::with_context)
+/// a git [command context](gix_command::Context) (depending on the commands needs).
 pub type Program = Any<validate::Program>;
 
 /// A key that represents an executable program as identified by name or path.
+///
+/// Once obtained with [trusted_program()](crate::config::Snapshot::trusted_program())
+/// one can run it with [command::prepare()](gix_command::prepare), possibly after
+/// [obtaining](crate::Repository::command_context) and [setting](gix_command::Prepare::with_context)
+/// a git [command context](gix_command::Context) (depending on the commands needs).
 pub type Executable = Any<validate::Executable>;
 
 /// A key that represents a path (to a resource).
diff --git a/gix/src/lib.rs b/gix/src/lib.rs
@@ -95,6 +95,8 @@
 pub use gix_actor as actor;
 #[cfg(feature = "attributes")]
 pub use gix_attributes as attrs;
+#[cfg(feature = "command")]
+pub use gix_command as command;
 pub use gix_commitgraph as commitgraph;
 #[cfg(feature = "credentials")]
 pub use gix_credentials as credentials;
