refactor

Byron · Byron · commit 67f224785193 · 2022-10-12T07:55:57.000+08:00
Move `index::from_tree` into `repository` module as it is
consuming a repository and is not a free-standing command like the
others.
diff --git a/gitoxide-core/src/index/mod.rs b/gitoxide-core/src/index/mod.rs
@@ -1,10 +1,5 @@
-use git::odb::FindExt;
 use git_repository as git;
-use std::ffi::OsString;
-use std::{
-    io::BufWriter,
-    path::{Path, PathBuf},
-};
+use std::path::Path;
 
 pub struct Options {
     pub object_hash: git::hash::Kind,
@@ -90,39 +85,3 @@ pub fn information(
         }
     }
 }
-
-pub fn from_tree(
-    spec: OsString,
-    index_path: Option<PathBuf>,
-    force: bool,
-    repo: git::Repository,
-    mut out: impl std::io::Write,
-) -> anyhow::Result<()> {
-    let spec = git::path::os_str_into_bstr(&spec)?;
-    let tree = repo.rev_parse_single(spec)?;
-    let state = git::index::State::from_tree(&tree, |oid, buf| repo.objects.find_tree_iter(oid, buf).ok())?;
-    let options = git::index::write::Options {
-        hash_kind: repo.object_hash(),
-        ..Default::default()
-    };
-
-    match index_path {
-        Some(index_path) => {
-            if index_path.is_file() {
-                if !force {
-                    anyhow::bail!(
-                        "File at \"{}\" already exists, to overwrite use the '-f' flag",
-                        index_path.display()
-                    );
-                }
-            }
-            let writer = BufWriter::new(std::fs::File::create(&index_path)?);
-            state.write_to(writer, options)?;
-        }
-        None => {
-            state.write_to(&mut out, options)?;
-        }
-    }
-
-    Ok(())
-}
diff --git a/gitoxide-core/src/repository/index.rs b/gitoxide-core/src/repository/index.rs
@@ -0,0 +1,40 @@
+use git::prelude::FindExt;
+use git_repository as git;
+use std::ffi::OsString;
+use std::{io::BufWriter, path::PathBuf};
+
+pub fn from_tree(
+    spec: OsString,
+    index_path: Option<PathBuf>,
+    force: bool,
+    repo: git::Repository,
+    mut out: impl std::io::Write,
+) -> anyhow::Result<()> {
+    let spec = git::path::os_str_into_bstr(&spec)?;
+    let tree = repo.rev_parse_single(spec)?;
+    let state = git::index::State::from_tree(&tree, |oid, buf| repo.objects.find_tree_iter(oid, buf).ok())?;
+    let options = git::index::write::Options {
+        hash_kind: repo.object_hash(),
+        ..Default::default()
+    };
+
+    match index_path {
+        Some(index_path) => {
+            if index_path.is_file() {
+                if !force {
+                    anyhow::bail!(
+                        "File at \"{}\" already exists, to overwrite use the '-f' flag",
+                        index_path.display()
+                    );
+                }
+            }
+            let writer = BufWriter::new(std::fs::File::create(&index_path)?);
+            state.write_to(writer, options)?;
+        }
+        None => {
+            state.write_to(&mut out, options)?;
+        }
+    }
+
+    Ok(())
+}
diff --git a/gitoxide-core/src/repository/mod.rs b/gitoxide-core/src/repository/mod.rs
@@ -19,6 +19,7 @@ pub mod config;
 mod credential;
 pub use credential::function as credential;
 pub mod exclude;
+pub mod index;
 pub mod mailmap;
 pub mod odb;
 pub mod remote;
diff --git a/src/plumbing/main.rs b/src/plumbing/main.rs
@@ -767,7 +767,7 @@ pub fn main() -> Result<()> {
                 progress_keep_open,
                 None,
                 move |_progress, out, _err| {
-                    core::index::from_tree(spec, index_output_path, force, repository(Mode::Strict)?, out)
+                    core::repository::index::from_tree(spec, index_output_path, force, repository(Mode::Strict)?, out)
                 },
             ),
         },
