draftline 0.1.0

Git-native versioning for creative content workflows.
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

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

use crate::{path::normalize_workspace_relative, DraftlineError, Result};

/// Defines which workspace files are user content.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContentPolicy {
    includes: Vec<PathBuf>,
    excludes: Vec<PathBuf>,
    large_file_threshold_bytes: u64,
}

impl Default for ContentPolicy {
    fn default() -> Self {
        Self {
            includes: Vec::new(),
            excludes: vec![PathBuf::from(".draftline")],
            large_file_threshold_bytes: 10 * 1024 * 1024,
        }
    }
}

impl ContentPolicy {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn include(mut self, path: impl AsRef<Path>) -> Result<Self> {
        self.includes.push(normalize_policy_path(path)?);
        Ok(self)
    }

    pub fn exclude(mut self, path: impl AsRef<Path>) -> Result<Self> {
        self.excludes.push(normalize_policy_path(path)?);
        Ok(self)
    }

    pub fn with_large_file_threshold(mut self, bytes: u64) -> Self {
        self.large_file_threshold_bytes = bytes;
        self
    }

    pub fn large_file_threshold_bytes(&self) -> u64 {
        self.large_file_threshold_bytes
    }

    pub fn tracks(&self, path: impl AsRef<Path>) -> Result<bool> {
        let path = normalize_workspace_relative(path)?;

        let included = self.includes.is_empty()
            || self
                .includes
                .iter()
                .any(|include| path == *include || path.starts_with(include));
        let excluded = self
            .excludes
            .iter()
            .any(|exclude| path == *exclude || path.starts_with(exclude));

        Ok(included && !excluded)
    }
}

fn normalize_policy_path(path: impl AsRef<Path>) -> Result<PathBuf> {
    let normalized = normalize_workspace_relative(path)?;
    if normalized.as_os_str().is_empty() {
        return Err(DraftlineError::InvalidContentPolicyPath(normalized));
    }

    Ok(normalized)
}

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

    #[test]
    fn excludes_draftline_state_by_default() {
        let policy = ContentPolicy::default();

        assert!(!policy.tracks(".draftline/ui-state.json").unwrap());
        assert!(policy.tracks("posts/hello.md").unwrap());
    }

    #[test]
    fn include_roots_limit_content() {
        let policy = ContentPolicy::new().include("content").unwrap();

        assert!(policy.tracks("content/post.md").unwrap());
        assert!(!policy.tracks("scratch/post.md").unwrap());
    }
}