feat: add Repository::index_or_empty().

Byron · Byron · commit 7d9ecdd1c230 · 2023-10-05T13:33:02.000+02:00
This is useful if a missing index should mean it's empty.
diff --git a/gix/src/repository/index.rs b/gix/src/repository/index.rs
@@ -55,6 +55,16 @@ impl crate::Repository {
         })
     }
 
+    /// Return the shared worktree index if present, or return a new empty one which has an association to the place where the index would be.
+    pub fn index_or_empty(&self) -> Result<worktree::Index, worktree::open_index::Error> {
+        Ok(self.try_index()?.unwrap_or_else(|| {
+            worktree::Index::new(gix_fs::FileSnapshot::new(gix_index::File::from_state(
+                gix_index::State::new(self.object_hash()),
+                self.index_path(),
+            )))
+        }))
+    }
+
     /// Return a shared worktree index which is updated automatically if the in-memory snapshot has become stale as the underlying file
     /// on disk has changed, or `None` if no such file exists.
     ///
diff --git a/gix/tests/repository/worktree.rs b/gix/tests/repository/worktree.rs
@@ -111,6 +111,7 @@ mod with_core_worktree_config {
     }
 
     #[test]
+    #[cfg(feature = "index")]
     fn bare_relative() -> crate::Result {
         let repo = repo("bare-relative-worktree");
 
@@ -123,6 +124,8 @@ mod with_core_worktree_config {
             repo.work_dir().is_none(),
             "we simply don't load core.worktree in bare repos either to match this behaviour"
         );
+        assert!(repo.try_index()?.is_none());
+        assert!(repo.index_or_empty()?.entries().is_empty());
         Ok(())
     }
 

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ mod with_core_worktree_config {`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`#[test]`
	`114`	`+ #[cfg(feature = "index")]`
`114`	`115`	`fn bare_relative() -> crate::Result {`
`115`	`116`	`let repo = repo("bare-relative-worktree");`
`116`	`117`
`@@ -123,6 +124,8 @@ mod with_core_worktree_config {`
`123`	`124`	`repo.work_dir().is_none(),`
`124`	`125`	`"we simply don't load core.worktree in bare repos either to match this behaviour"`
`125`	`126`	`);`
	`127`	`+ assert!(repo.try_index()?.is_none());`
	`128`	`+ assert!(repo.index_or_empty()?.entries().is_empty());`
`126`	`129`	`Ok(())`
`127`	`130`	`}`
`128`	`131`