Use the name state() instead of in_progress_operation() (#393)

It seems less descriptive, but then again, people are coming from
`git2` and might appreciate familiarity.

Maybe this can be merged into something more descriptive in a future
`status()` platform, like `status().in_progress()`.

Author: Byron

git-repository/src/repository/state.rs

@@ -3,7 +3,9 @@ use crate::state;
 impl crate::Repository {
     /// Returns the status of an in progress operation on a repository or [`None`]
     /// if no operation is currently in progress.
-    pub fn in_progress_operation(&self) -> Option<state::InProgress> {
+    ///
+    /// Note to be confused with the repositories 'status'.
+    pub fn state(&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

git-repository/tests/repository/state.rs

@@ -6,7 +6,7 @@ fn apply_mailbox() -> Result {
     let repo = named_repo("make_am_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::ApplyMailbox));
+    assert_eq!(repo.state(), Some(git::state::InProgress::ApplyMailbox));
     Ok(())
 }
 
@@ -15,7 +15,7 @@ fn bisect() -> Result {
     let repo = named_repo("make_bisect_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::Bisect));
+    assert_eq!(repo.state(), Some(git::state::InProgress::Bisect));
 
     Ok(())
 }
@@ -25,7 +25,7 @@ fn cherry_pick() -> Result {
     let repo = named_repo("make_cherry_pick_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::CherryPick));
+    assert_eq!(repo.state(), Some(git::state::InProgress::CherryPick));
     Ok(())
 }
 
@@ -34,10 +34,7 @@ fn cherry_pick_sequence() -> Result {
     let repo = named_repo("make_cherry_pick_sequence_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(
-        repo.in_progress_operation(),
-        Some(git::state::InProgress::CherryPickSequence)
-    );
+    assert_eq!(repo.state(), Some(git::state::InProgress::CherryPickSequence));
 
     Ok(())
 }
@@ -47,7 +44,7 @@ fn merge() -> Result {
     let repo = named_repo("make_merge_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::Merge));
+    assert_eq!(repo.state(), Some(git::state::InProgress::Merge));
 
     Ok(())
 }
@@ -57,10 +54,7 @@ fn rebase_interactive() -> Result {
     let repo = named_repo("make_rebase_i_repo.sh")?;
 
     assert!(repo.head()?.is_detached());
-    assert_eq!(
-        repo.in_progress_operation(),
-        Some(git::state::InProgress::RebaseInteractive)
-    );
+    assert_eq!(repo.state(), Some(git::state::InProgress::RebaseInteractive));
 
     Ok(())
 }
@@ -70,7 +64,7 @@ fn revert() -> Result {
     let repo = named_repo("make_revert_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(repo.in_progress_operation(), Some(git::state::InProgress::Revert));
+    assert_eq!(repo.state(), Some(git::state::InProgress::Revert));
 
     Ok(())
 }
@@ -80,10 +74,7 @@ fn revert_sequence() -> Result {
     let repo = named_repo("make_revert_sequence_repo.sh")?;
 
     assert_eq!(repo.head_name()?.unwrap().shorten(), "main");
-    assert_eq!(
-        repo.in_progress_operation(),
-        Some(git::state::InProgress::RevertSequence)
-    );
+    assert_eq!(repo.state(), Some(git::state::InProgress::RevertSequence));
 
     Ok(())
 }