feat: add attributes feature to allow ignore-only stacks.

Author: Byron

gix-worktree/Cargo.toml

@@ -14,8 +14,11 @@ autotests = false
 doctest = false
 
 [features]
+default = ["attributes"]
+## Instantiate stacks that can access `.gitattributes` information.
+attributes = ["dep:gix-attributes"]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
-serde = [ "dep:serde", "bstr/serde", "gix-index/serde", "gix-hash/serde", "gix-object/serde", "gix-attributes/serde", "gix-ignore/serde" ]
+serde = [ "dep:serde", "bstr/serde", "gix-index/serde", "gix-hash/serde", "gix-object/serde", "gix-attributes?/serde", "gix-ignore/serde" ]
 
 [dependencies]
 gix-index = { version = "^0.23.1", path = "../gix-index" }
@@ -24,7 +27,7 @@ gix-hash = { version = "^0.12.0", path = "../gix-hash" }
 gix-object = { version = "^0.35.0", path = "../gix-object" }
 gix-glob = { version = "^0.11.0", path = "../gix-glob" }
 gix-path = { version = "^0.9.0", path = "../gix-path" }
-gix-attributes = { version = "^0.17.0", path = "../gix-attributes" }
+gix-attributes = { version = "^0.17.0", path = "../gix-attributes", optional = true }
 gix-ignore = { version = "^0.6.0", path = "../gix-ignore" }
 gix-features = { version = "^0.33.0", path = "../gix-features" }
 

gix-worktree/src/stack/delegate.rs

