feat!: add Stack::from_state_and_ignore_case().

It adds `Stack::from_state_and_ignore_case()` as utility to more easily instantiate
a stack the is configured correctly.
This also removes the `stack::State::for_status()` method as it's not actually
suitable for status retrieval per se.

Author: Byron

gix-worktree/src/lib.rs

@@ -10,6 +10,7 @@
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 use bstr::BString;
+pub use gix_glob;
 
 /// A cache for efficiently executing operations on directories and files which are encountered in sorted order.
 /// That way, these operations can be re-used for subsequent invocations in the same directory.

gix-worktree/src/stack/delegate.rs

@@ -56,7 +56,7 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
         };
         match &mut self.state {
             #[cfg(feature = "attributes")]
-            State::CreateDirectoryAndAttributesStack { attributes, .. } => {
+            State::CreateDirectoryAndAttributesStack { attributes, .. } | State::AttributesStack(attributes) => {
                 attributes.push_directory(
                     stack.root(),
                     stack.current(),
@@ -89,16 +89,6 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
                     &mut self.statistics.ignore,
                 )?
             }
-            #[cfg(feature = "attributes")]
-            State::AttributesStack(attributes) => attributes.push_directory(
-                stack.root(),
-                stack.current(),
-                rela_dir,
-                self.buf,
-                self.id_mappings,
-                &mut self.find,
-                &mut self.statistics.attributes,
-            )?,
             State::IgnoreStack(ignore) => ignore.push_directory(
                 stack.root(),
                 stack.current(),
@@ -139,18 +129,14 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
         self.statistics.delegate.pop_directory += 1;
         match &mut self.state {
             #[cfg(feature = "attributes")]
-            State::CreateDirectoryAndAttributesStack { attributes, .. } => {
+            State::CreateDirectoryAndAttributesStack { attributes, .. } | State::AttributesStack(attributes) => {
                 attributes.pop_directory();
             }
             #[cfg(feature = "attributes")]
             State::AttributesAndIgnoreStack { attributes, ignore } => {
                 attributes.pop_directory();
                 ignore.pop_directory();
             }
-            #[cfg(feature = "attributes")]
-            State::AttributesStack(attributes) => {
-                attributes.pop_directory();
-            }
             State::IgnoreStack(ignore) => {
                 ignore.pop_directory();
             }

gix-worktree/src/stack/mod.rs

@@ -77,6 +77,27 @@ impl Stack {
             statistics: Statistics::default(),
         }
     }
+
+    /// Create a new stack that takes into consideration the `ignore_case` result of a filesystem probe in `root`. It takes a configured
+    /// `state` to control what it can do, while initializing attribute or ignore files that are to be queried from the ODB using
+    /// `index` and `path_backing`.
+    ///
+    /// This is the easiest way to correctly setup a stack.
+    pub fn from_state_and_ignore_case(
+        root: impl Into<PathBuf>,
+        ignore_case: bool,
+        state: State,
+        index: &gix_index::State,
+        path_backing: &gix_index::PathStorageRef,
+    ) -> Self {
+        let case = if ignore_case {
+            gix_glob::pattern::Case::Fold
+        } else {
+            gix_glob::pattern::Case::Sensitive
+        };
+        let attribute_files = state.id_mappings_from_index(index, path_backing, case);
+        Stack::new(root, state, case, Vec::with_capacity(512), attribute_files)
+    }
 }
 
 /// Entry points for attribute query

gix-worktree/src/stack/state/mod.rs

@@ -71,11 +71,6 @@ impl State {
     pub fn for_add(attributes: Attributes, ignore: Ignore) -> Self {
         State::AttributesAndIgnoreStack { attributes, ignore }
     }
-
-    /// Configure a state for status retrieval, which needs access to ignore files only.
-    pub fn for_status(ignore: Ignore) -> Self {
-        State::IgnoreStack(ignore)
-    }
 }
 
 /// Utilities

gix-worktree/tests/fixtures/generated-archives/.gitignore

@@ -1,2 +1,3 @@
 make_ignore_and_attributes_setup.tar.xz
 make_attributes_baseline.tar.xz
+symlink_stack.tar.xz

gix-worktree/tests/fixtures/symlink_stack.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+set -eu -o pipefail
+
+git init base;
+(cd base
+  touch file
+  mkdir dir
+  touch dir/file-in-dir
+  (cd dir
+    ln -s file-in-dir filelink
+    mkdir subdir
+    ln -s subdir dirlink
+  )
+
+  ln -s file root-filelink
+  ln -s dir root-dirlink
+
+cat <<EOF > .gitattributes
+/file file-attr
+/dir/file-in-dir dir-file-attr
+EOF
+  git add . && git commit -m "init"
+)
+
+ln -s base symlink-base
+

justfile

@@ -66,7 +66,10 @@ check:
         cargo check --features verbose-object-parsing-errors
     cd gix-attributes && cargo check --features serde
     cd gix-glob && cargo check --features serde
-    cd gix-worktree && cargo check --features serde
+    cd gix-worktree; \
+        set -ex; \
+        cargo check --features serde; \
+        cargo check --no-default-features;
     cd gix-actor && cargo check --features serde
     cd gix-date && cargo check --features serde
     cargo check -p gix-tempfile --features signals