refactor (#382)

Author: Byron

git-repository/src/lib.rs

@@ -192,9 +192,7 @@ pub enum Path {
 
 ///
 mod types;
-pub use types::{
-    Commit, DetachedObject, Head, Id, Object, Reference, Repository, RepositoryState, Tag, ThreadSafeRepository, Tree,
-};
+pub use types::{Commit, DetachedObject, Head, Id, Object, Reference, Repository, Tag, ThreadSafeRepository, Tree};
 
 pub mod commit;
 pub mod head;
@@ -317,6 +315,41 @@ pub mod init {
     }
 }
 
+/// Not to be confused with 'status'.
+pub mod state {
+    /// Tell what operation is currently in progress.
+    #[derive(Debug, PartialEq)]
+    pub enum InProgress {
+        /// A mailbox is being applied.
+        // TODO: test
+        ApplyMailbox,
+        /// A rebase is happening while a mailbox is being applied.
+        // TODO: test
+        ApplyMailboxRebase,
+        /// A git bisect operation has not yet been concluded.
+        // TODO: test
+        Bisect,
+        /// A cherry pick operation.
+        CherryPick,
+        /// A cherry pick with multiple commits pending.
+        // TODO: test
+        CherryPickSequence,
+        /// A merge operation.
+        // TODO: test
+        Merge,
+        /// A rebase operation.
+        // TODO: test
+        Rebase,
+        /// An interactive rebase operation.
+        RebaseInteractive,
+        /// A revert operation.
+        Revert,
+        /// A revert operation with multiple commits pending.
+        // TODO: test
+        RevertSequence,
+    }
+}
+
 ///
 pub mod discover {
     use crate::{path, ThreadSafeRepository};

git-repository/src/repository/state.rs

@@ -1,39 +1,39 @@
-use crate::RepositoryState;
+use crate::state;
 
 impl crate::Repository {
     /// Returns the status of an in progress operation on a repository or [`None`]
-    /// if nothing is happening.
-    pub fn in_progress_operation(&self) -> Option<RepositoryState> {
+    /// if no operation is currently in progress.
+    pub fn in_progress_operation(&self) -> Option<state::InProgress> {
         let git_dir = self.path();
 
         // This is modeled on the logic from wt_status_get_state in git's wt-status.c and
         // ps1 from git-prompt.sh.
 
         if git_dir.join("rebase-apply/applying").is_file() {
-            Some(RepositoryState::ApplyMailbox)
+            Some(state::InProgress::ApplyMailbox)
         } else if git_dir.join("rebase-apply/rebasing").is_file() {
-            Some(RepositoryState::Rebase)
+            Some(state::InProgress::Rebase)
         } else if git_dir.join("rebase-apply").is_dir() {
-            Some(RepositoryState::ApplyMailboxRebase)
+            Some(state::InProgress::ApplyMailboxRebase)
         } else if git_dir.join("rebase-merge/interactive").is_file() {
-            Some(RepositoryState::RebaseInteractive)
+            Some(state::InProgress::RebaseInteractive)
         } else if git_dir.join("rebase-merge").is_dir() {
-            Some(RepositoryState::Rebase)
+            Some(state::InProgress::Rebase)
         } else if git_dir.join("CHERRY_PICK_HEAD").is_file() {
             if git_dir.join("todo").is_file() {
-                Some(RepositoryState::CherryPickSequence)
+                Some(state::InProgress::CherryPickSequence)
             } else {
-                Some(RepositoryState::CherryPick)
+                Some(state::InProgress::CherryPick)
             }
         } else if git_dir.join("MERGE_HEAD").is_file() {
-            Some(RepositoryState::Merge)
+            Some(state::InProgress::Merge)
         } else if git_dir.join("BISECT_LOG").is_file() {
-            Some(RepositoryState::Bisect)
+            Some(state::InProgress::Bisect)
         } else if git_dir.join("REVERT_HEAD").is_file() {
             if git_dir.join("todo").is_file() {
-                Some(RepositoryState::RevertSequence)
+                Some(state::InProgress::RevertSequence)
             } else {
-                Some(RepositoryState::Revert)
+                Some(state::InProgress::Revert)
             }
         } else {
             None

git-repository/src/types.rs

@@ -124,31 +124,6 @@ pub struct Repository {
     pub(crate) config: crate::config::Cache,
 }
 
-/// The state of a git repository
-#[derive(Debug, PartialEq)]
-pub enum RepositoryState {
-    /// Apply mailbox in progress
-    ApplyMailbox,
-    /// Rebase while an apply mailbox operation is in progress
-    ApplyMailboxRebase,
-    /// Bisect in progress
-    Bisect,
-    /// Cherry pick operation in progress
-    CherryPick,
-    /// Cherry pick with multiple commits pending in the sequencer in progress
-    CherryPickSequence,
-    /// Merge operation in progress
-    Merge,
-    /// Rebase in progress
-    Rebase,
-    /// Interactive rebase in progress
-    RebaseInteractive,
-    /// Revert operation in progress
-    Revert,
-    /// Revert operation with multiple commits pending in the sequencer in progress
-    RevertSequence,
-}
-
 /// An instance with access to everything a git repository entails, best imagined as container implementing `Sync + Send` for _most_
 /// for system resources required to interact with a `git` repository which are loaded in once the instance is created.
 ///

git-repository/tests/repository/state.rs

@@ -1,5 +1,5 @@
 use crate::{named_repo, Result};
-use git_repository::RepositoryState;
+use git_repository as git;
 
 #[test]
 fn cherry_pick() -> Result {
@@ -9,7 +9,7 @@ fn cherry_pick() -> Result {
     let head_name = head.referent_name().expect("no detached head").shorten();
     assert_eq!(head_name, "main");
 
-    assert_eq!(repo.in_progress_operation(), Some(RepositoryState::CherryPick));
+    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::CherryPick));
     Ok(())
 }
 
@@ -19,7 +19,10 @@ fn rebase_interactive() -> Result {
 
     let head = repo.head()?;
     assert!(head.is_detached());
-    assert_eq!(repo.in_progress_operation(), Some(RepositoryState::RebaseInteractive));
+    assert_eq!(
+        repo.in_progress_operation(),
+        Some(git::state::InProgress::RebaseInteractive)
+    );
 
     Ok(())
 }
@@ -32,7 +35,7 @@ fn revert() -> Result {
     let head_name = head.referent_name().expect("no detached head").shorten();
     assert_eq!(head_name, "main");
 
-    assert_eq!(Some(RepositoryState::Revert), repo.in_progress_operation());
+    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::Revert));
 
     Ok(())
 }