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

use std::fs::File;
use std::path::Path;

use git2::Repository;

use crate::config::Config;
use crate::error::*;
use crate::repo_info::RepoInfo;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RepoConfig {
    #[serde(flatten)]
    pub config: Config,

    #[serde(default, flatten)]
    pub repo: RepoInfo,
}

impl RepoConfig {
    pub const DEFAULT_PATH: &'static str = ".codealong.yml";

    pub fn exists(dir: &Path) -> bool {
        Path::new(dir).join(Self::DEFAULT_PATH).exists()
    }

    pub fn from_path(path: &Path) -> Result<Self> {
        let file = File::open(path)?;
        Self::from_file(&file)
    }

    pub fn from_file(file: &File) -> Result<Self> {
        match serde_yaml::from_reader::<_, RepoConfig>(file) {
            Ok(mut config) => {
                config.config.maybe_apply_base();
                Ok(config)
            }
            Err(e) => Err(Error::from(e)),
        }
    }

    /// Attempts to read the config from the conventional location within the
    /// directory at `.codealong/config.yml`. If no config is found, fallback
    /// to the base config.
    ///
    /// If the config has no `name`, then default to the name of the directory.
    pub fn from_dir(path: &Path) -> Result<Self> {
        Self::from_repository(&Repository::discover(path)?)
    }

    pub fn from_repository(repo: &Repository) -> Result<Self> {
        // TODO once we go to bare repos we need to
        // read the object directly from git
        let path = repo.path();
        let file_path = path.join(".codealong").join(Self::DEFAULT_PATH);
        let mut config = if file_path.exists() {
            let mut config = Self::from_path(&file_path)?;
            config.config.maybe_apply_base();
            config
        } else {
            Self::default()
        };
        // TODO: merge this
        config.repo = RepoInfo::from_repository(&repo)?;
        Ok(config)
    }

    pub fn merge(&mut self, other: RepoConfig) {
        if let None = self.repo.github_name {
            self.repo.github_name = other.repo.github_name.clone();
        }
        self.config.merge(other.config);
    }
}

impl Default for RepoConfig {
    fn default() -> Self {
        RepoConfig {
            config: Config::default(),
            repo: RepoInfo::default(),
        }
    }
}
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_from_dir_without_config() {
        let config = RepoConfig::from_dir(Path::new("fixtures/repos/simple")).unwrap();
        assert_eq!(config.repo.name, "simple");
    }

    #[test]
    fn test_from_dir_with_config() {
        let config = RepoConfig::from_dir(Path::new("fixtures/repos/bare_config")).unwrap();
        assert_eq!(config.repo.name, "bare_config");
    }

    #[test]
    fn test_from_repository() {
        let config =
            RepoConfig::from_repository(&Repository::open("fixtures/repos/bare_config").unwrap())
                .unwrap();
        assert_eq!(config.repo.github_name, None);
        let config = RepoConfig::from_repository(&Repository::open_from_env().unwrap()).unwrap();
        assert_eq!(
            config.repo.github_name,
            Some("ghempton/codealong".to_owned())
        );
    }
}