consolidate naming of directories, use same convention as git2 (#364)

Author: Byron

cargo-smart-release/src/utils.rs

@@ -52,7 +52,7 @@ pub fn is_pre_release_version(semver: &Version) -> bool {
 
 pub fn is_top_level_package(manifest_path: &Utf8Path, repo: &git::Repository) -> bool {
     manifest_path
-        .strip_prefix(repo.work_tree().as_ref().expect("repo with working tree"))
+        .strip_prefix(repo.work_dir().as_ref().expect("repo with working tree"))
         .map_or(false, |p| p.components().count() == 1)
 }
 

git-repository/examples/stats.rs

@@ -5,7 +5,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let repo = git::discover(".")?.apply_environment();
     println!(
         "Repo: {}",
-        repo.work_tree().as_deref().unwrap_or(repo.git_dir()).display()
+        repo.work_dir().as_deref().unwrap_or(repo.git_dir()).display()
     );
     let commit_ids = repo
         .head()?

git-repository/src/reference/iter.rs

@@ -43,6 +43,30 @@ impl<'r> Platform<'r> {
             repo: self.repo,
         })
     }
+
+    // TODO: tests
+    /// Return an iterator over all references that are tags.
+    ///
+    /// They are all prefixed with `refs/tags`.
+    pub fn tags(&self) -> Result<Iter<'_>, init::Error> {
+        Ok(Iter {
+            inner: self.platform.prefixed("refs/tags/")?,
+            peel: false,
+            repo: self.repo,
+        })
+    }
+
+    // TODO: tests
+    /// Return an iterator over all branches.
+    ///
+    /// They are all prefixed with `refs/heads`.
+    pub fn branches(&self) -> Result<Iter<'_>, init::Error> {
+        Ok(Iter {
+            inner: self.platform.prefixed("refs/heads/")?,
+            peel: false,
+            repo: self.repo,
+        })
+    }
 }
 
 impl<'r> Iter<'r> {

git-repository/src/repository/location.rs

@@ -5,12 +5,12 @@ impl crate::Repository {
     }
 
     /// Return the work tree containing all checked out files, if there is one.
-    pub fn work_tree(&self) -> Option<&std::path::Path> {
+    pub fn work_dir(&self) -> Option<&std::path::Path> {
         self.work_tree.as_deref()
     }
 
     /// The directory of the binary path of the current process.
-    pub fn install_directory(&self) -> std::io::Result<std::path::PathBuf> {
+    pub fn install_dir(&self) -> std::io::Result<std::path::PathBuf> {
         std::env::current_exe()
     }
 

git-repository/src/repository/snapshots.rs

@@ -55,7 +55,7 @@ impl crate::Repository {
                     .map_err(|e| err.get_or_insert(e.into()))
                     .ok()
             });
-        match self.work_tree() {
+        match self.work_dir() {
             None => {
                 // TODO: replace with ref-spec `HEAD:.mailmap` for less verbose way of getting the blob id
                 blob_id = blob_id.or_else(|| {
@@ -94,7 +94,7 @@ impl crate::Repository {
             .value::<git_config::values::Path<'_>>("mailmap", None, "file")
             .ok()
             .and_then(|path| {
-                let install_dir = self.install_directory().ok()?;
+                let install_dir = self.install_dir().ok()?;
                 match path.interpolate(Some(install_dir.as_path())) {
                     Ok(path) => Some(path),
                     Err(e) => {

git-repository/tests/init/mod.rs

@@ -5,7 +5,7 @@ mod bare {
         let repo = git_repository::init_bare(tmp.path()).unwrap();
         assert_eq!(repo.kind(), git_repository::Kind::Bare);
         assert!(
-            repo.work_tree().is_none(),
+            repo.work_dir().is_none(),
             "a worktree isn't present in bare repositories"
         );
         assert_eq!(
@@ -34,15 +34,15 @@ mod non_bare {
         let tmp = tempfile::tempdir()?;
         let repo = git_repository::init(tmp.path())?;
         assert_eq!(repo.kind(), git_repository::Kind::WorkTree);
-        assert_eq!(repo.work_tree(), Some(tmp.path()), "there is a work tree by default");
+        assert_eq!(repo.work_dir(), Some(tmp.path()), "there is a work tree by default");
         assert_eq!(
             repo.git_dir(),
             tmp.path().join(".git"),
             "there is a work tree by default"
         );
         assert_eq!(git_repository::open(repo.git_dir())?, repo);
         assert_eq!(
-            git_repository::open(repo.work_tree().as_ref().expect("non-bare repo"))?,
+            git_repository::open(repo.work_dir().as_ref().expect("non-bare repo"))?,
             repo
         );
         Ok(())