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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;

use crate::issue::Issue;
use crate::issue::IssueSeverity;

pub mod annotation;
pub mod builder;
pub mod error;
pub mod issue;

pub type ReportCollection<'a> = Vec<&'a Report>;

#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct ReportFooter {
    pub message: String,
    pub notes: Vec<String>,
    pub summary: bool,
}

#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct Report {
    pub issues: Vec<Issue>,
    pub footer: Option<ReportFooter>,
}

pub trait Reportable {
    fn to_reports(&self) -> Vec<&Report>;
}

/// A report.
///
/// A report is a collection of issues.
///
/// Example:
///
/// ```rust
/// use ara_reporting::Report;
/// use ara_reporting::ReportFooter;
/// use ara_reporting::issue::Issue;
/// use ara_reporting::issue::IssueSeverity;
///
/// let report = Report::new()
///     .with_issue(Issue::error("0003", "standalone type `void` cannot be part of a union").with_source("main.ara", 10, 14))
///     .with_issue(Issue::warning("0023", "...").with_source("some_file.ara", 9, 10))
///     .with_footer(ReportFooter::new("This is a report message"));
///
/// # assert_eq!(report.issues.len(), 2);
/// # let footer = report.footer.unwrap();
/// # assert_eq!(footer.message, "This is a report message");
/// # assert!(footer.notes.is_empty());
/// # assert_eq!(report.issues[0].severity, IssueSeverity::Error);
/// # assert_eq!(report.issues[0].code, Some("0003".to_string()));
/// # assert_eq!(report.issues[0].message, "standalone type `void` cannot be part of a union");
/// # assert_eq!(report.issues[0].source, Some(("main.ara".to_string(), 10, 14)));
/// # assert_eq!(report.issues[1].severity, IssueSeverity::Warning);
/// # assert_eq!(report.issues[1].code, Some("0023".to_string()));
/// # assert_eq!(report.issues[1].message, "...");
/// # assert_eq!(report.issues[1].source, Some(("some_file.ara".to_string(), 9, 10)));
/// ```
impl Report {
    /// Create a new report.
    pub fn new() -> Self {
        Self {
            issues: vec![],
            footer: None,
        }
    }

    /// Add an issue to this report.
    #[must_use]
    pub fn with_issue(mut self, issue: Issue) -> Self {
        self.issues.push(issue);

        self
    }

    /// Add a footer to this report.
    #[must_use]
    pub fn with_footer(mut self, footer: ReportFooter) -> Self {
        self.footer = Some(footer);

        self
    }

    /// Returns the highest severity of all issues in this report.
    ///
    /// Example:
    ///
    /// ```rust
    /// use ara_reporting::Report;
    /// use ara_reporting::issue::Issue;
    /// use ara_reporting::issue::IssueSeverity;
    ///
    /// let empty_report = Report::new();
    ///
    /// let first_report = Report::new()
    ///     .with_issue(Issue::help("0001", "...").with_source("main.ara", 10, 11))
    ///     .with_issue(Issue::warning("0002", "...").with_source("some_file.ara", 9, 10))
    ///     .with_issue(Issue::note("0003", "...").with_source("main.ara", 10, 11));
    ///
    /// let second_report = Report::new()
    ///     .with_issue(Issue::warning("0001", "...").with_source("some_file.ara", 9, 10))
    ///     .with_issue(Issue::bug("0002", "...").with_source("main.ara", 10, 11))
    ///     .with_issue(Issue::error("0003", "...").with_source("main.ara", 10, 11));
    ///
    /// let third_report = Report::new()
    ///     .with_issue(Issue::help("0001", "...").with_source("main.ara", 10, 11))
    ///     .with_issue(Issue::note("0002", "...").with_source("main.ara", 10, 11))
    ///     .with_issue(Issue::note("0003", "...").with_source("main.ara", 10, 11));
    ///
    /// assert_eq!(empty_report.severity(), None);
    /// assert_eq!(first_report.severity().unwrap(), IssueSeverity::Warning);
    /// assert_eq!(second_report.severity().unwrap(), IssueSeverity::Bug);
    /// assert_eq!(third_report.severity().unwrap(), IssueSeverity::Help);
    /// ```
    pub fn severity(&self) -> Option<IssueSeverity> {
        self.issues.iter().map(|issue| issue.severity).max()
    }
}

impl Default for Report {
    fn default() -> Self {
        Self::new()
    }
}

impl std::fmt::Display for Report {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for issue in &self.issues {
            writeln!(f, "{issue}")?;
        }

        Ok(())
    }
}

impl From<Issue> for Report {
    fn from(val: Issue) -> Self {
        Report {
            issues: vec![val],
            footer: None,
        }
    }
}

/// Returns a report from anything that derives `std::error::Error`.
///
/// Example:
///
///```rust
/// use ara_reporting::issue::IssueSeverity;
/// use ara_reporting::Report;
///
/// let error: std::io::Error = std::fs::read_to_string("nonexistent_file.txt").unwrap_err();
/// let report: Report = error.into();
/// assert_eq!(report.issues.len(), 1);
///
/// let issue = report.issues.first().unwrap();
/// assert_eq!(IssueSeverity::Error, issue.severity);
/// assert_eq!(issue.message, "No such file or directory (os error 2)");
/// ```
#[doc(hidden)]
impl<E: std::error::Error> From<E> for Report {
    fn from(error: E) -> Self {
        Report::new().with_issue(error.into())
    }
}

/// A footer for a report.
///
/// A footer is a message that is displayed at the end of a report.
impl ReportFooter {
    /// Create a new footer.
    pub fn new<M: Into<String>>(message: M) -> Self {
        Self {
            message: message.into(),
            notes: vec![],
            summary: true,
        }
    }

    /// Add a note to this footer.
    #[must_use]
    pub fn with_note<S: Into<String>>(mut self, note: S) -> Self {
        self.notes.push(note.into());

        self
    }

    /// Defines if either the summary should be enabled or disabled
    #[must_use]
    pub fn with_summary(mut self, enabled: bool) -> Self {
        self.summary = enabled;

        self
    }
}

impl Reportable for Report {
    fn to_reports(&self) -> Vec<&Report> {
        vec![self]
    }
}

impl Reportable for ReportCollection<'_> {
    fn to_reports(&self) -> Vec<&Report> {
        self.to_vec()
    }
}