ocelot-base 0.1.2

Shared base utilities for the ocelot project
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

use crate::diagnostic_level::DiagnosticLevel;
use crate::source_diagnostic::SourceDiagnostic;
use crate::source_diagnostics::SourceDiagnostics;

/// Compilation state that accumulates source diagnostics.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct CompilationContext {
    /// Diagnostics produced during compilation.
    pub source_diagnostics: SourceDiagnostics,
}

impl CompilationContext {
    /// Creates a compilation context from the provided source diagnostics.
    pub fn new(source_diagnostics: SourceDiagnostics) -> Self {
        Self { source_diagnostics }
    }

    /// Appends one diagnostic to this compilation context.
    pub fn add_diagnostic(&mut self, diagnostic: SourceDiagnostic) {
        self.source_diagnostics.diagnostics.push(diagnostic);
    }

    /// Appends multiple diagnostics to this compilation context.
    pub fn add_diagnostics(&mut self, diagnostics: impl IntoIterator<Item = SourceDiagnostic>) {
        self.source_diagnostics.diagnostics.extend(diagnostics);
    }

    /// Returns true when any tracked diagnostic has error severity.
    pub fn has_errors(&self) -> bool {
        self.source_diagnostics
            .diagnostics
            .iter()
            .any(|diagnostic| diagnostic.level == DiagnosticLevel::Error)
    }
}

#[cfg(test)]
mod tests {
    use super::CompilationContext;
    use crate::diagnostic_level::DiagnosticLevel;
    use crate::source_diagnostic::SourceDiagnostic;
    use crate::source_diagnostics::SourceDiagnostics;

    #[test]
    fn compilation_context_reports_errors_when_present() {
        let context = CompilationContext::new(
            SourceDiagnostics::new()
                .with_diagnostic(SourceDiagnostic::new(
                    DiagnosticLevel::Warning,
                    "examples/test.ocelot",
                    "unused value",
                ))
                .with_diagnostic(SourceDiagnostic::new(
                    DiagnosticLevel::Error,
                    "examples/test.ocelot",
                    "type mismatch",
                )),
        );

        assert!(context.has_errors());
    }

    #[test]
    fn compilation_context_reports_no_errors_when_only_warnings_are_present() {
        let context = CompilationContext::new(SourceDiagnostics::new().with_diagnostic(
            SourceDiagnostic::new(
                DiagnosticLevel::Warning,
                "examples/test.ocelot",
                "unused value",
            ),
        ));

        assert!(!context.has_errors());
    }

    #[test]
    fn compilation_context_can_add_one_diagnostic() {
        let mut context = CompilationContext::default();

        context.add_diagnostic(SourceDiagnostic::new(
            DiagnosticLevel::Warning,
            "examples/test.ocelot",
            "unused value",
        ));

        assert_eq!(context.source_diagnostics.diagnostics.len(), 1);
        assert_eq!(
            context.source_diagnostics.diagnostics[0].message,
            "unused value"
        );
    }

    #[test]
    fn compilation_context_can_add_multiple_diagnostics() {
        let mut context = CompilationContext::default();

        context.add_diagnostics([
            SourceDiagnostic::new(
                DiagnosticLevel::Warning,
                "examples/test.ocelot",
                "unused value",
            ),
            SourceDiagnostic::new(
                DiagnosticLevel::Error,
                "examples/test.ocelot",
                "type mismatch",
            ),
        ]);

        assert_eq!(context.source_diagnostics.diagnostics.len(), 2);
        assert!(context.has_errors());
    }
}