fix: sorting of tree entries is now according to specificiation.

This means tree entries are compared as if they had a / appended to it.

Sebastian Thiel committed 3 years ago

Commit ca379151 parent d92a5885 files · +70 −20Browse files

Unified · Split

5 files

gix-object/src/tree/mod.rs +17 −12
gix-object/src/tree/write.rs +8 −8
gix-object/tests/fixtures/generated-archives/make_trees.tar.xz +3 −0
gix-object/tests/fixtures/make_trees.sh +19 −0
gix-object/tests/tree/mod.rs +23 −0

     pub filename: &'a BStr,
     /// The id of the object representing the entry.
     // TODO: figure out how these should be called. id or oid? It's inconsistent around the codebase.
-    // Answer: make it 'id', as in `git2`
+    //       Answer: make it 'id', as in `git2`
     #[cfg_attr(feature = "serde", serde(borrow))]
     pub oid: &'a gix_hash::oid,
 }
 }
 impl<'a> Ord for EntryRef<'a> {
-    /// Entries compare by the common portion of the filename. This is critical for proper functioning of algorithms working on trees.
+    fn cmp(&self, b: &Self) -> Ordering {
-    /// Doing it like this is needed for compatibility with older, potentially broken(?) trees.
+        let a = self;
-    fn cmp(&self, other: &Self) -> Ordering {
+        let common = a.filename.len().min(b.filename.len());
-        let len = self.filename.len().min(other.filename.len());
+        a.filename[..common].cmp(&b.filename[..common]).then_with(|| {
-        self.filename[..len].cmp(&other.filename[..len])
+            let a = a.filename.get(common).or_else(|| a.mode.is_tree().then_some(&b'/'));
+            let b = b.filename.get(common).or_else(|| b.mode.is_tree().then_some(&b'/'));
+            a.cmp(&b)
+        })
     }
 }
 }
 impl Ord for Entry {
-    /// Entries compare by the common portion of the filename. This is critical for proper functioning of algorithms working on trees.
+    fn cmp(&self, b: &Self) -> Ordering {
-    fn cmp(&self, other: &Self) -> Ordering {
+        let a = self;
-        let common_len = self.filename.len().min(other.filename.len());
+        let common = a.filename.len().min(b.filename.len());
-        self.filename[..common_len]
+        a.filename[..common].cmp(&b.filename[..common]).then_with(|| {
-            .cmp(&other.filename[..common_len])
+            let a = a.filename.get(common).or_else(|| a.mode.is_tree().then_some(&b'/'));
-            .then_with(|| self.filename.len().cmp(&other.filename.len()))
+            let b = b.filename.get(common).or_else(|| b.mode.is_tree().then_some(&b'/'));
+            a.cmp(&b)
+        })
     }
 }

gix-object/src/tree/write.rs+8−8

         Ok(())
     }
+    fn kind(&self) -> Kind {
+        Kind::Tree
+    }
     fn size(&self) -> usize {
         self.entries
             .iter()
             .map(|Entry { mode, filename, oid }| mode.as_bytes().len() + 1 + filename.len() + 1 + oid.as_bytes().len())
             .sum()
     }
-    fn kind(&self) -> Kind {
-        Kind::Tree
-    }
 }
 /// Serialization
         Ok(())
     }
+    fn kind(&self) -> Kind {
+        Kind::Tree
+    }
     fn size(&self) -> usize {
         self.entries
             .iter()
             })
             .sum()
     }
-    fn kind(&self) -> Kind {
-        Kind::Tree
-    }
 }

gix-object/tests/fixtures/generated-archives/make_trees.tar.xz+3−0

@@ -0,0 +1,3 @@
	1	version https://git-lfs.github.com/spec/v1
	2	oid sha256:9d0ebc472023fffe49d71303e5f41f8c6ca24e28d283468f2426791c6286ecf7
	3	size 10240

gix-object/tests/fixtures/make_trees.sh+19−0

@@ -0,0 +1,19 @@
	1	#!/bin/bash
	2	set -eu -o pipefail
	3
	4	function baseline() {
	5	local revspec=${1:?First argument is the revspec of the object to create a baseline for}
	6	local basename=${2:?Second argument is the name of the baseline file}
	7	local baseline_file="$basename.baseline"
	8	git rev-parse "$revspec" \| git cat-file --batch \| tail -n +2 > "$baseline_file"
	9	truncate -s "$(($(stat -c '%s' "$baseline_file")-1))" "$baseline_file"
	10	}
	11
	12	git init -q
	13	mkdir file
	14	touch bin bin.d file.to file.toml file.toml.bin file0 file/a
	15
	16	git add .
	17	git commit -m "c1"
	18
	19	baseline @^{tree} tree

gix-object/tests/tree/mod.rs+23−0

@@ -130,6 +130,29 @@ mod from_bytes { · 129 unmodified lines
130	}	130	}
131	}	131	}
132		132
		133	mod entries {
		134	use gix_object::{Tree, TreeRef};
		135
		136	#[test]
		137	fn sort_order_is_correct() -> crate::Result {
		138	let root = gix_testtools::scripted_fixture_read_only("make_trees.sh")?;
		139	let input = std::fs::read(root.join("tree.baseline"))?;
		140
		141	let mut tree = TreeRef::from_bytes(&input)?;
		142	let expected = tree.entries.clone();
		143
		144	tree.entries.sort();
		145	assert_eq!(tree.entries, expected);
		146
		147	let mut tree: Tree = tree.into();
		148	let expected = tree.entries.clone();
		149	tree.entries.sort();
		150
		151	assert_eq!(tree.entries, expected);
		152	Ok(())
		153	}
		154	}
		155
133	mod entry_mode {	156	mod entry_mode {
134	use gix_object::tree::EntryMode;	157	use gix_object::tree::EntryMode;
135		158

fix: sorting of tree entries is now according to specificiation.

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code