Add blame view

This closes #484.

Author: cruessler

asyncgit/src/lib.rs

@@ -77,7 +77,7 @@ pub enum AsyncNotification {
     Fetch,
 }
 
-/// current working director `./`
+/// current working directory `./`
 pub static CWD: &str = "./";
 
 /// helper function to calculate the hash of an arbitrary type that implements the `Hash` trait

asyncgit/src/sync/blame.rs

@@ -0,0 +1,189 @@
+//! Sync git API for fetching a file blame
+
+use super::{utils, CommitId};
+use crate::{error::Result, sync::get_commit_info};
+use std::io::{BufRead, BufReader};
+use std::path::Path;
+
+/// A `BlameHunk` contains all the information that will be shown to the user.
+#[derive(Clone, Hash, Debug, PartialEq, Eq)]
+pub struct BlameHunk {
+    ///
+    pub commit_id: CommitId,
+    ///
+    pub author: String,
+    ///
+    pub time: i64,
+    /// `git2::BlameHunk::final_start_line` returns 1-based indices, but
+    /// `start_line` is 0-based because the `Vec` storing the lines starts at
+    /// index 0.
+    pub start_line: usize,
+    ///
+    pub end_line: usize,
+}
+
+/// A `BlameFile` represents as a collection of hunks. This resembles `git2`’s
+/// API.
+#[derive(Default, Clone, Debug)]
+pub struct FileBlame {
+    ///
+    pub path: String,
+    ///
+    pub lines: Vec<(Option<BlameHunk>, String)>,
+}
+
+///
+pub fn blame_file(
+    repo_path: &str,
+    file_path: &str,
+    commit_id: &str,
+) -> Result<FileBlame> {
+    let repo = utils::repo(repo_path)?;
+
+    let spec = format!("{}:{}", commit_id, file_path);
+    let blame = repo.blame_file(Path::new(file_path), None)?;
+    let object = repo.revparse_single(&spec)?;
+    let blob = repo.find_blob(object.id())?;
+    let reader = BufReader::new(blob.content());
+
+    let lines: Vec<(Option<BlameHunk>, String)> = reader
+        .lines()
+        .enumerate()
+        .map(|(i, line)| {
+            // Line indices in a `FileBlame` are 1-based.
+            let corresponding_hunk = blame.get_line(i + 1);
+
+            if let Some(hunk) = corresponding_hunk {
+                let commit_id = CommitId::new(hunk.final_commit_id());
+                // Line indices in a `BlameHunk` are 1-based.
+                let start_line =
+                    hunk.final_start_line().saturating_sub(1);
+                let end_line =
+                    start_line.saturating_add(hunk.lines_in_hunk());
+
+                if let Ok(commit_info) =
+                    get_commit_info(repo_path, &commit_id)
+                {
+                    let hunk = BlameHunk {
+                        commit_id,
+                        author: commit_info.author.clone(),
+                        time: commit_info.time,
+                        start_line,
+                        end_line,
+                    };
+
+                    return (
+                        Some(hunk),
+                        line.unwrap_or_else(|_| "".into()),
+                    );
+                }
+            }
+
+            (None, line.unwrap_or_else(|_| "".into()))
+        })
+        .collect();
+
+    let file_blame = FileBlame {
+        path: file_path.into(),
+        lines,
+    };
+
+    Ok(file_blame)
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::error::Result;
+    use crate::sync::{
+        blame_file, commit, stage_add_file, tests::repo_init_empty,
+        BlameHunk,
+    };
+    use std::{
+        fs::{File, OpenOptions},
+        io::Write,
+        path::Path,
+    };
+
+    #[test]
+    fn test_blame() -> Result<()> {
+        let file_path = Path::new("foo");
+        let (_td, repo) = repo_init_empty()?;
+        let root = repo.path().parent().unwrap();
+        let repo_path = root.as_os_str().to_str().unwrap();
+
+        assert!(matches!(
+            blame_file(&repo_path, "foo", "HEAD"),
+            Err(_)
+        ));
+
+        File::create(&root.join(file_path))?
+            .write_all(b"line 1\n")?;
+
+        stage_add_file(repo_path, file_path)?;
+        commit(repo_path, "first commit")?;
+
+        let blame = blame_file(&repo_path, "foo", "HEAD")?;
+
+        assert!(matches!(
+            blame.lines.as_slice(),
+            [(
+                Some(BlameHunk {
+                    author,
+                    start_line: 0,
+                    end_line: 1,
+                    ..
+                }),
+                line
+            )] if author == "name" && line == "line 1"
+        ));
+
+        let mut file = OpenOptions::new()
+            .append(true)
+            .open(&root.join(file_path))?;
+
+        file.write(b"line 2\n")?;
+
+        stage_add_file(repo_path, file_path)?;
+        commit(repo_path, "second commit")?;
+
+        let blame = blame_file(&repo_path, "foo", "HEAD")?;
+
+        assert!(matches!(
+            blame.lines.as_slice(),
+            [
+                (
+                    Some(BlameHunk {
+                        start_line: 0,
+                        end_line: 1,
+                        ..
+                    }),
+                    first_line
+                ),
+                (
+                    Some(BlameHunk {
+                        author,
+                        start_line: 1,
+                        end_line: 2,
+                        ..
+                    }),
+                    second_line
+                )
+            ] if author == "name" && first_line == "line 1" && second_line == "line 2"
+        ));
+
+        file.write(b"line 3\n")?;
+
+        let blame = blame_file(&repo_path, "foo", "HEAD")?;
+
+        assert_eq!(blame.lines.len(), 2);
+
+        stage_add_file(repo_path, file_path)?;
+        commit(repo_path, "third commit")?;
+
+        let blame = blame_file(&repo_path, "foo", "HEAD")?;
+
+        assert_eq!(blame.lines.len(), 3);
+
+        Ok(())
+    }
+}