@@ -27,6 +27,7 @@ pub(crate) type FindFn<'a> = dyn for<'b> FnMut(
 pub(crate) struct StackDelegate<'a, 'find> {
     pub state: &'a mut State,
     pub buf: &'a mut Vec<u8>,
+    #[cfg_attr(not(feature = "attributes"), allow(dead_code))]
     pub is_dir: bool,
     pub id_mappings: &'a Vec<PathIdMapping>,
     pub find: &'find mut FindFn<'find>,
@@ -54,6 +55,7 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
             rela_dir_cow.as_ref()
         };
         match &mut self.state {
+            #[cfg(feature = "attributes")]
             State::CreateDirectoryAndAttributesStack { attributes, .. } => {
                 attributes.push_directory(
                     stack.root(),
@@ -65,6 +67,7 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
                     &mut self.statistics.attributes,
                 )?;
             }
+            #[cfg(feature = "attributes")]
             State::AttributesAndIgnoreStack { ignore, attributes } => {
                 attributes.push_directory(
                     stack.root(),
@@ -86,6 +89,7 @@ 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(),
@@ -109,9 +113,11 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
         Ok(())
     }
 
+    #[cfg_attr(not(feature = "attributes"), allow(unused_variables))]
     fn push(&mut self, is_last_component: bool, stack: &gix_fs::Stack) -> std::io::Result<()> {
         self.statistics.delegate.push_element += 1;
         match &mut self.state {
+            #[cfg(feature = "attributes")]
             State::CreateDirectoryAndAttributesStack {
                 unlink_on_collision,
                 attributes: _,
@@ -122,31 +128,37 @@ impl<'a, 'find> gix_fs::stack::Delegate for StackDelegate<'a, 'find> {
                 &mut self.statistics.delegate.num_mkdir_calls,
                 *unlink_on_collision,
             )?,
-            State::AttributesAndIgnoreStack { .. } | State::IgnoreStack(_) | State::AttributesStack(_) => {}
+            #[cfg(feature = "attributes")]
+            State::AttributesAndIgnoreStack { .. } | State::AttributesStack(_) => {}
+            State::IgnoreStack(_) => {}
         }
         Ok(())
     }
 
     fn pop_directory(&mut self) {
         self.statistics.delegate.pop_directory += 1;
         match &mut self.state {
+            #[cfg(feature = "attributes")]
             State::CreateDirectoryAndAttributesStack { attributes, .. } => {
                 attributes.pop_directory();
             }
+            #[cfg(feature = "attributes")]
             State::AttributesAndIgnoreStack { attributes, ignore } => {
                 attributes.pop_directory();
                 ignore.pop_directory();
             }
-            State::IgnoreStack(ignore) => {
-                ignore.pop_directory();
-            }
+            #[cfg(feature = "attributes")]
             State::AttributesStack(attributes) => {
                 attributes.pop_directory();
             }
+            State::IgnoreStack(ignore) => {
+                ignore.pop_directory();
+            }
         }
     }
 }
 
+#[cfg(feature = "attributes")]
 fn create_leading_directory(
     is_last_component: bool,
     stack: &gix_fs::Stack,

gix-worktree/src/stack/mod.rs

@@ -16,6 +16,7 @@ pub struct Statistics {
     /// Information about the stack delegate.
     pub delegate: delegate::Statistics,
     /// Information about attributes
+    #[cfg(feature = "attributes")]
     pub attributes: state::attributes::Statistics,
     /// Information about the ignore stack
     pub ignore: state::ignore::Statistics,
@@ -24,20 +25,23 @@ pub struct Statistics {
 #[derive(Clone)]
 pub enum State {
     /// Useful for checkout where directories need creation, but we need to access attributes as well.
+    #[cfg(feature = "attributes")]
     CreateDirectoryAndAttributesStack {
         /// If there is a symlink or a file in our path, try to unlink it before creating the directory.
         unlink_on_collision: bool,
         /// State to handle attribute information
         attributes: state::Attributes,
     },
     /// Used when adding files, requiring access to both attributes and ignore information, for example during add operations.
+    #[cfg(feature = "attributes")]
     AttributesAndIgnoreStack {
         /// State to handle attribute information
         attributes: state::Attributes,
         /// State to handle exclusion information
         ignore: state::Ignore,
     },
     /// Used when only attributes are required, typically with fully virtual worktrees.
+    #[cfg(feature = "attributes")]
     AttributesStack(state::Attributes),
     /// Used when providing worktree status information.
     IgnoreStack(state::Ignore),

gix-worktree/src/stack/platform.rs

@@ -40,6 +40,7 @@ impl<'a> Platform<'a> {
     /// # Panics
     ///
     /// If the cache was configured without attributes.
+    #[cfg(feature = "attributes")]
     pub fn matching_attributes(&self, out: &mut gix_attributes::search::Outcome) -> bool {
         let attrs = self.parent.state.attributes_or_panic();
         let relative_path =

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

@@ -1,15 +1,15 @@
-use std::path::PathBuf;
-
 use bstr::{BString, ByteSlice};
 use gix_glob::pattern::Case;
 
 use crate::{stack::State, PathIdMapping};
 
+#[cfg(feature = "attributes")]
 type AttributeMatchGroup = gix_attributes::Search;
 type IgnoreMatchGroup = gix_ignore::Search;
 
 /// State related to attributes associated with files in the repository.
 #[derive(Default, Clone)]
+#[cfg(feature = "attributes")]
 pub struct Attributes {
     /// Attribute patterns which aren't tied to the repository root, hence are global, they contribute first.
     globals: AttributeMatchGroup,
@@ -20,7 +20,7 @@ pub struct Attributes {
     stack: AttributeMatchGroup,
     /// The first time we push the root, we have to load additional information from this file if it exists along with the root attributes
     /// file if possible, and keep them there throughout.
-    info_attributes: Option<PathBuf>,
+    info_attributes: Option<std::path::PathBuf>,
     /// A lookup table to accelerate searches.
     collection: gix_attributes::search::MetadataCollection,
     /// Where to read `.gitattributes` data from.
@@ -50,13 +50,15 @@ pub struct Ignore {
 }
 
 ///
+#[cfg(feature = "attributes")]
 pub mod attributes;
 ///
 pub mod ignore;
 
 /// Initialization
 impl State {
     /// Configure a state to be suitable for checking out files, which only needs access to attribute files read from the index.
+    #[cfg(feature = "attributes")]
     pub fn for_checkout(unlink_on_collision: bool, attributes: Attributes) -> Self {
         State::CreateDirectoryAndAttributesStack {
             unlink_on_collision,
@@ -65,6 +67,7 @@ impl State {
     }
 
     /// Configure a state for adding files, with support for ignore files and attribute files.
+    #[cfg(feature = "attributes")]
     pub fn for_add(attributes: Attributes, ignore: Ignore) -> Self {
         State::AttributesAndIgnoreStack { attributes, ignore }
     }
@@ -96,6 +99,7 @@ impl State {
         case: Case,
     ) -> Vec<PathIdMapping> {
         let a1_backing;
+        #[cfg(feature = "attributes")]
         let a2_backing;
         let names = match self {
             State::IgnoreStack(ignore) => {
@@ -105,6 +109,7 @@ impl State {
                 )];
                 a1_backing.as_ref()
             }
+            #[cfg(feature = "attributes")]
             State::AttributesAndIgnoreStack { ignore, .. } => {
                 a2_backing = [
                     (
@@ -115,6 +120,7 @@ impl State {
                 ];
                 a2_backing.as_ref()
             }
+            #[cfg(feature = "attributes")]
             State::CreateDirectoryAndAttributesStack { .. } | State::AttributesStack(_) => {
                 a1_backing = [(".gitattributes".into(), None)];
                 a1_backing.as_ref()
@@ -160,13 +166,16 @@ impl State {
     pub(crate) fn ignore_or_panic(&self) -> &Ignore {
         match self {
             State::IgnoreStack(v) => v,
+            #[cfg(feature = "attributes")]
             State::AttributesAndIgnoreStack { ignore, .. } => ignore,
+            #[cfg(feature = "attributes")]
             State::AttributesStack(_) | State::CreateDirectoryAndAttributesStack { .. } => {
                 unreachable!("BUG: must not try to check excludes without it being setup")
             }
         }
     }
 
+    #[cfg(feature = "attributes")]
     pub(crate) fn attributes_or_panic(&self) -> &Attributes {
         match self {
             State::AttributesStack(attributes)

gix-worktree/tests/Cargo.toml

@@ -17,7 +17,7 @@ path = "integrate.rs"
 gix-features-parallel = ["gix-features/parallel"]
 
 [dev-dependencies]
-gix-worktree = { path = ".." }
+gix-worktree = { path = "..", features = ["attributes"] }
 gix-index = { path = "../../gix-index" }
 gix-fs = { path = "../../gix-fs" }
 gix-hash = { path = "../../gix-hash" }