[commitgraph] refactor

Author: Byron

git-commitgraph/src/file/access.rs

@@ -8,7 +8,7 @@ use std::{
 
 /// Access
 impl File {
-    /// Returns the commit data for the commit located at the given lex position.
+    /// Returns the commit data for the commit located at the given lexigraphical position.
     ///
     /// `pos` must range from 0 to self.num_commits().
     ///
@@ -23,13 +23,13 @@ impl File {
         HashKind::Sha1
     }
 
-    // copied from git-odb/src/pack/index/access.rs
     /// Returns 20 bytes sha1 at the given index in our list of (sorted) sha1 hashes.
     /// The position ranges from 0 to self.num_commits()
+    // copied from git-odb/src/pack/index/access.rs
     pub fn id_at(&self, pos: file::Position) -> borrowed::Id<'_> {
         assert!(
             pos.0 < self.num_commits(),
-            "expected lex position less than {}, got {}",
+            "expected lexigraphical position less than {}, got {}",
             self.num_commits(),
             pos.0
         );
@@ -85,7 +85,7 @@ impl File {
 
     /// Returns the number of commits in this graph file.
     ///
-    /// The maximum valid `Lexfile::Position` that can be used with this file is one less than
+    /// The maximum valid `file::Position` that can be used with this file is one less than
     /// `num_commits()`.
     pub fn num_commits(&self) -> u32 {
         self.fan[255]
@@ -101,7 +101,7 @@ impl File {
     pub(crate) fn commit_data_bytes(&self, pos: file::Position) -> &[u8] {
         assert!(
             pos.0 < self.num_commits(),
-            "expected lex position less than {}, got {}",
+            "expected lexigraphical position less than {}, got {}",
             self.num_commits(),
             pos.0
         );

git-commitgraph/src/file/commit.rs

@@ -45,7 +45,7 @@ const EXTENDED_EDGES_MASK: u32 = 0x8000_0000;
 
 pub struct Commit<'a> {
     file: &'a File,
-    lex_pos: file::Position,
+    pos: file::Position,
     // We can parse the below fields lazily if needed.
     commit_timestamp: u64,
     generation: u32,
@@ -59,7 +59,7 @@ impl<'a> Commit<'a> {
         let bytes = file.commit_data_bytes(pos);
         Commit {
             file,
-            lex_pos: pos,
+            pos,
             root_tree_id: borrowed::Id::try_from(&bytes[..SHA1_SIZE]).expect("20 bytes SHA1 to be alright"),
             parent1: ParentEdge::from_raw(BigEndian::read_u32(&bytes[SHA1_SIZE..SHA1_SIZE + 4])),
             parent2: ParentEdge::from_raw(BigEndian::read_u32(&bytes[SHA1_SIZE + 4..SHA1_SIZE + 8])),
@@ -94,7 +94,7 @@ impl<'a> Commit<'a> {
     }
 
     pub fn id(&self) -> borrowed::Id<'_> {
-        self.file.id_at(self.lex_pos)
+        self.file.id_at(self.pos)
     }
 
     pub fn parent1(&self) -> Result<Option<graph::Position>, Error> {
@@ -112,7 +112,7 @@ impl<'a> Debug for Commit<'a> {
             f,
             "Commit {{ id: {}, lex_pos: {}, generation: {}, root_tree_id: {}, parent1: {:?}, parent2: {:?} }}",
             self.id(),
-            self.lex_pos,
+            self.pos,
             self.generation(),
             self.root_tree_id(),
             self.parent1,
@@ -125,7 +125,7 @@ impl<'a> Eq for Commit<'a> {}
 
 impl<'a> PartialEq for Commit<'a> {
     fn eq(&self, other: &Self) -> bool {
-        self.file as *const File == other.file as *const File && self.lex_pos == other.lex_pos
+        self.file as *const File == other.file as *const File && self.pos == other.pos
     }
 }
 

git-commitgraph/src/graph/access.rs

@@ -8,17 +8,17 @@ use git_object::borrowed;
 impl Graph {
     pub fn commit_at(&self, pos: graph::Position) -> Commit<'_> {
         let r = self.lookup_by_pos(pos);
-        r.file.commit_at(r.lex_pos)
+        r.file.commit_at(r.pos)
     }
 
     pub fn commit_by_id(&self, id: borrowed::Id<'_>) -> Option<Commit<'_>> {
         let r = self.lookup_by_id(id)?;
-        Some(r.file.commit_at(r.lex_pos))
+        Some(r.file.commit_at(r.file_pos))
     }
 
     pub fn id_at(&self, pos: graph::Position) -> borrowed::Id<'_> {
         let r = self.lookup_by_pos(pos);
-        r.file.id_at(r.lex_pos)
+        r.file.id_at(r.pos)
     }
 
     /// Iterate over commits in unsorted order.
@@ -48,7 +48,7 @@ impl Graph {
             if let Some(lex_pos) = file.lookup(id) {
                 return Some(LookupByIdResult {
                     file,
-                    lex_pos,
+                    file_pos: lex_pos,
                     graph_pos: graph::Position(current_file_start + lex_pos.0),
                 });
             }
@@ -65,7 +65,7 @@ impl Graph {
                 None => {
                     return LookupByPositionResult {
                         file,
-                        lex_pos: file::Position(remaining),
+                        pos: file::Position(remaining),
                     }
                 }
             }
@@ -78,11 +78,11 @@ impl Graph {
 struct LookupByIdResult<'a> {
     pub file: &'a File,
     pub graph_pos: graph::Position,
-    pub lex_pos: file::Position,
+    pub file_pos: file::Position,
 }
 
 #[derive(Clone)]
 struct LookupByPositionResult<'a> {
     pub file: &'a File,
-    pub lex_pos: file::Position,
+    pub pos: file::Position,
 }

tasks.md

@@ -28,7 +28,7 @@
   * **Questions**
     * ~~How can `Commit` return Graph positions? It doesn't seem to learn about an offset.~~
       * Parent IDs are indeed specified as graph positions, not file positions, as they may be in previous commit graph files.
-  * **Still to be done**
+  * **Future Work**
     * A plumbing command to extract some value from the current implementation, maybe statistics, or verification
     * Application of the command above in a stress test
 * **git-config**