Merge pull request #1884 from GitoxideLabs/improvements

various improvements

Author: Byron

gitoxide-core/src/repository/archive.rs

@@ -30,7 +30,7 @@ pub fn stream(
     let (mut stream, index) = repo.worktree_stream(tree)?;
     if !add_paths.is_empty() {
         let root = gix::path::realpath(
-            repo.work_dir()
+            repo.workdir()
                 .ok_or_else(|| anyhow!("Adding files requires a worktree directory that contains them"))?,
         )?;
         for path in add_paths {

gitoxide-core/src/repository/attributes/query.rs

@@ -83,7 +83,7 @@ pub(crate) mod function {
                         gix::worktree::stack::state::attributes::Source::WorktreeThenIdMapping
                             .adjust_for_bare(repo.is_bare()),
                     )?;
-                    let workdir = repo.work_dir();
+                    let workdir = repo.workdir();
                     for pattern in pathspec.search().patterns() {
                         let path = pattern.path();
                         let entry = cache.at_entry(

gitoxide-core/src/repository/attributes/validate_baseline.rs

@@ -114,7 +114,7 @@ pub(crate) mod function {
         };
         let work_dir = ignore
             .then(|| {
-                repo.work_dir()
+                repo.workdir()
                     .map(ToOwned::to_owned)
                     .ok_or_else(|| anyhow!("repository at {:?} must have a worktree checkout", repo.path()))
             })
@@ -249,7 +249,7 @@ pub(crate) mod function {
             }
             bail!(
                 "{}: Validation failed with {} mismatches out of {}",
-                gix::path::realpath(repo.work_dir().unwrap_or(repo.git_dir()))?.display(),
+                gix::path::realpath(repo.workdir().unwrap_or(repo.git_dir()))?.display(),
                 mismatches.len(),
                 progress.counter().load(Ordering::Relaxed)
             );

gitoxide-core/src/repository/clean.rs

@@ -53,7 +53,7 @@ pub(crate) mod function {
         if format != OutputFormat::Human {
             bail!("JSON output isn't implemented yet");
         }
-        let Some(workdir) = repo.work_dir() else {
+        let Some(workdir) = repo.workdir() else {
             bail!("Need a worktree to clean, this is a bare repository");
         };
 

gitoxide-core/src/repository/exclude.rs

@@ -60,7 +60,7 @@ pub fn query(
             let mut pathspec = repo.pathspec(
                 true,
                 patterns.iter(),
-                repo.work_dir().is_some(),
+                repo.workdir().is_some(),
                 &index,
                 gix::worktree::stack::state::attributes::Source::WorktreeThenIdMapping.adjust_for_bare(repo.is_bare()),
             )?;
@@ -82,12 +82,12 @@ pub fn query(
                 let pathspec = repo.pathspec(
                     true,
                     patterns.iter(),
-                    repo.work_dir().is_some(),
+                    repo.workdir().is_some(),
                     &index,
                     gix::worktree::stack::state::attributes::Source::WorktreeThenIdMapping
                         .adjust_for_bare(repo.is_bare()),
                 )?;
-                let workdir = repo.work_dir();
+                let workdir = repo.workdir();
                 for pattern in pathspec.search().patterns() {
                     let path = pattern.path();
                     let entry = cache.at_entry(

gitoxide-core/src/repository/merge/file.rs

@@ -40,7 +40,7 @@ pub fn file(
     let base_id = repo.rev_parse_single(base.as_bstr()).ok();
     let ours_id = repo.rev_parse_single(ours.as_bstr()).ok();
     let theirs_id = repo.rev_parse_single(theirs.as_bstr()).ok();
-    let roots = worktree_roots(base_id, ours_id, theirs_id, repo.work_dir())?;
+    let roots = worktree_roots(base_id, ours_id, theirs_id, repo.workdir())?;
 
     let mut cache = repo.merge_resource_cache(roots)?;
     let null = repo.object_hash().null();

gix-fs/src/snapshot.rs

@@ -1,7 +1,6 @@
 // TODO: tests
-use std::ops::Deref;
-
 use gix_features::threading::{get_mut, get_ref, MutableOnDemand, OwnShared};
+use std::ops::Deref;
 
 /// A structure holding enough information to reload a value if its on-disk representation changes as determined by its modified time.
 #[derive(Debug)]
@@ -39,6 +38,16 @@ impl<T: Clone + std::fmt::Debug> Clone for FileSnapshot<T> {
     }
 }
 
+impl<T: Clone + std::fmt::Debug> FileSnapshot<T> {
+    /// Return the contained instance if nobody else is holding it, or clone it otherwise.
+    pub fn into_owned_or_cloned(self: OwnShared<Self>) -> T {
+        match OwnShared::try_unwrap(self) {
+            Ok(this) => this.value,
+            Err(this) => this.value.clone(),
+        }
+    }
+}
+
 /// A snapshot of a resource which is up-to-date in the moment it is retrieved.
 pub type SharedFileSnapshot<T> = OwnShared<FileSnapshot<T>>;
 

gix-fs/tests/capabilities/mod.rs renamed to gix-fs/tests/fs/capabilities.rs

@@ -3,4 +3,5 @@ type Result<T = ()> = std::result::Result<T, Box<dyn std::error::Error + Send +
 mod capabilities;
 mod dir;
 mod read_dir;
+mod snapshot;
 mod stack;

gix-fs/tests/dir/create.rs renamed to gix-fs/tests/fs/dir/create.rs

@@ -0,0 +1,54 @@
+use gix_fs::SharedFileSnapshotMut;
+use std::path::Path;
+
+#[test]
+fn journey() -> Result<(), Box<dyn std::error::Error>> {
+    let tmp = tempfile::tempdir().unwrap();
+    if !has_nanosecond_times(tmp.path())? {
+        return Ok(());
+    }
+
+    let file_path = tmp.path().join("content");
+    let smut = SharedFileSnapshotMut::<String>::new();
+
+    let check = || file_path.metadata().ok()?.modified().ok();
+    let open = || {
+        Ok(match std::fs::read_to_string(&file_path) {
+            Ok(s) => Some(s),
+            Err(err) if err.kind() == std::io::ErrorKind::NotFound => None,
+            Err(err) => return Err(err),
+        })
+    };
+    let snap = smut.recent_snapshot(check, open)?;
+    assert!(snap.is_none());
+
+    std::fs::write(&file_path, "content")?;
+    let snap = smut.recent_snapshot(check, open)?.expect("content read");
+    assert_eq!(&**snap, "content", "it read the file for the first time");
+
+    std::fs::write(&file_path, "change")?;
+    let snap = smut.recent_snapshot(check, open)?.expect("content read");
+    assert_eq!(&**snap, "change", "it picks up the change");
+
+    std::fs::remove_file(&file_path)?;
+    let snap = smut.recent_snapshot(check, open)?;
+    assert!(snap.is_none(), "file deleted, nothing to see here");
+
+    std::fs::write(&file_path, "new")?;
+    let snap = smut.recent_snapshot(check, open)?.expect("content read again");
+    let owned: String = snap.into_owned_or_cloned();
+    assert_eq!(owned, "new", "owned versions are possible easily and efficiently");
+    Ok(())
+}
+
+fn has_nanosecond_times(root: &Path) -> std::io::Result<bool> {
+    let test_file = root.join("nanosecond-test");
+
+    std::fs::write(&test_file, "a")?;
+    let first_time = test_file.metadata()?.modified()?;
+
+    std::fs::write(&test_file, "b")?;
+    let second_time = test_file.metadata()?.modified()?;
+
+    Ok(first_time != second_time)
+}

gix-fs/tests/dir/mod.rs renamed to gix-fs/tests/fs/dir/mod.rs

@@ -47,7 +47,8 @@ pub use index_as_worktree_with_renames::function::index_as_worktree_with_renames
 /// It can efficiently validate paths when these are queried in sort-order, which leads to each component
 /// to only be checked once.
 pub struct SymlinkCheck {
-    inner: gix_fs::Stack,
+    /// Supports querying additional information, like the stack root.
+    pub inner: gix_fs::Stack,
 }
 
 mod stack;

gix-fs/tests/dir/remove.rs renamed to gix-fs/tests/fs/dir/remove.rs

@@ -27,11 +27,11 @@ fn main() -> anyhow::Result<()> {
 
     println!(
         "Checking out into {:?} ...",
-        prepare_checkout.repo().work_dir().expect("should be there")
+        prepare_checkout.repo().workdir().expect("should be there")
     );
 
     let (repo, _) = prepare_checkout.main_worktree(gix::progress::Discard, &gix::interrupt::IS_INTERRUPTED)?;
-    println!("Repo cloned into {:?}", repo.work_dir().expect("directory pre-created"));
+    println!("Repo cloned into {:?}", repo.workdir().expect("directory pre-created"));
 
     let remote = repo
         .find_default_remote(gix::remote::Direction::Fetch)

gix-fs/tests/fs.rs renamed to gix-fs/tests/fs/main.rs

@@ -4,7 +4,7 @@ use gix::{prelude::ObjectIdExt, Reference};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut repo = gix::discover(".")?;
-    println!("Repo: {}", repo.work_dir().unwrap_or_else(|| repo.git_dir()).display());
+    println!("Repo: {}", repo.workdir().unwrap_or_else(|| repo.git_dir()).display());
     let mut max_parents = 0;
     let mut avg_parents = 0;
     repo.object_cache_size(32 * 1024);

gix-fs/tests/read_dir/mod.rs renamed to gix-fs/tests/fs/read_dir.rs

@@ -68,7 +68,7 @@ impl PrepareFetch {
 impl Drop for PrepareFetch {
     fn drop(&mut self) {
         if let Some(repo) = self.repo.take() {
-            std::fs::remove_dir_all(repo.work_dir().unwrap_or_else(|| repo.path())).ok();
+            std::fs::remove_dir_all(repo.workdir().unwrap_or_else(|| repo.path())).ok();
         }
     }
 }

gix-fs/tests/fs/snapshot.rs

@@ -92,7 +92,7 @@ pub mod main_worktree {
                 .repo
                 .as_ref()
                 .expect("BUG: this method may only be called until it is successful");
-            let workdir = repo.work_dir().ok_or_else(|| Error::BareRepository {
+            let workdir = repo.workdir().ok_or_else(|| Error::BareRepository {
                 git_dir: repo.git_dir().to_owned(),
             })?;
 
@@ -118,9 +118,7 @@ pub mod main_worktree {
                 })?;
             let mut index = gix_index::File::from_state(index, repo.index_path());
 
-            let mut opts = repo
-                .config
-                .checkout_options(repo, gix_worktree::stack::state::attributes::Source::IdMapping)?;
+            let mut opts = repo.checkout_options(gix_worktree::stack::state::attributes::Source::IdMapping)?;
             opts.destination_is_initially_empty = true;
 
             let mut files = progress.add_child_with_id("checkout".to_string(), ProgressId::CheckoutFiles.into());
@@ -173,7 +171,7 @@ impl PrepareCheckout {
 impl Drop for PrepareCheckout {
     fn drop(&mut self) {
         if let Some(repo) = self.repo.take() {
-            std::fs::remove_dir_all(repo.work_dir().unwrap_or_else(|| repo.path())).ok();
+            std::fs::remove_dir_all(repo.workdir().unwrap_or_else(|| repo.path())).ok();
         }
     }
 }

gix-fs/tests/stack/mod.rs renamed to gix-fs/tests/fs/stack.rs

@@ -303,7 +303,7 @@ impl crate::Repository {
     }
 
     fn apply_changed_values(&mut self) {
-        self.refs.write_reflog = util::reflog_or_default(self.config.reflog, self.work_dir().is_some());
+        self.refs.write_reflog = util::reflog_or_default(self.config.reflog, self.workdir().is_some());
         self.refs.namespace.clone_from(&self.config.refs_namespace);
     }
 }

gix-status/src/lib.rs

@@ -34,7 +34,7 @@ pub struct Outcome {
     /// The pathspecs used to guide the operation,
     pub pathspec: PathspecDetached,
     /// The root actually being used for the traversal, and useful to transform the paths returned for the user.
-    /// It's always within the [`work-dir`](Repository::work_dir).
+    /// It's always within the [`work-dir`](Repository::workdir).
     pub traversal_root: PathBuf,
     /// The actual result of the dirwalk.
     pub dirwalk: gix_dir::walk::Outcome,

gix/examples/clone.rs

@@ -64,7 +64,7 @@ pub struct Outcome<'repo> {
     /// The pathspecs used to guide the operation,
     pub pathspec: Pathspec<'repo>,
     /// The root actually being used for the traversal, and useful to transform the paths returned for the user.
-    /// It's always within the [`work-dir`](crate::Repository::work_dir).
+    /// It's always within the [`work-dir`](crate::Repository::workdir).
     pub traversal_root: PathBuf,
     /// The actual result of the dirwalk.
     pub dirwalk: gix_dir::walk::Outcome,

gix/examples/stats.rs

@@ -228,7 +228,7 @@ impl Pipeline<'_> {
 
         let rela_path_as_path = gix_path::from_bstr(rela_path);
         let repo = self.repo;
-        let worktree_dir = repo.work_dir().ok_or(Error::MissingWorktree)?;
+        let worktree_dir = repo.workdir().ok_or(Error::MissingWorktree)?;
         let path = worktree_dir.join(&rela_path_as_path);
         let md = match std::fs::symlink_metadata(&path) {
             Ok(md) => md,

gix/src/clone/access.rs

@@ -60,7 +60,7 @@ impl<'repo> Pathspec<'repo> {
             patterns,
             prefix,
             &gix_path::realpath_opts(
-                repo.work_dir().unwrap_or_else(|| repo.git_dir()),
+                repo.workdir().unwrap_or_else(|| repo.git_dir()),
                 repo.options.current_dir_or_empty(),
                 gix_path::realpath::MAX_SYMLINKS,
             )?,

gix/src/clone/checkout.rs

@@ -444,7 +444,7 @@ fn insert_head(
     head: Option<crate::Head<'_>>,
     out: &mut BTreeMap<gix_ref::FullName, Vec<PathBuf>>,
 ) -> Result<(), update::Error> {
-    if let Some((head, wd)) = head.and_then(|head| head.repo.work_dir().map(|wd| (head, wd))) {
+    if let Some((head, wd)) = head.and_then(|head| head.repo.workdir().map(|wd| (head, wd))) {
         out.entry("HEAD".try_into().expect("valid"))
             .or_default()
             .push(wd.to_owned());

gix/src/config/cache/init.rs

@@ -126,7 +126,7 @@ mod update {
             (
                 "+refs/remotes/origin/g:refs/heads/main",
                 fetch::refs::update::Mode::RejectedCurrentlyCheckedOut {
-                    worktree_dirs: vec![repo.work_dir().expect("present").to_owned()],
+                    worktree_dirs: vec![repo.workdir().expect("present").to_owned()],
                 },
                 None,
                 "checked out branches cannot be written, as it requires a merge of sorts which isn't done here",
@@ -498,7 +498,7 @@ mod update {
                 "refs/heads/main",
                 fetch::refs::Update {
                     mode: fetch::refs::update::Mode::RejectedCurrentlyCheckedOut {
-                        worktree_dirs: vec![repo.work_dir().expect("present").to_owned()],
+                        worktree_dirs: vec![repo.workdir().expect("present").to_owned()],
                     },
                     type_change: None,
                     edit_index: None,

gix/src/dirwalk/iter.rs

@@ -50,7 +50,7 @@ impl Repository {
         Ok(AttributeStack::new(
             gix_worktree::Stack::new(
                 // this is alright as we don't cause mutation of that directory, it's virtual.
-                self.work_dir().unwrap_or(self.git_dir()),
+                self.workdir().unwrap_or(self.git_dir()),
                 state,
                 case,
                 buf,
@@ -82,7 +82,7 @@ impl Repository {
         Ok(AttributeStack::new(
             gix_worktree::Stack::new(
                 // this is alright as we don't cause mutation of that directory, it's virtual.
-                self.work_dir().unwrap_or(self.git_dir()),
+                self.workdir().unwrap_or(self.git_dir()),
                 state,
                 case,
                 buf,
@@ -127,7 +127,7 @@ impl Repository {
         Ok(AttributeStack::new(
             gix_worktree::Stack::new(
                 // this is alright as we don't cause mutation of that directory, it's virtual.
-                self.work_dir().unwrap_or(self.git_dir()),
+                self.workdir().unwrap_or(self.git_dir()),
                 state,
                 case,
                 buf,

gix/src/dirwalk/mod.rs

@@ -0,0 +1,14 @@
+use crate::{config, Repository};
+
+impl Repository {
+    /// Return options that can be used to drive a low-level checkout operation.
+    /// Use `attributes_source` to determine where `.gitattributes` files should be read from, which depends on
+    /// the presence of a worktree to begin with.
+    /// Here, typically this value would be [`gix_worktree::stack::state::attributes::Source::IdMapping`]
+    pub fn checkout_options(
+        &self,
+        attributes_source: gix_worktree::stack::state::attributes::Source,
+    ) -> Result<gix_worktree_state::checkout::Options, config::checkout_options::Error> {
+        self.config.checkout_options(self, attributes_source)
+    }
+}

gix/src/filter.rs

@@ -107,7 +107,7 @@ impl crate::Repository {
                     .into()
             },
             git_dir: self.git_dir().to_owned().into(),
-            worktree_dir: self.work_dir().map(ToOwned::to_owned),
+            worktree_dir: self.workdir().map(ToOwned::to_owned),
             no_replace_objects: config::shared::is_replace_refs_enabled(
                 &self.config.resolved,
                 self.config.lenient_config,

gix/src/pathspec.rs

@@ -36,7 +36,7 @@ impl Repository {
         delegate: &mut dyn gix_dir::walk::Delegate,
     ) -> Result<dirwalk::Outcome<'_>, dirwalk::Error> {
         let _span = gix_trace::coarse!("gix::dirwalk");
-        let workdir = self.work_dir().ok_or(dirwalk::Error::MissingWorkDir)?;
+        let workdir = self.workdir().ok_or(dirwalk::Error::MissingWorkDir)?;
         let mut excludes = self.excludes(
             index,
             None,
@@ -56,7 +56,7 @@ impl Repository {
         let accelerate_lookup = fs_caps.ignore_case.then(|| index.prepare_icase_backing());
         let mut opts = gix_dir::walk::Options::from(options);
         let worktree_relative_worktree_dirs_storage;
-        if let Some(workdir) = self.work_dir().filter(|_| opts.for_deletion.is_some()) {
+        if let Some(workdir) = self.workdir().filter(|_| opts.for_deletion.is_some()) {
             let linked_worktrees = self.worktrees()?;
             if !linked_worktrees.is_empty() {
                 let real_workdir = gix_path::realpath_opts(

gix/src/remote/connection/fetch/update_refs/mod.rs

@@ -31,7 +31,7 @@ impl std::fmt::Debug for crate::Repository {
         f.debug_struct("Repository")
             .field("kind", &self.kind())
             .field("git_dir", &self.git_dir())
-            .field("work_dir", &self.work_dir())
+            .field("workdir", &self.workdir())
             .finish()
     }
 }