codealong 0.1.1

Git analytics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use git2::{Commit, Repository};
use slog::Logger;

use crate::analyzed_commit::AnalyzedCommit;
use crate::diff_analyzer::DiffAnalyzer;
use crate::error::Error;
use crate::repo_config::RepoConfig;

pub struct CommitAnalyzer<'a> {
    repo: &'a Repository,
    commit: Commit<'a>,
    config: &'a RepoConfig,
    logger: Logger,
}

impl<'a> CommitAnalyzer<'a> {
    pub fn new(
        repo: &'a Repository,
        commit: Commit<'a>,
        config: &'a RepoConfig,
        parent_logger: &Logger,
    ) -> CommitAnalyzer<'a> {
        let logger = parent_logger.new(o!("commit_id" => commit.id().to_string()));
        CommitAnalyzer {
            repo,
            commit,
            config,
            logger,
        }
    }

    pub fn analyze(&self) -> Result<AnalyzedCommit, Error> {
        let mut result = AnalyzedCommit::new(&self.commit);
        debug!(self.logger, "Analyzing commit"; "commit_time" => &result.authored_at.to_rfc2822(), "commit_author" => &result.author.to_string(), "commit_summary" => &result.summary);
        // TODO: deal with merge commits
        let mut has_parents = false;
        for parent in self.commit.parents() {
            let diff_analyzer =
                DiffAnalyzer::new(self.repo, &self.commit, Some(&parent), &self.config.config);
            result.merge_diff(&diff_analyzer.analyze()?);
            has_parents = true;
        }
        // handle initial commit
        if !has_parents {
            let diff_analyzer =
                DiffAnalyzer::new(self.repo, &self.commit, None, &self.config.config);
            result.merge_diff(&diff_analyzer.analyze()?);
        }
        if let Some(ref github_name) = self.config.repo.github_name {
            result.github_url = Some(format!(
                "https://github.com/{}/commit/{}",
                github_name, result.id
            ));
        }
        result.repo = Some(self.config.repo.partial());
        result.normalized_author = Some(self.config.config.person_for_identity(&result.author));
        result.normalized_committer =
            Some(self.config.config.person_for_identity(&result.committer));
        debug!(self.logger, "Done analyzing");
        return Ok(result);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test::build_test_logger;
    use crate::work_stats::WorkStats;
    use git2::Oid;
    use std::path::Path;

    #[test]
    fn test_initial_commit() {
        let repo = Repository::open("./fixtures/repos/simple").unwrap();
        let commit = repo
            .find_commit(Oid::from_str("86d242301830075e93ff039a4d1e88673a4a3020").unwrap())
            .unwrap();
        let config = RepoConfig::default();
        let analyzer = CommitAnalyzer::new(&repo, commit, &config, &build_test_logger());
        let res = analyzer.analyze().unwrap();
        assert_eq!(res.diff.stats.new_work, 1);
    }

    #[test]
    fn test_merge_commit() {
        let repo = Repository::open("./fixtures/repos/simple").unwrap();
        let commit = repo
            .find_commit(Oid::from_str("bf51d175af7e82fbd43cb8598b45aa1830890ff0").unwrap())
            .unwrap();
        let config = RepoConfig::default();
        let analyzer = CommitAnalyzer::new(&repo, commit, &config, &build_test_logger());
        let res = analyzer.analyze().unwrap();
        assert_eq!(
            res.diff.stats,
            // XXX: tweak this
            WorkStats {
                new_work: 11,
                legacy_refactor: 10,
                churn: 1,
                help_others: 0,
                other: 0,
                impact: 10
            }
        );
    }

    #[test]
    fn test_with_config() {
        let repo = Repository::open("./fixtures/repos/simple").unwrap();
        let commit = repo
            .find_commit(Oid::from_str("86d242301830075e93ff039a4d1e88673a4a3020").unwrap())
            .unwrap();
        let config = RepoConfig::from_path(Path::new("./fixtures/configs/simple.yml")).unwrap();
        let analyzer = CommitAnalyzer::new(&repo, commit, &config, &build_test_logger());
        let res = analyzer.analyze().unwrap();
        assert_eq!(res.github_url, Some("https://github.com/ghempton/codealong/commit/86d242301830075e93ff039a4d1e88673a4a3020".to_string()));
        assert_eq!(res.diff.tag_stats.get("docs").unwrap().new_work, 1);
    }
}