refactor

Author: Byron

git-diff/src/lib.rs

@@ -2,60 +2,65 @@
 #![forbid(unsafe_code, rust_2018_idioms)]
 
 ///
-pub mod tree {
-    use git_hash::{oid, ObjectId};
+pub mod visit {
     use git_object::immutable;
-    use quick_error::quick_error;
-
-    const EMPTY_TREE: immutable::Tree<'static> = immutable::Tree::empty();
-
-    quick_error! {
-        #[derive(Debug)]
-        pub enum Error {
-            NotFound(oid: ObjectId) {
-                display("The object {} referenced by the tree was not found in the database", oid)
-            }
-            Cancelled {
-                display("The delegate cancelled the operation")
-            }
-        }
-    }
 
     #[derive(Default, Clone)]
     pub struct State {
         buf1: Vec<u8>,
         buf2: Vec<u8>,
     }
 
-    pub struct VisitChanges<'a>(Option<&'a immutable::Tree<'a>>);
+    pub struct Changes<'a>(Option<&'a immutable::Tree<'a>>);
 
-    impl<'a, T> From<T> for VisitChanges<'a>
+    impl<'a, T> From<T> for Changes<'a>
     where
         T: Into<Option<&'a immutable::Tree<'a>>>,
     {
         fn from(v: T) -> Self {
-            VisitChanges(v.into())
+            Changes(v.into())
         }
     }
 
-    impl<'a> VisitChanges<'a> {
-        /// Returns the changes that need to be applied to `self` to get `other`.
-        pub fn to_obtain<LocateFn>(
-            &self,
-            _other: &git_object::immutable::Tree<'_>,
-            _state: &mut State,
-            _locate: LocateFn,
-            _delegate: &mut impl Delegate,
-        ) -> Result<(), Error>
-        where
-            LocateFn: for<'b> FnMut(&oid, &'b mut Vec<u8>) -> Option<immutable::Object<'b>>,
-        {
-            let _this = *self.0.as_ref().unwrap_or(&&EMPTY_TREE);
-            todo!("changes tree to tree")
+    mod changes {
+        use crate::visit;
+        use git_hash::{oid, ObjectId};
+        use git_object::immutable;
+        use quick_error::quick_error;
+
+        const EMPTY_TREE: immutable::Tree<'static> = immutable::Tree::empty();
+
+        quick_error! {
+            #[derive(Debug)]
+            pub enum Error {
+                NotFound(oid: ObjectId) {
+                    display("The object {} referenced by the tree was not found in the database", oid)
+                }
+                Cancelled {
+                    display("The delegate cancelled the operation")
+                }
+            }
+        }
+
+        impl<'a> visit::Changes<'a> {
+            /// Returns the changes that need to be applied to `self` to get `other`.
+            pub fn to_obtain_tree<LocateFn>(
+                &self,
+                _other: &git_object::immutable::Tree<'_>,
+                _state: &mut visit::State,
+                _locate: LocateFn,
+                _delegate: &mut impl visit::Record,
+            ) -> Result<(), Error>
+            where
+                LocateFn: for<'b> FnMut(&oid, &'b mut Vec<u8>) -> Option<immutable::Object<'b>>,
+            {
+                let _this = *self.0.as_ref().unwrap_or(&&EMPTY_TREE);
+                todo!("changes tree to tree")
+            }
         }
     }
 
-    pub mod delegate {
+    pub mod record {
         use git_hash::ObjectId;
         use git_object::{bstr::BStr, tree};
 
@@ -88,29 +93,12 @@ pub mod tree {
             Cancel,
         }
 
-        pub trait Delegate {
+        pub trait Record {
             fn update_path_component(&mut self, component: PathComponent<'_>, mode: PathComponentMode);
             fn pop_path_component(&mut self);
             fn record(change: Change) -> Action;
         }
 
-        #[derive(Clone, Default)]
-        pub struct Recorder;
-
-        impl Delegate for Recorder {
-            fn update_path_component(&mut self, _component: PathComponent<'_>, _mode: PathComponentMode) {
-                todo!()
-            }
-
-            fn pop_path_component(&mut self) {
-                todo!()
-            }
-
-            fn record(_change: Change) -> Action {
-                todo!()
-            }
-        }
-
         #[cfg(test)]
         mod tests {
             use super::*;
@@ -125,5 +113,31 @@ pub mod tree {
             }
         }
     }
-    pub use delegate::Delegate;
+    pub use record::Record;
+
+    pub mod recorder {
+        use crate::visit::record;
+
+        #[derive(Clone, Default)]
+        pub struct Recorder;
+
+        impl record::Record for Recorder {
+            fn update_path_component(
+                &mut self,
+                _component: record::PathComponent<'_>,
+                _mode: record::PathComponentMode,
+            ) {
+                todo!()
+            }
+
+            fn pop_path_component(&mut self) {
+                todo!()
+            }
+
+            fn record(_change: record::Change) -> record::Action {
+                todo!()
+            }
+        }
+    }
+    pub use recorder::Recorder;
 }

git-diff/tests/tree/mod.rs

@@ -41,11 +41,11 @@ mod with_tree {
                 .and_then(|tree| tree.into_tree())
         };
 
-        git_diff::tree::VisitChanges::from(previous_tree.as_ref()).to_obtain(
+        git_diff::visit::Changes::from(previous_tree.as_ref()).to_obtain_tree(
             &main_tree,
-            &mut git_diff::tree::State::default(),
+            &mut git_diff::visit::State::default(),
             |_oid, _buf| todo!("Actual lookup in db"),
-            &mut git_diff::tree::delegate::Recorder::default(),
+            &mut git_diff::visit::Recorder::default(),
         )?;
         Ok(())
     }