asyncgit/src/sync/commits_info.rs

@@ -95,6 +95,26 @@ pub fn get_commits_info(
     Ok(res)
 }
 
+///
+pub fn get_commit_info(
+    repo_path: &str,
+    commit_id: &CommitId,
+) -> Result<CommitInfo> {
+    scope_time!("get_commit_info");
+
+    let repo = repo(repo_path)?;
+
+    let commit = repo.find_commit((*commit_id).into())?;
+    let author = commit.author();
+
+    Ok(CommitInfo {
+        message: commit.message().unwrap_or("").into(),
+        author: author.name().unwrap_or("<unknown>").into(),
+        time: commit.time().seconds(),
+        id: CommitId(commit.id()),
+    })
+}
+
 ///
 pub fn get_message(
     c: &Commit,

asyncgit/src/sync/mod.rs

@@ -3,6 +3,7 @@
 //TODO: remove once we have this activated on the toplevel
 #![deny(clippy::expect_used)]
 
+pub mod blame;
 pub mod branch;
 mod commit;
 mod commit_details;
@@ -24,6 +25,7 @@ pub mod status;
 mod tags;
 pub mod utils;
 
+pub use blame::{blame_file, BlameHunk, FileBlame};
 pub use branch::{
     branch_compare_upstream, checkout_branch, config_is_pull_rebase,
     create_branch, delete_branch, get_branch_remote,
@@ -37,7 +39,9 @@ pub use commit_details::{
     get_commit_details, CommitDetails, CommitMessage,
 };
 pub use commit_files::get_commit_files;
-pub use commits_info::{get_commits_info, CommitId, CommitInfo};
+pub use commits_info::{
+    get_commit_info, get_commits_info, CommitId, CommitInfo,
+};
 pub use diff::get_diff_commit;
 pub use hooks::{
     hooks_commit_msg, hooks_post_commit, hooks_pre_commit, HookResult,