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

use crate::Issue as _;

#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "lowercase")]
#[allow(dead_code)]
pub enum Severity {
    Blocker,
    Critical,
    Major,
    Minor,
    Info,
}

impl From<crate::Severity> for Severity {
    fn from(severity: crate::Severity) -> Self {
        match severity {
            crate::Severity::Blocker => Self::Blocker,
            crate::Severity::Critical => Self::Critical,
            crate::Severity::Major => Self::Major,
            crate::Severity::Minor => Self::Minor,
            crate::Severity::Info => Self::Info,
        }
    }
}

#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "lowercase")]
#[allow(dead_code)]
pub enum Category {
    #[serde(rename = "Bug Risk")] // Yes, with a space 🤷
    BugRisk,
    Clarity,
    Compatibility,
    Complexity,
    Duplication,
    Performance,
    Security,
    Style,
}

impl From<crate::Category> for Category {
    fn from(category: crate::Category) -> Self {
        match category {
            crate::Category::Bug => Self::BugRisk,
            crate::Category::Complexity => Self::Complexity,
            crate::Category::Duplication => Self::Duplication,
            crate::Category::Performance => Self::Performance,
            crate::Category::Security => Self::Security,
            crate::Category::Style => Self::Style,
        }
    }
}

#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "lowercase")]
pub struct LineColumn {
    pub line: usize,
    pub column: usize,
}

#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Position {
    Lines { begin: usize, end: usize },
    Positions { begin: LineColumn, end: LineColumn },
}

#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Location {
    pub path: String,
    #[serde(flatten)]
    pub position: Position,
}

impl From<crate::Location> for Location {
    fn from(location: crate::Location) -> Self {
        Self {
            path: location.path.to_string_lossy().to_string(),
            position: Position::Positions {
                begin: LineColumn {
                    line: location.range.start.line,
                    column: location.range.start.column,
                },
                end: LineColumn {
                    line: location.range.end.line,
                    column: location.range.end.column,
                },
            },
        }
    }
}

#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "snake_case")]
pub struct Issue {
    pub description: String,
    pub check_name: String,
    pub fingerprint: String,
    pub severity: Severity,
    pub location: Location,
}

#[derive(Debug, Default, serde::Serialize)]
pub struct Issues(Vec<Issue>);

impl Issues {
    /// Give the number of generated issues
    #[must_use]
    #[allow(clippy::len_without_is_empty)]
    pub fn len(&self) -> usize {
        self.0.len()
    }
}

impl FromIterator<Issue> for Issues {
    fn from_iter<T: IntoIterator<Item = Issue>>(issues: T) -> Self {
        Self(issues.into_iter().collect())
    }
}

#[derive(Debug)]
pub struct CodeClimate;

impl<'c> crate::FromIssues<'c> for CodeClimate {
    type Report = Issues;

    fn from_issues(issues: impl IntoIterator<Item = crate::IssueType<'c>>) -> Self::Report {
        issues
            .into_iter()
            .filter_map(|issue| {
                issue.location().map(|location| Issue {
                    description: location.message.clone(),
                    check_name: issue.issue_uid(),
                    fingerprint: format!("{:x}", issue.fingerprint()),
                    severity: Severity::from(issue.severity()),
                    location: Location::from(location),
                })
            })
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::{CodeClimate, Position, Severity};
    use crate::{test::Issue, FromIssues as _, IssueType};
    use test_log::test;

    #[test]
    fn simple_issue() {
        let issues = CodeClimate::from_issues(vec![IssueType::Test(Issue)]);
        let issue = &issues.0[0];
        assert_eq!(issue.check_name, "fake::fake_issue");
        assert!(matches!(issue.severity, Severity::Info));
        assert_eq!(issue.fingerprint, "1d623b89683f9ce4e074de1676d12416");
        assert_eq!(issue.description, "this issue is bad!");
        assert_eq!(issue.location.path, "Cargo.lock");
        let Position::Positions { begin, end } = &issue.location.position else {
            panic!("not matching a Position::Positions variant");
        };
        assert_eq!(begin.line, 1);
        assert_eq!(end.line, 2);
        assert_eq!(begin.column, 1);
        assert_eq!(end.column, 42);
    }
}