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

use std::path::{Path, PathBuf};

use crate::config::Config;
use crate::error::*;
use crate::repo::Repo;
use crate::repo_info::RepoInfo;
use crate::workspace_config::{RepoEntry, WorkspaceConfig};

/// Represents a working directory for analyzing multiple repositories. This
/// directory contains all of the working copies of repositories that are under
/// analysis as well as a root configuration file.
pub struct Workspace {
    dir: PathBuf,
    config: WorkspaceConfig,
}

impl Workspace {
    /// Returns a workspace if the current directory has a config
    pub fn discover(dir: PathBuf) -> Option<Result<Workspace>> {
        if WorkspaceConfig::exists(&dir) {
            Some(Self::from_dir(dir))
        } else {
            None
        }
    }

    /// Return a discovered workspace or the default.
    pub fn current(dir: PathBuf) -> Result<Workspace> {
        Self::discover(dir).unwrap_or_else(|| Self::default())
    }

    /// The default workspace.
    pub fn default() -> Result<Workspace> {
        Self::from_dir(dirs::home_dir().unwrap().join(".codealong"))
    }

    /// Similar to new, but reads existing configs, creating a new one if none
    /// is present.
    pub fn from_dir(dir: PathBuf) -> Result<Workspace> {
        let config = match WorkspaceConfig::from_dir(&dir) {
            Ok(config) => config,
            Err(_) => WorkspaceConfig::default(),
        };
        Ok(Self::new(dir, config))
    }

    pub fn new(dir: PathBuf, config: WorkspaceConfig) -> Workspace {
        Workspace { dir, config }
    }

    pub fn repos_dir(&self) -> &Path {
        &self.dir
    }

    pub fn repo_dir(&self, repo_entry: &RepoEntry) -> PathBuf {
        self.repos_dir().join(&repo_entry.path())
    }

    pub fn repos(&self) -> Vec<Repo> {
        self.config
            .repos
            .iter()
            .filter(|entry| !entry.ignore)
            .map(|entry| self.repo(&entry))
            .collect()
    }

    pub fn repo(&self, entry: &RepoEntry) -> Repo {
        let path = self.repo_dir(&entry);
        Repo::new(self.config.config.clone(), path, entry.repo_info.clone())
    }

    pub fn add(&mut self, repo_info: RepoInfo, path: Option<String>) -> Result<()> {
        Ok(self.config.add(repo_info, path))
    }

    pub fn get_repo(self, name: &str) -> Option<Repo> {
        self.config.get_entry(name).map(|entry| self.repo(entry))
    }

    pub fn add_config(&mut self, config: Config) {
        self.config.config.merge(config);
    }

    pub fn dir(&self) -> &Path {
        &self.dir
    }

    pub fn path(&self) -> &Path {
        &self.dir
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_discover() -> Result<()> {
        assert!(!Workspace::discover(Path::new(".").to_owned()).is_some());
        assert!(
            Workspace::discover(Path::new("./fixtures/workspaces/serde-rs").to_owned()).is_some()
        );
        Ok(())
    }
}