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
use crate::analysis::AnalysisReport;

use snafu::{ResultExt, Snafu};
use std::{fmt::Debug, io::Write, path::PathBuf};

/// Error type
#[derive(Debug, Snafu)]
#[allow(missing_docs)]
pub enum Error {
    /// Rendering of report to Json failed
    #[snafu(display("failed to render report to Json: {}", source))]
    RenderJsonFailed { source: serde_json::Error },
    /// Failed to read handlebars template from file
    #[snafu(display("failed to read handlebars template from file '{}': {}", path.display(), source))]
    ReadHbsTemplateFileFailed { path: PathBuf, source: std::io::Error },
    /// Handlebars template for Markdown is invalid
    #[snafu(display("Handlebars template is invalid: {}", source))]
    InvalidHbsTemplate { source: ::handlebars::TemplateError },
    /// Rendering of report to Markdown failed
    #[snafu(display("failed to render handlebars template: {}", source))]
    RenderHbsTemplateFailed { source: ::handlebars::RenderError },
}

pub type Result<T, E = Error> = std::result::Result<T, E>;

pub trait Renderer<W: Write>: Debug {
    fn render(&self, report: &AnalysisReport, w: W) -> Result<()>;
}

pub use crate::renderer::handlebars::HbsRenderer;
pub use json::JsonRenderer;

pub mod json {
    use super::*;

    #[derive(Default, Debug, Eq, PartialEq, Clone)]
    pub struct JsonRenderer {}

    impl JsonRenderer {
        pub fn new() -> Self { JsonRenderer {} }
    }

    impl<W: Write> Renderer<W> for JsonRenderer {
        fn render(&self, report: &AnalysisReport, w: W) -> Result<()> {
            serde_json::to_writer(w, report).context(RenderJsonFailed {})
        }
    }
}

pub mod handlebars {
    use super::*;

    use ::handlebars::Handlebars;
    use std::{fs::File, io::Read, path::Path};

    #[derive(Default, Debug, Eq, PartialEq, Clone)]
    pub struct HbsRenderer {
        template: String,
    }

    impl HbsRenderer {
        pub fn new<T: Into<String>>(template: T) -> Self {
            HbsRenderer {
                template: template.into(),
            }
        }

        pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
            let mut file = File::open(path.as_ref()).context(ReadHbsTemplateFileFailed {
                path: path.as_ref().to_path_buf(),
            })?;
            let mut template = String::new();
            file.read_to_string(&mut template).context(ReadHbsTemplateFileFailed {
                path: path.as_ref().to_path_buf(),
            })?;

            Ok(HbsRenderer { template })
        }
    }

    impl<W: Write> Renderer<W> for HbsRenderer {
        fn render(&self, report: &AnalysisReport, w: W) -> Result<()> {
            let mut handlebars = Handlebars::new();
            handlebars.register_helper("inc", Box::new(helpers::inc));
            handlebars.register_helper("rfc2822", Box::new(helpers::date_time_2822));
            handlebars.register_helper("rfc3339", Box::new(helpers::date_time_3339));
            handlebars.register_helper("escape", Box::new(helpers::escape));
            handlebars
                .register_template_string("template", &self.template)
                .context(InvalidHbsTemplate {})?;
            handlebars
                .render_to_write("template", report, w)
                .context(RenderHbsTemplateFailed {})
        }
    }

    mod helpers {
        use chrono::{DateTime, Local};
        use handlebars::{Context, Handlebars, Helper, HelperResult, Output, RenderContext, RenderError};

        pub(crate) fn inc(
            h: &Helper,
            _: &Handlebars,
            _: &Context,
            _: &mut RenderContext,
            out: &mut dyn Output,
        ) -> HelperResult {
            let value = h
                .param(0)
                .ok_or_else(|| RenderError::new("no such parameter"))?
                .value()
                .as_i64()
                .ok_or_else(|| RenderError::new("parameter is not a number"))?;
            let inc = format!("{}", value + 1);
            out.write(&inc).map_err(RenderError::with)
        }

        pub(crate) fn date_time_2822(
            h: &Helper,
            _: &Handlebars,
            _: &Context,
            _: &mut RenderContext,
            out: &mut dyn Output,
        ) -> HelperResult {
            let dt = date_param(h)?;
            out.write(&dt.to_rfc2822()).map_err(RenderError::with)
        }

        pub(crate) fn date_time_3339(
            h: &Helper,
            _: &Handlebars,
            _: &Context,
            _: &mut RenderContext,
            out: &mut dyn Output,
        ) -> HelperResult {
            let dt = date_param(h)?;
            out.write(&dt.to_rfc3339()).map_err(RenderError::with)
        }

        fn date_param(h: &Helper) -> ::std::result::Result<DateTime<Local>, RenderError> {
            let dt_str = h
                .param(0)
                .ok_or_else(|| RenderError::new("no such parameter"))?
                .value()
                .as_str()
                .ok_or_else(|| RenderError::new("parameter is not a string"))?;
            dt_str.parse::<DateTime<Local>>().map_err(RenderError::with)
        }

        pub(crate) fn escape(
            h: &Helper,
            _: &Handlebars,
            _: &Context,
            _: &mut RenderContext,
            out: &mut dyn Output,
        ) -> HelperResult {
            let from = h
                .param(0)
                .ok_or_else(|| RenderError::new("no 'from' parameter"))?
                .value()
                .as_str()
                .ok_or_else(|| RenderError::new("'from' parameter is not a string"))?;

            let to = h
                .param(1)
                .ok_or_else(|| RenderError::new("no 'to' parameter"))?
                .value()
                .as_str()
                .ok_or_else(|| RenderError::new("'to' parameter is not a string"))?;

            let data = h
                .param(2)
                .ok_or_else(|| RenderError::new("no 'data' parameter"))?
                .value()
                .as_str()
                .ok_or_else(|| RenderError::new("'data' parameter is not a string"))?;

            let escaped = data.replace(from, to);
            out.write(&escaped).map_err(RenderError::with)
        }
    }
}