protofetch 0.1.17

A source dependency management tool for Protobuf.
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
120
121
122

use std::{env, error::Error, path::PathBuf, sync::Arc};

use crate::{
    config::ProtofetchConfig, fetch::ParallelConfig, git::cache::ProtofetchGitCache, Protofetch,
};

#[derive(Default)]
pub struct ProtofetchBuilder {
    // All other paths are relative to `root`
    root: Option<PathBuf>,
    module_file_name: Option<PathBuf>,
    lock_file_name: Option<PathBuf>,
    cache_directory_path: Option<PathBuf>,
    output_directory_name: Option<PathBuf>,
    jobs: Option<usize>,
    copy_jobs: Option<usize>,
}

impl ProtofetchBuilder {
    /// Project root directory.
    ///
    /// Defaults to the current directory.
    pub fn root(mut self, path: impl Into<PathBuf>) -> Self {
        self.root = Some(path.into());
        self
    }

    /// Name of the protofetch configuration toml file.
    ///
    /// Defaults to `protofetch.toml`.
    pub fn module_file_name(mut self, path: impl Into<PathBuf>) -> Self {
        self.module_file_name = Some(path.into());
        self
    }

    /// Name of the protofetch lock file.
    ///
    /// Defaults to `protofetch.lock`.
    pub fn lock_file_name(mut self, path: impl Into<PathBuf>) -> Self {
        self.lock_file_name = Some(path.into());
        self
    }

    /// Name of the default output directory for proto source files.
    /// It will override the `proto_out_dir` set in the module toml config.
    pub fn output_directory_name(mut self, path: impl Into<PathBuf>) -> Self {
        self.output_directory_name = Some(path.into());
        self
    }

    /// Location of the protofetch cache directory.
    ///
    /// Defaults to `$HOME/.protofetch/cache`.
    pub fn cache_directory(mut self, path: impl Into<PathBuf>) -> Self {
        self.cache_directory_path = Some(path.into());
        self
    }

    /// Maximum number of in-flight network jobs (resolve + fetch). Defaults
    /// to 16. Setting `0` falls back to 1 (effectively sequential).
    pub fn jobs(mut self, jobs: usize) -> Self {
        self.jobs = Some(jobs.max(1));
        self
    }

    /// Maximum number of in-flight disk jobs (worktree + copy). Defaults to
    /// `max(4, num_cpus / 2)`.
    pub fn copy_jobs(mut self, jobs: usize) -> Self {
        self.copy_jobs = Some(jobs.max(1));
        self
    }

    pub fn try_build(self) -> Result<Protofetch, Box<dyn Error>> {
        let config = ProtofetchConfig::load()?;

        let Self {
            root,
            module_file_name,
            lock_file_name,
            output_directory_name,
            cache_directory_path,
            jobs,
            copy_jobs,
        } = self;
        let root = match root {
            Some(root) => root,
            None => env::current_dir()?,
        };

        let module_file_name = module_file_name.unwrap_or_else(|| PathBuf::from("protofetch.toml"));

        let lock_file_name = lock_file_name.unwrap_or_else(|| PathBuf::from("protofetch.lock"));

        let cache_directory = root.join(cache_directory_path.unwrap_or(config.cache_dir));

        let cache = ProtofetchGitCache::new(cache_directory, config.default_protocol)?;

        // Build the effective ParallelConfig: defaults < config < explicit builder calls.
        let mut parallel = ParallelConfig::default();
        if let Some(j) = config.jobs {
            parallel.network_jobs = j.max(1);
        }
        if let Some(j) = config.copy_jobs {
            parallel.copy_jobs = j.max(1);
        }
        if let Some(j) = jobs {
            parallel.network_jobs = j;
        }
        if let Some(j) = copy_jobs {
            parallel.copy_jobs = j;
        }

        Ok(Protofetch {
            cache: Arc::new(cache),
            root,
            module_file_name,
            lock_file_name,
            output_directory_name,
            parallel,
        })
    }
}