ppt-rs 0.2.23

Create, read, and update PowerPoint 2007+ (.pptx) files with rich formatting, bullet styles, themes, and templates.
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Structured validation report types.

/// Severity of a package validation finding.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum ValidationSeverity {
    Warning,
    Error,
}

/// Category grouping for validation findings (used in tests and filtering).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ValidationCategory {
    MissingPart,
    Relationship,
    ContentType,
    Presentation,
    SlideMaster,
    Slide,
    Chart,
    Xml,
    Theme,
}

/// A single structural issue found in a PPTX package.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct PackageValidationIssue {
    pub category: ValidationCategory,
    pub severity: ValidationSeverity,
    pub message: String,
    /// Part path most relevant to the issue, when applicable.
    pub path: Option<String>,
}

impl PackageValidationIssue {
    pub fn error(
        category: ValidationCategory,
        message: impl Into<String>,
        path: Option<&str>,
    ) -> Self {
        Self {
            category,
            severity: ValidationSeverity::Error,
            message: message.into(),
            path: path.map(str::to_string),
        }
    }

    pub fn warning(
        category: ValidationCategory,
        message: impl Into<String>,
        path: Option<&str>,
    ) -> Self {
        Self {
            category,
            severity: ValidationSeverity::Warning,
            message: message.into(),
            path: path.map(str::to_string),
        }
    }
}

/// Aggregated result of running all package validation rules.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct PackageValidationReport {
    pub issues: Vec<PackageValidationIssue>,
}

impl PackageValidationReport {
    pub fn is_valid(&self) -> bool {
        self.issues
            .iter()
            .all(|i| i.severity != ValidationSeverity::Error)
    }

    pub fn is_ok(&self) -> bool {
        self.is_valid()
    }

    pub fn error_count(&self) -> usize {
        self.issues
            .iter()
            .filter(|i| i.severity == ValidationSeverity::Error)
            .count()
    }

    pub fn warning_count(&self) -> usize {
        self.issues
            .iter()
            .filter(|i| i.severity == ValidationSeverity::Warning)
            .count()
    }

    pub fn push(&mut self, issue: PackageValidationIssue) {
        self.issues.push(issue);
    }

    pub fn extend(&mut self, issues: impl IntoIterator<Item = PackageValidationIssue>) {
        self.issues.extend(issues);
    }

    /// Flat string list of error messages (compat with legacy `CompatReport`).
    pub fn error_messages(&self) -> Vec<String> {
        self.issues
            .iter()
            .filter(|i| i.severity == ValidationSeverity::Error)
            .map(|i| i.message.clone())
            .collect()
    }

    pub fn issues_in_category(
        &self,
        category: ValidationCategory,
    ) -> impl Iterator<Item = &PackageValidationIssue> {
        self.issues
            .iter()
            .filter(move |i| i.category == category)
    }
}

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

    #[test]
    fn counts_errors_and_warnings() {
        let mut report = PackageValidationReport::default();
        report.push(PackageValidationIssue::error(
            ValidationCategory::Presentation,
            "bad",
            Some("ppt/presentation.xml"),
        ));
        report.push(PackageValidationIssue::warning(
            ValidationCategory::Theme,
            "soft",
            None,
        ));
        assert_eq!(report.error_count(), 1);
        assert_eq!(report.warning_count(), 1);
        assert!(!report.is_valid());
    }
}